opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-05-31 07:27:13 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
podman/docs/source/markdown/podman-healthcheck-run.1.md
Ed Santiago c6090c290e 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>
2020-06-24 10:39:10 -06:00

754 B
Raw Blame History

% podman-healthcheck-run(1)

NAME

podman-healthcheck-run - Run a container healthcheck

SYNOPSIS

podman healthcheck run container

DESCRIPTION

Runs the healthcheck command defined in a running container manually. The resulting error codes are defined as follows:

  • 0 = healthcheck command succeeded
  • 1 = healthcheck command failed
  • 125 = an error has occurred

Possible errors that can occur during the healthcheck are:

  • unable to find the container
  • container has no defined healthcheck
  • container is not running

OPTIONS

--help

Print usage statement

EXAMPLES

$ podman healthcheck run mywebapp

SEE ALSO

podman-healthcheck(1)

HISTORY

Feb 2019, Originally compiled by Brent Baude bbaude@redhat.com