THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Browse Source

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)
pull/9633/head
Rich Salz 1 month ago
parent
commit
5e0d9c861b

+ 1
- 1
doc/man3/BIO_s_bio.pod View File

@@ -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

+ 1
- 1
doc/man3/BN_mod_mul_montgomery.pod View File

@@ -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.

+ 1
- 1
doc/man3/RSA_padding_add_PKCS1_type_1.pod View File

@@ -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

+ 1
- 1
doc/man3/RSA_public_encrypt.pod View File

@@ -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

+ 1
- 1
doc/man3/SSL_library_init.pod View File

@@ -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.

+ 1
- 1
doc/man3/SSL_write.pod View File

@@ -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

+ 1
- 1
doc/man3/X509_STORE_CTX_set_verify_cb.pod View File

@@ -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

+ 1
- 2
doc/man5/x509v3_config.pod View File

@@ -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

+ 2
- 0
util/find-doc-nits View File

@@ -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"

Loading…
Cancel
Save