From: Hugo Landau <hlandau@openssl.org>
Date: Thu, 24 Aug 2023 13:34:04 +0000 (+0100)
Subject: Tweak documentation for WAIT_PEER
X-Git-Tag: openssl-3.2.0-alpha1~117
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=84adf0764bf21e6be9f0a7b3c7a6b0448541bf0f;p=thirdparty%2Fopenssl.git

Tweak documentation for WAIT_PEER

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/21815)
---

diff --git a/doc/man3/SSL_shutdown.pod b/doc/man3/SSL_shutdown.pod
index 68de45e9a13..5d59f677f1d 100644
--- a/doc/man3/SSL_shutdown.pod
+++ b/doc/man3/SSL_shutdown.pod
@@ -360,7 +360,9 @@ If a locally initiated shutdown has already been triggered or the connection has
 started terminating for another reason, this flag has no effect.
 
 B<SSL_SHUTDOWN_FLAG_WAIT_PEER> implies B<SSL_SHUTDOWN_FLAG_NO_STREAM_FLUSH>, as
-stream data cannot be flushed after a peer closes the connection.
+stream data cannot be flushed after a peer closes the connection. Stream data
+may still be sent to the peer in any time spent waiting before the peer closes
+the connection, though there is no guarantee of this.
 
 =head2 Nonblocking Mode