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;
31 Find small errors (nits) in documentation. Options:
33 -n Print nits in POD pages
34 -s Also print missing sections in POD pages (implies -n)
35 -u List undocumented functions
36 -h Print this help message
41 my $temp = '/tmp/docnits.txt';
44 my %mandatory_sections =
45 ( '*' => [ 'NAME', 'DESCRIPTION', 'COPYRIGHT' ],
46 1 => [ 'SYNOPSIS', 'OPTIONS' ],
47 3 => [ 'SYNOPSIS', 'RETURN VALUES' ],
51 # Cross-check functions in the NAME and SYNOPSIS section.
58 # Get NAME section and all words in it.
59 return unless $contents =~ /=head1 NAME(.*)=head1 SYNOPSIS/ms;
65 my $dirname = dirname($filename);
66 my $simplename = basename($filename);
67 $simplename =~ s/.pod$//;
68 my $foundfilename = 0;
69 my %foundfilenames = ();
71 foreach my $n ( split ' ', $tmp ) {
73 $foundfilename++ if $n eq $simplename;
74 $foundfilenames{$n} = 1
75 if -f "$dirname/$n.pod" && $n ne $simplename;
77 print "$id the following exist as other .pod files:\n",
78 join(" ", sort keys %foundfilenames), "\n"
80 print "$id $simplename (filename) missing from NAME section\n",
81 unless $foundfilename;
83 # Find all functions in SYNOPSIS
84 return unless $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms;
86 foreach my $line ( split /\n+/, $syn ) {
88 $line =~ s/STACK_OF\([^)]+\)/int/g;
89 $line =~ s/__declspec\([^)]+\)//;
90 if ( $line =~ /env (\S*)=/ ) {
91 # environment variable env NAME=...
93 } elsif ( $line =~ /typedef.*\(\*(\S+)\)\(.*/ ) {
94 # a callback function: typedef ... (*NAME)(...
96 } elsif ( $line =~ /typedef.* (\S+);/ ) {
97 # a simple typedef: typedef ... NAME;
99 } elsif ( $line =~ /enum (\S*) {/ ) {
100 # an enumeration: enum ... {
102 } elsif ( $line =~ /#define ([A-Za-z0-9_]+)/ ) {
104 } elsif ( $line =~ /([A-Za-z0-9_]+)\(/ ) {
110 print "$id $sym missing from NAME section\n"
111 unless defined $names{$sym};
114 # Do some sanity checks on the prototype.
115 print "$id prototype missing spaces around commas: $line\n"
116 if ( $line =~ /[a-z0-9],[^ ]/ );
119 foreach my $n ( keys %names ) {
120 next if $names{$n} == 2;
121 print "$id $n missing from SYNOPSIS\n";
127 my $filename = shift;
128 my $dirname = basename(dirname($filename));
133 open POD, $filename or die "Couldn't open $filename, $!";
138 my $id = "${filename}:1:";
140 &name_synopsis($id, $filename, $contents)
141 unless $contents =~ /=for comment generic/
142 or $filename =~ m@man[157]/@;
144 print "$id doesn't start with =pod\n"
145 if $contents !~ /^=pod/;
146 print "$id doesn't end with =cut\n"
147 if $contents !~ /=cut\n$/;
148 print "$id more than one cut line.\n"
149 if $contents =~ /=cut.*=cut/ms;
150 print "$id missing copyright\n"
151 if $contents !~ /Copyright .* The OpenSSL Project Authors/;
152 print "$id copyright not last\n"
153 if $contents =~ /head1 COPYRIGHT.*=head/ms;
154 print "$id head2 in All uppercase\n"
155 if $contents =~ /head2\s+[A-Z ]+\n/;
156 print "$id extra space after head\n"
157 if $contents =~ /=head\d\s\s+/;
158 print "$id period in NAME section\n"
159 if $contents =~ /=head1 NAME.*\.\n.*=head1 SYNOPSIS/ms;
160 print "$id POD markup in NAME section\n"
161 if $contents =~ /=head1 NAME.*[<>].*=head1 SYNOPSIS/ms;
163 # Look for multiple consecutive openssl #include lines.
164 # Consecutive because of files like md5.pod. Sometimes it's okay
165 # or necessary, as in ssl/SSL_set1_host.pod
166 if ( $contents !~ /=for comment multiple includes/ ) {
167 if ( $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms ) {
169 foreach my $line ( split /\n+/, $1 ) {
170 if ( $line =~ m@include <openssl/@ ) {
171 if ( ++$count == 2 ) {
172 print "$id has multiple includes\n";
181 return unless $opt_s;
183 # Find what section this page is in. If run from "." assume
186 $section = $1 if $dirname =~ /man([1-9])/;
188 foreach ((@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}})) {
189 print "$id: missing $_ head1 section\n"
190 if $contents !~ /^=head1\s+${_}\s*$/m;
193 open my $OUT, '>', $temp
194 or die "Can't open $temp, $!";
195 podchecker($filename, $OUT);
197 open $OUT, '<', $temp
198 or die "Can't read $temp, $!";
200 next if /\(section\) in.*deprecated/;
204 unlink $temp || warn "Can't remove $temp, $!";
214 open my $IN, '<', $file
215 or die "Can't open $file, $!, stopped";
218 next if /\bNOEXIST\b/;
219 next if /\bEXPORT_VAR_AS_FUNC\b/;
220 push @apis, $1 if /([^\s]+).\s/;
225 print "# Found ", scalar(@apis), " in $file\n";
234 foreach my $pod ( glob("$dir/*.pod") ) {
235 my %podinfo = extract_pod_info($pod);
236 foreach my $n ( @{$podinfo{names}} ) {
238 print "# Duplicate $n in $pod and $dups{$n}\n"
239 if defined $dups{$n} && $dups{$n} ne $pod;
255 foreach my $func ( &parsenum($numfile) ) {
256 next if $docced{$func};
258 # Skip ASN1 utilities
259 next if $func =~ /^ASN1_/;
261 print "$libname:$func\n";
264 print "# Found $count missing from $numfile\n\n";
268 # Collection of links in each POD file.
269 # filename => [ "foo(1)", "bar(3)", ... ]
270 my %link_collection = ();
271 # Collection of names in each POD file.
272 # "name(s)" => filename
273 my %name_collection = ();
276 my $filename = shift;
277 $filename =~ m|man(\d)/|;
279 my $simplename = basename($filename, ".pod");
280 my $id = "${filename}:1:";
285 open POD, $filename or die "Couldn't open $filename, $!";
290 $contents =~ /=head1 NAME([^=]*)=head1 /ms;
292 unless (defined $tmp) {
293 print "$id weird name section\n";
299 my @names = map { s/\s+//g; $_ } split(/,/, $tmp);
300 unless (grep { $simplename eq $_ } @names) {
301 print "$id missing $simplename\n";
302 push @names, $simplename;
304 foreach my $name (@names) {
306 my $name_sec = "$name($section)";
307 if (! exists $name_collection{$name_sec}) {
308 $name_collection{$name_sec} = $filename;
309 } else { #elsif ($filename ne $name_collection{$name_sec}) {
310 print "$id $name_sec also in $name_collection{$name_sec}\n";
315 map { map { s/\s+//g; $_ } split(/,/, $_) }
316 $contents =~ /=for\s+comment\s+foreign\s+manuals:\s*(.*)\n\n/;
317 foreach (@foreign_names) {
318 $name_collection{$_} = undef; # It still exists!
321 my @links = $contents =~ /L<
322 # if the link is of the form L<something|name(s)>,
323 # then remove 'something'. Note that 'something'
324 # may contain POD codes as well...
325 (?:(?:[^\|]|<[^>]*>)*\|)?
326 # we're only interested in referenses that have
327 # a one digit section number
330 $link_collection{$filename} = [ @links ];
334 foreach my $filename (sort keys %link_collection) {
335 foreach my $link (@{$link_collection{$filename}}) {
336 print "${filename}:1: reference to non-existing $link\n"
337 unless exists $name_collection{$link};
344 &help() if ( $opt_h );
346 die "Need one of -l -n -s or -u flags.\n"
347 unless $opt_l or $opt_n or $opt_s or $opt_u;
349 if ( $opt_n or $opt_s ) {
350 foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
356 foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {
363 my %temp = &getdocced('doc/man3');
364 foreach ( keys %temp ) {
365 $docced{$_} = $temp{$_};
367 &printem('crypto', 'util/libcrypto.num');
368 &printem('ssl', 'util/libssl.num');