[openssl-commits] [openssl] master update

Rich Salz rsalz at openssl.org
Tue Jun 7 18:47:01 UTC 2016


The branch master has been updated
       via  fbba5d113f1294992cd99643c79860df8f64015a (commit)
      from  a9da48157c90b4b6d19d912666ad2183b5a16a1f (commit)


- Log -----------------------------------------------------------------
commit fbba5d113f1294992cd99643c79860df8f64015a
Author: Rich Salz <rsalz at openssl.org>
Date:   Tue Jun 7 13:08:20 2016 -0400

    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 at openssl.org>
    Reviewed-by: Viktor Dukhovni <viktor at openssl.org>

-----------------------------------------------------------------------

Summary of changes:
 doc/crypto/{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 b0fab95..59647f9 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;


More information about the openssl-commits mailing list