Enforce return values section check
authorPaul Yang <yang.yang@baishancloud.com>
Tue, 2 Jan 2018 17:07:57 +0000 (01:07 +0800)
committerMatt Caswell <matt@openssl.org>
Tue, 16 Jan 2018 17:34:08 +0000 (17:34 +0000)
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)

doc/man3/OPENSSL_Applink.pod
doc/man3/OPENSSL_ia32cap.pod
util/find-doc-nits

index d3a461b..5c97d59 100644 (file)
@@ -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).
 
+=head1 RETURN VALUES
+
+Not available.
+
 =head1 COPYRIGHT
 
 Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.
index e4f5037..b90eb32 100644 (file)
@@ -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.
 
+=head1 RETURN VALUES
+
+Not available.
+
 =head1 COPYRIGHT
 
 Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.
index 7087d36..8d580de 100755 (executable)
@@ -24,7 +24,6 @@ our($opt_h);
 our($opt_l);
 our($opt_n);
 our($opt_p);
-our($opt_s);
 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
-    -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
@@ -217,7 +215,6 @@ sub check()
 
     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;
     }
@@ -474,13 +471,13 @@ sub checkflags() {
     return $ok;
 }
 
-getopts('cdlnsphu');
+getopts('cdlnphu');
 
 &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;
 
-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 ) {