1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
|
#!/usr/bin/perl
#
# xref-helpmsgs-manpages - cross-reference --help options against man pages
#
package LibPod::CI::XrefHelpmsgsManpages;
use v5.14;
use utf8;
use strict;
use warnings;
(our $ME = $0) =~ s|.*/||;
our $VERSION = '0.1';
# For debugging, show data structures using DumpTree($var)
#use Data::TreeDumper; $Data::TreeDumper::Displayaddress = 0;
# unbuffer output
$| = 1;
###############################################################################
# BEGIN user-customizable section
# Path to podman executable
my $Default_Podman = './bin/podman';
my $PODMAN = $ENV{PODMAN} || $Default_Podman;
# Path to all doc files, including .rst and (down one level) markdown
my $Docs_Path = 'docs/source';
# Path to podman markdown source files (of the form podman-*.1.md)
my $Markdown_Path = "$Docs_Path/markdown";
# Global error count
my $Errs = 0;
# END user-customizable section
###############################################################################
use FindBin;
###############################################################################
# BEGIN boilerplate args checking, usage messages
sub usage {
print <<"END_USAGE";
Usage: $ME [OPTIONS]
$ME recursively runs 'podman --help' against
all subcommands; and recursively reads podman-*.1.md files
in $Markdown_Path, then cross-references that each --help
option is listed in the appropriate man page and vice-versa.
$ME invokes '\$PODMAN' (default: $Default_Podman).
In the spirit of shoehorning functionality where it wasn't intended,
$ME also checks the SEE ALSO section of each man page
to ensure that references and links are properly formatted
and valid.
Exit status is zero if no inconsistencies found, one otherwise
OPTIONS:
-v, --verbose show verbose progress indicators
-n, --dry-run make no actual changes
--help display this message
--version display program name and version
END_USAGE
exit;
}
# Command-line options. Note that this operates directly on @ARGV !
our $debug = 0;
our $verbose = 0;
sub handle_opts {
use Getopt::Long;
GetOptions(
'debug!' => \$debug,
'verbose|v' => \$verbose,
help => \&usage,
version => sub { print "$ME version $VERSION\n"; exit 0 },
) or die "Try `$ME --help' for help\n";
}
# END boilerplate args checking, usage messages
###############################################################################
############################## CODE BEGINS HERE ###############################
# The term is "modulino".
__PACKAGE__->main() unless caller();
# Main code.
sub main {
# Note that we operate directly on @ARGV, not on function parameters.
# This is deliberate: it's because Getopt::Long only operates on @ARGV
# and there's no clean way to make it use @_.
handle_opts(); # will set package globals
# Fetch command-line arguments. Barf if too many.
die "$ME: Too many arguments; try $ME --help\n" if @ARGV;
my $help = podman_help();
my $man = podman_man('podman');
my $rst = podman_rst();
xref_by_help($help, $man);
xref_by_man($help, $man);
xref_rst($help, $rst);
exit !!$Errs;
}
###############################################################################
# BEGIN cross-referencing
##################
# xref_by_help # Find keys in '--help' but not in man
##################
sub xref_by_help {
my ($help, $man, @subcommand) = @_;
for my $k (sort keys %$help) {
if (exists $man->{$k}) {
if (ref $help->{$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', which is not in $man\n";
++$Errs;
}
}
}
#################
# xref_by_man # Find keys in man pages but not in --help
#################
#
# In an ideal world we could share the functionality in one function; but
# there are just too many special cases in man pages.
#
sub xref_by_man {
my ($help, $man, @subcommand) = @_;
# FIXME: this generates way too much output
for my $k (grep { $_ ne '_path' } sort keys %$man) {
if (exists $help->{$k}) {
if (ref $man->{$k}) {
xref_by_man($help->{$k}, $man->{$k}, @subcommand, $k);
}
}
elsif ($k ne '--help' && $k ne '-h') {
my $man = $man->{_path} || 'man';
# Special case: podman-inspect serves dual purpose (image, ctr)
my %ignore = map { $_ => 1 } qw(-l -s -t --latest --size --type);
next if $man =~ /-inspect/ && $ignore{$k};
# Special case: podman-diff serves dual purpose (image, ctr)
my %diffignore = map { $_ => 1 } qw(-l --latest );
next if $man =~ /-diff/ && $diffignore{$k};
# Special case: the 'trust' man page is a mess
next if $man =~ /-trust/;
# Special case: '--net' is an undocumented shortcut
next if $k eq '--net' && $help->{'--network'};
# Special case: these are actually global options
next if $k =~ /^--(cni-config-dir|runtime)$/ && $man =~ /-build/;
# Special case: weirdness with Cobra and global/local options
next if $k eq '--namespace' && $man =~ /-ps/;
next if "@subcommand" eq 'system' && $k eq 'service';
# Special case: podman completion is a hidden command
next if $k eq 'completion';
warn "$ME: 'podman @subcommand': $k in $man, but not --help\n";
++$Errs;
}
}
}
##############
# xref_rst # Cross-check *.rst files against help
##############
sub xref_rst {
my ($help, $rst, @subcommand) = @_;
# Cross-check against rst (but only subcommands, not options).
# We key on $help because that is Absolute Truth: anything in podman --help
# must be referenced in an rst (the converse is not true).
for my $k (sort grep { $_ !~ /^-/ } keys %$help) {
# Check for subcommands, if any (eg podman system -> connection -> add)
if (ref $help->{$k}) {
xref_rst($help->{$k}, $rst->{$k}, @subcommand, $k);
}
}
}
# END cross-referencing
###############################################################################
# BEGIN data gathering
#################
# podman_help # Parse output of 'podman [subcommand] --help'
#################
sub podman_help {
my %help;
open my $fh, '-|', $PODMAN, @_, '--help'
or die "$ME: Cannot fork: $!\n";
my $section = '';
while (my $line = <$fh>) {
# Cobra is blessedly consistent in its output:
# Usage: ...
# Available Commands:
# ....
# Options:
# ....
#
# Start by identifying the section we're in...
if ($line =~ /^Available\s+(Commands):/) {
$section = lc $1;
}
elsif ($line =~ /^(Options):/) {
$section = lc $1;
}
# ...then track commands and options. For subcommands, recurse.
elsif ($section eq 'commands') {
if ($line =~ /^\s{1,4}(\S+)\s/) {
my $subcommand = $1;
print "> podman @_ $subcommand\n" if $debug;
# check that the same subcommand is not listed twice (#12356)
if (exists $help{$subcommand}) {
warn "$ME: 'podman @_ help' lists '$subcommand' twice\n";
++$Errs;
}
$help{$subcommand} = podman_help(@_, $subcommand)
unless $subcommand eq 'help'; # 'help' not in man
}
}
elsif ($section eq 'options') {
# Handle '--foo' or '-f, --foo'
if ($line =~ /^\s{1,10}(--\S+)\s/) {
print "> podman @_ $1\n" if $debug;
$help{$1} = 1;
}
elsif ($line =~ /^\s{1,10}(-\S),\s+(--\S+)\s/) {
print "> podman @_ $1, $2\n" if $debug;
$help{$1} = $help{$2} = 1;
}
}
}
close $fh
or die "$ME: Error running 'podman @_ --help'\n";
return \%help;
}
################
# podman_man # Parse contents of podman-*.1.md
################
sub podman_man {
my $command = shift;
my $subpath = "$Markdown_Path/$command.1.md";
my $manpath = "$FindBin::Bin/../$subpath";
print "** $subpath \n" if $debug;
my %man = (_path => $subpath);
open my $fh, '<', $manpath
or die "$ME: Cannot read $manpath: $!\n";
my $section = '';
my @most_recent_flags;
my $previous_subcmd = '';
my $previous_flag = '';
while (my $line = <$fh>) {
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';
$previous_flag = '';
}
elsif ($line =~ /^###\s+\w+\s+OPTIONS/) {
# podman image trust has sections for set & show
$section = 'flags';
$previous_flag = '';
}
elsif ($line =~ /^\#\#\s+(SUB)?COMMANDS/) {
$section = 'commands';
}
elsif ($line =~ /^\#\#\s+SEE\s+ALSO/) {
$section = 'see-also';
}
elsif ($line =~ /^\#\#[^#]/) {
$section = '';
}
# This will be a table containing subcommand names, links to man pages.
# The format is slightly different between podman.1.md and subcommands.
elsif ($section eq 'commands') {
# In podman.1.md
if ($line =~ /^\|\s*\[podman-(\S+?)\(\d\)\]/) {
# $1 will be changed by recursion _*BEFORE*_ left-hand assignment
my $subcmd = $1;
$man{$subcmd} = podman_man("podman-$1");
}
# In podman-<subcommand>.1.md
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);
}
}
# Options should always be of the form '**-f**' or '**\-\-flag**',
# possibly separated by comma-space.
elsif ($section eq 'flags') {
# e.g. 'podman run --ip6', documented in man page, but nonexistent
if ($line =~ /^not\s+implemented/i) {
delete $man{$_} for @most_recent_flags;
}
@most_recent_flags = ();
# As of PR #8292, all options are <h4> and anchored
if ($line =~ s/^\#{4}\s+//) {
# If option has long and short form, long must come first.
# This is a while-loop because there may be multiple long
# option names, e.g. --net/--network
my $is_first = 1;
while ($line =~ s/^\*\*(--[a-z0-9-]+)\*\*(,\s+)?//g) {
my $flag = $1;
$man{$flag} = 1;
if ($flag lt $previous_flag && $is_first) {
warn "$ME: $subpath:$.: $flag should precede $previous_flag\n";
++$Errs;
}
$previous_flag = $flag if $is_first;
push @most_recent_flags, $flag;
# Further iterations of /g are allowed to be out of order,
# e.g., it's OK for "--namespace, -ns" to precede --nohead
$is_first = 0;
}
# Short form
if ($line =~ s/^\*\*(-[a-zA-Z0-9])\*\*//) {
my $flag = $1;
$man{$flag} = 1;
# Keep track of them, in case we see 'Not implemented' below
push @most_recent_flags, $flag;
}
# Options with no '=whatever'
next if !$line;
# Anything remaining *must* be of the form '=<possibilities>'
if ($line !~ /^=/) {
warn "$ME: $subpath:$.: could not parse '$line' in option description\n";
++$Errs;
}
# For some years it was traditional, albeit wrong, to write
# **--foo**=*bar*, **-f**
# The correct way is to add =*bar* at the end.
if ($line =~ s/,\s\*\*(-[a-zA-Z])\*\*//) {
$man{$1} = 1;
warn "$ME: $subpath:$.: please rewrite as ', **$1**$line'\n";
++$Errs;
}
# List of possibilities ('=*a* | *b*') must be space-separated
if ($line =~ /\|/) {
if ($line =~ /[^\s]\|[^\s]/) {
# Sigh, except for this one special case
if ($line !~ /SOURCE-VOLUME.*HOST-DIR.*CONTAINER-DIR/) {
warn "$ME: $subpath:$.: values must be space-separated: '$line'\n";
++$Errs;
}
}
my $copy = $line;
if ($copy =~ s/\**true\**//) {
if ($copy =~ s/\**false\**//) {
if ($copy !~ /[a-z]/) {
warn "$ME: $subpath:$.: Do not enumerate true/false for boolean-only options\n";
++$Errs;
}
}
}
}
}
}
# It's easy to make mistakes in the SEE ALSO elements.
elsif ($section eq 'see-also') {
_check_seealso_links( "$subpath:$.", $line );
}
}
close $fh;
# Special case: the 'image trust' man page tries hard to cover both set
# and show, which means it ends up not being machine-readable.
if ($command eq 'podman-image-trust') {
my %set = %man;
my %show = %man;
$show{$_} = 1 for qw(--raw -j --json);
return +{ set => \%set, show => \%show }
}
return \%man;
}
################
# podman_rst # Parse contents of docs/source/*.rst
################
sub podman_rst {
my %rst;
# Read all .rst files, looking for ":doc:`subcmd <target>` description"
for my $rst (glob "$Docs_Path/*.rst") {
open my $fh, '<', $rst
or die "$ME: Cannot read $rst: $!\n";
# The basename of foo.rst is usually, but not always, the name of
# a podman subcommand. There are a few special cases:
(my $command = $rst) =~ s!^.*/(.*)\.rst!$1!;
my $subcommand_href = \%rst;
if ($command eq 'Commands') {
;
}
elsif ($command eq 'managecontainers') {
$subcommand_href = $rst{container} //= { };
}
elsif ($command eq 'connection') {
$subcommand_href = $rst{system}{connection} //= { };
}
else {
$subcommand_href = $rst{$command} //= { };
}
my $previous_subcommand = '';
while (my $line = <$fh>) {
if ($line =~ /^:doc:`(\S+)\s+<(.*?)>`\s+(.*)/) {
my ($subcommand, $target, $desc) = ($1, $2, $3);
# Check that entries are in alphabetical order
if ($subcommand lt $previous_subcommand) {
warn "$ME: $rst:$.: '$previous_subcommand' and '$subcommand' are out of order\n";
++$Errs;
}
$previous_subcommand = $subcommand;
# Mark this subcommand as documented.
$subcommand_href->{$subcommand}{_desc} = $desc;
# Check for invalid links. These will be one of two forms:
# <markdown/foo.1> -> markdown/foo.1.md
# <foo> -> foo.rst
if ($target =~ m!^markdown/!) {
if (! -e "$Docs_Path/$target.md") {
warn "$ME: $rst:$.: '$subcommand' links to nonexistent $target\n";
++$Errs;
}
}
else {
if (! -e "$Docs_Path/$target.rst") {
warn "$ME: $rst:$.: '$subcommand' links to nonexistent $target.rst\n";
}
}
}
}
close $fh;
}
# Special case: 'image trust set/show' are documented in image-trust.1
$rst{image}{trust}{$_} = { _desc => 'ok' } for (qw(set show));
return \%rst;
}
# END data gathering
###############################################################################
# BEGIN sanity checking of SEE ALSO links
##########################
# _check_seealso_links # Check formatting and link validity.
##########################
sub _check_seealso_links {
my $path = shift;
my $line = shift;
return if ! $line;
# Line must be a comma-separated list of man page references, e.g.
# **foo(1)**, **[podman-bar(1)](podman-bar.1.md)**, **[xxx(8)](http...)**
TOKEN:
for my $token (split /,\s+/, $line) {
# Elements must be separated by comma and space. (We don't do further
# checks here, so it's possible for the dev to add the space and then
# have us fail on the next iteration. I choose not to address that.)
if ($token =~ /,/) {
warn "$ME: $path: please add space after comma: '$token'\n";
++$Errs;
next TOKEN;
}
# Each token must be of the form '**something**'
if ($token !~ s/^\*\*(.*)\*\*$/$1/) {
if ($token =~ /\*\*/) {
warn "$ME: $path: '$token' has asterisks in the wrong place\n";
}
else {
warn "$ME: $path: '$token' should be bracketed by '**'\n";
}
++$Errs;
next TOKEN;
}
# Is it a markdown link?
if ($token =~ /^\[(\S+)\]\((\S+)\)$/) {
my ($name, $link) = ($1, $2);
if ($name =~ /^(.*)\((\d)\)$/) {
my ($base, $section) = ($1, $2);
if (-e "$Markdown_Path/$base.$section.md" || -e "$Markdown_Path/links/$base.$section") {
if ($link ne "$base.$section.md") {
warn "$ME: $path: inconsistent link $name -> $link, expected $base.$section.md\n";
++$Errs;
}
}
else {
if (! _is_valid_external_link($base, $section, $link)) {
warn "$ME: $path: invalid link $name -> $link\n";
++$Errs;
}
}
}
else {
warn "$ME: $path: could not parse '$name' as 'manpage(N)'\n";
++$Errs;
}
}
# Not a markdown link; it must be a plain man reference, e.g. 'foo(5)'
elsif ($token =~ m!^(\S+)\((\d+)\)$!) {
my ($base, $section) = ($1, $2);
# Unadorned 'podman-foo(1)' must be a link.
if (-e "$Markdown_Path/$base.$section.md" || -e "$Markdown_Path/links/$base.$section") {
warn "$ME: $path: '$token' should be '[$token]($base.$section.md)'\n";
++$Errs;
}
# Link to man page foo(5) but without a link. This is not an error
# but Ed may sometimes want to see those on a manual test run.
warn "$ME: $path: plain '$token' would be so much nicer as a link\n"
if $verbose;
}
else {
warn "$ME: $path: invalid token '$token'\n";
++$Errs;
}
}
}
#############################
# _is_valid_external_link # Tries to validate links to external man pages
#############################
#
# This performs no actual fetches, so we can't actually check for 404.
# All we do is ensure that links conform to standard patterns. This is
# good for catching things like 'conmon(8)' pointing to a .5 URL, or
# linking to .md instead of .html.
#
# FIXME: we could actually rewrite this so as to offer hints on what to fix.
# That's a lot of work, and a lot of convoluted code, for questionable ROI.
#
sub _is_valid_external_link {
my ($base, $section, $link) = @_;
return 1 if $link =~ m!^https://github\.com/\S+/blob/(main|master)(/.*)?/\Q$base\E\.$section\.md!;
return 1 if $link =~ m!^https://.*unix\.com/man-page/(linux|redhat)/$section/$base$!;
return 1 if $link eq "https://man7\.org/linux/man-pages/man$section/$base\.$section\.html";
if ($base =~ /systemd/) {
return 1 if $link eq "https://www.freedesktop.org/software/systemd/man/$base.html";
}
return;
}
# END sanity checking of SEE ALSO links
###############################################################################
1;
|