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, 24 insertions, 20 deletions

diff --git a/cmd/podman/images/tag.go b/cmd/podman/images/tag.go
index dae3416c4..859489552 100644
--- a/cmd/podman/images/tag.go
+++ b/cmd/podman/images/tag.go
@@ -9,22 +9,24 @@ import (
 var (
 	tagDescription = "Adds one or more additional names to locally-stored image."
 	tagCommand     = &cobra.Command{
-		Use:   "tag [flags] IMAGE TARGET_NAME [TARGET_NAME...]",
-		Short: "Add an additional name to a local image",
-		Long:  tagDescription,
-		RunE:  tag,
-		Args:  cobra.MinimumNArgs(2),
+		Use:                   "tag IMAGE TARGET_NAME [TARGET_NAME...]",
+		Short:                 "Add an additional name to a local image",
+		Long:                  tagDescription,
+		RunE:                  tag,
+		Args:                  cobra.MinimumNArgs(2),
+		DisableFlagsInUseLine: true,
 		Example: `podman tag 0e3bbc2 fedora:latest
   podman tag imageID:latest myNewImage:newTag
   podman tag httpd myregistryhost:5000/fedora/httpd:v2`,
 	}
 
 	imageTagCommand = &cobra.Command{
-		Args:  tagCommand.Args,
-		Use:   tagCommand.Use,
-		Short: tagCommand.Short,
-		Long:  tagCommand.Long,
-		RunE:  tagCommand.RunE,
+		Args:                  tagCommand.Args,
+		DisableFlagsInUseLine: true,
+		Use:                   tagCommand.Use,
+		Short:                 tagCommand.Short,
+		Long:                  tagCommand.Long,
+		RunE:                  tagCommand.RunE,
 		Example: `podman image tag 0e3bbc2 fedora:latest
   podman image tag imageID:latest myNewImage:newTag
   podman image tag httpd myregistryhost:5000/fedora/httpd:v2`,
diff --git a/cmd/podman/images/untag.go b/cmd/podman/images/untag.go
index 266a3f115..5d1274895 100644
--- a/cmd/podman/images/untag.go
+++ b/cmd/podman/images/untag.go
@@ -8,22 +8,24 @@ import (
 
 var (
 	untagCommand = &cobra.Command{
-		Use:   "untag [flags] IMAGE [NAME...]",
-		Short: "Remove a name from a local image",
-		Long:  "Removes one or more names from a locally-stored image.",
-		RunE:  untag,
-		Args:  cobra.MinimumNArgs(1),
+		Use:                   "untag IMAGE [NAME...]",
+		Short:                 "Remove a name from a local image",
+		Long:                  "Removes one or more names from a locally-stored image.",
+		RunE:                  untag,
+		Args:                  cobra.MinimumNArgs(1),
+		DisableFlagsInUseLine: true,
 		Example: `podman untag 0e3bbc2
   podman untag imageID:latest otherImageName:latest
   podman untag httpd myregistryhost:5000/fedora/httpd:v2`,
 	}
 
 	imageUntagCommand = &cobra.Command{
-		Args:  untagCommand.Args,
-		Use:   untagCommand.Use,
-		Short: untagCommand.Short,
-		Long:  untagCommand.Long,
-		RunE:  untagCommand.RunE,
+		Args:                  untagCommand.Args,
+		DisableFlagsInUseLine: true,
+		Use:                   untagCommand.Use,
+		Short:                 untagCommand.Short,
+		Long:                  untagCommand.Long,
+		RunE:                  untagCommand.RunE,
 		Example: `podman image untag 0e3bbc2
   podman image untag imageID:latest otherImageName:latest
   podman image untag httpd myregistryhost:5000/fedora/httpd:v2`,