From fbba5d113f1294992cd99643c79860df8f64015a Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Tue, 7 Jun 2016 13:08:20 -0400 Subject: [PATCH] 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 Reviewed-by: Viktor Dukhovni --- .../{X509_PUBKEY.pod => X509_PUBKEY_new.pod} | 0 util/find-doc-nits.pl | 14 ++++++++++++++ 2 files changed, 14 insertions(+) rename doc/crypto/{X509_PUBKEY.pod => X509_PUBKEY_new.pod} (100%) diff --git a/doc/crypto/X509_PUBKEY.pod b/doc/crypto/X509_PUBKEY_new.pod similarity index 100% rename from doc/crypto/X509_PUBKEY.pod rename to 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;