diff options
author | Ed Santiago <santiago@redhat.com> | 2020-08-10 08:39:06 -0600 |
---|---|---|
committer | Ed Santiago <santiago@redhat.com> | 2020-08-11 07:49:10 -0600 |
commit | ca893b83293e895d2dbd27f6fa287e396368d3bc (patch) | |
tree | de85149b7455576a7859d4c50b2dca221a1acebb /hack/xref-helpmsgs-manpages | |
parent | 6d3075a6c79a6e761c183e0d5e6aa239fad21b63 (diff) | |
download | podman-ca893b83293e895d2dbd27f6fa287e396368d3bc.tar.gz podman-ca893b83293e895d2dbd27f6fa287e396368d3bc.tar.bz2 podman-ca893b83293e895d2dbd27f6fa287e396368d3bc.zip |
Man pages: assert that subcommands are in order
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>
Diffstat (limited to 'hack/xref-helpmsgs-manpages')
-rwxr-xr-x | hack/xref-helpmsgs-manpages | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/hack/xref-helpmsgs-manpages b/hack/xref-helpmsgs-manpages index 16b596589..fd8fe152d 100755 --- a/hack/xref-helpmsgs-manpages +++ b/hack/xref-helpmsgs-manpages @@ -29,6 +29,9 @@ my $PODMAN = $ENV{PODMAN} || $Default_Podman; # Path to podman markdown source files (of the form podman-*.1.md) my $Markdown_Path = 'docs/source/markdown'; +# Global error count +my $Errs = 0; + # END user-customizable section ############################################################################### @@ -97,10 +100,10 @@ sub main { my $help = podman_help(); my $man = podman_man('podman'); - my $retval = xref_by_help($help, $man) - + xref_by_man($help, $man); + xref_by_help($help, $man); + xref_by_man($help, $man); - exit !!$retval; + exit !!$Errs; } ################## @@ -108,23 +111,20 @@ sub main { ################## sub xref_by_help { my ($help, $man, @subcommand) = @_; - my $errs = 0; for my $k (sort keys %$help) { if (exists $man->{$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 } else { my $man = $man->{_path} || 'man'; 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 { my ($help, $man, @subcommand) = @_; - my $errs = 0; - # FIXME: this generates way too much output for my $k (grep { $_ ne '_path' } sort keys %$man) { if (exists $help->{$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') { @@ -175,11 +173,9 @@ sub xref_by_man { next if "@subcommand" eq 'system' && $k eq 'service'; 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"; my $section = ''; my @most_recent_flags; + my $previous_subcmd = ''; while (my $line = <$fh>) { chomp $line; next unless $line; # skip empty lines @@ -278,6 +275,11 @@ sub podman_man { elsif ($line =~ /^\|\s+(\S+)\s+\|\s+\[\S+\]\((\S+)\.1\.md\)/) { # $1 will be changed by recursion _*BEFORE*_ left-hand assignment 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); } } |