summaryrefslogtreecommitdiff
path: root/hack/xref-helpmsgs-manpages
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-09-26 15:42:47 +0200
committerGitHub <noreply@github.com>2022-09-26 15:42:47 +0200
commitcad59a12b9b390bbebbd64586dbb4028750858cc (patch)
treeee9ece4ed2603a93db2d38a6da1e4e1137854301 /hack/xref-helpmsgs-manpages
parenta00376111ef4d4275628c41d8424c223110cc626 (diff)
parentfde4d21be5ed3a696f2b6dc777ca153646c69f48 (diff)
downloadpodman-cad59a12b9b390bbebbd64586dbb4028750858cc.tar.gz
podman-cad59a12b9b390bbebbd64586dbb4028750858cc.tar.bz2
podman-cad59a12b9b390bbebbd64586dbb4028750858cc.zip
Merge pull request #15935 from edsantiago/xref_manpage_title
[CI:DOCS] man page xref: verify page title
Diffstat (limited to 'hack/xref-helpmsgs-manpages')
-rwxr-xr-xhack/xref-helpmsgs-manpages9
1 files changed, 9 insertions, 0 deletions
diff --git a/hack/xref-helpmsgs-manpages b/hack/xref-helpmsgs-manpages
index de9ef8630..fbf2deb22 100755
--- a/hack/xref-helpmsgs-manpages
+++ b/hack/xref-helpmsgs-manpages
@@ -292,6 +292,15 @@ sub podman_man {
chomp $line;
next unless $line; # skip empty lines
+ # First line (page title) must match the command name.
+ if ($line =~ /^%\s+/) {
+ my $expect = "% $command 1";
+ if ($line ne $expect) {
+ warn "$ME: $subpath:$.: wrong title line '$line'; should be '$expect'\n";
+ ++$Errs;
+ }
+ }
+
# .md files designate sections with leading double hash
if ($line =~ /^##\s*(GLOBAL\s+)?OPTIONS/) {
$section = 'flags';