X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=util%2Ffind-doc-nits;h=901e34f384380e9a903f87f1c299015bdd4b1af1;hp=ecd9f9af5174aab7a0e3ac093ac2ce241f389434;hb=04bc70d7373300d378aa9c075289d1ee404ec528;hpb=211da00b79f5ab9df62f69ddff65d493759eae4c;ds=sidebyside diff --git a/util/find-doc-nits b/util/find-doc-nits index ecd9f9af51..901e34f384 100755 --- a/util/find-doc-nits +++ b/util/find-doc-nits @@ -10,6 +10,7 @@ require 5.10.0; use warnings; use strict; + use Pod::Checker; use File::Find; use File::Basename; @@ -18,6 +19,9 @@ use Getopt::Std; use lib catdir(dirname($0), "perl"); use OpenSSL::Util::Pod; +# Set to 1 for debug output +my $debug = 0; + # Options. our($opt_d); our($opt_e); @@ -31,39 +35,61 @@ our($opt_u); our($opt_v); our($opt_c); -sub help() -{ +# Print usage message and exit. +sub help { print < [ 'NAME', 'DESCRIPTION', 'COPYRIGHT' ], + 1 => [ 'SYNOPSIS', 'OPTIONS' ], + 3 => [ 'SYNOPSIS', 'RETURN VALUES' ], + 5 => [ ], + 7 => [ ] +); -my %mandatory_sections = - ( '*' => [ 'NAME', 'DESCRIPTION', 'COPYRIGHT' ], - 1 => [ 'SYNOPSIS', 'OPTIONS' ], - 3 => [ 'SYNOPSIS', 'RETURN VALUES' ], - 5 => [ ], - 7 => [ ] ); + +# Print error message, set $status. +sub err { + print join(" ", @_), "\n"; + $status = 1 +} # Cross-check functions in the NAME and SYNOPSIS section. -sub name_synopsis() -{ +sub name_synopsis { my $id = shift; my $filename = shift; my $contents = shift; @@ -72,36 +98,40 @@ sub name_synopsis() return unless $contents =~ /=head1 NAME(.*)=head1 SYNOPSIS/ms; my $tmp = $1; $tmp =~ tr/\n/ /; - print "$id trailing comma before - in NAME\n" if $tmp =~ /, *-/; + err($id, "trailing comma before - in NAME") + if $tmp =~ /, *-/; $tmp =~ s/ -.*//g; - print "$id POD markup among the names in NAME\n" if $tmp =~ /[<>]/; + err($id, "POD markup among the names in NAME") + if $tmp =~ /[<>]/; $tmp =~ s/ */ /g; - print "$id missing comma in NAME\n" if $tmp =~ /[^,] /; + err($id, "missing comma in NAME") + if $tmp =~ /[^,] /; my $dirname = dirname($filename); - my $simplename = basename($filename); - $simplename =~ s/.pod$//; + my $simplename = basename(basename($filename, ".in"), ".pod"); my $foundfilename = 0; my %foundfilenames = (); my %names; foreach my $n ( split ',', $tmp ) { $n =~ s/^\s+//; $n =~ s/\s+$//; - print "$id the name '$n' contains white-space\n" + err($id, "the name '$n' contains white-space") if $n =~ /\s/; $names{$n} = 1; $foundfilename++ if $n eq $simplename; $foundfilenames{$n} = 1 if -f "$dirname/$n.pod" && $n ne $simplename; } - print "$id the following exist as other .pod files:\n", - join(" ", sort keys %foundfilenames), "\n" + err($id, "the following exist as other .pod files:", + sort keys %foundfilenames) if %foundfilenames; - print "$id $simplename (filename) missing from NAME section\n" + err($id, "$simplename (filename) missing from NAME section") unless $foundfilename; - foreach my $n ( keys %names ) { - print "$id $n is not public\n" - if $opt_p and !defined $public{$n}; + if ( $filename !~ /internal/ ) { + foreach my $n ( keys %names ) { + err($id, "$n is not public") + if !defined $public{$n}; + } } # Find all functions in SYNOPSIS @@ -110,25 +140,33 @@ sub name_synopsis() foreach my $line ( split /\n+/, $syn ) { next unless $line =~ /^\s/; my $sym; + my $is_prototype = 1; $line =~ s/STACK_OF\([^)]+\)/int/g; $line =~ s/SPARSE_ARRAY_OF\([^)]+\)/int/g; $line =~ s/__declspec\([^)]+\)//; + if ( $line =~ /typedef.*\(\*\S+\)\s+\(/ ) { + # a callback function with whitespace before the argument list: + # typedef ... (*NAME) (... + err($id, "function typedef has space before arg list: $line"); + } if ( $line =~ /env (\S*)=/ ) { # environment variable env NAME=... $sym = $1; - } elsif ( $line =~ /typedef.*\(\*(\S+)\)\(.*/ ) { + } elsif ( $line =~ /typedef.*\(\*(\S+)\)\s*\(/ ) { # a callback function pointer: typedef ... (*NAME)(... $sym = $1; - } elsif ( $line =~ /typedef.* (\S+)\(.*/ ) { + } elsif ( $line =~ /typedef.* (\S+)\(/ ) { # a callback function signature: typedef ... NAME(... $sym = $1; } elsif ( $line =~ /typedef.* (\S+);/ ) { # a simple typedef: typedef ... NAME; + $is_prototype = 0; $sym = $1; } elsif ( $line =~ /enum (\S*) \{/ ) { # an enumeration: enum ... { $sym = $1; } elsif ( $line =~ /#(?:define|undef) ([A-Za-z0-9_]+)/ ) { + $is_prototype = 0; $sym = $1; } elsif ( $line =~ /([A-Za-z0-9_]+)\(/ ) { $sym = $1; @@ -136,37 +174,266 @@ sub name_synopsis() else { next; } - print "$id $sym missing from NAME section\n" + err($id, "$sym missing from NAME section") unless defined $names{$sym}; $names{$sym} = 2; # Do some sanity checks on the prototype. - print "$id prototype missing spaces around commas: $line\n" - if ( $line =~ /[a-z0-9],[^ ]/ ); + err($id, "prototype missing spaces around commas: $line") + if $is_prototype && $line =~ /[a-z0-9],[^ ]/; } foreach my $n ( keys %names ) { next if $names{$n} == 2; - print "$id $n missing from SYNOPSIS\n"; + err($id, "$n missing from SYNOPSIS") } } -# Check if SECTION is located before BEFORE -sub check_section_location() -{ - my $filename = shift; +# Check if SECTION ($3) is located before BEFORE ($4) +sub check_section_location { + my $id = shift; my $contents = shift; my $section = shift; my $before = shift; return unless $contents =~ /=head1 $section/ and $contents =~ /=head1 $before/; - print "$filename: $section should be placed before $before section\n" + err($id, "$section should appear before $before section") if $contents =~ /=head1 $before.*=head1 $section/ms; } -sub check() -{ +# Check if a =head1 is duplicated, or a =headX is duplicated within a +# =head1. Treats =head2 =head3 as equivalent -- it doesn't reset the head3 +# sets if it finds a =head2 -- but that is good enough for now. Also check +# for proper capitalization, trailing periods, etc. +sub check_head_style { + my $id = shift; + my $contents = shift; + my %head1; + my %subheads; + + foreach my $line ( split /\n+/, $contents ) { + next unless $line =~ /^=head/; + if ( $line =~ /head1/ ) { + err($id, "duplicate section $line") + if defined $head1{$line}; + $head1{$line} = 1; + %subheads = (); + } else { + err($id, "duplicate subsection $line") + if defined $subheads{$line}; + $subheads{$line} = 1; + } + err($id, "period in =head") + if $line =~ /\.[^\w]/ or $line =~ /\.$/; + err($id, "not all uppercase in =head1") + if $line =~ /head1.*[a-z]/; + err($id, "all uppercase in subhead") + if $line =~ /head[234][ A-Z0-9]+$/; + } +} + +# Because we have options and symbols with extra markup, we need +# to take that into account, so we need a regexp that extracts +# markup chunks, including recursive markup. +# please read up on /(?R)/ in perlre(1) +# (note: order is important, (?R) needs to come before .) +# (note: non-greedy is important, or something like 'B and B' +# will be captured as one item) +my $markup_re = + qr/( # Capture group + [BIL]< # The start of what we recurse on + (?:(?-1)|.)*? # recurse the whole regexp (referring to + # the last opened capture group, i.e. the + # start of this regexp), or pick next + # character. Do NOT be greedy! + > # The end of what we recurse on + )/x; # (the x allows this sort of split up regexp) + +# Options must start with a dash, followed by a letter, possibly +# followed by letters, digits, dashes and underscores, and the last +# character must be a letter or a digit. +# We do also accept the single -? or -n, where n is a digit +my $option_re = + qr/(?: + \? # Single question mark + | + \d # Single digit + | + - # Single dash (--) + | + [[:alpha:]](?:[-_[:alnum:]]*?[[:alnum:]])? + )/x; + +# Helper function to check if a given $thing is properly marked up +# option. It returns one of these values: +# undef if it's not an option +# "" if it's a malformed option +# $unwrapped the option with the outermost B<> wrapping removed. +sub normalise_option { + my $id = shift; + my $filename = shift; + my $thing = shift; + + my $unwrapped = $thing; + my $unmarked = $thing; + + # $unwrapped is the option with the outer B<> markup removed + $unwrapped =~ s/^B$//; + # $unmarked is the option with *all* markup removed + $unmarked =~ s/[BIL]<|>//msg; + + + # If we found an option, check it, collect it + if ( $unwrapped =~ /^\s*-/ ) { + return $unwrapped # return option with outer B<> removed + if $unmarked =~ /^-${option_re}$/; + return ""; # Malformed option + } + return undef; # Something else +} + +# Checks of command option (man1) formatting. The man1 checks are +# restricted to the SYNOPSIS and OPTIONS sections, the rest is too +# free form, we simply cannot be too strict there. + +sub option_check { + my $id = shift; + my $filename = shift; + my $contents = shift; + + my $synopsis = ($contents =~ /=head1\s+SYNOPSIS(.*?)=head1/s, $1); + + # Some pages have more than one OPTIONS section, let's make sure + # to get them all + my $options = ''; + while ( $contents =~ /=head1\s+[A-Z ]*?OPTIONS$(.*?)(?==head1)/msg ) { + $options .= $1; + } + + # Look for options with no or incorrect markup + while ( $synopsis =~ + /(?[:alnum:]])/msg ) { + err($id, "Malformed option [1] in SYNOPSIS: $&"); + } + + while ( $synopsis =~ /$markup_re/msg ) { + my $found = $&; + print STDERR "$id:DEBUG[option_check] SYNOPSIS: found $found\n" + if $debug; + my $option_uw = normalise_option($id, $filename, $found); + err($id, "Malformed option [2] in SYNOPSIS: $found") + if defined $option_uw && $option_uw eq ''; + } + + # In OPTIONS, we look for =item paragraphs. + # (?=^\s*$) detects an empty line. + while ( $options =~ /=item\s+(.*?)(?=^\s*$)/msg ) { + my $item = $&; + + while ( $item =~ /(\[\s*)?($markup_re)/msg ) { + my $found = $2; + print STDERR "$id:DEBUG[option_check] OPTIONS: found $&\n" + if $debug; + err($id, "Unexpected bracket in OPTIONS =item: $item") + if ($1 // '') ne '' && $found =~ /^B<\s*-/; + + my $option_uw = normalise_option($id, $filename, $found); + err($id, "Malformed option in OPTIONS: $found") + if defined $option_uw && $option_uw eq ''; + } + } +} + +# Normal symbol form +my $symbol_re = qr/[[:alpha:]_][_[:alnum:]]*?/; + +# Checks of function name (man3) formatting. The man3 checks are +# easier than the man1 checks, we only check the names followed by (), +# and only the names that have POD markup. +sub functionname_check { + my $id = shift; + my $filename = shift; + my $contents = shift; + + while ( $contents =~ /($markup_re)\(\)/msg ) { + print STDERR "$id:DEBUG[functionname_check] SYNOPSIS: found $&\n" + if $debug; + + my $symbol = $1; + my $unmarked = $symbol; + $unmarked =~ s/[BIL]<|>//msg; + + err($id, "Malformed symbol: $symbol") + unless $symbol =~ /^B<.*>$/ && $unmarked =~ /^${symbol_re}$/ + } + + # We can't do the kind of collecting coolness that option_check() + # does, because there are too many things that can't be found in + # name repositories like the NAME sections, such as symbol names + # with a variable part (typically marked up as B_bar> +} + +# This is from http://man7.org/linux/man-pages/man7/man-pages.7.html +my %preferred_words = ( + 'bitmask' => 'bit mask', + 'builtin' => 'built-in', + #'epoch' => 'Epoch', # handled specially, below + 'file name' => 'filename', + 'file system' => 'filesystem', + 'host name' => 'hostname', + 'i-node' => 'inode', + 'lower case' => 'lowercase', + 'lower-case' => 'lowercase', + 'non-zero' => 'nonzero', + 'path name' => 'pathname', + 'pseudo-terminal' => 'pseudoterminal', + 'reserved port' => 'privileged port', + 'system port' => 'privileged port', + 'realtime' => 'real-time', + 'real time' => 'real-time', + 'runtime' => 'run time', + 'saved group ID'=> 'saved set-group-ID', + 'saved set-GID' => 'saved set-group-ID', + 'saved user ID' => 'saved set-user-ID', + 'saved set-UID' => 'saved set-user-ID', + 'set-GID' => 'set-group-ID', + 'setgid' => 'set-group-ID', + 'set-UID' => 'set-user-ID', + 'setuid' => 'set-user-ID', + 'super user' => 'superuser', + 'super-user' => 'superuser', + 'super block' => 'superblock', + 'super-block' => 'superblock', + 'time stamp' => 'timestamp', + 'time zone' => 'timezone', + 'upper case' => 'uppercase', + 'upper-case' => 'uppercase', + 'useable' => 'usable', + 'userspace' => 'user space', + 'user name' => 'username', + 'zeroes' => 'zeros' +); + +# Search manpage for words that have a different preferred use. +sub wording { + my $id = shift; + my $contents = shift; + + foreach my $k ( keys %preferred_words ) { + # Sigh, trademark + next if $k eq 'file system' + and $contents =~ /Microsoft Encrypted File System/; + err($id, "found '$k' should use '$preferred_words{$k}'") + if $contents =~ /\b\Q$k\E\b/i; + } + err($id, "found 'epoch' should use 'Epoch'") + if $contents =~ /\bepoch\b/; +} + +# Perform all sorts of nit/error checks on a manpage +sub check { my $filename = shift; my $dirname = basename(dirname($filename)); @@ -178,50 +445,92 @@ sub check() close POD; } - # Check if EXAMPLES is located after RETURN VALUES section. - &check_section_location($filename, $contents, "RETURN VALUES", "EXAMPLES") if $filename =~ m|man3/|; - # Check if HISTORY is located after SEE ALSO - &check_section_location($filename, $contents, "SEE ALSO", "HISTORY") if $filename =~ m|man3/|; - # Check if SEE ALSO is located after EXAMPLES - &check_section_location($filename, $contents, "EXAMPLES", "SEE ALSO") if $filename =~ m|man3/|; - my $id = "${filename}:1:"; + check_head_style($id, $contents); + + # Check ordering of some sections in man3 + if ( $filename =~ m|man3/| ) { + check_section_location($id, $contents, "RETURN VALUES", "EXAMPLES"); + check_section_location($id, $contents, "SEE ALSO", "HISTORY"); + check_section_location($id, $contents, "EXAMPLES", "SEE ALSO"); + } + + # Make sure every link has a section. + while ( $contents =~ /$markup_re/msg ) { + my $target = $1; + next unless $target =~ /^L<(.*)>$/; # Skip if not L<...> + $target = $1; # Peal away L< and > + $target =~ s/\/[^\/]*$//; # Peal away possible anchor + $target =~ s/.*\|//g; # Peal away possible link text + next if $target eq ''; # Skip if links within page, or + next if $target =~ /::/; # links to a Perl module, or + next if $target =~ /^https?:/; # is a URL link, or + next if $target =~ /\([1357]\)$/; # it has a section + err($id, "Section missing in $target") + } + # Check for proper links to commands. + while ( $contents =~ /L<([^>]*)\(1\)(?:\/.*)?>/g ) { + my $target = $1; + next if $target =~ /openssl-?/; + next if -f "doc/man1/$target.pod"; + # TODO: Filter out "foreign manual" links. + next if $target =~ /ps|apropos|sha1sum|procmail|perl/; + err($id, "Bad command link L<$target(1)>"); + } + # Check for proper in-man-3 API links. + while ( $contents =~ /L<([^>]*)\(3\)(?:\/.*)?>/g ) { + my $target = $1; + err($id, "Bad L<$target>") + unless $target =~ /^[_[:alpha:]][_[:alnum:]]*$/ + } + + unless ( $contents =~ /=for openssl generic/ ) { + if ( $filename =~ m|man3/| ) { + name_synopsis($id, $filename, $contents); + functionname_check($id, $filename, $contents); + } elsif ( $filename =~ m|man1/| ) { + option_check($id, $filename, $contents) + } + } - &name_synopsis($id, $filename, $contents) - unless $contents =~ /=for comment generic/ - or $filename =~ m@man[157]/@; + wording($id, $contents); - print "$id doesn't start with =pod\n" + err($id, "doesn't start with =pod") if $contents !~ /^=pod/; - print "$id doesn't end with =cut\n" + err($id, "doesn't end with =cut") if $contents !~ /=cut\n$/; - print "$id more than one cut line.\n" + err($id, "more than one cut line.") if $contents =~ /=cut.*=cut/ms; - print "$id missing copyright\n" + err($id, "EXAMPLE not EXAMPLES section.") + if $contents =~ /=head1 EXAMPLE[^S]/; + err($id, "WARNING not WARNINGS section.") + if $contents =~ /=head1 WARNING[^S]/; + err($id, "missing copyright") if $contents !~ /Copyright .* The OpenSSL Project Authors/; - print "$id copyright not last\n" + err($id, "copyright not last") if $contents =~ /head1 COPYRIGHT.*=head/ms; - print "$id head2 in All uppercase\n" + err($id, "head2 in All uppercase") if $contents =~ /head2\s+[A-Z ]+\n/; - print "$id extra space after head\n" + err($id, "extra space after head") if $contents =~ /=head\d\s\s+/; - print "$id period in NAME section\n" + err($id, "period in NAME section") if $contents =~ /=head1 NAME.*\.\n.*=head1 SYNOPSIS/ms; - print "$id Duplicate $1 in L<>\n" + err($id, "Duplicate $1 in L<>") if $contents =~ /L<([^>]*)\|([^>]*)>/ && $1 eq $2; - print "$id Bad =over $1\n" + err($id, "Bad =over $1") if $contents =~ /=over([^ ][^24])/; - print "$id Possible version style issue\n" + err($id, "Possible version style issue") if $contents =~ /OpenSSL version [019]/; - if ( $contents !~ /=for comment multiple includes/ ) { + if ( $contents !~ /=for openssl multiple includes/ ) { # Look for multiple consecutive openssl #include lines # (non-consecutive lines are okay; see man3/MD5.pod). if ( $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms ) { my $count = 0; foreach my $line ( split /\n+/, $1 ) { if ( $line =~ m@include [ "foo(1)", "bar(3)", ... ] +my %link_map = (); +# Map of names in each POD file; "name(s)" => filename +my %name_map = (); +# Load file of symbol names that we know aren't documented. sub loadmissing($) { my $missingfile = shift; my @missing; open FH, $missingfile - || die "Can't open $missingfile"; + or die "Can't open $missingfile"; while ( ) { chomp; next if /^#/; @@ -312,134 +605,126 @@ sub loadmissing($) } close FH; + for (@missing) { + err("$missingfile:", "$_ is documented in $name_map{$_}") + if !$opt_o && exists $name_map{$_} && defined $name_map{$_}; + } + return @missing; } -sub checkmacros() -{ +# Check for undocumented macros; ignore those in the "missing" file +# and do simple check for #define in our header files. +sub checkmacros { my $count = 0; my %seen; my @missing; - if ($opt_o) { + if ( $opt_o ) { @missing = loadmissing('util/missingmacro111.txt'); - } elsif ($opt_v) { + } elsif ( $opt_v ) { @missing = loadmissing('util/missingmacro.txt'); } - print "# Checking macros (approximate)\n" if !$opt_s; foreach my $f ( glob('include/openssl/*.h') ) { # Skip some internals we don't want to document yet. next if $f eq 'include/openssl/asn1.h'; next if $f eq 'include/openssl/asn1t.h'; next if $f eq 'include/openssl/err.h'; - open(IN, $f) || die "Can't open $f, $!"; + open(IN, $f) + or die "Can't open $f, $!"; while ( ) { next unless /^#\s*define\s*(\S+)\(/; - my $macro = $1; - next if $docced{$macro} || defined $seen{$macro}; - next if $macro =~ /i2d_/ - || $macro =~ /d2i_/ - || $macro =~ /DEPRECATEDIN/ - || $macro =~ /IMPLEMENT_/ - || $macro =~ /DECLARE_/; + my $macro = "$1(3)"; # We know they're all in section 3 + next if exists $name_map{$macro} || defined $seen{$macro}; + next if $macro =~ /^i2d_/ + || $macro =~ /^d2i_/ + || $macro =~ /^DEPRECATEDIN/ + || $macro =~ /\Q_fnsig(3)\E$/ + || $macro =~ /^IMPLEMENT_/ + || $macro =~ /^_?DECLARE_/; # Skip macros known to be missing - next if $opt_v && grep( /^$macro$/, @missing); - - print "$f:$macro\n" if $opt_d || $opt_e; + next if $opt_v && grep( /^\Q$macro\E$/, @missing); + + err("$f:", "macro $macro undocumented") + if $opt_d || $opt_e; $count++; $seen{$macro} = 1; } close(IN); } - print "# Found $count macros missing\n" if !$opt_s || $count > 0; + err("# $count macros undocumented (count is approximate)") + if $count > 0; } -sub printem() -{ +# Find out what is undocumented (filtering out the known missing ones) +# and display them. +sub printem { my $libname = shift; my $numfile = shift; my $missingfile = shift; my $count = 0; my %seen; - my @missing = loadmissing($missingfile) if ($opt_v); + my @missing = loadmissing($missingfile) if $opt_v; - foreach my $func ( &parsenum($numfile) ) { - next if $docced{$func} || defined $seen{$func}; + foreach my $func ( parsenum($numfile) ) { + $func .= '(3)'; # We know they're all in section 3 + next if exists $name_map{$func} || defined $seen{$func}; # Skip ASN1 utilities next if $func =~ /^ASN1_/; - # Skip functions known to be missing - next if $opt_v && grep( /^$func$/, @missing); + # Skip functions known to be missing. + next if $opt_v && grep( /^\Q$func\E$/, @missing); - print "$libname:$func\n" if $opt_d || $opt_e; + err("$libname:", "function $func undocumented") + if $opt_d || $opt_e; $count++; $seen{$func} = 1; } - print "# Found $count missing from $numfile\n\n" if !$opt_s || $count > 0; + err("# $count in $numfile are not documented") + if $count > 0; } - -# Collection of links in each POD file. -# filename => [ "foo(1)", "bar(3)", ... ] -my %link_collection = (); -# Collection of names in each POD file. -# "name(s)" => filename -my %name_collection = (); - +# Collect all the names in a manpage. sub collectnames { my $filename = shift; $filename =~ m|man(\d)/|; my $section = $1; my $simplename = basename($filename, ".pod"); my $id = "${filename}:1:"; + my %podinfo = extract_pod_info($filename, { debug => $debug }); - my $contents = ''; - { - local $/ = undef; - open POD, $filename or die "Couldn't open $filename, $!"; - $contents = ; - close POD; + unless ( grep { $simplename eq $_ } @{$podinfo{names}} ) { + err($id, "$simplename not in NAME section"); + push @{$podinfo{names}}, $simplename; } - - $contents =~ /=head1 NAME([^=]*)=head1 /ms; - my $tmp = $1; - unless (defined $tmp) { - print "$id weird name section\n"; - return; - } - $tmp =~ tr/\n/ /; - $tmp =~ s/-.*//g; - - my @names = map { s/^\s+//g; s/\s+$//g; $_ } split(/,/, $tmp); - unless (grep { $simplename eq $_ } @names) { - print "$id missing $simplename\n"; - push @names, $simplename; - } - foreach my $name (@names) { + foreach my $name ( @{$podinfo{names}} ) { next if $name eq ""; - if ($name =~ /\s/) { - print "$id '$name' contains white space\n"; - } + err($id, "'$name' contains white space") + if $name =~ /\s/; my $name_sec = "$name($section)"; - if (! exists $name_collection{$name_sec}) { - $name_collection{$name_sec} = $filename; - } else { #elsif ($filename ne $name_collection{$name_sec}) { - print "$id $name_sec also in $name_collection{$name_sec}\n"; + if ( !exists $name_map{$name_sec} ) { + $name_map{$name_sec} = $filename; + } elsif ( $filename eq $name_map{$name_sec} ) { + err($id, "$name_sec duplicated in NAME section of", + $name_map{$name_sec}); + } else { + err($id, "$name_sec also in NAME section of", + $name_map{$name_sec}); } } - my @foreign_names = - map { map { s/\s+//g; $_ } split(/,/, $_) } - $contents =~ /=for\s+comment\s+foreign\s+manuals:\s*(.*)\n\n/; - foreach (@foreign_names) { - $name_collection{$_} = undef; # It still exists! + if ( $podinfo{contents} =~ /=for openssl foreign manual (.*)\n/ ) { + foreach my $f ( split / /, $1 ) { + $name_map{$f} = undef; # It still exists! + } } - my @links = $contents =~ /L< + my @links = + $podinfo{contents} =~ /L< # if the link is of the form L, # then remove 'something'. Note that 'something' # may contain POD codes as well... @@ -448,30 +733,34 @@ sub collectnames { # a one digit section number ([^\/>\(]+\(\d\)) /gx; - $link_collection{$filename} = [ @links ]; + $link_map{$filename} = [ @links ]; } +# Look for L<> ("link") references that point to files that do not exist. sub checklinks { - foreach my $filename (sort keys %link_collection) { - foreach my $link (@{$link_collection{$filename}}) { - print "${filename}:1: reference to non-existing $link\n" - unless exists $name_collection{$link}; + foreach my $filename ( sort keys %link_map ) { + foreach my $link ( @{$link_map{$filename}} ) { + err("${filename}:1:", "reference to non-existing $link") + unless exists $name_map{$link}; } } } -sub publicize() { - foreach my $name ( &parsenum('util/libcrypto.num') ) { +# Load the public symbol/macro names +sub publicize { + foreach my $name ( parsenum('util/libcrypto.num') ) { $public{$name} = 1; } - foreach my $name ( &parsenum('util/libssl.num') ) { + foreach my $name ( parsenum('util/libssl.num') ) { $public{$name} = 1; } - foreach my $name ( &parsenum('util/private.num') ) { + foreach my $name ( parsenum('util/other.syms') ) { $public{$name} = 1; } } +# Cipher/digests to skip if they show up as "not implemented" +# because they are, via the "-*" construct. my %skips = ( 'aes128' => 1, 'aes192' => 1, @@ -485,19 +774,21 @@ my %skips = ( 'des' => 1, 'des3' => 1, 'idea' => 1, - '[cipher]' => 1, - '[digest]' => 1, + 'cipher' => 1, + 'digest' => 1, ); -sub checkflags() { +# Check the flags of a command and see if everything is in the manpage +sub checkflags { my $cmd = shift; + my $doc = shift; my %cmdopts; my %docopts; - my $ok = 1; + my %localskips; # Get the list of options in the command. open CFH, "./apps/openssl list --options $cmd|" - || die "Can list options for $cmd, $!"; + or die "Can list options for $cmd, $!"; while ( ) { chop; s/ .$//; @@ -506,68 +797,58 @@ sub checkflags() { close CFH; # Get the list of flags from the synopsis - open CFH, " ) { chop; last if /DESCRIPTION/; - next unless /\[B<-([^ >]+)/; + if ( /=for openssl ifdef (.*)/ ) { + foreach my $f ( split / /, $1 ) { + $localskips{$f} = 1; + } + next; + } + my $opt; + if ( /\[B<-([^ >]+)/ ) { + $opt = $1; + } elsif ( /^B<-([^ >]+)/ ) { + $opt = $1; + } else { + next; + } + $opt = $1 if $opt =~ /I<(.*)/; $docopts{$1} = 1; } close CFH; # See what's in the command not the manpage. - my @undocced = (); - foreach my $k ( keys %cmdopts ) { - push @undocced, $k unless $docopts{$k}; - } - if ( scalar @undocced > 0 ) { - $ok = 0; - foreach ( @undocced ) { - print "doc/man1/$cmd.pod: Missing -$_\n"; - } + my @undocced = sort grep { !defined $docopts{$_} } keys %cmdopts; + foreach ( @undocced ) { + next if /-/; # Skip the -- end-of-flags marker + err("$doc: undocumented option -$_"); } # See what's in the command not the manpage. - my @unimpl = (); - foreach my $k ( keys %docopts ) { - push @unimpl, $k unless $cmdopts{$k}; - } - if ( scalar @unimpl > 0 ) { - $ok = 0; - foreach ( @unimpl ) { - next if defined $skips{$_}; - print "doc/man1/$cmd.pod: Not implemented -$_\n"; - } + my @unimpl = sort grep { !defined $cmdopts{$_} } keys %docopts; + foreach ( @unimpl ) { + next if defined $skips{$_} || defined $localskips{$_}; + err("$doc: $cmd does not implement -$_"); } - - return $ok; } -getopts('cdesolnphuv'); - -&help() if $opt_h; - -$opt_n = 1 if $opt_p; -$opt_u = 1 if $opt_d; -$opt_e = 1 if $opt_s; -$opt_v = 1 if $opt_o || $opt_e; - -die "Cannot use both -u and -v" if $opt_u && $opt_v; -die "Cannot use both -d and -e" if $opt_d && $opt_e; - -# We only need to check c, l, n, u and v. -# Options d, e, s, o and p imply one of the above. -die "Need one of -[cdesolnpuv] flags.\n" - unless $opt_c or $opt_l or $opt_n or $opt_u or $opt_v; +## +## MAIN() +## Do the work requested by the various getopt flags. +## The flags are parsed in alphabetical order, just because we have +## to have *some way* of listing them. +## if ( $opt_c ) { - my $ok = 1; my @commands = (); # Get list of commands. open FH, "./apps/openssl list -1 -commands|" - || die "Can't list commands, $!"; + or die "Can't list commands, $!"; while ( ) { chop; push @commands, $_; @@ -575,64 +856,69 @@ if ( $opt_c ) { close FH; # See if each has a manpage. - foreach ( @commands ) { - next if $_ eq 'help' || $_ eq 'exit'; - if ( ! -f "doc/man1/$_.pod" ) { - print "doc/man1/$_.pod does not exist\n"; - $ok = 0; + foreach my $cmd ( @commands ) { + next if $cmd eq 'help' || $cmd eq 'exit'; + my $doc = "doc/man1/openssl-$cmd.pod"; + # Handle "tsget" and "CA.pl" pod pages + $doc = "doc/man1/$cmd.pod" if -f "doc/man1/$cmd.pod"; + if ( ! -f "$doc" ) { + err("$doc does not exist"); } else { - $ok = 0 if not &checkflags($_); + checkflags($cmd, $doc); } } # See what help is missing. open FH, "./apps/openssl list --missing-help |" - || die "Can't list missing help, $!"; + or die "Can't list missing help, $!"; while ( ) { chop; my ($cmd, $flag) = split; - print "$cmd has no help for -$flag\n"; - $ok = 0; + err("$cmd has no help for -$flag"); } close FH; - exit 1 if not $ok; + exit $status; } -if ( $opt_l ) { - foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'), - glob('doc/internal/*/*.pod'))) { +# Preparation for some options, populate %name_map and %link_map +if ( $opt_l || $opt_u || $opt_v ) { + foreach ( glob('doc/*/*.pod doc/internal/*/*.pod') ) { collectnames($_); } +} + +if ( $opt_l ) { + foreach my $func ( loadmissing("util/missingcrypto.txt") ) { + $name_map{$func} = undef; + } checklinks(); } if ( $opt_n ) { - &publicize() if $opt_p; - foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) { - &check($_); + publicize(); + foreach ( @ARGV ? @ARGV : glob('doc/*/*.pod doc/internal/*/*.pod') ) { + check($_); } - { - local $opt_p = undef; - foreach (@ARGV ? @ARGV : glob('doc/internal/*/*.pod')) { - &check($_); + + # If not given args, check that all man1 commands are named properly. + if ( scalar @ARGV == 0 ) { + foreach ( glob('doc/man1/*.pod') ) { + next if /CA.pl/ || /openssl\.pod/ || /tsget\.pod/; + err("$_ doesn't start with openssl-") unless /openssl-/; } } } if ( $opt_u || $opt_v) { - my %temp = getdocced('doc/man3'); - foreach ( keys %temp ) { - $docced{$_} = $temp{$_}; - } - if ($opt_o) { - &printem('crypto', 'util/libcrypto.num', 'util/missingcrypto111.txt'); - &printem('ssl', 'util/libssl.num', 'util/missingssl111.txt'); + if ( $opt_o ) { + printem('crypto', 'util/libcrypto.num', 'util/missingcrypto111.txt'); + printem('ssl', 'util/libssl.num', 'util/missingssl111.txt'); } else { - &printem('crypto', 'util/libcrypto.num', 'util/missingcrypto.txt'); - &printem('ssl', 'util/libssl.num', 'util/missingssl.txt'); + printem('crypto', 'util/libcrypto.num', 'util/missingcrypto.txt'); + printem('ssl', 'util/libssl.num', 'util/missingssl.txt'); } - &checkmacros(); + checkmacros(); } -exit; +exit $status;