util/find-doc-nits

   1 #! /usr/bin/env perl
   2 # Copyright 2002-2019 The OpenSSL Project Authors. All Rights Reserved.
   3 #
   4 # Licensed under the Apache License 2.0 (the "License").  You may not use
   5 # this file except in compliance with the License.  You can obtain a copy
   6 # in the file LICENSE in the source distribution or at
   7 # https://www.openssl.org/source/license.html
   8
   9
  10 require 5.10.0;
  11 use warnings;
  12 use strict;
  13 use Pod::Checker;
  14 use File::Find;
  15 use File::Basename;
  16 use File::Spec::Functions;
  17 use Getopt::Std;
  18 use lib catdir(dirname($0), "perl");
  19 use OpenSSL::Util::Pod;
  20
  21 # Options.
  22 our($opt_d);
  23 our($opt_e);
  24 our($opt_s);
  25 our($opt_o);
  26 our($opt_h);
  27 our($opt_l);
  28 our($opt_n);
  29 our($opt_p);
  30 our($opt_u);
  31 our($opt_v);
  32 our($opt_c);
  33
  34 sub help()
  35 {
  36     print <<EOF;
  37 Find small errors (nits) in documentation.  Options:
  38     -d Detailed list of undocumented (implies -u)
  39     -e Detailed list of new undocumented (implies -v)
  40     -s Same as -e except no output is generated if nothing is undocumented
  41     -o Causes -e/-v to count symbols added since 1.1.1 as new (implies -v)
  42     -l Print bogus links
  43     -n Print nits in POD pages
  44     -p Warn if non-public name documented (implies -n)
  45     -u Count undocumented functions
  46     -v Count new undocumented functions
  47     -h Print this help message
  48     -c List undocumented commands and options
  49 EOF
  50     exit;
  51 }
  52
  53 my $temp = '/tmp/docnits.txt';
  54 my $OUT;
  55 my %public;
  56
  57 my %mandatory_sections =
  58     ( '*'    => [ 'NAME', 'DESCRIPTION', 'COPYRIGHT' ],
  59       1      => [ 'SYNOPSIS', 'OPTIONS' ],
  60       3      => [ 'SYNOPSIS', 'RETURN VALUES' ],
  61       5      => [ ],
  62       7      => [ ] );
  63
  64 # Cross-check functions in the NAME and SYNOPSIS section.
  65 sub name_synopsis()
  66 {
  67     my $id = shift;
  68     my $filename = shift;
  69     my $contents = shift;
  70
  71     # Get NAME section and all words in it.
  72     return unless $contents =~ /=head1 NAME(.*)=head1 SYNOPSIS/ms;
  73     my $tmp = $1;
  74     $tmp =~ tr/\n/ /;
  75     print "$id trailing comma before - in NAME\n" if $tmp =~ /, *-/;
  76     $tmp =~ s/ -.*//g;
  77     print "$id POD markup among the names in NAME\n" if $tmp =~ /[<>]/;
  78     $tmp =~ s/  */ /g;
  79     print "$id missing comma in NAME\n" if $tmp =~ /[^,] /;
  80
  81     my $dirname = dirname($filename);
  82     my $simplename = basename($filename);
  83     $simplename =~ s/.pod$//;
  84     my $foundfilename = 0;
  85     my %foundfilenames = ();
  86     my %names;
  87     foreach my $n ( split ',', $tmp ) {
  88         $n =~ s/^\s+//;
  89         $n =~ s/\s+$//;
  90         print "$id the name '$n' contains white-space\n"
  91             if $n =~ /\s/;
  92         $names{$n} = 1;
  93         $foundfilename++ if $n eq $simplename;
  94         $foundfilenames{$n} = 1
  95             if -f "$dirname/$n.pod" && $n ne $simplename;
  96     }
  97     print "$id the following exist as other .pod files:\n",
  98         join(" ", sort keys %foundfilenames), "\n"
  99         if %foundfilenames;
 100     print "$id $simplename (filename) missing from NAME section\n"
 101         unless $foundfilename;
 102     foreach my $n ( keys %names ) {
 103         print "$id $n is not public\n"
 104             if $opt_p and !defined $public{$n};
 105     }
 106
 107     # Find all functions in SYNOPSIS
 108     return unless $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms;
 109     my $syn = $1;
 110     foreach my $line ( split /\n+/, $syn ) {
 111         next unless $line =~ /^\s/;
 112         my $sym;
 113         $line =~ s/STACK_OF\([^)]+\)/int/g;
 114         $line =~ s/SPARSE_ARRAY_OF\([^)]+\)/int/g;
 115         $line =~ s/__declspec\([^)]+\)//;
 116         if ( $line =~ /env (\S*)=/ ) {
 117             # environment variable env NAME=...
 118             $sym = $1;
 119         } elsif ( $line =~ /typedef.*\(\*(\S+)\)\(.*/ ) {
 120             # a callback function pointer: typedef ... (*NAME)(...
 121             $sym = $1;
 122         } elsif ( $line =~ /typedef.* (\S+)\(.*/ ) {
 123             # a callback function signature: typedef ... NAME(...
 124             $sym = $1;
 125         } elsif ( $line =~ /typedef.* (\S+);/ ) {
 126             # a simple typedef: typedef ... NAME;
 127             $sym = $1;
 128         } elsif ( $line =~ /enum (\S*) \{/ ) {
 129             # an enumeration: enum ... {
 130             $sym = $1;
 131         } elsif ( $line =~ /#(?:define|undef) ([A-Za-z0-9_]+)/ ) {
 132             $sym = $1;
 133         } elsif ( $line =~ /([A-Za-z0-9_]+)\(/ ) {
 134             $sym = $1;
 135         }
 136         else {
 137             next;
 138         }
 139         print "$id $sym missing from NAME section\n"
 140             unless defined $names{$sym};
 141         $names{$sym} = 2;
 142
 143         # Do some sanity checks on the prototype.
 144         print "$id prototype missing spaces around commas: $line\n"
 145             if ( $line =~ /[a-z0-9],[^ ]/ );
 146     }
 147
 148     foreach my $n ( keys %names ) {
 149         next if $names{$n} == 2;
 150         print "$id $n missing from SYNOPSIS\n";
 151     }
 152 }
 153
 154 # Check if SECTION is located before BEFORE
 155 sub check_section_location()
 156 {
 157     my $filename = shift;
 158     my $contents = shift;
 159     my $section = shift;
 160     my $before = shift;
 161
 162     return unless $contents =~ /=head1 $section/
 163         and $contents =~ /=head1 $before/;
 164     print "$filename: $section should be placed before $before section\n"
 165         if $contents =~ /=head1 $before.*=head1 $section/ms;
 166 }
 167
 168 sub check()
 169 {
 170     my $filename = shift;
 171     my $dirname = basename(dirname($filename));
 172
 173     my $contents = '';
 174     {
 175         local $/ = undef;
 176         open POD, $filename or die "Couldn't open $filename, $!";
 177         $contents = <POD>;
 178         close POD;
 179     }
 180
 181     # Check if EXAMPLES is located after RETURN VALUES section.
 182     &check_section_location($filename, $contents, "RETURN VALUES", "EXAMPLES") if $filename =~ m|man3/|;
 183     # Check if HISTORY is located after SEE ALSO
 184     &check_section_location($filename, $contents, "SEE ALSO", "HISTORY") if $filename =~ m|man3/|;
 185     # Check if SEE ALSO is located after EXAMPLES
 186     &check_section_location($filename, $contents, "EXAMPLES", "SEE ALSO") if $filename =~ m|man3/|;
 187
 188     my $id = "${filename}:1:";
 189
 190     &name_synopsis($id, $filename, $contents)
 191         unless $contents =~ /=for comment generic/
 192             or $filename =~ m@man[157]/@;
 193
 194     print "$id doesn't start with =pod\n"
 195         if $contents !~ /^=pod/;
 196     print "$id doesn't end with =cut\n"
 197         if $contents !~ /=cut\n$/;
 198     print "$id more than one cut line.\n"
 199         if $contents =~ /=cut.*=cut/ms;
 200     print "$id missing copyright\n"
 201         if $contents !~ /Copyright .* The OpenSSL Project Authors/;
 202     print "$id copyright not last\n"
 203         if $contents =~ /head1 COPYRIGHT.*=head/ms;
 204     print "$id head2 in All uppercase\n"
 205         if $contents =~ /head2\s+[A-Z ]+\n/;
 206     print "$id extra space after head\n"
 207         if $contents =~ /=head\d\s\s+/;
 208     print "$id period in NAME section\n"
 209         if $contents =~ /=head1 NAME.*\.\n.*=head1 SYNOPSIS/ms;
 210     print "$id Duplicate $1 in L<>\n"
 211         if $contents =~ /L<([^>]*)\|([^>]*)>/ && $1 eq $2;
 212     print "$id Bad =over $1\n"
 213         if $contents =~ /=over([^ ][^24])/;
 214     print "$id Possible version style issue\n"
 215         if $contents =~ /OpenSSL version [019]/;
 216
 217     if ( $contents !~ /=for comment multiple includes/ ) {
 218         # Look for multiple consecutive openssl #include lines
 219         # (non-consecutive lines are okay; see man3/MD5.pod).
 220         if ( $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms ) {
 221             my $count = 0;
 222             foreach my $line ( split /\n+/, $1 ) {
 223                 if ( $line =~ m@include <openssl/@ ) {
 224                     print "$id has multiple includes\n" if ++$count == 2;
 225                 } else {
 226                     $count = 0;
 227                 }
 228             }
 229         }
 230     }
 231
 232     open my $OUT, '>', $temp
 233         or die "Can't open $temp, $!";
 234     podchecker($filename, $OUT);
 235     close $OUT;
 236     open $OUT, '<', $temp
 237         or die "Can't read $temp, $!";
 238     while ( <$OUT> ) {
 239         next if /\(section\) in.*deprecated/;
 240         print;
 241     }
 242     close $OUT;
 243     unlink $temp || warn "Can't remove $temp, $!";
 244
 245     # Find what section this page is in; assume 3.
 246     my $section = 3;
 247     $section = $1 if $dirname =~ /man([1-9])/;
 248
 249     foreach ((@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}})) {
 250         # Skip "return values" if not -s
 251         print "$id: missing $_ head1 section\n"
 252             if $contents !~ /^=head1\s+${_}\s*$/m;
 253     }
 254 }
 255
 256 my %dups;
 257
 258 sub parsenum()
 259 {
 260     my $file = shift;
 261     my @apis;
 262
 263     open my $IN, '<', $file
 264         or die "Can't open $file, $!, stopped";
 265
 266     while ( <$IN> ) {
 267         next if /^#/;
 268         next if /\bNOEXIST\b/;
 269         next if /\bEXPORT_VAR_AS_FUNC\b/;
 270         my @fields = split();
 271         die "Malformed line $_"
 272             if scalar @fields != 2 && scalar @fields != 4;
 273         push @apis, $fields[0];
 274     }
 275
 276     close $IN;
 277
 278     print "# Found ", scalar(@apis), " in $file\n" unless $opt_p;
 279     return sort @apis;
 280 }
 281
 282 sub getdocced
 283 {
 284     my $dir = shift;
 285     my %return;
 286
 287     foreach my $pod ( glob("$dir/*.pod") ) {
 288         my %podinfo = extract_pod_info($pod);
 289         foreach my $n ( @{$podinfo{names}} ) {
 290             $return{$n} = $pod;
 291             print "# Duplicate $n in $pod and $dups{$n}\n"
 292                 if defined $dups{$n} && $dups{$n} ne $pod;
 293             $dups{$n} = $pod;
 294         }
 295     }
 296
 297     return %return;
 298 }
 299
 300 my %docced;
 301
 302 sub loadmissing($)
 303 {
 304     my $missingfile = shift;
 305     my @missing;
 306
 307     open FH, $missingfile
 308         || die "Can't open $missingfile";
 309     while ( <FH> ) {
 310         chomp;
 311         next if /^#/;
 312         push @missing, $_;
 313     }
 314     close FH;
 315
 316     return @missing;
 317 }
 318
 319 sub checkmacros()
 320 {
 321     my $count = 0;
 322     my %seen;
 323     my @missing;
 324
 325     if ($opt_o) {
 326         @missing = loadmissing('util/missingmacro111.txt');
 327     } elsif ($opt_v) {
 328         @missing = loadmissing('util/missingmacro.txt');
 329     }
 330
 331     print "# Checking macros (approximate)\n" if !$opt_s;
 332     foreach my $f ( glob('include/openssl/*.h') ) {
 333         # Skip some internals we don't want to document yet.
 334         next if $f eq 'include/openssl/asn1.h';
 335         next if $f eq 'include/openssl/asn1t.h';
 336         next if $f eq 'include/openssl/err.h';
 337         open(IN, $f) || die "Can't open $f, $!";
 338         while ( <IN> ) {
 339             next unless /^#\s*define\s*(\S+)\(/;
 340             my $macro = $1;
 341             next if $docced{$macro} || defined $seen{$macro};
 342             next if $macro =~ /i2d_/
 343                 || $macro =~ /d2i_/
 344                 || $macro =~ /DEPRECATEDIN/
 345                 || $macro =~ /IMPLEMENT_/
 346                 || $macro =~ /DECLARE_/;
 347
 348             # Skip macros known to be missing
 349             next if $opt_v && grep( /^$macro$/, @missing);
 350
 351             print "$f:$macro\n" if $opt_d || $opt_e;
 352             $count++;
 353             $seen{$macro} = 1;
 354         }
 355         close(IN);
 356     }
 357     print "# Found $count macros missing\n" if !$opt_s || $count > 0;
 358 }
 359
 360 sub printem()
 361 {
 362     my $libname = shift;
 363     my $numfile = shift;
 364     my $missingfile = shift;
 365     my $count = 0;
 366     my %seen;
 367
 368     my @missing = loadmissing($missingfile) if ($opt_v);
 369
 370     foreach my $func ( &parsenum($numfile) ) {
 371         next if $docced{$func} || defined $seen{$func};
 372
 373         # Skip ASN1 utilities
 374         next if $func =~ /^ASN1_/;
 375
 376         # Skip functions known to be missing
 377         next if $opt_v && grep( /^$func$/, @missing);
 378
 379         print "$libname:$func\n" if $opt_d || $opt_e;
 380         $count++;
 381         $seen{$func} = 1;
 382     }
 383     print "# Found $count missing from $numfile\n\n" if !$opt_s || $count > 0;
 384 }
 385
 386
 387 # Collection of links in each POD file.
 388 # filename => [ "foo(1)", "bar(3)", ... ]
 389 my %link_collection = ();
 390 # Collection of names in each POD file.
 391 # "name(s)" => filename
 392 my %name_collection = ();
 393
 394 sub collectnames {
 395     my $filename = shift;
 396     $filename =~ m|man(\d)/|;
 397     my $section = $1;
 398     my $simplename = basename($filename, ".pod");
 399     my $id = "${filename}:1:";
 400
 401     my $contents = '';
 402     {
 403         local $/ = undef;
 404         open POD, $filename or die "Couldn't open $filename, $!";
 405         $contents = <POD>;
 406         close POD;
 407     }
 408
 409     $contents =~ /=head1 NAME([^=]*)=head1 /ms;
 410     my $tmp = $1;
 411     unless (defined $tmp) {
 412         print "$id weird name section\n";
 413         return;
 414     }
 415     $tmp =~ tr/\n/ /;
 416     $tmp =~ s/-.*//g;
 417
 418     my @names = map { s/^\s+//g; s/\s+$//g; $_ } split(/,/, $tmp);
 419     unless (grep { $simplename eq $_ } @names) {
 420         print "$id missing $simplename\n";
 421         push @names, $simplename;
 422     }
 423     foreach my $name (@names) {
 424         next if $name eq "";
 425         if ($name =~ /\s/) {
 426             print "$id '$name' contains white space\n";
 427         }
 428         my $name_sec = "$name($section)";
 429         if (! exists $name_collection{$name_sec}) {
 430             $name_collection{$name_sec} = $filename;
 431         } else { #elsif ($filename ne $name_collection{$name_sec}) {
 432             print "$id $name_sec also in $name_collection{$name_sec}\n";
 433         }
 434     }
 435
 436     my @foreign_names =
 437         map { map { s/\s+//g; $_ } split(/,/, $_) }
 438         $contents =~ /=for\s+comment\s+foreign\s+manuals:\s*(.*)\n\n/;
 439     foreach (@foreign_names) {
 440         $name_collection{$_} = undef; # It still exists!
 441     }
 442
 443     my @links = $contents =~ /L<
 444                               # if the link is of the form L<something|name(s)>,
 445                               # then remove 'something'.  Note that 'something'
 446                               # may contain POD codes as well...
 447                               (?:(?:[^\|]|<[^>]*>)*\|)?
 448                               # we're only interested in references that have
 449                               # a one digit section number
 450                               ([^\/>\(]+\(\d\))
 451                              /gx;
 452     $link_collection{$filename} = [ @links ];
 453 }
 454
 455 sub checklinks {
 456     foreach my $filename (sort keys %link_collection) {
 457         foreach my $link (@{$link_collection{$filename}}) {
 458             print "${filename}:1: reference to non-existing $link\n"
 459                 unless exists $name_collection{$link};
 460         }
 461     }
 462 }
 463
 464 sub publicize() {
 465     foreach my $name ( &parsenum('util/libcrypto.num') ) {
 466         $public{$name} = 1;
 467     }
 468     foreach my $name ( &parsenum('util/libssl.num') ) {
 469         $public{$name} = 1;
 470     }
 471     foreach my $name ( &parsenum('util/private.num') ) {
 472         $public{$name} = 1;
 473     }
 474 }
 475
 476 my %skips = (
 477     'aes128' => 1,
 478     'aes192' => 1,
 479     'aes256' => 1,
 480     'aria128' => 1,
 481     'aria192' => 1,
 482     'aria256' => 1,
 483     'camellia128' => 1,
 484     'camellia192' => 1,
 485     'camellia256' => 1,
 486     'des' => 1,
 487     'des3' => 1,
 488     'idea' => 1,
 489     '[cipher]' => 1,
 490     '[digest]' => 1,
 491 );
 492
 493 sub checkflags() {
 494     my $cmd = shift;
 495     my %cmdopts;
 496     my %docopts;
 497     my $ok = 1;
 498
 499     # Get the list of options in the command.
 500     open CFH, "./apps/openssl list --options $cmd|"
 501         || die "Can list options for $cmd, $!";
 502     while ( <CFH> ) {
 503         chop;
 504         s/ .$//;
 505         $cmdopts{$_} = 1;
 506     }
 507     close CFH;
 508
 509     # Get the list of flags from the synopsis
 510     open CFH, "<doc/man1/$cmd.pod"
 511         || die "Can't open $cmd.pod, $!";
 512     while ( <CFH> ) {
 513         chop;
 514         last if /DESCRIPTION/;
 515         next unless /\[B<-([^ >]+)/;
 516         $docopts{$1} = 1;
 517     }
 518     close CFH;
 519
 520     # See what's in the command not the manpage.
 521     my @undocced = ();
 522     foreach my $k ( keys %cmdopts ) {
 523         push @undocced, $k unless $docopts{$k};
 524     }
 525     if ( scalar @undocced > 0 ) {
 526         $ok = 0;
 527         foreach ( @undocced ) {
 528             print "doc/man1/$cmd.pod: Missing -$_\n";
 529         }
 530     }
 531
 532     # See what's in the command not the manpage.
 533     my @unimpl = ();
 534     foreach my $k ( keys %docopts ) {
 535         push @unimpl, $k unless $cmdopts{$k};
 536     }
 537     if ( scalar @unimpl > 0 ) {
 538         $ok = 0;
 539         foreach ( @unimpl ) {
 540             next if defined $skips{$_};
 541             print "doc/man1/$cmd.pod: Not implemented -$_\n";
 542         }
 543     }
 544
 545     return $ok;
 546 }
 547
 548 getopts('cdesolnphuv');
 549
 550 &help() if $opt_h;
 551
 552 $opt_n = 1 if $opt_p;
 553 $opt_u = 1 if $opt_d;
 554 $opt_e = 1 if $opt_s;
 555 $opt_v = 1 if $opt_o || $opt_e;
 556
 557 die "Cannot use both -u and -v" if $opt_u && $opt_v;
 558 die "Cannot use both -d and -e" if $opt_d && $opt_e;
 559
 560 # We only need to check c, l, n, u and v.
 561 # Options d, e, s, o and p imply one of the above.
 562 die "Need one of -[cdesolnpuv] flags.\n"
 563     unless $opt_c or $opt_l or $opt_n or $opt_u or $opt_v;
 564
 565 if ( $opt_c ) {
 566     my $ok = 1;
 567     my @commands = ();
 568
 569     # Get list of commands.
 570     open FH, "./apps/openssl list -1 -commands|"
 571         || die "Can't list commands, $!";
 572     while ( <FH> ) {
 573         chop;
 574         push @commands, $_;
 575     }
 576     close FH;
 577
 578     # See if each has a manpage.
 579     foreach ( @commands ) {
 580         next if $_ eq 'help' || $_ eq 'exit';
 581         if ( ! -f "doc/man1/$_.pod" ) {
 582             print "doc/man1/$_.pod does not exist\n";
 583             $ok = 0;
 584         } else {
 585             $ok = 0 if not &checkflags($_);
 586         }
 587     }
 588
 589     # See what help is missing.
 590     open FH, "./apps/openssl list --missing-help |"
 591         || die "Can't list missing help, $!";
 592     while ( <FH> ) {
 593         chop;
 594         my ($cmd, $flag) = split;
 595         print "$cmd has no help for -$flag\n";
 596         $ok = 0;
 597     }
 598     close FH;
 599
 600     exit 1 if not $ok;
 601 }
 602
 603 if ( $opt_l ) {
 604     foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'),
 605                               glob('doc/internal/*/*.pod'))) {
 606         collectnames($_);
 607     }
 608     checklinks();
 609 }
 610
 611 if ( $opt_n ) {
 612     &publicize() if $opt_p;
 613     foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
 614         &check($_);
 615     }
 616     {
 617         local $opt_p = undef;
 618         foreach (@ARGV ? @ARGV : glob('doc/internal/*/*.pod')) {
 619             &check($_);
 620         }
 621     }
 622 }
 623
 624 if ( $opt_u || $opt_v) {
 625     my %temp = getdocced('doc/man3');
 626     foreach ( keys %temp ) {
 627         $docced{$_} = $temp{$_};
 628     }
 629     if ($opt_o) {
 630         &printem('crypto', 'util/libcrypto.num', 'util/missingcrypto111.txt');
 631         &printem('ssl', 'util/libssl.num', 'util/missingssl111.txt');
 632     } else {
 633         &printem('crypto', 'util/libcrypto.num', 'util/missingcrypto.txt');
 634         &printem('ssl', 'util/libssl.num', 'util/missingssl.txt');
 635     }
 636     &checkmacros();
 637 }
 638
 639 exit;