opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-08-06 19:44:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

man pages: fix inconsistencies

Browse Source 
I wrote a script to cross-reference podman --help against
man pages. It found a bunch of inconsistencies fix them:

 * options missing from man pages
 * options misspelled or misformatted in man pages (usually
   misplaced asterisks or missing dashes, but see --dns-opt)
 * one spurious comma in the actual source file --help

This is a fix in which I iterate over 'podman CMD --help'
and check for presence in man pages. The other way around
(look for flags in man pages, check podman CMD --help)
is probably impossible: there are too many special cases

Signed-off-by: Ed Santiago <santiago@redhat.com>
This commit is contained in:
Ed Santiago
2020-03-10 14:03:50 -06:00
parent fe49daa3c2
commit 281def2647
23 changed files with 73 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/markdown/podman-pod-stop.1.md
View File

@ -27,7 +27,7 @@ Instead of providing the pod name or ID, stop the last created pod.
The latest option is not supported on the remote client.
**--timeout**, **--time**, **-t**=*time*
**--timeout**, **-t**=*time*
Timeout to wait before forcibly stopping the containers in the pod.