aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiquel Ruiz <mruiz@cpan.org>2018-10-22 22:34:57 +0100
committerTomas Mraz <tmraz@fedoraproject.org>2019-06-19 15:11:36 +0200
commitdf9fd168ceb1f187365d24fef829d6d48b1077a9 (patch)
treec39dfbcd1491ef85f66bd878c10e2669bcd6bb88
parent1fa90bb3a9089f974e9b07f3e76a964bd2da6976 (diff)
downloadopenssl-df9fd168ceb1f187365d24fef829d6d48b1077a9.zip
openssl-df9fd168ceb1f187365d24fef829d6d48b1077a9.tar.gz
openssl-df9fd168ceb1f187365d24fef829d6d48b1077a9.tar.bz2
Add SSL_shutdown to SSL_get_error's documentation
SSL_shutdown can fail if called during initialization, and in such case, it'll add an error to the error queue. This adds SSL_shutdown to the list of functions that should preceed the call to SSL_get_error. CLA: trivial Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/7465)
-rw-r--r--doc/man3/SSL_get_error.pod6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/man3/SSL_get_error.pod b/doc/man3/SSL_get_error.pod
index 150dd50..8d081a5 100644
--- a/doc/man3/SSL_get_error.pod
+++ b/doc/man3/SSL_get_error.pod
@@ -14,9 +14,9 @@ SSL_get_error - obtain result code for TLS/SSL I/O operation
SSL_get_error() returns a result code (suitable for the C "switch"
statement) for a preceding call to SSL_connect(), SSL_accept(), SSL_do_handshake(),
-SSL_read_ex(), SSL_read(), SSL_peek_ex(), SSL_peek(), SSL_write_ex() or
-SSL_write() on B<ssl>. The value returned by that TLS/SSL I/O function must be
-passed to SSL_get_error() in parameter B<ret>.
+SSL_read_ex(), SSL_read(), SSL_peek_ex(), SSL_peek(), SSL_shutdown(),
+SSL_write_ex() or SSL_write() on B<ssl>. The value returned by that TLS/SSL I/O
+function must be passed to SSL_get_error() in parameter B<ret>.
In addition to B<ssl> and B<ret>, SSL_get_error() inspects the
current thread's OpenSSL error queue. Thus, SSL_get_error() must be