Commit 0e05f88e authored by Nick Alcock's avatar Nick Alcock Committed by Lutz Jaenicke
Browse files

Fix POD errors to stop make install_docs dying with pod2man 2.5.0+ 

podlators 2.5.0 has switched to dying on POD syntax errors. This means
that a bunch of long-standing erroneous POD in the openssl documentation
now leads to fatal errors from pod2man, halting installation.

Unfortunately POD constraints mean that you have to sort numeric lists
in ascending order if they start with 1: you cannot do 1, 0, 2 even if
you want 1 to appear first. I've reshuffled such (alas, I wish there
were a better way but I don't know of one).
(cherry picked from commit 5cc27077)
parent 6715f000

doc/crypto/X509_STORE_CTX_get_error.pod

+2 −0
Original line number Diff line number Diff line
@@ -278,6 +278,8 @@ happen if extended CRL checking is enabled. 
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

doc/ssl/SSL_CTX_set_client_CA_list.pod

+4 −4
Original line number Diff line number Diff line
@@ -66,16 +66,16 @@ values: 


=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

doc/ssl/SSL_CTX_use_psk_identity_hint.pod

+4 −0
Original line number Diff line number Diff line
@@ -81,6 +81,8 @@ SSL_CTX_use_psk_identity_hint() and SSL_use_psk_identity_hint() return 


Return values from the server callback are interpreted as follows:



=over 4



=item > 0



PSK identity was found and the server callback has provided the PSK
@@ -99,4 +101,6 @@ completely. 
PSK identity was not found. An "unknown_psk_identity" alert message

will be sent and the connection setup fails.



=back



=cut

doc/ssl/SSL_accept.pod

+5 −5
Original line number Diff line number Diff line
@@ -44,17 +44,17 @@ The following return values can occur: 


=over 4



=item 1



The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been

established.



=item 0



The TLS/SSL handshake was not successful but was shut down controlled and

by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the

return value B<ret> to find out the reason.



=item 1



The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been

established.



=item E<lt>0



The TLS/SSL handshake was not successful because a fatal error occurred either

doc/ssl/SSL_connect.pod

+5 −5
Original line number Diff line number Diff line
@@ -41,17 +41,17 @@ The following return values can occur: 


=over 4



=item 1



The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been

established.



=item 0



The TLS/SSL handshake was not successful but was shut down controlled and

by the specifications of the TLS/SSL protocol. Call SSL_get_error() with the

return value B<ret> to find out the reason.



=item 1



The TLS/SSL handshake was successfully completed, a TLS/SSL connection has been

established.



=item E<lt>0



The TLS/SSL handshake was not successful, because a fatal error occurred either