diff options
author | Rich Salz <rsalz@openssl.org> | 2016-06-07 13:08:20 -0400 |
---|---|---|
committer | Rich Salz <rsalz@openssl.org> | 2016-06-07 14:46:33 -0400 |
commit | fbba5d113f1294992cd99643c79860df8f64015a (patch) | |
tree | d757702c7c2411a2e18d6fca3c71b18d136c865b | |
parent | a9da48157c90b4b6d19d912666ad2183b5a16a1f (diff) | |
download | openssl-fbba5d113f1294992cd99643c79860df8f64015a.tar.gz |
Nit about pod filenames
The asdf.pod filename must have asdf in its NAME section.
also check for names existing as a different filename (via Levitte)
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
-rw-r--r-- | doc/crypto/X509_PUBKEY_new.pod (renamed from doc/crypto/X509_PUBKEY.pod) | 0 | ||||
-rwxr-xr-x | util/find-doc-nits.pl | 14 |
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/crypto/X509_PUBKEY.pod b/doc/crypto/X509_PUBKEY_new.pod index 0e8a14abb5..0e8a14abb5 100644 --- a/doc/crypto/X509_PUBKEY.pod +++ b/doc/crypto/X509_PUBKEY_new.pod diff --git a/util/find-doc-nits.pl b/util/find-doc-nits.pl index b0fab95353..59647f9294 100755 --- a/util/find-doc-nits.pl +++ b/util/find-doc-nits.pl @@ -48,10 +48,24 @@ sub name_synopsis() $tmp =~ tr/\n/ /; $tmp =~ s/-.*//g; $tmp =~ s/,//g; + + my $dirname = dirname($filename); + my $simplename = basename($filename); + $simplename =~ s/.pod$//; + my $foundfilename = 0; + my %foundfilenames = (); my %names; foreach my $n ( split ' ', $tmp ) { $names{$n} = 1; + $foundfilename++ if $n eq $simplename; + $foundfilenames{$n} = 1 + if -f "$dirname/$n.pod" && $n ne $simplename; } + 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", + unless $foundfilename; # Find all functions in SYNOPSIS return unless $contents =~ /=head1 SYNOPSIS(.*)=head1 DESCRIPTION/ms; |