The attached patches fix various errors/warnings in pod files. Most are due to recent mods to pod2man utility, which now issues warnings [which unfortunately end up in manpage source output], when subsequent item tags are not 'sequential' ..
Affects all versions; applies against revision in CVS as of May 14 2011
--- a/doc/ssl/SSL_CTX_set_client_CA_list.pod +++ b/doc/ssl/SSL_CTX_set_client_CA_list.pod @@ -66,16 +66,16 @@ =over 4 -=item 1 - -The operation succeeded. - =item 0 A failure while manipulating the STACK_OF(X509_NAME) object occurred or the X509_NAME could not be extracted from B<cacert>. Check the error stack to find out the reason. +=item 1 + +The operation succeeded. + =back =head1 EXAMPLES
--- a/doc/apps/genpkey.pod +++ b/doc/apps/genpkey.pod @@ -114,6 +114,8 @@ The number of bits in the generated parameters. If not specified 1024 is used. +=back + =head1 DH PARAMETER GENERATION OPTIONS =over 4
--- a/doc/apps/openssl.pod +++ b/doc/apps/openssl.pod @@ -287,8 +287,6 @@ SHA-1 Digest -=back - =item B<sha224> SHA-224 Digest @@ -305,6 +303,8 @@ SHA-512 Digest +=back + =head2 ENCODING AND CIPHER COMMANDS =over 10
--- a/doc/ssl/SSL_accept.pod +++ b/doc/ssl/SSL_accept.pod @@ -44,10 +44,13 @@ =over 4 -=item 1 +=item E<lt>0 -The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been -established. +The TLS/SSL handshake was not successful because a fatal error occurred either +at the protocol level or a connection failure occurred. The shutdown was +not clean. It can also occur of action is need to continue the operation +for non-blocking BIOs. Call SSL_get_error() with the return value B<ret> +to find out the reason. =item 0 @@ -55,13 +58,10 @@ by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the return value B<ret> to find out the reason. -=item E<lt>0 +=item 1 -The TLS/SSL handshake was not successful because a fatal error occurred either -at the protocol level or a connection failure occurred. The shutdown was -not clean. It can also occur of action is need to continue the operation -for non-blocking BIOs. Call SSL_get_error() with the return value B<ret> -to find out the reason. +The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been +established. =back
--- a/doc/ssl/SSL_connect.pod +++ b/doc/ssl/SSL_connect.pod @@ -41,10 +41,13 @@ =over 4 -=item 1 +=item E<lt>0 -The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been -established. +The TLS/SSL handshake was not successful, because a fatal error occurred either +at the protocol level or a connection failure occurred. The shutdown was +not clean. It can also occur of action is need to continue the operation +for non-blocking BIOs. Call SSL_get_error() with the return value B<ret> +to find out the reason. =item 0 @@ -52,13 +55,10 @@ by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the return value B<ret> to find out the reason. -=item E<lt>0 +=item 1 -The TLS/SSL handshake was not successful, because a fatal error occurred either -at the protocol level or a connection failure occurred. The shutdown was -not clean. It can also occur of action is need to continue the operation -for non-blocking BIOs. Call SSL_get_error() with the return value B<ret> -to find out the reason. +The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been +established. =back
--- a/doc/ssl/SSL_do_handshake.pod +++ b/doc/ssl/SSL_do_handshake.pod @@ -45,10 +45,13 @@ =over 4 -=item 1 +=item E<lt>0 -The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been -established. +The TLS/SSL handshake was not successful because a fatal error occurred either +at the protocol level or a connection failure occurred. The shutdown was +not clean. It can also occur of action is need to continue the operation +for non-blocking BIOs. Call SSL_get_error() with the return value B<ret> +to find out the reason. =item 0 @@ -56,13 +59,10 @@ by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the return value B<ret> to find out the reason. -=item E<lt>0 +=item 1 -The TLS/SSL handshake was not successful because a fatal error occurred either -at the protocol level or a connection failure occurred. The shutdown was -not clean. It can also occur of action is need to continue the operation -for non-blocking BIOs. Call SSL_get_error() with the return value B<ret> -to find out the reason. +The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been +established. =back
--- a/doc/ssl/SSL_shutdown.pod +++ b/doc/ssl/SSL_shutdown.pod @@ -92,10 +92,13 @@ =over 4 -=item 1 +=item -1 -The shutdown was successfully completed. The "close notify" alert was sent -and the peer's "close notify" alert was received. +The shutdown was not successful because a fatal error occurred either +at the protocol level or a connection failure occurred. It can also occur if +action is need to continue the operation for non-blocking BIOs. +Call L<SSL_get_error(3)|SSL_get_error(3)> with the return value B<ret> +to find out the reason. =item 0 @@ -104,13 +107,10 @@ The output of L<SSL_get_error(3)|SSL_get_error(3)> may be misleading, as an erroneous SSL_ERROR_SYSCALL may be flagged even though no error occurred. -=item -1 +=item 1 -The shutdown was not successful because a fatal error occurred either -at the protocol level or a connection failure occurred. It can also occur if -action is need to continue the operation for non-blocking BIOs. -Call L<SSL_get_error(3)|SSL_get_error(3)> with the return value B<ret> -to find out the reason. +The shutdown was successfully completed. The "close notify" alert was sent +and the peer's "close notify" alert was received. =back
--- a/doc/ssl/SSL_CTX_use_psk_identity_hint.pod +++ b/doc/ssl/SSL_CTX_use_psk_identity_hint.pod @@ -81,6 +81,13 @@ Return values from the server callback are interpreted as follows: +=over 4 + +=item 0 + +PSK identity was not found. An "unknown_psk_identity" alert message +will be sent and the connection setup fails. + =item > 0 PSK identity was found and the server callback has provided the PSK @@ -94,9 +101,6 @@ connection will fail with decryption_error before it will be finished completely. -=item 0 - -PSK identity was not found. An "unknown_psk_identity" alert message -will be sent and the connection setup fails. +=back =cut
--- a/doc/crypto/X509_STORE_CTX_get_error.pod +++ b/doc/crypto/X509_STORE_CTX_get_error.pod @@ -278,6 +278,8 @@ an application specific error. This will never be returned unless explicitly set by an application. +=back + =head1 NOTES The above functions should be used instead of directly referencing the fields
