#! /usr/bin/env perl
-# Copyright 2002-2018 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
# Options.
our($opt_d);
+our($opt_e);
+our($opt_s);
our($opt_h);
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
-l Print bogus links
-n Print nits in POD pages
-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
$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
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=...
} 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"
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;
- print "# Checking macros (approximate)\n";
+ my @missing = loadmissing('util/missingmacro.txt') if ($opt_v);
+
+ 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';
while ( <IN> ) {
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);
+
+ print "$f:$macro\n" if $opt_d || $opt_e;
$count++;
+ $seen{$macro} = 1;
}
close(IN);
}
- print "# Found $count macros missing (not all should be documented)\n"
+ 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" if $opt_d;
+ # 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;
return $ok;
}
-getopts('cdlnphu');
+getopts('cdeslnphuv');
&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_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;
-die "Need one of -[cdlnpu] flags.\n"
- unless $opt_c or $opt_l or $opt_n or $opt_u;
+die "Need one of -[cdelnpuv] flags.\n"
+ unless $opt_c or $opt_l or $opt_n or $opt_u or $opt_v;
if ( $opt_c ) {
my $ok = 1;
}
if ( $opt_l ) {
- foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
+ foreach (@ARGV ? @ARGV : (glob('doc/*/*.pod'),
+ glob('doc/internal/*/*.pod'))) {
collectnames($_);
}
checklinks();
foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
&check($_);
}
+ {
+ local $opt_p = undef;
+ foreach (@ARGV ? @ARGV : glob('doc/internal/*/*.pod')) {
+ &check($_);
+ }
+ }
}
-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');
+ &printem('crypto', 'util/libcrypto.num', 'util/missingcrypto.txt');
+ &printem('ssl', 'util/libssl.num', 'util/missingssl.txt');
&checkmacros();
}
projects / openssl.git / blobdiff