our($opt_h);
our($opt_n);
our($opt_l);
+our($opt_p);
sub help()
{
-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
-h Print this help message
EOF
my $temp = '/tmp/docnits.txt';
my $OUT;
+my %public;
my %mandatory_sections =
( '*' => [ 'NAME', 'DESCRIPTION', 'COPYRIGHT' ],
my $tmp = $1;
$tmp =~ tr/\n/ /;
print "$id trailing comma before - in NAME\n" if $tmp =~ /, *-/;
- $tmp =~ s/-.*//g;
+ $tmp =~ s/ -.*//g;
+ $tmp =~ s/ */ /g;
+ print "$id missing comma in NAME\n" if $tmp =~ /[^,] /;
$tmp =~ s/,//g;
my $dirname = dirname($filename);
print "$id the following exist as other .pod files:\n",
join(" ", sort keys %foundfilenames), "\n"
if %foundfilenames;
- print "$id $simplename (filename) missing from NAME section\n",
+ print "$id $simplename (filename) missing from NAME section\n"
unless $foundfilename;
+ 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;
or die "Can't open $file, $!, stopped";
while ( <$IN> ) {
+ 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;
- print "# Found ", scalar(@apis), " in $file\n";
+ print "# Found ", scalar(@apis), " in $file\n" unless $opt_p;
return sort @apis;
}
my %docced;
+sub checkmacros()
+{
+ my $count = 0;
+
+ 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';
+ 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};
+ next if $macro =~ /i2d_/
+ || $macro =~ /d2i_/
+ || $macro =~ /DEPRECATEDIN/
+ || $macro =~ /IMPLEMENT_/
+ || $macro =~ /DECLARE_/;
+ print "$f:$macro\n";
+ $count++;
+ }
+ close(IN);
+ }
+ print "# Found $count macros missing (not all should be documnted)\n"
+}
+
sub printem()
{
my $libname = shift;
}
}
-getopts('lnshu');
+sub publicize() {
+ foreach my $name ( &parsenum('util/libcrypto.num') ) {
+ $public{$name} = 1;
+ }
+ foreach my $name ( &parsenum('util/libssl.num') ) {
+ $public{$name} = 1;
+ }
+ foreach my $name ( &parsenum('util/private.num') ) {
+ $public{$name} = 1;
+ }
+}
+
+getopts('lnsphu');
+
+&help() if $opt_h;
-&help() if ( $opt_h );
+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;
-die "Need one of -l -n -s or -u flags.\n"
- unless $opt_l or $opt_n or $opt_s or $opt_u;
+$opt_n = 1 if $opt_s or $opt_p;
-if ( $opt_n or $opt_s ) {
+if ( $opt_n ) {
+ &publicize() if $opt_p;
foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
&check($_);
}
}
&printem('crypto', 'util/libcrypto.num');
&printem('ssl', 'util/libssl.num');
+ &checkmacros();
}
exit;