opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-05-20 08:36:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Cross-reference *.rst files too

Browse Source 
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>
This commit is contained in:
Ed Santiago
2020-08-10 13:34:24 -06:00
parent ca893b8329
commit 8e11a825e1
5 changed files with 116 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/Commands.rst
View File

@ -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

6
docs/source/image.rst
View File

@ -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

4
docs/source/managecontainers.rst
View File

@ -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

2
docs/source/system.rst
View File

@ -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