From 8e11a825e18a571ca8fd624ce0053682b238133f Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Mon, 10 Aug 2020 13:34:24 -0600 Subject: Cross-reference *.rst files too There are a bunch of *.rst files in docs/source, linking sometimes to man pages and sometimes to other .rst files. These files each have entries of the following form: :doc:`foo ` Description of foo ...for all podman sub and sub-subcommands 'foo'. Read all .rst files and make sure that: - all entries in a given file are in alphabetical order - all link-to-foo targets point to existing doc files - every subcommand known by 'podman help' has a corresponding doc entry in a .rst file Signed-off-by: Ed Santiago --- docs/source/Commands.rst | 2 +- docs/source/image.rst | 6 +++--- docs/source/managecontainers.rst | 4 ++-- docs/source/system.rst | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) (limited to 'docs/source') diff --git a/docs/source/Commands.rst b/docs/source/Commands.rst index a3ff24e89..096bdbedf 100644 --- a/docs/source/Commands.rst +++ b/docs/source/Commands.rst @@ -98,7 +98,7 @@ Commands :doc:`top ` Display the running processes of a container -:doc:`umount ` Unmounts working container's root filesystem +:doc:`unmount ` Unmounts working container's root filesystem :doc:`unpause ` Unpause the processes in one or more containers diff --git a/docs/source/image.rst b/docs/source/image.rst index fe3a7aa3b..2b0ef3d43 100644 --- a/docs/source/image.rst +++ b/docs/source/image.rst @@ -18,7 +18,7 @@ Image :doc:`load ` Load an image from container archive -:doc:`mount ` Mount an image's root filesystem. +:doc:`mount ` Mount an image's root filesystem. :doc:`prune ` Remove unused images @@ -40,6 +40,6 @@ Image :doc:`trust ` Manage container image trust policy -:doc:`untag ` Removes one or more names from a locally-stored image - :doc:`unmount ` Unmount an image's root filesystem + +:doc:`untag ` Removes one or more names from a locally-stored image diff --git a/docs/source/managecontainers.rst b/docs/source/managecontainers.rst index 2e787c9e9..849fd1d25 100644 --- a/docs/source/managecontainers.rst +++ b/docs/source/managecontainers.rst @@ -37,10 +37,10 @@ Manage Containers :doc:`port ` List port mappings or a specific mapping for the container -:doc:`restart ` Restart one or more containers - :doc:`prune ` Remove all stopped containers +:doc:`restart ` Restart one or more containers + :doc:`restore ` Restores one or more containers from a checkpoint :doc:`rm ` Remove one or more containers diff --git a/docs/source/system.rst b/docs/source/system.rst index e3dfa9d01..566fd1a95 100644 --- a/docs/source/system.rst +++ b/docs/source/system.rst @@ -1,7 +1,7 @@ System ====== -:doc:`connection ` Manage the destination(s) for Podman service(s) +:doc:`connection ` Manage the destination(s) for Podman service(s) :doc:`df ` Show podman disk usage -- cgit v1.2.3-54-g00ecf