diff options
| author | Ed Santiago <santiago@redhat.com> | 2020-06-24 10:16:59 -0600 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2020-06-24 10:39:10 -0600 |
| commit | c6090c290e1eb8b60148a026773c5f8cce6eb435 (patch) | |
| tree | e1bc4c93f87a91913bfcec82807a637cd06d0acf /cmd/podman/manifest/inspect.go | |
| parent | 988fd27541dfa852ee9543c2d8a916896ef0c774 (diff) | |
| download | podman-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 'cmd/podman/manifest/inspect.go')
| -rw-r--r-- | cmd/podman/manifest/inspect.go | 13 |
1 files changed, 7 insertions, 6 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, } ) |