summaryrefslogtreecommitdiff
path: root/docs/podman-image-prune.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2019-03-20 08:15:56 -0600
committerEd Santiago <santiago@redhat.com>2019-03-20 14:37:59 -0600
commitbeb71323b1ffbb6efdce663ba9ba7719fa0709f5 (patch)
tree4ab50d66769599e7d3e40a0e726a05c6e28fa38c /docs/podman-image-prune.1.md
parenta7098485969095197059fe27f3d636a689f642fd (diff)
downloadpodman-beb71323b1ffbb6efdce663ba9ba7719fa0709f5.tar.gz
podman-beb71323b1ffbb6efdce663ba9ba7719fa0709f5.tar.bz2
podman-beb71323b1ffbb6efdce663ba9ba7719fa0709f5.zip
man pages - consistency fixes
podman-generate and -play had the wrong NAMEs. podman-restart and -volume-prune the wrong SYNOPSIS. All the rest are varying degrees of minor: - missing a space between the NAME and description - multi-line SYNOPSIS that could be collapsed into one - use of UPPER CASE in synopsis instead of *asterisks* - improper use of **double asterisks** for options - varlink and version were transposed in podman-1 - fixed inconsistencies between the description in the man page and that in the parent manpage. These are too numerous for me to fix all. Added: script that could be used in CI to prevent future such inconsistencies. It cannot be enabled yet because there are still 35+ inconsistencies in need of cleaning. This will be difficult to review on github. I suggest pulling the PR and running 'git log -1 -p | cdif | less' 'cdif' is a handy tool for colorizing individual diffs between lines: http://kaz-utashiro.github.io/cdif/ There are other such tools; use your favorite. Comparing without visual highlights may be painful. I also encourage you to run hack/man-page-checker and suggest more fixes for the problems it's finding. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/podman-image-prune.1.md')
-rw-r--r--docs/podman-image-prune.1.md4
1 files changed, 1 insertions, 3 deletions
diff --git a/docs/podman-image-prune.1.md b/docs/podman-image-prune.1.md
index df912c380..7d5fd2fc8 100644
--- a/docs/podman-image-prune.1.md
+++ b/docs/podman-image-prune.1.md
@@ -5,9 +5,7 @@
podman-image-prune - Remove all unused images
# SYNOPSIS
-**podman image prune**
-[**-a**|**--all**]
-[**-h**|**--help**]
+**podman image prune** [*-a*|*--all*] [*-h*|*--help*]
# DESCRIPTION
**podman image prune** removes all dangling images from local storage. With the `all` option,