diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2022-09-26 15:42:47 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-26 15:42:47 +0200 |
| commit | cad59a12b9b390bbebbd64586dbb4028750858cc (patch) | |
| tree | ee9ece4ed2603a93db2d38a6da1e4e1137854301 | |
| parent | a00376111ef4d4275628c41d8424c223110cc626 (diff) | |
| parent | fde4d21be5ed3a696f2b6dc777ca153646c69f48 (diff) | |
| download | podman-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
| -rw-r--r-- | docs/source/markdown/podman-machine-list.1.md | 2 | ||||
| -rwxr-xr-x | hack/xref-helpmsgs-manpages | 9 |
2 files changed, 10 insertions, 1 deletions
diff --git a/docs/source/markdown/podman-machine-list.1.md b/docs/source/markdown/podman-machine-list.1.md index 351e8cf1b..0c929dcdc 100644 --- a/docs/source/markdown/podman-machine-list.1.md +++ b/docs/source/markdown/podman-machine-list.1.md @@ -1,4 +1,4 @@ -% podman-machine-ls 1 +% podman-machine-list 1 ## NAME podman\-machine\-list - List virtual machines 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'; |