summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2020-08-10 13:34:24 -0600
committerEd Santiago <santiago@redhat.com>2020-08-11 08:03:37 -0600
commit8e11a825e18a571ca8fd624ce0053682b238133f (patch)
treeb81ff38098c2dd50a654fedb429a970c00e9e00b /docs
parentca893b83293e895d2dbd27f6fa287e396368d3bc (diff)
downloadpodman-8e11a825e18a571ca8fd624ce0053682b238133f.tar.gz
podman-8e11a825e18a571ca8fd624ce0053682b238133f.tar.bz2
podman-8e11a825e18a571ca8fd624ce0053682b238133f.zip
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 <link-to-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 <santiago@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/source/Commands.rst2
-rw-r--r--docs/source/image.rst6
-rw-r--r--docs/source/managecontainers.rst4
-rw-r--r--docs/source/system.rst2
4 files changed, 7 insertions, 7 deletions
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 <markdown/podman-top.1>` Display the running processes of a container
-:doc:`umount <markdown/podman-umount.1>` Unmounts working container's root filesystem
+:doc:`unmount <markdown/podman-unmount.1>` Unmounts working container's root filesystem
:doc:`unpause <markdown/podman-unpause.1>` 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 <markdown/podman-load.1>` Load an image from container archive
-:doc:`mount <markdown/podman-images-mount.1>` Mount an image's root filesystem.
+:doc:`mount <markdown/podman-image-mount.1>` Mount an image's root filesystem.
:doc:`prune <markdown/podman-image-prune.1>` Remove unused images
@@ -40,6 +40,6 @@ Image
:doc:`trust <markdown/podman-image-trust.1>` Manage container image trust policy
-:doc:`untag <markdown/podman-untag.1>` Removes one or more names from a locally-stored image
-
:doc:`unmount <markdown/podman-unmount.1>` Unmount an image's root filesystem
+
+:doc:`untag <markdown/podman-untag.1>` 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 <markdown/podman-port.1>` List port mappings or a specific mapping for the container
-:doc:`restart <markdown/podman-restart.1>` Restart one or more containers
-
:doc:`prune <markdown/podman-container-prune.1>` Remove all stopped containers
+:doc:`restart <markdown/podman-restart.1>` Restart one or more containers
+
:doc:`restore <markdown/podman-container-restore.1>` Restores one or more containers from a checkpoint
:doc:`rm <markdown/podman-rm.1>` 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 <markdown/podman-system-conection.1>` Manage the destination(s) for Podman service(s)
+:doc:`connection <connection>` Manage the destination(s) for Podman service(s)
:doc:`df <markdown/podman-system-df.1>` Show podman disk usage