X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=util%2Ffind-doc-nits;h=eac87dedd0cb561c564e7a56dbf7a5adaf508d09;hp=aaf3eeb4f0d9a91ef180adb3bb7dd16dda608c5d;hb=6f02932edba62186a6866e8c9f0f0714674f6bab;hpb=0ed78e78007bb74e48e6f59fa2388bb244153bf0 diff --git a/util/find-doc-nits b/util/find-doc-nits index aaf3eeb4f0..eac87dedd0 100755 --- a/util/find-doc-nits +++ b/util/find-doc-nits @@ -1,7 +1,7 @@ #! /usr/bin/env perl -# Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved. +# Copyright 2002-2019 The OpenSSL Project Authors. All Rights Reserved. # -# Licensed under the OpenSSL license (the "License"). You may not use +# Licensed under the Apache License 2.0 (the "License"). You may not use # this file except in compliance with the License. You can obtain a copy # in the file LICENSE in the source distribution or at # https://www.openssl.org/source/license.html @@ -18,35 +18,58 @@ use Getopt::Std; use lib catdir(dirname($0), "perl"); use OpenSSL::Util::Pod; +my $debug = 0; # Set to 1 for debug output + # Options. our($opt_d); +our($opt_e); +our($opt_s); +our($opt_o); our($opt_h); our($opt_l); our($opt_n); our($opt_p); -our($opt_s); our($opt_u); +our($opt_v); our($opt_c); -sub help() -{ +# Print usage message and exit. +sub help { print < [ 'NAME', 'DESCRIPTION', 'COPYRIGHT' ], @@ -55,9 +78,14 @@ my %mandatory_sections = 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; @@ -66,40 +94,51 @@ 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; + err($id, "POD markup among the names in NAME") + if $tmp =~ /[<>]/; $tmp =~ s/ */ /g; - print "$id missing comma in NAME\n" if $tmp =~ /[^,] /; - $tmp =~ s/,//g; + 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 ) { + foreach my $n ( split ',', $tmp ) { + $n =~ s/^\s+//; + $n =~ s/\s+$//; + 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; + if ((-f "$dirname/$n.pod.in" || -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 or .pod.in 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 return unless $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms; my $syn = $1; foreach my $line ( split /\n+/, $syn ) { + next unless $line =~ /^\s/; my $sym; $line =~ s/STACK_OF\([^)]+\)/int/g; + $line =~ s/SPARSE_ARRAY_OF\([^)]+\)/int/g; $line =~ s/__declspec\([^)]+\)//; if ( $line =~ /env (\S*)=/ ) { # environment variable env NAME=... @@ -116,7 +155,7 @@ sub name_synopsis() } elsif ( $line =~ /enum (\S*) \{/ ) { # an enumeration: enum ... { $sym = $1; - } elsif ( $line =~ /#define ([A-Za-z0-9_]+)/ ) { + } elsif ( $line =~ /#(?:define|undef) ([A-Za-z0-9_]+)/ ) { $sym = $1; } elsif ( $line =~ /([A-Za-z0-9_]+)\(/ ) { $sym = $1; @@ -124,23 +163,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" + err($id, "prototype missing spaces around commas: $line") if ( $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") } } -sub check() -{ +# 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/; + err($id, "$section should appear before $before section") + if $contents =~ /=head1 $before.*=head1 $section/ms; +} + +# 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 (refering 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' +); + +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/; +} + +sub check { my $filename = shift; my $dirname = basename(dirname($filename)); @@ -153,34 +435,51 @@ sub check() } 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"); + } + + unless ( $contents =~ /=for comment 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 POD markup in NAME section\n" - if $contents =~ /=head1 NAME.*[<>].*=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/ ) { @@ -190,7 +489,8 @@ sub check() my $count = 0; foreach my $line ( split /\n+/, $1 ) { if ( $line =~ m@include ) { next if /^#/; next if /\bNOEXIST\b/; - next if /\bEXPORT_VAR_AS_FUNC\b/; my @fields = split(); die "Malformed line $_" if scalar @fields != 2 && scalar @fields != 4; @@ -245,20 +542,19 @@ sub parsenum() close $IN; - print "# Found ", scalar(@apis), " in $file\n" unless $opt_p; return sort @apis; } -sub getdocced() +sub getdocced { my $dir = shift; my %return; - foreach my $pod ( glob("$dir/*.pod") ) { + foreach my $pod ( glob("$dir/*.pod"), glob("$dir/*.pod.in") ) { my %podinfo = extract_pod_info($pod); foreach my $n ( @{$podinfo{names}} ) { $return{$n} = $pod; - print "# Duplicate $n in $pod and $dups{$n}\n" + err("# Duplicate $n in $pod and $dups{$n}") if defined $dups{$n} && $dups{$n} ne $pod; $dups{$n} = $pod; } @@ -269,11 +565,34 @@ sub getdocced() my %docced; -sub checkmacros() +sub loadmissing($) { + my $missingfile = shift; + my @missing; + + open FH, $missingfile + || die "Can't open $missingfile"; + while ( ) { + chomp; + next if /^#/; + push @missing, $_; + } + close FH; + + return @missing; +} + +sub checkmacros { my $count = 0; + my %seen; + my @missing; + + if ($opt_o) { + @missing = loadmissing('util/missingmacro111.txt'); + } elsif ($opt_v) { + @missing = loadmissing('util/missingmacro.txt'); + } - print "# Checking macros (approximate)\n"; 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'; @@ -283,36 +602,52 @@ sub checkmacros() while ( ) { next unless /^#\s*define\s*(\S+)\(/; my $macro = $1; - next if $docced{$macro}; + next if $docced{$macro} || defined $seen{$macro}; next if $macro =~ /i2d_/ || $macro =~ /d2i_/ || $macro =~ /DEPRECATEDIN/ || $macro =~ /IMPLEMENT_/ || $macro =~ /DECLARE_/; - print "$f:$macro\n" if $opt_d; + + # Skip macros known to be missing + next if $opt_v && grep( /^$macro$/, @missing); + + err("$f:", "macro $macro undocumented") + if $opt_d || $opt_e; $count++; + $seen{$macro} = 1; } close(IN); } - print "# Found $count macros missing (not all should be documented)\n" + err("# $count macros undocumented (count is approximate)") + if $count > 0; } -sub printem() -{ +sub printem { my $libname = shift; my $numfile = shift; + my $missingfile = shift; my $count = 0; + my %seen; + + my @missing = loadmissing($missingfile) if ($opt_v); - foreach my $func ( &parsenum($numfile) ) { - next if $docced{$func}; + foreach my $func ( parsenum($numfile) ) { + next if $docced{$func} || defined $seen{$func}; # Skip ASN1 utilities next if $func =~ /^ASN1_/; - print "$libname:$func\n" if $opt_d; + # Skip functions known to be missing + next if $opt_v && grep( /^$func$/, @missing); + + err("$libname:", "function $func undocumented") + if $opt_d || $opt_e; $count++; + $seen{$func} = 1; } - print "# Found $count missing from $numfile\n\n"; + err("# $count in $numfile are not documented") + if $count > 0; } @@ -327,7 +662,7 @@ sub collectnames { my $filename = shift; $filename =~ m|man(\d)/|; my $section = $1; - my $simplename = basename($filename, ".pod"); + my $simplename = basename(basename($filename, ".in"), ".pod"); my $id = "${filename}:1:"; my $contents = ''; @@ -341,24 +676,34 @@ sub collectnames { $contents =~ /=head1 NAME([^=]*)=head1 /ms; my $tmp = $1; unless (defined $tmp) { - print "$id weird name section\n"; + err($id, "weird name section"); return; } $tmp =~ tr/\n/ /; - $tmp =~ s/-.*//g; + $tmp =~ s/ -.*//g; - my @names = map { s/\s+//g; $_ } split(/,/, $tmp); + my @names = + map { s|/|-|g; $_ } # Treat slash as dash + map { s/^\s+//g; s/\s+$//g; $_ } # Trim prefix and suffix blanks + split(/,/, $tmp); unless (grep { $simplename eq $_ } @names) { - print "$id missing $simplename\n"; + err($id, "missing $simplename"); push @names, $simplename; } foreach my $name (@names) { next if $name eq ""; + if ($name =~ /\s/) { + err($id, "'$name' contains white space") + } 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"; + } elsif ($filename eq $name_collection{$name_sec}) { + err($id, "$name_sec repeated in NAME section of", + $name_collection{$name_sec}); + } else { + err($id, "$name_sec also in NAME section of", + $name_collection{$name_sec}); } } @@ -374,7 +719,7 @@ sub collectnames { # then remove 'something'. Note that 'something' # may contain POD codes as well... (?:(?:[^\|]|<[^>]*>)*\|)? - # we're only interested in referenses that have + # we're only interested in references that have # a one digit section number ([^\/>\(]+\(\d\)) /gx; @@ -384,24 +729,26 @@ sub collectnames { sub checklinks { foreach my $filename (sort keys %link_collection) { foreach my $link (@{$link_collection{$filename}}) { - print "${filename}:1: reference to non-existing $link\n" + err("${filename}:1:", "reference to non-existing $link") unless exists $name_collection{$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 not documented my %skips = ( 'aes128' => 1, 'aes192' => 1, @@ -415,15 +762,16 @@ my %skips = ( 'des' => 1, 'des3' => 1, 'idea' => 1, - '[cipher]' => 1, - '[digest]' => 1, + 'cipher' => 1, + 'digest' => 1, ); -sub checkflags() { +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|" @@ -436,12 +784,20 @@ sub checkflags() { close CFH; # Get the list of flags from the synopsis - open CFH, " ) { chop; last if /DESCRIPTION/; + if ( /=for comment ifdef (.*)/ ) { + foreach my $f ( split / /, $1 ) { + $localskips{$f} = 1; + } + next; + } next unless /\[B<-([^ >]+)/; + my $opt = $1; + $opt = $1 if $opt =~ /I<(.*)/; $docopts{$1} = 1; } close CFH; @@ -452,9 +808,9 @@ sub checkflags() { push @undocced, $k unless $docopts{$k}; } if ( scalar @undocced > 0 ) { - $ok = 0; foreach ( @undocced ) { - print "doc/man1/$cmd.pod: Missing -$_\n"; + next if /-/; # Skip the -- end-of-flags marker + err("$doc: undocumented option -$_"); } } @@ -464,27 +820,14 @@ sub checkflags() { 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"; + next if defined $skips{$_} || defined $localskips{$_}; + err("$cmd documented but not implemented -$_"); } } - - return $ok; } -getopts('cdlnsphu'); - -&help() if $opt_h; -$opt_n = 1 if $opt_s or $opt_p; -$opt_u = 1 if $opt_d; - -die "Need one of -[cdlnspu] flags.\n" - unless $opt_c or $opt_l or $opt_n or $opt_u; - if ( $opt_c ) { - my $ok = 1; my @commands = (); # Get list of commands. @@ -497,13 +840,14 @@ 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/$cmd.pod"; + $doc = "doc/man1/openssl-$cmd.pod" if -f "doc/man1/openssl-$cmd.pod"; + if ( ! -f "$doc" ) { + err("$doc does not exist"); } else { - $ok = 0 if not &checkflags($_); + checkflags($cmd, $doc); } } @@ -513,36 +857,52 @@ if ( $opt_c ) { 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')) { + foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'), glob('doc/*/*.pod.in'), + glob('doc/internal/*/*.pod'))) { collectnames($_); } checklinks(); } if ( $opt_n ) { - &publicize() if $opt_p; - foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) { - &check($_); + publicize(); + foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'), glob('doc/*/*.pod.in'))) { + check($_); + } + 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 ) { - my %temp = &getdocced('doc/man3'); +if ( $opt_u || $opt_v) { + my %temp = getdocced('doc/man3'); foreach ( keys %temp ) { $docced{$_} = $temp{$_}; } - &printem('crypto', 'util/libcrypto.num'); - &printem('ssl', 'util/libssl.num'); - &checkmacros(); + 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'); + } + checkmacros(); } -exit; +exit $status;