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
20 my $temp = '/tmp/docnits.txt';
23 my %mandatory_sections =
24 ( '*' => [ 'NAME', 'DESCRIPTION', 'COPYRIGHT' ],
25 1 => [ 'SYNOPSIS', '(COMMAND\s+)?OPTIONS' ],
26 3 => [ 'SYNOPSIS', 'RETURN\s+VALUES' ],
29 my %default_sections =
34 # Cross-check functions in the NAME and SYNOPSIS section.
41 # Get NAME section and all words in it.
42 return unless $contents =~ /=head1 NAME(.*)=head1 SYNOPSIS/ms;
48 my $dirname = dirname($filename);
49 my $simplename = basename($filename);
50 $simplename =~ s/.pod$//;
51 my $foundfilename = 0;
52 my %foundfilenames = ();
54 foreach my $n ( split ' ', $tmp ) {
56 $foundfilename++ if $n eq $simplename;
57 $foundfilenames{$n} = 1
58 if -f "$dirname/$n.pod" && $n ne $simplename;
60 print "$id the following exist as other .pod files:\n",
61 join(" ", sort keys %foundfilenames), "\n"
63 print "$id $simplename (filename) missing from NAME section\n",
64 unless $foundfilename;
66 # Find all functions in SYNOPSIS
67 return unless $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms;
69 foreach my $line ( split /\n+/, $syn ) {
71 $line =~ s/STACK_OF\([^)]+\)//;
72 if ( $line =~ /typedef.* (\S+);/ ) {
74 } elsif ( $line =~ /#define (\S+)/ ) {
76 } elsif ( $line =~ /([A-Za-z0-9_]+)\(/ ) {
82 print "$id $sym missing from NAME section\n"
83 unless defined $names{$sym};
87 foreach my $n ( keys %names ) {
88 next if $names{$n} == 2;
89 print "$id $n missing from SYNOPSIS\n";
96 my $dirname = basename(dirname($filename));
101 open POD, $filename or die "Couldn't open $filename, $!";
106 my $id = "${filename}:1:";
108 &name_synopsis($id, $filename, $contents)
109 unless $contents =~ /=for comment generic/
110 or $contents =~ /=for comment openssl_manual_section:7/
111 or $filename =~ m@/apps/@;
113 print "$id doesn't start with =pod\n"
114 if $contents !~ /^=pod/;
115 print "$id doesn't end with =cut\n"
116 if $contents !~ /=cut\n$/;
117 print "$id more than one cut line.\n"
118 if $contents =~ /=cut.*=cut/ms;
119 print "$id missing copyright\n"
120 if $contents !~ /Copyright .* The OpenSSL Project Authors/;
121 print "$id copyright not last\n"
122 if $contents =~ /head1 COPYRIGHT.*=head/ms;
123 print "$id head2 in All uppercase\n"
124 if $contents =~ /head2\s+[A-Z ]+\n/;
125 print "$id extra space after head\n"
126 if $contents =~ /=head\d\s\s+/;
127 print "$id period in NAME section\n"
128 if $contents =~ /=head1 NAME.*\.\n.*=head1 SYNOPSIS/ms;
129 print "$id POD markup in NAME section\n"
130 if $contents =~ /=head1 NAME.*[<>].*=head1 SYNOPSIS/ms;
132 # Look for multiple consecutive openssl #include lines.
133 # Consecutive because of files like md5.pod. Sometimes it's okay
134 # or necessary, as in ssl/SSL_set1_host.pod
135 if ( $contents !~ /=for comment multiple includes/ ) {
136 if ( $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms ) {
138 foreach my $line ( split /\n+/, $1 ) {
139 if ( $line =~ m@include <openssl/@ ) {
140 if ( ++$count == 2 ) {
141 print "$id has multiple includes\n";
150 return unless $opt_s;
152 # Find what section this page is in. If run from "." assume
154 my $section = $default_sections{$dirname} || 3;
155 if ($contents =~ /^=for\s+comment\s+openssl_manual_section:\s*(\d+)\s*$/m) {
159 foreach ((@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}})) {
160 print "$id doesn't have a head1 section matching $_\n"
161 if $contents !~ /^=head1\s+${_}\s*$/m;
164 open my $OUT, '>', $temp
165 or die "Can't open $temp, $!";
166 podchecker($filename, $OUT);
168 open $OUT, '<', $temp
169 or die "Can't read $temp, $!";
171 next if /\(section\) in.*deprecated/;
175 unlink $temp || warn "Can't remove $temp, $!";
180 foreach (@ARGV ? @ARGV : glob('doc/*/*.pod')) {