summaryrefslogtreecommitdiff
path: root/cmd/podman/healthcheck
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 /cmd/podman/healthcheck
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 'cmd/podman/healthcheck')
-rw-r--r--cmd/podman/healthcheck/run.go13
1 files changed, 7 insertions, 6 deletions
diff --git a/cmd/podman/healthcheck/run.go b/cmd/podman/healthcheck/run.go
index 5612910cb..17ddf17b6 100644
--- a/cmd/podman/healthcheck/run.go
+++ b/cmd/podman/healthcheck/run.go
@@ -12,12 +12,13 @@ import (
var (
healthcheckRunDescription = "run the health check of a container"
healthcheckrunCommand = &cobra.Command{
- Use: "run [flags] CONTAINER",
- Short: "run the health check of a container",
- Long: healthcheckRunDescription,
- Example: `podman healthcheck run mywebapp`,
- RunE: run,
- Args: cobra.ExactArgs(1),
+ Use: "run CONTAINER",
+ Short: "run the health check of a container",
+ Long: healthcheckRunDescription,
+ Example: `podman healthcheck run mywebapp`,
+ RunE: run,
+ Args: cobra.ExactArgs(1),
+ DisableFlagsInUseLine: true,
}
)