Commit 40cb2be7 authored by Rich Salz's avatar Rich Salz Committed by Richard Levitte
Browse files

Fix some pod-page ordering nits 

Backport of https://github.com/openssl/openssl/pull/9602



Reviewed-by: default avatarMatthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9632)
parent be4660f8

doc/man1/engine.pod

+1 −1
Original line number Original line Diff line number Diff line
@@ -64,7 +64,7 @@ See the example below. 




=back

=back





=head1 EXAMPLE

=head1 EXAMPLES





To list all the commands available to a dynamic engine:

To list all the commands available to a dynamic engine:

doc/man1/errstr.pod

+1 −1
Original line number Original line Diff line number Diff line
@@ -20,7 +20,7 @@ second colon. 




None.

None.





=head1 EXAMPLE

=head1 EXAMPLES





The error code:

The error code:

doc/man1/pkeyparam.pod

+1 −1
Original line number Original line Diff line number Diff line
@@ -60,7 +60,7 @@ This option checks the correctness of parameters. 




=back

=back





=head1 EXAMPLE

=head1 EXAMPLES





Print out text version of parameters:

Print out text version of parameters:

doc/man3/ASYNC_start_job.pod

+1 −1
Original line number Original line Diff line number Diff line
@@ -170,7 +170,7 @@ is included, commonly as one of the first included headers. Therefore 
it is defined as an application developer's responsibility to include

it is defined as an application developer's responsibility to include

windows.h prior to async.h.

windows.h prior to async.h.





=head1 EXAMPLE

=head1 EXAMPLES





The following example demonstrates how to use most of the core async APIs:

The following example demonstrates how to use most of the core async APIs:

doc/man3/BIO_f_ssl.pod

+18 −18
Original line number Original line Diff line number Diff line
@@ -129,9 +129,25 @@ BIO_set_ssl(), BIO_get_ssl(), BIO_set_ssl_mode(), 
BIO_set_ssl_renegotiate_bytes(), BIO_set_ssl_renegotiate_timeout(),

BIO_set_ssl_renegotiate_bytes(), BIO_set_ssl_renegotiate_timeout(),

BIO_get_num_renegotiates(), and BIO_do_handshake() are implemented as macros.

BIO_get_num_renegotiates(), and BIO_do_handshake() are implemented as macros.





=head1 EXAMPLE

=head1 RETURN VALUES



BIO_f_ssl() returns the SSL B<BIO_METHOD> structure.



BIO_set_ssl(), BIO_get_ssl(), BIO_set_ssl_mode(), BIO_set_ssl_renegotiate_bytes(),

BIO_set_ssl_renegotiate_timeout() and BIO_get_num_renegotiates() return 1 on

success or a value which is less than or equal to 0 if an error occurred.



BIO_new_ssl(), BIO_new_ssl_connect() and BIO_new_buffer_ssl_connect() return

a valid B<BIO> structure on success or B<NULL> if an error occurred.



BIO_ssl_copy_session_id() returns 1 on success or 0 on error.



BIO_do_handshake() returns 1 if the connection was established successfully.

A zero or negative value is returned if the connection could not be established.



=head1 EXAMPLES





This SSL/TLS client example, attempts to retrieve a page from an

This SSL/TLS client example attempts to retrieve a page from an

SSL/TLS web server. The I/O routines are identical to those of the

SSL/TLS web server. The I/O routines are identical to those of the

unencrypted example in L<BIO_s_connect(3)>.

unencrypted example in L<BIO_s_connect(3)>.
@@ -271,22 +287,6 @@ a client and also echoes the request to standard output. 
 BIO_flush(sbio);

 BIO_flush(sbio);

 BIO_free_all(sbio);

 BIO_free_all(sbio);





=head1 RETURN VALUES



BIO_f_ssl() returns the SSL B<BIO_METHOD> structure.



BIO_set_ssl(), BIO_get_ssl(), BIO_set_ssl_mode(), BIO_set_ssl_renegotiate_bytes(),

BIO_set_ssl_renegotiate_timeout() and BIO_get_num_renegotiates() return 1 on

success or a value which is less than or equal to 0 if an error occurred.



BIO_new_ssl(), BIO_new_ssl_connect() and BIO_new_buffer_ssl_connect() return

a valid B<BIO> structure on success or B<NULL> if an error occurred.



BIO_ssl_copy_session_id() returns 1 on success or 0 on error.



BIO_do_handshake() returns 1 if the connection was established successfully.

A zero or negative value is returned if the connection could not be established.



=head1 HISTORY

=head1 HISTORY





In OpenSSL before 1.0.0 the BIO_pop() call was handled incorrectly,

In OpenSSL before 1.0.0 the BIO_pop() call was handled incorrectly,