Use WARNINGS heading not WARNING

Also update find-doc-nits to reject "=head1 WARNING"

Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/9602)

diff --git a/doc/man3/BIO_s_bio.pod b/doc/man3/BIO_s_bio.pod
index bad818cf4dbfcc09943374aa79fe233a016c2943..0f4ea77d6db3b7a33102ac8ac0823f309722679a 100644 (file)
--- a/doc/man3/BIO_s_bio.pod
+++ b/doc/man3/BIO_s_bio.pod
@@ -176,7 +176,7 @@ and must be transferred to the network. Use BIO_ctrl_get_read_request() to
 find out, how many bytes must be written into the buffer before the
 SSL_operation() can successfully be continued.
 
 find out, how many bytes must be written into the buffer before the
 SSL_operation() can successfully be continued.
 

-=head1 WARNING
+=head1 WARNINGS

 
 As the data is buffered, SSL_operation() may return with an ERROR_SSL_WANT_READ
 condition, but there is still data in the write buffer. An application must
 
 As the data is buffered, SSL_operation() may return with an ERROR_SSL_WANT_READ
 condition, but there is still data in the write buffer. An application must

diff --git a/doc/man3/BN_mod_mul_montgomery.pod b/doc/man3/BN_mod_mul_montgomery.pod
index bb11c426c0998574f4b4c788431c5041a5d6bfaa..5cb2c2c377547fbdce5ead70ae17e66ffd6a3eb6 100644 (file)
--- a/doc/man3/BN_mod_mul_montgomery.pod
+++ b/doc/man3/BN_mod_mul_montgomery.pod
@@ -64,7 +64,7 @@ BN_MONT_CTX_free() has no return value.
 For the other functions, 1 is returned for success, 0 on error.
 The error codes can be obtained by L<ERR_get_error(3)>.
 
 For the other functions, 1 is returned for success, 0 on error.
 The error codes can be obtained by L<ERR_get_error(3)>.
 

-=head1 WARNING
+=head1 WARNINGS

 
 The inputs must be reduced modulo B<m>, otherwise the result will be
 outside the expected range.
 
 The inputs must be reduced modulo B<m>, otherwise the result will be
 outside the expected range.

diff --git a/doc/man3/RSA_padding_add_PKCS1_type_1.pod b/doc/man3/RSA_padding_add_PKCS1_type_1.pod
index 40eb8f94a938e492f4d2cfb3e9bf16191a0a1163..6e679bba0f983a918d068f4060822501ea5a789c 100644 (file)
--- a/doc/man3/RSA_padding_add_PKCS1_type_1.pod
+++ b/doc/man3/RSA_padding_add_PKCS1_type_1.pod
@@ -123,7 +123,7 @@ The RSA_padding_check_xxx() functions return the length of the
 recovered data, -1 on error. Error codes can be obtained by calling
 L<ERR_get_error(3)>.
 
 recovered data, -1 on error. Error codes can be obtained by calling
 L<ERR_get_error(3)>.
 

-=head1 WARNING
+=head1 WARNINGS

 
 The result of RSA_padding_check_PKCS1_type_2() is a very sensitive
 information which can potentially be used to mount a Bleichenbacher
 
 The result of RSA_padding_check_PKCS1_type_2() is a very sensitive
 information which can potentially be used to mount a Bleichenbacher

diff --git a/doc/man3/RSA_public_encrypt.pod b/doc/man3/RSA_public_encrypt.pod
index 9c75944cae8c2fc1f3a73f3423b065fe7a8d92a0..09f26ebc07b4ca1a85c762e62951ac6d3d11a3fe 100644 (file)
--- a/doc/man3/RSA_public_encrypt.pod
+++ b/doc/man3/RSA_public_encrypt.pod
@@ -81,7 +81,7 @@ means only that the plaintext was empty.
 On error, -1 is returned; the error codes can be
 obtained by L<ERR_get_error(3)>.
 
 On error, -1 is returned; the error codes can be
 obtained by L<ERR_get_error(3)>.
 

-=head1 WARNING
+=head1 WARNINGS

 
 Decryption failures in the RSA_PKCS1_PADDING mode leak information
 which can potentially be used to mount a Bleichenbacher padding oracle
 
 Decryption failures in the RSA_PKCS1_PADDING mode leak information
 which can potentially be used to mount a Bleichenbacher padding oracle

diff --git a/doc/man3/SSL_library_init.pod b/doc/man3/SSL_library_init.pod
index ff49a83e6f919109c049675d632e6386475aa7aa..1b56c3b8aa29903701d54bb72a9b7c684e736800 100644 (file)
--- a/doc/man3/SSL_library_init.pod
+++ b/doc/man3/SSL_library_init.pod
@@ -25,7 +25,7 @@ implemented as a macro.
 SSL_library_init() must be called before any other action takes place.
 SSL_library_init() is not reentrant.
 
 SSL_library_init() must be called before any other action takes place.
 SSL_library_init() is not reentrant.
 

