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

Man pages: assert that subcommands are in order

Browse Source 
For each podman*.md file with a subcommand table (podman,
podman-container, etc), assert that the subcommand list
is sorted.

Change is bigger than it should be, because it switches from
nice clean local per-function error counting to using a nasty
global.

Signed-off-by: Ed Santiago <santiago@redhat.com>
This commit is contained in:
Ed Santiago
2020-08-10 08:39:06 -06:00
parent 6d3075a6c7
commit ca893b8329
1 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
hack/xref-helpmsgs-manpages
View File

@ -29,6 +29,9 @@ my $PODMAN = $ENV{PODMAN} || $Default_Podman;
# Path to podman markdown source files (of the form podman-*.1.md) # Path to podman markdown source files (of the form podman-*.1.md)
my $Markdown_Path = 'docs/source/markdown'; my $Markdown_Path = 'docs/source/markdown';
# Global error count
my $Errs = 0;
# END user-customizable section # END user-customizable section
############################################################################### ###############################################################################
@ -97,10 +100,10 @@ sub main {
my $help = podman_help(); my $help = podman_help();
my $man = podman_man('podman'); my $man = podman_man('podman');
my $retval = xref_by_help($help, $man) xref_by_help($help, $man);
+ xref_by_man($help, $man); xref_by_man($help, $man);
exit !!$retval; exit !!$Errs;
} }
################## ##################
@ -108,23 +111,20 @@ sub main {
################## ##################
sub xref_by_help { sub xref_by_help {
my ($help, $man, @subcommand) = @_; my ($help, $man, @subcommand) = @_;
my $errs = 0;
for my $k (sort keys %$help) { for my $k (sort keys %$help) {
if (exists $man->{$k}) { if (exists $man->{$k}) {
if (ref $help->{$k}) { if (ref $help->{$k}) {
$errs += xref_by_help($help->{$k}, $man->{$k}, @subcommand, $k); xref_by_help($help->{$k}, $man->{$k}, @subcommand, $k);
} }
# Otherwise, non-ref is leaf node such as a --option # Otherwise, non-ref is leaf node such as a --option
} }
else { else {
my $man = $man->{_path} || 'man'; my $man = $man->{_path} || 'man';
warn "$ME: podman @subcommand --help lists $k, but $k not in $man\n"; warn "$ME: podman @subcommand --help lists $k, but $k not in $man\n";
++$errs; ++$Errs;
} }
} }
return $errs;
} }
################# #################
@ -137,13 +137,11 @@ sub xref_by_help {
sub xref_by_man { sub xref_by_man {
my ($help, $man, @subcommand) = @_; my ($help, $man, @subcommand) = @_;
my $errs = 0;
# FIXME: this generates way too much output # FIXME: this generates way too much output
for my $k (grep { $_ ne '_path' } sort keys %$man) { for my $k (grep { $_ ne '_path' } sort keys %$man) {
if (exists $help->{$k}) { if (exists $help->{$k}) {
if (ref $man->{$k}) { if (ref $man->{$k}) {
$errs += xref_by_man($help->{$k}, $man->{$k}, @subcommand, $k); xref_by_man($help->{$k}, $man->{$k}, @subcommand, $k);
} }
} }
elsif ($k ne '--help' && $k ne '-h') { elsif ($k ne '--help' && $k ne '-h') {
@ -175,11 +173,9 @@ sub xref_by_man {
next if "@subcommand" eq 'system' && $k eq 'service'; next if "@subcommand" eq 'system' && $k eq 'service';
warn "$ME: podman @subcommand: $k in $man, but not --help\n"; warn "$ME: podman @subcommand: $k in $man, but not --help\n";
++$errs; ++$Errs;
} }
} }
return $errs;
} }
@ -249,6 +245,7 @@ sub podman_man {
or die "$ME: Cannot read $manpath: $!\n"; or die "$ME: Cannot read $manpath: $!\n";
my $section = ''; my $section = '';
my @most_recent_flags; my @most_recent_flags;
my $previous_subcmd = '';
while (my $line = <$fh>) { while (my $line = <$fh>) {
chomp $line; chomp $line;
next unless $line; # skip empty lines next unless $line; # skip empty lines
@ -278,6 +275,11 @@ sub podman_man {
elsif ($line =~ /^\|\s+(\S+)\s+\|\s+\[\S+\]\((\S+)\.1\.md\)/) { elsif ($line =~ /^\|\s+(\S+)\s+\|\s+\[\S+\]\((\S+)\.1\.md\)/) {
# $1 will be changed by recursion _*BEFORE*_ left-hand assignment # $1 will be changed by recursion _*BEFORE*_ left-hand assignment
my $subcmd = $1; my $subcmd = $1;
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($2);
} }
} }