summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-04-09 00:48:36 -0700
committerGitHub <noreply@github.com>2019-04-09 00:48:36 -0700
commit0fdbf1d306a806520257e100bb9f306e516fd8f0 (patch)
tree439f6d4c8b85928ab2db258ac515a39509642bb7
parentc94903ab45396d04f3c94587b8f505435d0ea723 (diff)
parentb57d2c7d704235a9d830d43573ab8f4e063b15b2 (diff)
downloadpodman-0fdbf1d306a806520257e100bb9f306e516fd8f0.tar.gz
podman-0fdbf1d306a806520257e100bb9f306e516fd8f0.tar.bz2
podman-0fdbf1d306a806520257e100bb9f306e516fd8f0.zip
Merge pull request #2873 from edsantiago/podman_command_check_usability
CI check for --help vs man pages: usability fix
-rwxr-xr-xhack/podman-commands.sh22
1 files changed, 22 insertions, 0 deletions
diff --git a/hack/podman-commands.sh b/hack/podman-commands.sh
index eb599763c..7530e20d0 100755
--- a/hack/podman-commands.sh
+++ b/hack/podman-commands.sh
@@ -82,4 +82,26 @@ function compare_help_and_man() {
compare_help_and_man
+if [ $rc -ne 0 ]; then
+ cat <<EOF
+
+**************************
+** INTERPRETING RESULTS **
+**************************************************************************
+*
+* The above results show differences between 'podman --help' and
+* podman man pages.
+*
+* The 'checking:' header indicates the specific command (and possibly
+* subcommand) being tested, e.g. podman --help vs docs/podman.1.md.
+*
+* A '-' indicates a subcommand present in 'podman --help' but not the
+* corresponding man page.
+*
+* A '+' indicates a subcommand present in the man page but not --help.
+*
+**************************************************************************
+EOF
+fi
+
exit $rc