diff options
| -rw-r--r-- | doc/man3/BIO_s_bio.pod | 2 | ||||
| -rw-r--r-- | doc/man3/BN_mod_mul_montgomery.pod | 2 | ||||
| -rw-r--r-- | doc/man3/RSA_padding_add_PKCS1_type_1.pod | 2 | ||||
| -rw-r--r-- | doc/man3/RSA_public_encrypt.pod | 2 | ||||
| -rw-r--r-- | doc/man3/SSL_library_init.pod | 2 | ||||
| -rw-r--r-- | doc/man3/SSL_write.pod | 2 | ||||
| -rw-r--r-- | doc/man3/X509_STORE_CTX_set_verify_cb.pod | 2 | ||||
| -rw-r--r-- | doc/man5/x509v3_config.pod | 3 | ||||
| -rwxr-xr-x | util/find-doc-nits | 2 |
9 files changed, 10 insertions, 9 deletions
diff --git a/doc/man3/BIO_s_bio.pod b/doc/man3/BIO_s_bio.pod index bad818cf4d..0f4ea77d6d 100644 --- 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. -=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 diff --git a/doc/man3/BN_mod_mul_montgomery.pod b/doc/man3/BN_mod_mul_montgomery.pod index bb11c426c0..5cb2c2c377 100644 --- 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)>. -=head1 WARNING +=head1 WARNINGS 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 40eb8f94a9..6e679bba0f 100644 --- 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)>. -=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 diff --git a/doc/man3/RSA_public_encrypt.pod b/doc/man3/RSA_public_encrypt.pod index 9c75944cae..09f26ebc07 100644 --- 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)>. -=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 diff --git a/doc/man3/SSL_library_init.pod b/doc/man3/SSL_library_init.pod index ff49a83e6f..1b56c3b8aa 100644 --- 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. -=head1 WARNING +=head1 WARNINGS 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 04cc46b27a..56a8c8b172 100644 --- 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. -=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 diff --git a/doc/man3/X509_STORE_CTX_set_verify_cb.pod b/doc/man3/X509_STORE_CTX_set_verify_cb.pod index 6e4624671f..64ccefa7ff 100644 --- 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. -=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 diff --git a/doc/man5/x509v3_config.pod b/doc/man5/x509v3_config.pod index b8fc00ed2d..f9e4b1f7aa 100644 --- 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 -=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 @@ -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. - =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 690d9405e5..1b9a2333a3 100755 --- 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]/; + 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" |