require 5.10.0;
use warnings;
use strict;
+
use Pod::Checker;
use File::Find;
use File::Basename;
use lib catdir(dirname($0), "perl");
use OpenSSL::Util::Pod;
-my $debug = 0; # Set to 1 for debug output
+# Set to 1 for debug output
+my $debug = 0;
+
+# Where to find openssl command
+my $BLDTOP = $ENV{BLDTOP} || ".";
+my $openssl = "$BLDTOP/util/opensslwrap.sh";
# Options.
our($opt_d);
my %public;
my $status = 0;
-my %mandatory_sections =
- ( '*' => [ '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 {
$names{$n} = 1;
$foundfilename++ if $n eq $simplename;
$foundfilenames{$n} = 1
- if ((-f "$dirname/$n.pod.in" || -f "$dirname/$n.pod")
- && $n ne $simplename);
+ if -f "$dirname/$n.pod" && $n ne $simplename;
}
- err($id, "the following exist as other .pod or .pod.in files:",
+ err($id, "the following exist as other .pod files:",
sort keys %foundfilenames)
if %foundfilenames;
err($id, "$simplename (filename) missing from NAME section")
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;
# Do some sanity checks on the prototype.
err($id, "prototype missing spaces around commas: $line")
- if ( $line =~ /[a-z0-9],[^ ]/ );
+ if $is_prototype && $line =~ /[a-z0-9],[^ ]/;
}
foreach my $n ( keys %names ) {
my $markup_re =
qr/( # Capture group
[BIL]< # The start of what we recurse on
- (?:(?-1)|.)*? # recurse the whole regexp (refering to
+ (?:(?-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!
# 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.
+# 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;
# 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;
'zeroes' => 'zeros'
);
+# Search manpage for words that have a different preferred use.
sub wording {
my $id = shift;
my $contents = shift;
if $contents =~ /\bepoch\b/;
}
+# Perform all sorts of nit/error checks on a manpage
sub check {
my $filename = shift;
my $dirname = basename(dirname($filename));
check_section_location($id, $contents, "EXAMPLES", "SEE ALSO");
}
- unless ( $contents =~ /=for comment generic/ ) {
+ # 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);
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 $section = 3;
$section = $1 if $dirname =~ /man([1-9])/;
- foreach ((@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}})) {
- # Skip "return values" if not -s
+ foreach ( (@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}}) ) {
err($id, "missing $_ head1 section")
if $contents !~ /^=head1\s+${_}\s*$/m;
}
}
-my %dups;
-
+# Parse libcrypto.num, etc., and return sorted list of what's there.
sub parsenum {
my $file = shift;
my @apis;
return sort @apis;
}
-sub getdocced
-{
- my $dir = shift;
- my %return;
-
- foreach my $pod ( glob("$dir/*.pod"), glob("$dir/*.pod.in") ) {
- my %podinfo = extract_pod_info($pod);
- foreach my $n ( @{$podinfo{names}} ) {
- $return{$n} = $pod;
- err("# Duplicate $n in $pod and $dups{$n}")
- if defined $dups{$n} && $dups{$n} ne $pod;
- $dups{$n} = $pod;
- }
- }
-
- return %return;
-}
-
-my %docced;
+# Parse all the manpages, getting return map of what they document
+# (by looking at their NAME sections).
+# Map of links in each POD file; filename => [ "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 ( <FH> ) {
chomp;
next if /^#/;
}
close FH;
+ for (@missing) {
+ err("$missingfile:", "$_ is documented in $name_map{$_}")
+ if !$opt_o && exists $name_map{$_} && defined $name_map{$_};
+ }
+
return @missing;
}
+# 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');
}
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 ( <IN> ) {
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);
-
+ next if $opt_v && grep( /^\Q$macro\E$/, @missing);
+
err("$f:", "macro $macro undocumented")
if $opt_d || $opt_e;
$count++;
if $count > 0;
}
+# Find out what is undocumented (filtering out the known missing ones)
+# and display them.
sub printem {
my $libname = shift;
my $numfile = 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};
+ $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);
err("$libname:", "function $func undocumented")
if $opt_d || $opt_e;
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(basename($filename, ".in"), ".pod");
+ 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 = <POD>;
- close POD;
- }
-
- $contents =~ /=head1 NAME([^=]*)=head1 /ms;
- my $tmp = $1;
- unless (defined $tmp) {
- err($id, "weird name section");
- return;
+ unless ( grep { $simplename eq $_ } @{$podinfo{names}} ) {
+ err($id, "$simplename not in NAME section");
+ push @{$podinfo{names}}, $simplename;
}
- $tmp =~ tr/\n/ /;
- $tmp =~ s/ -.*//g;
-
- 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) {
- err($id, "missing $simplename");
- push @names, $simplename;
- }
- foreach my $name (@names) {
+ foreach my $name ( @{$podinfo{names}} ) {
next if $name eq "";
- if ($name =~ /\s/) {
- err($id, "'$name' contains white space")
- }
+ 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;
- } elsif ($filename eq $name_collection{$name_sec}) {
- err($id, "$name_sec repeated in NAME section of",
- $name_collection{$name_sec});
+ 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_collection{$name_sec});
+ $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<something|name(s)>,
# then remove 'something'. Note that 'something'
# may contain POD codes as well...
# 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}}) {
+ foreach my $filename ( sort keys %link_map ) {
+ foreach my $link ( @{$link_map{$filename}} ) {
err("${filename}:1:", "reference to non-existing $link")
- unless exists $name_collection{$link};
+ unless exists $name_map{$link};
}
}
}
}
}
-# Cipher/digests to skip if not documented
+# Cipher/digests to skip if they show up as "not implemented"
+# because they are, via the "-*" construct.
my %skips = (
'aes128' => 1,
'aes192' => 1,
'digest' => 1,
);
+# Check the flags of a command and see if everything is in the manpage
sub checkflags {
my $cmd = shift;
my $doc = shift;
my %localskips;
# Get the list of options in the command.
- open CFH, "./apps/openssl list --options $cmd|"
- || die "Can list options for $cmd, $!";
+ open CFH, "$openssl list --options $cmd|"
+ or die "Can list options for $cmd, $!";
while ( <CFH> ) {
chop;
s/ .$//;
# Get the list of flags from the synopsis
open CFH, "<$doc"
- || die "Can't open $doc, $!";
+ or die "Can't open $doc, $!";
while ( <CFH> ) {
chop;
last if /DESCRIPTION/;
- if ( /=for comment ifdef (.*)/ ) {
+ if ( /=for openssl ifdef (.*)/ ) {
foreach my $f ( split / /, $1 ) {
$localskips{$f} = 1;
}
next;
}
- next unless /\[B<-([^ >]+)/;
- my $opt = $1;
+ 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 ) {
- foreach ( @undocced ) {
- err("$doc: undocumented option -$_");
- }
+ 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 ) {
- foreach ( @unimpl ) {
- next if defined $skips{$_} || defined $localskips{$_};
- err("$cmd documented but not implemented -$_");
- }
+ my @unimpl = sort grep { !defined $cmdopts{$_} } keys %docopts;
+ foreach ( @unimpl ) {
+ next if defined $skips{$_} || defined $localskips{$_};
+ err("$doc: $cmd does not implement -$_");
}
}
+##
+## 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 @commands = ();
# Get list of commands.
- open FH, "./apps/openssl list -1 -commands|"
- || die "Can't list commands, $!";
+ open FH, "$openssl list -1 -commands|"
+ or die "Can't list commands, $!";
while ( <FH> ) {
chop;
push @commands, $_;
# See if each has a manpage.
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";
+ 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 {
}
# See what help is missing.
- open FH, "./apps/openssl list --missing-help |"
- || die "Can't list missing help, $!";
+ open FH, "$openssl list --missing-help |"
+ or die "Can't list missing help, $!";
while ( <FH> ) {
chop;
my ($cmd, $flag) = split;
exit $status;
}
-if ( $opt_l ) {
- foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'), glob('doc/*/*.pod.in'),
- 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();
- foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'), glob('doc/*/*.pod.in'))) {
- check($_);
- }
- foreach (@ARGV ? @ARGV : glob('doc/internal/*/*.pod')) {
+ foreach ( @ARGV ? @ARGV : glob('doc/*/*.pod 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/;
+ 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) {
+ if ( $opt_o ) {
printem('crypto', 'util/libcrypto.num', 'util/missingcrypto111.txt');
printem('ssl', 'util/libssl.num', 'util/missingssl111.txt');
} else {
projects / openssl.git / blobdiff