[openssl-commits] [openssl] master update

[Rich Salz]

The branch master has been updated
       via  9a2dfc0febaf89403cdbd4bfdb2417fd3d055e95 (commit)
      from  36c438514db71eba3e8062fef7869b9211630a19 (commit)


- Log -----------------------------------------------------------------
commit 9a2dfc0febaf89403cdbd4bfdb2417fd3d055e95
Author: Rich Salz <rsalz at openssl.org>
Date:   Thu Jun 8 15:57:50 2017 -0400

    List undocumented macros
    
    The search is approximate; look only for those that look like
    functions.
    
    [skip ci]
    
    Reviewed-by: Matt Caswell <matt at openssl.org>
    (Merged from https://github.com/openssl/openssl/pull/3641)

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

Summary of changes:
 util/find-doc-nits | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/util/find-doc-nits b/util/find-doc-nits
index d016985..8f6d482 100755
--- a/util/find-doc-nits
+++ b/util/find-doc-nits
@@ -264,6 +264,34 @@ sub getdocced()
 
 my %docced;
 
+sub checkmacros()
+{
+    my $count = 0;
+
+    print "# Checking macros (approximate)\n";
+    foreach my $f ( glob('include/openssl/*.h') ) {
+        # Skip some internals we don't want to document yet.
+        next if $f eq 'include/openssl/asn1.h';
+        next if $f eq 'include/openssl/asn1t.h';
+        next if $f eq 'include/openssl/err.h';
+        open(IN, $f) || die "Can't open $f, $!";
+        while ( <IN> ) {
+            next unless /^#\s*define\s*(\S+)\(/;
+            my $macro = $1;
+            next if $docced{$macro};
+            next if $macro =~ /i2d_/
+                || $macro =~ /d2i_/
+                || $macro =~ /DEPRECATEDIN/
+                || $macro =~ /IMPLEMENT_/
+                || $macro =~ /DECLARE_/;
+            print "$f:$macro\n";
+            $count++;
+        }
+        close(IN);
+    }
+    print "# Found $count macros missing (not all should be documnted)\n"
+}
+
 sub printem()
 {
     my $libname = shift;
@@ -399,6 +427,7 @@ if ( $opt_u ) {
     }
     &printem('crypto', 'util/libcrypto.num');
     &printem('ssl', 'util/libssl.num');
+    &checkmacros();
 }
 
 exit;