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>

2 files changed, 14 insertions, 12 deletions

diff --git a/cmd/podman/manifest/inspect.go b/cmd/podman/manifest/inspect.go
index 5112aa5b2..861f4be4f 100644
--- a/cmd/podman/manifest/inspect.go
+++ b/cmd/podman/manifest/inspect.go
@@ -12,12 +12,13 @@ import (
 
 var (
 	inspectCmd = &cobra.Command{
-		Use:     "inspect [flags] IMAGE",
-		Short:   "Display the contents of a manifest list or image index",
-		Long:    "Display the contents of a manifest list or image index.",
-		RunE:    inspect,
-		Example: "podman manifest inspect localhost/list",
-		Args:    cobra.ExactArgs(1),
+		Use:                   "inspect IMAGE",
+		Short:                 "Display the contents of a manifest list or image index",
+		Long:                  "Display the contents of a manifest list or image index.",
+		RunE:                  inspect,
+		Example:               "podman manifest inspect localhost/list",
+		Args:                  cobra.ExactArgs(1),
+		DisableFlagsInUseLine: true,
 	}
 )
 
diff --git a/cmd/podman/manifest/remove.go b/cmd/podman/manifest/remove.go
index 4d345efc0..815a3f0a8 100644
--- a/cmd/podman/manifest/remove.go
+++ b/cmd/podman/manifest/remove.go
@@ -12,12 +12,13 @@ import (
 
 var (
 	removeCmd = &cobra.Command{
-		Use:     "remove [flags] LIST IMAGE",
-		Short:   "Remove an entry from a manifest list or image index",
-		Long:    "Removes an image from a manifest list or image index.",
-		RunE:    remove,
-		Example: `podman manifest remove mylist:v1.11 sha256:15352d97781ffdf357bf3459c037be3efac4133dc9070c2dce7eca7c05c3e736`,
-		Args:    cobra.ExactArgs(2),
+		Use:                   "remove LIST IMAGE",
+		Short:                 "Remove an entry from a manifest list or image index",
+		Long:                  "Removes an image from a manifest list or image index.",
+		RunE:                  remove,
+		Example:               `podman manifest remove mylist:v1.11 sha256:15352d97781ffdf357bf3459c037be3efac4133dc9070c2dce7eca7c05c3e736`,
+		Args:                  cobra.ExactArgs(2),
+		DisableFlagsInUseLine: true,
 	}
 )