#! /usr/bin/env perl
# Copyright 2002-2018 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
-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
-h Print this help message
-c List undocumented commands and options
EOF
$tmp =~ s/ -.*//g;
$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
} 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;
return sort @apis;
}
-sub getdocced()
+sub getdocced
{
my $dir = shift;
my %return;
sub checkmacros()
{
my $count = 0;
+ my %seen;
print "# Checking macros (approximate)\n";
foreach my $f ( glob('include/openssl/*.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 =~ /DECLARE_/;
print "$f:$macro\n" if $opt_d;
$count++;
+ $seen{$macro} = 1;
}
close(IN);
}
my $libname = shift;
my $numfile = shift;
my $count = 0;
+ my %seen;
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;
$count++;
+ $seen{$func} = 1;
}
print "# Found $count missing from $numfile\n\n";
}
$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;
}
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');
+ my %temp = getdocced('doc/man3');
foreach ( keys %temp ) {
$docced{$_} = $temp{$_};
}