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_read.pod | |
| parent | bf19b64aaeeddd5463d911823f9e2c3c40091005 (diff) | |
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_read.pod')
| -rw-r--r-- | doc/man3/SSL_read.pod | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/man3/SSL_read.pod b/doc/man3/SSL_read.pod index 3cbab3009f..0bfc2a4135 100644 --- a/doc/man3/SSL_read.pod +++ b/doc/man3/SSL_read.pod @@ -72,7 +72,7 @@ not set. Note that if B<SSL_MODE_AUTO_RETRY> is set and only non-application data is available the call will hang. -If the underlying BIO is B<non-blocking>, a read function will also return when +If the underlying BIO is B<nonblocking>, a read function will also return when the underlying BIO could not satisfy the needs of the function to continue the operation. In this case a call to L<SSL_get_error(3)> with the @@ -83,7 +83,7 @@ a read function can also cause write operations. The calling process then must repeat the call after taking appropriate action to satisfy the needs of the read function. The action depends on the underlying BIO. -When using a non-blocking socket, nothing is to be done, but select() can be +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. |