-=head1 WARNING
+=head1 WARNINGS

 
 SSL_library_init() adds ciphers and digests used directly and indirectly by
 SSL/TLS.
 
 SSL_library_init() adds ciphers and digests used directly and indirectly by
 SSL/TLS.

diff --git a/doc/man3/SSL_write.pod b/doc/man3/SSL_write.pod
index 04cc46b27a5c3b7ec5f0bb8e1262de867d87f0f5..56a8c8b172074515d84dccadb64e24fff4676a78 100644 (file)
--- a/doc/man3/SSL_write.pod
+++ b/doc/man3/SSL_write.pod
@@ -66,7 +66,7 @@ operation is considered completed. The bytes are sent and a new write call with
 a new buffer (with the already sent bytes removed) must be started. A partial
 write is performed with the size of a message block, which is 16kB.
 
 a new buffer (with the already sent bytes removed) must be started. A partial
 write is performed with the size of a message block, which is 16kB.
 

-=head1 WARNING
+=head1 WARNINGS

 
 When a write function call has to be repeated because L<SSL_get_error(3)>
 returned B<SSL_ERROR_WANT_READ> or B<SSL_ERROR_WANT_WRITE>, it must be repeated
 
 When a write function call has to be repeated because L<SSL_get_error(3)>
 returned B<SSL_ERROR_WANT_READ> or B<SSL_ERROR_WANT_WRITE>, it must be repeated

diff --git a/doc/man3/X509_STORE_CTX_set_verify_cb.pod b/doc/man3/X509_STORE_CTX_set_verify_cb.pod
index 6e4624671ffb7b05bf7423da8283c84d00139d61..64ccefa7ffdf864031e9eeea0bb4d3d7b6317222 100644 (file)
--- a/doc/man3/X509_STORE_CTX_set_verify_cb.pod
+++ b/doc/man3/X509_STORE_CTX_set_verify_cb.pod
@@ -76,7 +76,7 @@ from the corresponding B<X509_STORE>, please see
 L<X509_STORE_set_verify(3)> for more information.
 
 
 L<X509_STORE_set_verify(3)> for more information.
 
 

-=head1 WARNING
+=head1 WARNINGS

 
 In general a verification callback should B<NOT> unconditionally return 1 in
 all circumstances because this will allow verification to succeed no matter
 
 In general a verification callback should B<NOT> unconditionally return 1 in
 all circumstances because this will allow verification to succeed no matter

diff --git a/doc/man5/x509v3_config.pod b/doc/man5/x509v3_config.pod
index b8fc00ed2d56fffdb165a18646b9bca6de3a48c3..f9e4b1f7aaaaef282c40e4ea783d53b74aa05e43 100644 (file)
--- a/doc/man5/x509v3_config.pod
+++ b/doc/man5/x509v3_config.pod
@@ -483,7 +483,7 @@ For example:
 
  basicConstraints=critical,DER:00:01:02:03
 
 
  basicConstraints=critical,DER:00:01:02:03
 

-=head1 WARNING
+=head1 WARNINGS

 
 There is no guarantee that a specific implementation will process a given
 extension. It may therefore be sometimes possible to use certificates for
 
 There is no guarantee that a specific implementation will process a given
 extension. It may therefore be sometimes possible to use certificates for


@@ -493,7 +493,6 @@ not recognize or honour the values of the relevant extensions.
 The DER and ASN1 options should be used with caution. It is possible to create
 totally invalid extensions if they are not used carefully.
 
 The DER and ASN1 options should be used with caution. It is possible to create
 totally invalid extensions if they are not used carefully.
 

-

 =head1 NOTES
 
 If an extension is multi-value and a field value must contain a comma the long
 =head1 NOTES
 
 If an extension is multi-value and a field value must contain a comma the long

diff --git a/util/find-doc-nits b/util/find-doc-nits
index 690d9405e507b87af97a9ab6c682df047fc3381f..1b9a2333a3d5678af29889f20e6ad94b2367f73b 100755 (executable)
--- a/util/find-doc-nits
+++ b/util/find-doc-nits
@@ -199,6 +199,8 @@ sub check()
         if $contents =~ /=cut.*=cut/ms;
     print "$id EXAMPLE not EXAMPLES section.\n"
         if $contents =~ /=head1 EXAMPLE[^S]/;
         if $contents =~ /=cut.*=cut/ms;
     print "$id EXAMPLE not EXAMPLES section.\n"
         if $contents =~ /=head1 EXAMPLE[^S]/;

+    print "$id WARNING not WARNINGS section.\n"
+        if $contents =~ /=head1 WARNING[^S]/;

     print "$id missing copyright\n"
         if $contents !~ /Copyright .* The OpenSSL Project Authors/;
     print "$id copyright not last\n"
     print "$id missing copyright\n"
         if $contents !~ /Copyright .* The OpenSSL Project Authors/;
     print "$id copyright not last\n"