podman/docs/podman-healthcheck.1.md at dc19c3e9f8675fd45d7f69cff8a7b496b06b02b8

mirror of https://github.com/containers/podman synced 2024-10-20 17:23:30 +00:00

Ed Santiago beb71323b1 man pages - consistency fixes

podman-generate and -play had the wrong NAMEs.

podman-restart and -volume-prune the wrong SYNOPSIS.

All the rest are varying degrees of minor:

  - missing a space between the NAME and description
  - multi-line SYNOPSIS that could be collapsed into one
  - use of UPPER CASE in synopsis instead of *asterisks*
  - improper use of **double asterisks** for options
  - varlink and version were transposed in podman-1
  - fixed inconsistencies between the description in
    the man page and that in the parent manpage. These
    are too numerous for me to fix all.

Added: script that could be used in CI to prevent future
such inconsistencies. It cannot be enabled yet because
there are still 35+ inconsistencies in need of cleaning.

This will be difficult to review on github. I suggest
pulling the PR and running 'git log -1 -p | cdif | less'

'cdif' is a handy tool for colorizing individual diffs between
lines:

   http://kaz-utashiro.github.io/cdif/

There are other such tools; use your favorite. Comparing
without visual highlights may be painful.

I also encourage you to run hack/man-page-checker and suggest
more fixes for the problems it's finding.

Signed-off-by: Ed Santiago <santiago@redhat.com>

2019-03-20 14:37:59 -06:00

785 B

Raw Blame History

% podman-healthcheck(1)

NAME

podman-healthcheck - Manage healthchecks for containers

SYNOPSIS

podman healthcheck subcommand

DESCRIPTION

podman healthcheck is a set of subcommands that manage container healthchecks

SUBCOMMANDS

Command	Man Page	Description
run	podman-healthcheck-run(1)	Run a container healthcheck

HISTORY

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

785 B Raw Blame History