#! /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
use OpenSSL::Util::Pod;
# Options.
+our($opt_d);
+our($opt_e);
our($opt_s);
-our($opt_u);
+our($opt_o);
our($opt_h);
-our($opt_n);
our($opt_l);
+our($opt_n);
our($opt_p);
+our($opt_u);
+our($opt_v);
+our($opt_c);
sub help()
{
print <<EOF;
Find small errors (nits) in documentation. Options:
+ -d Detailed list of undocumented (implies -u)
+ -e Detailed list of new undocumented (implies -v)
+ -s Same as -e except no output is generated if nothing is undocumented
+ -o Causes -e/-v to count symbols added since 1.1.1 as new (implies -v)
-l Print bogus links
-n Print nits in POD pages
- -s Also print missing sections in POD pages (implies -n)
-p Warn if non-public name documented (implies -n)
- -u List undocumented functions
+ -u Count undocumented functions
+ -v Count new undocumented functions
-h Print this help message
+ -c List undocumented commands and options
EOF
exit;
}
$tmp =~ tr/\n/ /;
print "$id trailing comma before - in NAME\n" if $tmp =~ /, *-/;
$tmp =~ s/ -.*//g;
+ print "$id POD markup among the names in NAME\n" if $tmp =~ /[<>]/;
$tmp =~ s/ */ /g;
print "$id missing comma in NAME\n" if $tmp =~ /[^,] /;
- $tmp =~ s/,//g;
my $dirname = dirname($filename);
my $simplename = basename($filename);
my $foundfilename = 0;
my %foundfilenames = ();
my %names;
- foreach my $n ( split ' ', $tmp ) {
+ foreach my $n ( split ',', $tmp ) {
+ $n =~ s/^\s+//;
+ $n =~ s/\s+$//;
+ print "$id the name '$n' contains white-space\n"
+ if $n =~ /\s/;
$names{$n} = 1;
$foundfilename++ if $n eq $simplename;
$foundfilenames{$n} = 1
if %foundfilenames;
print "$id $simplename (filename) missing from NAME section\n"
unless $foundfilename;
- print "$id $simplename is not public\n"
- if $opt_p and !defined $public{$simplename};
+ foreach my $n ( keys %names ) {
+ print "$id $n is not public\n"
+ if $opt_p and !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=...
$sym = $1;
} elsif ( $line =~ /typedef.*\(\*(\S+)\)\(.*/ ) {
- # a callback function: typedef ... (*NAME)(...
+ # a callback function pointer: typedef ... (*NAME)(...
+ $sym = $1;
+ } elsif ( $line =~ /typedef.* (\S+)\(.*/ ) {
+ # a callback function signature: typedef ... NAME(...
$sym = $1;
} elsif ( $line =~ /typedef.* (\S+);/ ) {
# a simple typedef: typedef ... NAME;
} 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;
}
}
+# Check if SECTION is located before BEFORE
+sub check_section_location()
+{
+ my $filename = 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"
+ if $contents =~ /=head1 $before.*=head1 $section/ms;
+}
+
sub check()
{
my $filename = shift;
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:";
&name_synopsis($id, $filename, $contents)
if $contents =~ /=head\d\s\s+/;
print "$id period in NAME section\n"
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"
if $contents =~ /L<([^>]*)\|([^>]*)>/ && $1 eq $2;
print "$id Bad =over $1\n"
if $contents =~ /=over([^ ][^24])/;
+ print "$id Possible version style issue\n"
+ if $contents =~ /OpenSSL version [019]/;
- # Look for multiple consecutive openssl #include lines.
- # Consecutive because of files like md5.pod. Sometimes it's okay
- # or necessary, as in ssl/SSL_set1_host.pod
if ( $contents !~ /=for comment 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 <openssl/@ ) {
- if ( ++$count == 2 ) {
- print "$id has multiple includes\n";
- }
+ print "$id has multiple includes\n" if ++$count == 2;
} else {
$count = 0;
}
}
}
- return unless $opt_s;
-
- # Find what section this page is in. If run from "." assume
- # section 3.
- my $section = 3;
- $section = $1 if $dirname =~ /man([1-9])/;
-
- foreach ((@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}})) {
- print "$id: missing $_ head1 section\n"
- if $contents !~ /^=head1\s+${_}\s*$/m;
- }
-
open my $OUT, '>', $temp
or die "Can't open $temp, $!";
podchecker($filename, $OUT);
}
close $OUT;
unlink $temp || warn "Can't remove $temp, $!";
+
+ # Find what section this page is in; assume 3.
+ my $section = 3;
+ $section = $1 if $dirname =~ /man([1-9])/;
+
+ foreach ((@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}})) {
+ # Skip "return values" if not -s
+ print "$id: missing $_ head1 section\n"
+ if $contents !~ /^=head1\s+${_}\s*$/m;
+ }
}
my %dups;
next if /^#/;
next if /\bNOEXIST\b/;
next if /\bEXPORT_VAR_AS_FUNC\b/;
- push @apis, $1 if /([^\s]+).\s/;
+ my @fields = split();
+ die "Malformed line $_"
+ if scalar @fields != 2 && scalar @fields != 4;
+ push @apis, $fields[0];
}
close $IN;
return sort @apis;
}
-sub getdocced()
+sub getdocced
{
my $dir = shift;
my %return;
my %docced;
+sub loadmissing($)
+{
+ my $missingfile = shift;
+ my @missing;
+
+ open FH, $missingfile
+ || die "Can't open $missingfile";
+ while ( <FH> ) {
+ 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" 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, $!";
+ 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_/;
+
+ # Skip macros known to be missing
+ next if $opt_v && grep( /^$macro$/, @missing);
+
+ print "$f:$macro\n" if $opt_d || $opt_e;
+ $count++;
+ $seen{$macro} = 1;
+ }
+ close(IN);
+ }
+ print "# Found $count macros missing\n" if !$opt_s || $count > 0;
+}
+
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};
+ next if $docced{$func} || defined $seen{$func};
# Skip ASN1 utilities
next if $func =~ /^ASN1_/;
- print "$libname:$func\n";
+ # Skip functions known to be missing
+ next if $opt_v && grep( /^$func$/, @missing);
+
+ print "$libname:$func\n" if $opt_d || $opt_e;
$count++;
+ $seen{$func} = 1;
}
- print "# Found $count missing from $numfile\n\n";
+ print "# Found $count missing from $numfile\n\n" if !$opt_s || $count > 0;
}
$tmp =~ tr/\n/ /;
$tmp =~ s/-.*//g;
- my @names = map { s/\s+//g; $_ } split(/,/, $tmp);
+ 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) {
next if $name eq "";
+ if ($name =~ /\s/) {
+ print "$id '$name' contains white space\n";
+ }
my $name_sec = "$name($section)";
if (! exists $name_collection{$name_sec}) {
$name_collection{$name_sec} = $filename;
# 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;
}
}
-getopts('lnsphu');
+my %skips = (
+ 'aes128' => 1,
+ 'aes192' => 1,
+ 'aes256' => 1,
+ 'aria128' => 1,
+ 'aria192' => 1,
+ 'aria256' => 1,
+ 'camellia128' => 1,
+ 'camellia192' => 1,
+ 'camellia256' => 1,
+ 'des' => 1,
+ 'des3' => 1,
+ 'idea' => 1,
+ '[cipher]' => 1,
+ '[digest]' => 1,
+);
+
+sub checkflags() {
+ my $cmd = shift;
+ my %cmdopts;
+ my %docopts;
+ my $ok = 1;
+
+ # Get the list of options in the command.
+ open CFH, "./apps/openssl list --options $cmd|"
+ || die "Can list options for $cmd, $!";
+ while ( <CFH> ) {
+ chop;
+ s/ .$//;
+ $cmdopts{$_} = 1;
+ }
+ close CFH;
+
+ # Get the list of flags from the synopsis
+ open CFH, "<doc/man1/$cmd.pod"
+ || die "Can't open $cmd.pod, $!";
+ while ( <CFH> ) {
+ chop;
+ last if /DESCRIPTION/;
+ next unless /\[B<-([^ >]+)/;
+ $docopts{$1} = 1;
+ }
+ close CFH;
-&help() if $opt_h;
+ # 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";
+ }
+ }
-die "Need one of -l -n -s -p or -u flags.\n"
- unless $opt_l or $opt_n or $opt_s or $opt_p or $opt_u;
+ # 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";
+ }
+ }
-$opt_n = 1 if $opt_s or $opt_p;
+ return $ok;
+}
-if ( $opt_n ) {
- &publicize() if $opt_p;
- foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
- &check($_);
+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;
+
+if ( $opt_c ) {
+ my $ok = 1;
+ my @commands = ();
+
+ # Get list of commands.
+ open FH, "./apps/openssl list -1 -commands|"
+ || die "Can't list commands, $!";
+ while ( <FH> ) {
+ chop;
+ push @commands, $_;
+ }
+ 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;
+ } else {
+ $ok = 0 if not &checkflags($_);
+ }
}
+
+ # See what help is missing.
+ open FH, "./apps/openssl list --missing-help |"
+ || die "Can't list missing help, $!";
+ while ( <FH> ) {
+ chop;
+ my ($cmd, $flag) = split;
+ print "$cmd has no help for -$flag\n";
+ $ok = 0;
+ }
+ close FH;
+
+ exit 1 if not $ok;
}
if ( $opt_l ) {
- foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
+ foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'),
+ glob('doc/internal/*/*.pod'))) {
collectnames($_);
}
checklinks();
}
-if ( $opt_u ) {
- my %temp = &getdocced('doc/man3');
+if ( $opt_n ) {
+ &publicize() if $opt_p;
+ foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
+ &check($_);
+ }
+ {
+ local $opt_p = undef;
+ foreach (@ARGV ? @ARGV : glob('doc/internal/*/*.pod')) {
+ &check($_);
+ }
+ }
+}
+
+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');
+ 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;
projects / openssl.git / blobdiff