From 81005f463ef0de79b4b94bb2b78f3ac0791b2703 Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Wed, 11 Mar 2020 14:59:25 -0600 Subject: New test: man page cross-ref against --help New hack/xref-helpmsgs-manpages script, added to CI 'gate' task, runs 'podman [subcommand] --help' and cross-references against man pages in docs/source/markdown/podman*.1.md See #5453 and #5460 for instances of the problems the script has found. The careful reader will find an alarming number of special-case bypasses. These are a tradeoff I am making: to get perfect coverage with no handwaving, it would be necessary to make drastic changes to some man pages, and I believe those would be counterproductive. Signed-off-by: Ed Santiago --- hack/man-page-checker | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) (limited to 'hack/man-page-checker') diff --git a/hack/man-page-checker b/hack/man-page-checker index 99d280539..ac6b9662f 100755 --- a/hack/man-page-checker +++ b/hack/man-page-checker @@ -1,16 +1,6 @@ #!/bin/bash # -# man-page-name-checker - validate and cross-reference man page names -# -# FIXME as of 2019-03-20 there are still four files with inconsistent names: -# -# podman-logs.1.md NAME= podman-container-logs -# podman-info.1.md NAME= podman-system-info -# podman-rm.1.md NAME= podman-container-rm -# podman-rmi.1.md NAME= podman-image-rm -# -# If those four get renamed (with suitable symlink fixes), this script -# can be enabled in CI to prevent future inconsistencies. +# man-page-checker - validate and cross-reference man page names # die() { -- cgit v1.2.3-54-g00ecf