opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-05-17 15:18:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

man page xref: validate displayed man page names

Browse Source 
command tables are chock full of duplication, hence they break.
Look for inconsistencies between the displayed man page name
and the actual man page name:

    |  foo    | [podman-foo(1)](podman-cmd-foo.1.md) | ...
                        ^^^

Inspired by #17474.

We can't actually check the subcommand name (the plain "foo")
because there are many existing subcommands whose name does
not match the man page: rmi vs image-rm, list vs podman-ps.

Signed-off-by: Ed Santiago <santiago@redhat.com>
This commit is contained in:
Ed Santiago
2023-02-13 05:31:22 -07:00
parent 86da741d89
commit 34d412e13d
3 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
hack/xref-helpmsgs-manpages
View File

@ -429,15 +429,27 @@ sub podman_man {
}
# In podman-<subcommand>.1.md
elsif ($line =~ /^\|\s+(\S+)\s+\|\s+\[\S+\]\((\S+)\.1\.md\)/) {
# 1 1 2 3 3 4 4 2
elsif ($line =~ /^\|\s+(\S+)\s+\|\s+(\[(\S+)\]\((\S+)\.1\.md\))/) {
# $1 will be changed by recursion _*BEFORE*_ left-hand assignment
my $subcmd = $1;
my ($subcmd, $blob, $shown_name, $link_name) = ($1, $2, $3, $4);
if ($previous_subcmd gt $subcmd) {
warn "$ME: $subpath:$.: '$previous_subcmd' and '$subcmd' are out of order\n";
++$Errs;
}
$previous_subcmd = $subcmd;
$man{$subcmd} = podman_man($2);
$man{$subcmd} = podman_man($link_name);
# Check for inconsistencies between the displayed man page name
# and the actual man page name, e.g.
# '[podman-bar(1)](podman-baz.1.md)
$shown_name =~ s/\(\d\)$//;
$shown_name =~ s/\\//g; # backslashed hyphens
(my $should_be = $link_name) =~ s/\.1\.md$//;
if ($shown_name ne $should_be) {
warn "$ME: $subpath:$.: '$shown_name' should be '$should_be' in '$blob'\n";
++$Errs;
}
}
}