diff options
| author | Gustaf Neumann <neumann@wu-wien.ac.at> | 2020-07-17 12:31:26 +0200 |
|---|---|---|
| committer | Dr. Matthias St. Pierre <matthias.st.pierre@ncp-e.com> | 2020-07-22 09:15:00 +0200 |
| commit | 490c87110cc1fd673604fa1b94d5538f9fd852bb (patch) | |
| tree | 3edd4a289e298a405dd7785fd1b21e81e8cd55e0 /doc/man3/SSL_connect.pod | |
| parent | bf19b64aaeeddd5463d911823f9e2c3c40091005 (diff) | |
| download | openssl-490c87110cc1fd673604fa1b94d5538f9fd852bb.tar.gz | |
Align documentation with recommendations of Linux Documentation Project
This change applies the recommendation of the Linux Documentation Project
to the documentation files of OpenSSL. Additionally, util/find-doc-nits
was updated accordingly.
The change follows a suggestion of mspncp on https://github.com/openssl/openssl/pull/12370
and incoporates the requested changes on the pull request
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/12460)
Diffstat (limited to 'doc/man3/SSL_connect.pod')
| -rw-r--r-- | doc/man3/SSL_connect.pod | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/man3/SSL_connect.pod b/doc/man3/SSL_connect.pod index b74aa1d2b6..4e9bd9ca07 100644 --- a/doc/man3/SSL_connect.pod +++ b/doc/man3/SSL_connect.pod @@ -23,14 +23,14 @@ The behaviour of SSL_connect() depends on the underlying BIO. If the underlying BIO is B<blocking>, SSL_connect() will only return once the handshake has been finished or an error occurred. -If the underlying BIO is B<non-blocking>, SSL_connect() will also return +If the underlying BIO is B<nonblocking>, SSL_connect() will also return when the underlying BIO could not satisfy the needs of SSL_connect() to continue the handshake, indicating the problem by the return value -1. In this case a call to SSL_get_error() with the return value of SSL_connect() will yield B<SSL_ERROR_WANT_READ> or B<SSL_ERROR_WANT_WRITE>. The calling process then must repeat the call after taking appropriate action to satisfy the needs of SSL_connect(). -The action depends on the underlying BIO. When using a non-blocking socket, +The action depends on the underlying BIO. When using a nonblocking socket, nothing is to be done, but select() can be used to check for the required condition. When using a buffering BIO, like a BIO pair, data must be written into or retrieved out of the BIO before being able to continue. @@ -72,7 +72,7 @@ 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 if action is needed to continue the operation -for non-blocking BIOs. Call SSL_get_error() with the return value B<ret> +for nonblocking BIOs. Call SSL_get_error() with the return value B<ret> to find out the reason. =back |