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(basename($filename, ".in"), ".pod");
  83     my $foundfilename = 0;
  84     my %foundfilenames = ();
  85     my %names;
  86     foreach my $n ( split ',', $tmp ) {
  87         $n =~ s/^\s+//;
  88         $n =~ s/\s+$//;
  89         print "$id the name '$n' contains white-space\n"
  90             if $n =~ /\s/;
  91         $names{$n} = 1;
  92         $foundfilename++ if $n eq $simplename;
  93         $foundfilenames{$n} = 1
  94             if ((-f "$dirname/$n.pod.in" || -f "$dirname/$n.pod")
  95                 && $n ne $simplename);
  96     }
  97     print "$id the following exist as other .pod or .pod.in 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 ($3) is located before BEFORE ($4)
 155 sub check_section_location()
 156 {
 157     my $id = shift;
 158     my $contents = shift;
 159     my $section = shift;
 160     my $before = shift;
 161
 162     return
 163         unless $contents =~ /=head1 $section/ and $contents =~ /=head1 $before/;
 164     print "$id $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     my $id = "${filename}:1:";
 182
 183     # Check ordering of some sections in man3
 184     if ( $filename =~ m|man3/| ) {
 185         &check_section_location($id, $contents, "RETURN VALUES", "EXAMPLES");
 186         &check_section_location($id, $contents, "SEE ALSO", "HISTORY");
 187         &check_section_location($id, $contents, "EXAMPLES", "SEE ALSO");
 188     }
 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 EXAMPLE not EXAMPLES section.\n"
 201         if $contents =~ /=head1 EXAMPLE[^S]/;
 202     print "$id missing copyright\n"
 203         if $contents !~ /Copyright .* The OpenSSL Project Authors/;
 204     print "$id copyright not last\n"
 205         if $contents =~ /head1 COPYRIGHT.*=head/ms;
 206     print "$id head2 in All uppercase\n"
 207         if $contents =~ /head2\s+[A-Z ]+\n/;
 208     print "$id extra space after head\n"
 209         if $contents =~ /=head\d\s\s+/;
 210     print "$id period in NAME section\n"
 211         if $contents =~ /=head1 NAME.*\.\n.*=head1 SYNOPSIS/ms;
 212     print "$id Duplicate $1 in L<>\n"
 213         if $contents =~ /L<([^>]*)\|([^>]*)>/ && $1 eq $2;
 214     print "$id Bad =over $1\n"
 215         if $contents =~ /=over([^ ][^24])/;
 216     print "$id Possible version style issue\n"
 217         if $contents =~ /OpenSSL version [019]/;
 218
 219     if ( $contents !~ /=for comment multiple includes/ ) {
 220         # Look for multiple consecutive openssl #include lines
 221         # (non-consecutive lines are okay; see man3/MD5.pod).
 222         if ( $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms ) {
 223             my $count = 0;
 224             foreach my $line ( split /\n+/, $1 ) {
 225                 if ( $line =~ m@include <openssl/@ ) {
 226                     print "$id has multiple includes\n" if ++$count == 2;
 227                 } else {
 228                     $count = 0;
 229                 }
 230             }
 231         }
 232     }
 233
 234     open my $OUT, '>', $temp
 235         or die "Can't open $temp, $!";
 236     podchecker($filename, $OUT);
 237     close $OUT;
 238     open $OUT, '<', $temp
 239         or die "Can't read $temp, $!";
 240     while ( <$OUT> ) {
 241         next if /\(section\) in.*deprecated/;
 242         print;
 243     }
 244     close $OUT;
 245     unlink $temp || warn "Can't remove $temp, $!";
 246
 247     # Find what section this page is in; assume 3.
 248     my $section = 3;
 249     $section = $1 if $dirname =~ /man([1-9])/;
 250
 251     foreach ((@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}})) {
 252         # Skip "return values" if not -s
 253         print "$id: missing $_ head1 section\n"
 254             if $contents !~ /^=head1\s+${_}\s*$/m;
 255     }
 256 }
 257
 258 my %dups;
 259
 260 sub parsenum()
 261 {
 262     my $file = shift;
 263     my @apis;
 264
 265     open my $IN, '<', $file
 266         or die "Can't open $file, $!, stopped";
 267
 268     while ( <$IN> ) {
 269         next if /^#/;
 270         next if /\bNOEXIST\b/;
 271         my @fields = split();
 272         die "Malformed line $_"
 273             if scalar @fields != 2 && scalar @fields != 4;
 274         push @apis, $fields[0];
 275     }
 276
 277     close $IN;
 278
 279     print "# Found ", scalar(@apis), " in $file\n" unless $opt_p;
 280     return sort @apis;
 281 }
 282
 283 sub getdocced
 284 {
 285     my $dir = shift;
 286     my %return;
 287
 288     foreach my $pod ( glob("$dir/*.pod"), glob("$dir/*.pod.in") ) {
 289         my %podinfo = extract_pod_info($pod);
 290         foreach my $n ( @{$podinfo{names}} ) {
 291             $return{$n} = $pod;
 292             print "# Duplicate $n in $pod and $dups{$n}\n"
 293                 if defined $dups{$n} && $dups{$n} ne $pod;
 294             $dups{$n} = $pod;
 295         }
 296     }
 297
 298     return %return;
 299 }
 300
 301 my %docced;
 302
 303 sub loadmissing($)
 304 {
 305     my $missingfile = shift;
 306     my @missing;
 307
 308     open FH, $missingfile
 309         || die "Can't open $missingfile";
 310     while ( <FH> ) {
 311         chomp;
 312         next if /^#/;
 313         push @missing, $_;
 314     }
 315     close FH;
 316
 317     return @missing;
 318 }
 319
 320 sub checkmacros()
 321 {
 322     my $count = 0;
 323     my %seen;
 324     my @missing;
 325
 326     if ($opt_o) {
 327         @missing = loadmissing('util/missingmacro111.txt');
 328     } elsif ($opt_v) {
 329         @missing = loadmissing('util/missingmacro.txt');
 330     }
 331
 332     print "# Checking macros (approximate)\n" if !$opt_s;
 333     foreach my $f ( glob('include/openssl/*.h') ) {
 334         # Skip some internals we don't want to document yet.
 335         next if $f eq 'include/openssl/asn1.h';
 336         next if $f eq 'include/openssl/asn1t.h';
 337         next if $f eq 'include/openssl/err.h';
 338         open(IN, $f) || die "Can't open $f, $!";
 339         while ( <IN> ) {
 340             next unless /^#\s*define\s*(\S+)\(/;
 341             my $macro = $1;
 342             next if $docced{$macro} || defined $seen{$macro};
 343             next if $macro =~ /i2d_/
 344                 || $macro =~ /d2i_/
 345                 || $macro =~ /DEPRECATEDIN/
 346                 || $macro =~ /IMPLEMENT_/
 347                 || $macro =~ /DECLARE_/;
 348
 349             # Skip macros known to be missing
 350             next if $opt_v && grep( /^$macro$/, @missing);
 351
 352             print "$f:$macro\n" if $opt_d || $opt_e;
 353             $count++;
 354             $seen{$macro} = 1;
 355         }
 356         close(IN);
 357     }
 358     print "# Found $count macros missing\n" if !$opt_s || $count > 0;
 359 }
 360
 361 sub printem()
 362 {
 363     my $libname = shift;
 364     my $numfile = shift;
 365     my $missingfile = shift;
 366     my $count = 0;
 367     my %seen;
 368
 369     my @missing = loadmissing($missingfile) if ($opt_v);
 370
 371     foreach my $func ( &parsenum($numfile) ) {
 372         next if $docced{$func} || defined $seen{$func};
 373
 374         # Skip ASN1 utilities
 375         next if $func =~ /^ASN1_/;
 376
 377         # Skip functions known to be missing
 378         next if $opt_v && grep( /^$func$/, @missing);
 379
 380         print "$libname:$func\n" if $opt_d || $opt_e;
 381         $count++;
 382         $seen{$func} = 1;
 383     }
 384     print "# Found $count missing from $numfile\n\n" if !$opt_s || $count > 0;
 385 }
 386
 387
 388 # Collection of links in each POD file.
 389 # filename => [ "foo(1)", "bar(3)", ... ]
 390 my %link_collection = ();
 391 # Collection of names in each POD file.
 392 # "name(s)" => filename
 393 my %name_collection = ();
 394
 395 sub collectnames {
 396     my $filename = shift;
 397     $filename =~ m|man(\d)/|;
 398     my $section = $1;
 399     my $simplename = basename(basename($filename, ".in"), ".pod");
 400     my $id = "${filename}:1:";
 401
 402     my $contents = '';
 403     {
 404         local $/ = undef;
 405         open POD, $filename or die "Couldn't open $filename, $!";
 406         $contents = <POD>;
 407         close POD;
 408     }
 409
 410     $contents =~ /=head1 NAME([^=]*)=head1 /ms;
 411     my $tmp = $1;
 412     unless (defined $tmp) {
 413         print "$id weird name section\n";
 414         return;
 415     }
 416     $tmp =~ tr/\n/ /;
 417     $tmp =~ s/ -.*//g;
 418
 419     my @names =
 420         map { s|/|-|g; $_ }              # Treat slash as dash
 421         map { s/^\s+//g; s/\s+$//g; $_ } # Trim prefix and suffix blanks
 422         split(/,/, $tmp);
 423     unless (grep { $simplename eq $_ } @names) {
 424         print "$id missing $simplename\n";
 425         push @names, $simplename;
 426     }
 427     foreach my $name (@names) {
 428         next if $name eq "";
 429         if ($name =~ /\s/) {
 430             print "$id '$name' contains white space\n";
 431         }
 432         my $name_sec = "$name($section)";
 433         if (! exists $name_collection{$name_sec}) {
 434             $name_collection{$name_sec} = $filename;
 435         } elsif ($filename eq $name_collection{$name_sec}) {
 436             print "$id $name_sec repeated in NAME section of $name_collection{$name_sec}\n"
 437         } else {
 438             print "$id $name_sec also in NAME section of $name_collection{$name_sec}\n";
 439         }
 440     }
 441
 442     my @foreign_names =
 443         map { map { s/\s+//g; $_ } split(/,/, $_) }
 444         $contents =~ /=for\s+comment\s+foreign\s+manuals:\s*(.*)\n\n/;
 445     foreach (@foreign_names) {
 446         $name_collection{$_} = undef; # It still exists!
 447     }
 448
 449     my @links = $contents =~ /L<
 450                               # if the link is of the form L<something|name(s)>,
 451                               # then remove 'something'.  Note that 'something'
 452                               # may contain POD codes as well...
 453                               (?:(?:[^\|]|<[^>]*>)*\|)?
 454                               # we're only interested in references that have
 455                               # a one digit section number
 456                               ([^\/>\(]+\(\d\))
 457                              /gx;
 458     $link_collection{$filename} = [ @links ];
 459 }
 460
 461 sub checklinks {
 462     foreach my $filename (sort keys %link_collection) {
 463         foreach my $link (@{$link_collection{$filename}}) {
 464             print "${filename}:1: reference to non-existing $link\n"
 465                 unless exists $name_collection{$link};
 466         }
 467     }
 468 }
 469
 470 sub publicize() {
 471     foreach my $name ( &parsenum('util/libcrypto.num') ) {
 472         $public{$name} = 1;
 473     }
 474     foreach my $name ( &parsenum('util/libssl.num') ) {
 475         $public{$name} = 1;
 476     }
 477     foreach my $name ( &parsenum('util/private.num') ) {
 478         $public{$name} = 1;
 479     }
 480 }
 481
 482 my %skips = (
 483     'aes128' => 1,
 484     'aes192' => 1,
 485     'aes256' => 1,
 486     'aria128' => 1,
 487     'aria192' => 1,
 488     'aria256' => 1,
 489     'camellia128' => 1,
 490     'camellia192' => 1,
 491     'camellia256' => 1,
 492     'des' => 1,
 493     'des3' => 1,
 494     'idea' => 1,
 495     '[cipher]' => 1,
 496     '[digest]' => 1,
 497 );
 498
 499 sub checkflags() {
 500     my $cmd = shift;
 501     my %cmdopts;
 502     my %docopts;
 503     my $ok = 1;
 504
 505     # Get the list of options in the command.
 506     open CFH, "./apps/openssl list --options $cmd|"
 507         || die "Can list options for $cmd, $!";
 508     while ( <CFH> ) {
 509         chop;
 510         s/ .$//;
 511         $cmdopts{$_} = 1;
 512     }
 513     close CFH;
 514
 515     # Get the list of flags from the synopsis
 516     open CFH, "<doc/man1/$cmd.pod"
 517         || die "Can't open $cmd.pod, $!";
 518     while ( <CFH> ) {
 519         chop;
 520         last if /DESCRIPTION/;
 521         next unless /\[B<-([^ >]+)/;
 522         $docopts{$1} = 1;
 523     }
 524     close CFH;
 525
 526     # See what's in the command not the manpage.
 527     my @undocced = ();
 528     foreach my $k ( keys %cmdopts ) {
 529         push @undocced, $k unless $docopts{$k};
 530     }
 531     if ( scalar @undocced > 0 ) {
 532         $ok = 0;
 533         foreach ( @undocced ) {
 534             print "doc/man1/$cmd.pod: Missing -$_\n";
 535         }
 536     }
 537
 538     # See what's in the command not the manpage.
 539     my @unimpl = ();
 540     foreach my $k ( keys %docopts ) {
 541         push @unimpl, $k unless $cmdopts{$k};
 542     }
 543     if ( scalar @unimpl > 0 ) {
 544         $ok = 0;
 545         foreach ( @unimpl ) {
 546             next if defined $skips{$_};
 547             print "doc/man1/$cmd.pod: Not implemented -$_\n";
 548         }
 549     }
 550
 551     return $ok;
 552 }
 553
 554 getopts('cdesolnphuv');
 555
 556 &help() if $opt_h;
 557
 558 $opt_n = 1 if $opt_p;
 559 $opt_u = 1 if $opt_d;
 560 $opt_e = 1 if $opt_s;
 561 $opt_v = 1 if $opt_o || $opt_e;
 562
 563 die "Cannot use both -u and -v" if $opt_u && $opt_v;
 564 die "Cannot use both -d and -e" if $opt_d && $opt_e;
 565
 566 # We only need to check c, l, n, u and v.
 567 # Options d, e, s, o and p imply one of the above.
 568 die "Need one of -[cdesolnpuv] flags.\n"
 569     unless $opt_c or $opt_l or $opt_n or $opt_u or $opt_v;
 570
 571 if ( $opt_c ) {
 572     my $ok = 1;
 573     my @commands = ();
 574
 575     # Get list of commands.
 576     open FH, "./apps/openssl list -1 -commands|"
 577         || die "Can't list commands, $!";
 578     while ( <FH> ) {
 579         chop;
 580         push @commands, $_;
 581     }
 582     close FH;
 583
 584     # See if each has a manpage.
 585     foreach ( @commands ) {
 586         next if $_ eq 'help' || $_ eq 'exit';
 587         if ( ! -f "doc/man1/$_.pod" ) {
 588             print "doc/man1/$_.pod does not exist\n";
 589             $ok = 0;
 590         } else {
 591             $ok = 0 if not &checkflags($_);
 592         }
 593     }
 594
 595     # See what help is missing.
 596     open FH, "./apps/openssl list --missing-help |"
 597         || die "Can't list missing help, $!";
 598     while ( <FH> ) {
 599         chop;
 600         my ($cmd, $flag) = split;
 601         print "$cmd has no help for -$flag\n";
 602         $ok = 0;
 603     }
 604     close FH;
 605
 606     exit 1 if not $ok;
 607 }
 608
 609 if ( $opt_l ) {
 610     foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'), glob('doc/*/*.pod.in'),
 611                               glob('doc/internal/*/*.pod'))) {
 612         collectnames($_);
 613     }
 614     checklinks();
 615 }
 616
 617 if ( $opt_n ) {
 618     &publicize() if $opt_p;
 619     foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'), glob('doc/*/*.pod.in'))) {
 620         &check($_);
 621     }
 622     {
 623         local $opt_p = undef;
 624         foreach (@ARGV ? @ARGV : glob('doc/internal/*/*.pod')) {
 625             &check($_);
 626         }
 627     }
 628 }
 629
 630 if ( $opt_u || $opt_v) {
 631     my %temp = getdocced('doc/man3');
 632     foreach ( keys %temp ) {
 633         $docced{$_} = $temp{$_};
 634     }
 635     if ($opt_o) {
 636         &printem('crypto', 'util/libcrypto.num', 'util/missingcrypto111.txt');
 637         &printem('ssl', 'util/libssl.num', 'util/missingssl111.txt');
 638     } else {
 639         &printem('crypto', 'util/libcrypto.num', 'util/missingcrypto.txt');
 640         &printem('ssl', 'util/libssl.num', 'util/missingssl.txt');
 641     }
 642     &checkmacros();
 643 }
 644
 645 exit;