Enforce return values section check

To avoid check failure, make dummy RETURN VALUES sections in the docs
which have no real functions decribed inside...

Reviewed-by: Andy Polyakov <appro@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/4976)

diff --git a/doc/man3/OPENSSL_Applink.pod b/doc/man3/OPENSSL_Applink.pod
index d3a461ba39d3e0befd3f1c082a21b290a02287c1..5c97d59279af5ff23c194ed4abd1459c98d8d36b 100644 (file)
--- a/doc/man3/OPENSSL_Applink.pod
+++ b/doc/man3/OPENSSL_Applink.pod
@@ -19,6 +19,10 @@ compiler of their choice and link it into the target application.
 The referred module is available as F<applink.c>, located alongside
 the public header files (only on the platforms where applicable).
 
 The referred module is available as F<applink.c>, located alongside
 the public header files (only on the platforms where applicable).
 

+=head1 RETURN VALUES
+
+Not available.
+

 =head1 COPYRIGHT
 
 Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.
 =head1 COPYRIGHT
 
 Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.

diff --git a/doc/man3/OPENSSL_ia32cap.pod b/doc/man3/OPENSSL_ia32cap.pod
index e4f5037588b7f43782e612b81c143735346f6ece..b90eb3257c339224e2beee09dba70e06c9f13645 100644 (file)
--- a/doc/man3/OPENSSL_ia32cap.pod
+++ b/doc/man3/OPENSSL_ia32cap.pod
@@ -151,6 +151,10 @@ the problem by making build procedure use following script:
 instead of real clang. In which case it doesn't matter which clang
 version is used, as it is GNU assembler version that will be checked.
 
 instead of real clang. In which case it doesn't matter which clang
 version is used, as it is GNU assembler version that will be checked.
 

+=head1 RETURN VALUES
+
+Not available.
+

 =head1 COPYRIGHT
 
 Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.
 =head1 COPYRIGHT
 
 Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.

diff --git a/util/find-doc-nits b/util/find-doc-nits
index 7087d366d2e97f722c737dfdd5a6707a89559a94..8d580de045f1a8b27f19941af854ca55c32f4d88 100755 (executable)
--- a/util/find-doc-nits
+++ b/util/find-doc-nits
@@ -24,7 +24,6 @@ our($opt_h);
 our($opt_l);
 our($opt_n);
 our($opt_p);
 our($opt_l);
 our($opt_n);
 our($opt_p);

-our($opt_s);

 our($opt_u);
 our($opt_c);
 
 our($opt_u);
 our($opt_c);
 


@@ -35,7 +34,6 @@ Find small errors (nits) in documentation.  Options:
     -d Detailed list of undocumented (implies -u)
     -l Print bogus links
     -n Print nits in POD pages
     -d Detailed list of undocumented (implies -u)
     -l Print bogus links
     -n Print nits in POD pages

-    -s Also print missing sections in POD pages (implies -n)

     -p Warn if non-public name documented (implies -n)
     -u List undocumented functions
     -h Print this help message
     -p Warn if non-public name documented (implies -n)
     -u List undocumented functions
     -h Print this help message


@@ -217,7 +215,6 @@ sub check()
 
     foreach ((@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}})) {
         # Skip "return values" if not -s
 
     foreach ((@{$mandatory_sections{'*'}}, @{$mandatory_sections{$section}})) {
         # Skip "return values" if not -s

-        next if $_ eq 'RETURN VALUES' and not $opt_s;

         print "$id: missing $_ head1 section\n"
             if $contents !~ /^=head1\s+${_}\s*$/m;
     }
         print "$id: missing $_ head1 section\n"
             if $contents !~ /^=head1\s+${_}\s*$/m;
     }


@@ -474,13 +471,13 @@ sub checkflags() {
     return $ok;
 }
 
     return $ok;
 }
 

-getopts('cdlnsphu');
+getopts('cdlnphu');

 
 &help() if $opt_h;
 
 &help() if $opt_h;

-$opt_n = 1 if $opt_s or $opt_p;
+$opt_n = 1 if $opt_p;

 $opt_u = 1 if $opt_d;
 
 $opt_u = 1 if $opt_d;
 

-die "Need one of -[cdlnspu] flags.\n"
+die "Need one of -[cdlnpu] flags.\n"

     unless $opt_c or $opt_l or $opt_n or $opt_u;
 
 if ( $opt_c ) {
     unless $opt_c or $opt_l or $opt_n or $opt_u;
 
 if ( $opt_c ) {