summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-system-reset.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2020-06-24 10:16:59 -0600
committerEd Santiago <santiago@redhat.com>2020-06-24 10:39:10 -0600
commitc6090c290e1eb8b60148a026773c5f8cce6eb435 (patch)
treee1bc4c93f87a91913bfcec82807a637cd06d0acf /docs/source/markdown/podman-system-reset.1.md
parent988fd27541dfa852ee9543c2d8a916896ef0c774 (diff)
downloadpodman-c6090c290e1eb8b60148a026773c5f8cce6eb435.tar.gz
podman-c6090c290e1eb8b60148a026773c5f8cce6eb435.tar.bz2
podman-c6090c290e1eb8b60148a026773c5f8cce6eb435.zip
Docs: consistency between man / --help
New functionality in hack/man-page-checker: start cross- referencing the man page 'Synopsis' line against the output of 'podman foo --help'. This is part 1, flag/option consistency. Part 2 (arg consistency) is too big and will have to wait for later. flag/option consistency means: if 'podman foo --help' includes the string '[flags]' in the Usage message, make sure the man page includes '[*options*]' in its Synopsis line, and vice-versa. This found several inconsistencies, which I've fixed. While doing this I realized that Cobra automatically includes a 'Flags:' subsection in its --help output for all subcommands that have defined flags. This is great - it lets us cross-check against the usage synopsis, and make sure that '[flags]' is present or absent as needed, without fear of human screwups. If a flag-less subcommand ever gets extended with flags, but the developer forgets to add '[flags]' and remove DisableFlagsInUseLine, we now have a test that will catch that. (This, too, caught two instances which I fixed). I don't actually know if the new man-page-checker functionality will work in CI: I vaguely recall that it might run before 'make podman' does; and also vaguely recall that some steps were taken to remedy that. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-system-reset.1.md')
-rw-r--r--docs/source/markdown/podman-system-reset.1.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-system-reset.1.md b/docs/source/markdown/podman-system-reset.1.md
index 432f275f4..f290e26d5 100644
--- a/docs/source/markdown/podman-system-reset.1.md
+++ b/docs/source/markdown/podman-system-reset.1.md
@@ -4,7 +4,7 @@
podman\-system\-reset - Reset storage back to initial state
## SYNOPSIS
-**podman system reset**
+**podman system reset** [*options*]
## DESCRIPTION
**podman system reset** removes all pods, containers, images and volumes.