From: Hugo Landau <hlandau@openssl.org>
Date: Wed, 23 Aug 2023 17:36:38 +0000 (+0100)
Subject: Tweak documentation for WAIT_PEER
X-Git-Tag: openssl-3.2.0-alpha1~119
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=7ff1696e5b4d090839b0baa92c5333d482240fe0;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 913b5559771..68de45e9a13 100644
--- a/doc/man3/SSL_shutdown.pod
+++ b/doc/man3/SSL_shutdown.pod
@@ -359,6 +359,9 @@ either success or failure depending on whether a shutdown has occurred.
 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.
+
 =head2 Nonblocking Mode
 
 SSL_shutdown() and SSL_shutdown_ex() block if the connection is configured in