2 # Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
4 # Licensed under the OpenSSL license (the "License"). You may not use
5 # this file except in compliance with the License. You can obtain a copy
6 # in the file LICENSE in the source distribution or at
7 # https://www.openssl.org/source/license.html
16 use File::Spec::Functions;
18 use lib catdir(dirname($0), "perl");
19 use OpenSSL::Util::Pod;
33 Find small errors (nits) in documentation. Options:
34 -d Detailed list of undocumented (implies -u)
36 -n Print nits in POD pages
37 -s Also print missing sections in POD pages (implies -n)
38 -p Warn if non-public name documented (implies -n)
39 -u List undocumented functions
40 -h Print this help message
45 my $temp = '/tmp/docnits.txt';
49 my %mandatory_sections =
50 ( '*' => [ 'NAME', 'DESCRIPTION', 'COPYRIGHT' ],
51 1 => [ 'SYNOPSIS', 'OPTIONS' ],
52 3 => [ 'SYNOPSIS', 'RETURN VALUES' ],
56 # Cross-check functions in the NAME and SYNOPSIS section.
63 # Get NAME section and all words in it.
64 return unless $contents =~ /=head1 NAME(.*)=head1 SYNOPSIS/ms;
67 print "$id trailing comma before - in NAME\n" if $tmp =~ /, *-/;
70 print "$id missing comma in NAME\n" if $tmp =~ /[^,] /;
73 my $dirname = dirname($filename);
74 my $simplename = basename($filename);
75 $simplename =~ s/.pod$//;
76 my $foundfilename = 0;
77 my %foundfilenames = ();
79 foreach my $n ( split ' ', $tmp ) {
81 $foundfilename++ if $n eq $simplename;
82 $foundfilenames{$n} = 1
83 if -f "$dirname/$n.pod" && $n ne $simplename;
85 print "$id the following exist as other .pod files:\n",
86 join(" ", sort keys %foundfilenames), "\n"
88 print "$id $simplename (filename) missing from NAME section\n"
89 unless $foundfilename;
90 foreach my $n ( keys %names ) {
91 print "$id $n is not public\n"
92 if $opt_p and !defined $public{$n};
95 # Find all functions in SYNOPSIS
96 return unless $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms;
98 foreach my $line ( split /\n+/, $syn ) {
100 $line =~ s/STACK_OF\([^)]+\)/int/g;
101 $line =~ s/__declspec\([^)]+\)//;
102 if ( $line =~ /env (\S*)=/ ) {
103 # environment variable env NAME=...
105 } elsif ( $line =~ /typedef.*\(\*(\S+)\)\(.*/ ) {
106 # a callback function: typedef ... (*NAME)(...
108 } elsif ( $line =~ /typedef.* (\S+);/ ) {
109 # a simple typedef: typedef ... NAME;
111 } elsif ( $line =~ /enum (\S*) \{/ ) {
112 # an enumeration: enum ... {
114 } elsif ( $line =~ /#define ([A-Za-z0-9_]+)/ ) {
116 } elsif ( $line =~ /([A-Za-z0-9_]+)\(/ ) {
122 print "$id $sym missing from NAME section\n"
123 unless defined $names{$sym};
126 # Do some sanity checks on the prototype.
127 print "$id prototype missing spaces around commas: $line\n"
128 if ( $line =~ /[a-z0-9],[^ ]/ );
131 foreach my $n ( keys %names ) {
132 next if $names{$n} == 2;
133 print "$id $n missing from SYNOPSIS\n";
139 my $filename = shift;
140 my $dirname = basename(dirname($filename));
145 open POD, $filename or die "Couldn't open $filename, $!";
150 my $id = "${filename}:1:";
152 &name_synopsis($id, $filename, $contents)
153 unless $contents =~ /=for comment generic/
154 or $filename =~ m@man[157]/@;
156 print "$id doesn't start with =pod\n"
157 if $contents !~ /^=pod/;
158 print "$id doesn't end with =cut\n"
159 if $contents !~ /=cut\n$/;
160 print "$id more than one cut line.\n"
161 if $contents =~ /=cut.*=cut/ms;
162 print "$id missing copyright\n"
163 if $contents !~ /Copyright .* The OpenSSL Project Authors/;
164 print "$id copyright not last\n"
165 if $contents =~ /head1 COPYRIGHT.*=head/ms;
166 print "$id head2 in All uppercase\n"
167 if $contents =~ /head2\s+[A-Z ]+\n/;
168 print "$id extra space after head\n"
169 if $contents =~ /=head\d\s\s+/;
170 print "$id period in NAME section\n"
171 if $contents =~ /=head1 NAME.*\.\n.*=head1 SYNOPSIS/ms;
172 print "$id POD markup in NAME section\n"
173 if $contents =~ /=head1 NAME.*[<>].*=head1 SYNOPSIS/ms;
174 print "$id Duplicate $1 in L<>\n"
175 if $contents =~ /L<([^>]*)\|([^>]*)>/ && $1 eq $2;
176 print "$id Bad =over $1\n"
177 if $contents =~ /=over([^ ][^24])/;
178 print "$id Possible version style issue\n"
179 if $contents =~ /OpenSSL version [019]/;
181 if ( $contents !~ /=for comment multiple includes/ ) {
182 # Look for multiple consecutive openssl #include lines
183 # (non-consecutive lines are okay; see man3/MD5.pod).
184 if ( $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms ) {
186 foreach my $line ( split /\n+/, $1 ) {
187 if ( $line =~ m@include <openssl/@ ) {
188 print "$id has multiple includes\n" if ++$count == 2;
196 open my $OUT, '>', $temp
197 or die "Can't open $temp, $!";
198 podchecker($filename, $OUT);
200 open $OUT, '<', $temp
201 or die "Can't read $temp, $!";
203 next if /\(section\) in.*deprecated/;
207 unlink $temp || warn "Can't remove $temp, $!";
209 # Find what section this page is in; assume 3.
211 $section = $1 if $dirname =~ /man([1-9])/;
213 foreach ((@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}})) {
214 # Skip "return values" if not -s
215 next if $_ eq 'RETURN VALUES' and not $opt_s;
216 print "$id: missing $_ head1 section\n"
217 if $contents !~ /^=head1\s+${_}\s*$/m;
228 open my $IN, '<', $file
229 or die "Can't open $file, $!, stopped";
233 next if /\bNOEXIST\b/;
234 next if /\bEXPORT_VAR_AS_FUNC\b/;
235 my @fields = split();
236 die "Malformed line $_"
237 if scalar @fields != 2 && scalar @fields != 4;
238 push @apis, $fields[0];
243 print "# Found ", scalar(@apis), " in $file\n" unless $opt_p;
252 foreach my $pod ( glob("$dir/*.pod") ) {
253 my %podinfo = extract_pod_info($pod);
254 foreach my $n ( @{$podinfo{names}} ) {
256 print "# Duplicate $n in $pod and $dups{$n}\n"
257 if defined $dups{$n} && $dups{$n} ne $pod;
271 print "# Checking macros (approximate)\n";
272 foreach my $f ( glob('include/openssl/*.h') ) {
273 # Skip some internals we don't want to document yet.
274 next if $f eq 'include/openssl/asn1.h';
275 next if $f eq 'include/openssl/asn1t.h';
276 next if $f eq 'include/openssl/err.h';
277 open(IN, $f) || die "Can't open $f, $!";
279 next unless /^#\s*define\s*(\S+)\(/;
281 next if $docced{$macro};
282 next if $macro =~ /i2d_/
284 || $macro =~ /DEPRECATEDIN/
285 || $macro =~ /IMPLEMENT_/
286 || $macro =~ /DECLARE_/;
287 print "$f:$macro\n" if $opt_d;
292 print "# Found $count macros missing (not all should be documented)\n"
301 foreach my $func ( &parsenum($numfile) ) {
302 next if $docced{$func};
304 # Skip ASN1 utilities
305 next if $func =~ /^ASN1_/;
307 print "$libname:$func\n" if $opt_d;
310 print "# Found $count missing from $numfile\n\n";
314 # Collection of links in each POD file.
315 # filename => [ "foo(1)", "bar(3)", ... ]
316 my %link_collection = ();
317 # Collection of names in each POD file.
318 # "name(s)" => filename
319 my %name_collection = ();
322 my $filename = shift;
323 $filename =~ m|man(\d)/|;
325 my $simplename = basename($filename, ".pod");
326 my $id = "${filename}:1:";
331 open POD, $filename or die "Couldn't open $filename, $!";
336 $contents =~ /=head1 NAME([^=]*)=head1 /ms;
338 unless (defined $tmp) {
339 print "$id weird name section\n";
345 my @names = map { s/\s+//g; $_ } split(/,/, $tmp);
346 unless (grep { $simplename eq $_ } @names) {
347 print "$id missing $simplename\n";
348 push @names, $simplename;
350 foreach my $name (@names) {
352 my $name_sec = "$name($section)";
353 if (! exists $name_collection{$name_sec}) {
354 $name_collection{$name_sec} = $filename;
355 } else { #elsif ($filename ne $name_collection{$name_sec}) {
356 print "$id $name_sec also in $name_collection{$name_sec}\n";
361 map { map { s/\s+//g; $_ } split(/,/, $_) }
362 $contents =~ /=for\s+comment\s+foreign\s+manuals:\s*(.*)\n\n/;
363 foreach (@foreign_names) {
364 $name_collection{$_} = undef; # It still exists!
367 my @links = $contents =~ /L<
368 # if the link is of the form L<something|name(s)>,
369 # then remove 'something'. Note that 'something'
370 # may contain POD codes as well...
371 (?:(?:[^\|]|<[^>]*>)*\|)?
372 # we're only interested in referenses that have
373 # a one digit section number
376 $link_collection{$filename} = [ @links ];
380 foreach my $filename (sort keys %link_collection) {
381 foreach my $link (@{$link_collection{$filename}}) {
382 print "${filename}:1: reference to non-existing $link\n"
383 unless exists $name_collection{$link};
389 foreach my $name ( &parsenum('util/libcrypto.num') ) {
392 foreach my $name ( &parsenum('util/libssl.num') ) {
395 foreach my $name ( &parsenum('util/private.num') ) {
403 $opt_n = 1 if $opt_s or $opt_p;
404 $opt_u = 1 if $opt_d;
406 die "Need one of -[dlnspu] flags.\n"
407 unless $opt_l or $opt_n or $opt_u;
411 &publicize() if $opt_p;
412 foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
418 foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
425 my %temp = &getdocced('doc/man3');
426 foreach ( keys %temp ) {
427 $docced{$_} = $temp{$_};
429 &printem('crypto', 'util/libcrypto.num');
430 &printem('ssl', 'util/libssl.num');