X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=doc%2Fssl%2FSSL_clear.pod;h=8b735d81dcbc8e245e9da6bf038ba9b374fc49da;hp=c68938b4bce1db588e2ce49c85bd1951d61eb908;hb=f2ab7d13921890e40c847fba3d22c936a2681f6b;hpb=cc99526db1ee5b948736f6b07958a786fec1240b

diff --git a/doc/ssl/SSL_clear.pod b/doc/ssl/SSL_clear.pod
index c68938b4bc..8b735d81dc 100644
--- a/doc/ssl/SSL_clear.pod
+++ b/doc/ssl/SSL_clear.pod
@@ -2,19 +2,28 @@
 
 =head1 NAME
 
-SSL_clear - Reset SSL to allow another connection
+SSL_clear - reset SSL object to allow another connection
 
 =head1 SYNOPSIS
 
  #include <openssl/ssl.h>
 
- int *SSL_clear(SSL *ssl);
+ int SSL_clear(SSL *ssl);
 
 =head1 DESCRIPTION
 
-Reset the B<ssl> to allow another connection. All settings (method, ciphers,
-BIOs) are kept. A completely negotiated SSL_SESSION is not freed but left
-untouched for the underlying SSL_CTX.
+Reset B<ssl> to allow another connection. All settings (method, ciphers,
+BIOs) are kept.
+
+=head1 NOTES
+
+SSL_clear is used to prepare an SSL object for a new connection. While all
+settings are kept, a side effect is the handling of the current SSL session.
+If a session is still B<open>, it is considered bad and will be removed
+from the session cache, as required by RFC2246. A session is considered open,
+if L<SSL_shutdown(3)|SSL_shutdown(3)> was not called for the connection
+or at least L<SSL_set_shutdown(3)|SSL_set_shutdown(3)> was used to
+set the SSL_SENT_SHUTDOWN state.
 
 =head1 RETURN VALUES
 
@@ -29,11 +38,12 @@ find out the reason.
 
 =item 1
 
-The SSL_clear() operation was successfull.
+The SSL_clear() operation was successful.
 
 =back
 
 L<SSL_new(3)|SSL_new(3)>, L<SSL_free(3)|SSL_free(3)>,
-L<ssl(3)|ssl(3)>
+L<SSL_shutdown(3)|SSL_shutdown(3)>, L<SSL_set_shutdown(3)|SSL_set_shutdown(3)>,
+L<SSL_CTX_set_options(3)|SSL_CTX_set_options(3)>, L<ssl(3)|ssl(3)>
 
 =cut