From: sashan <anedvedicky@gmail.com>
Date: Fri, 18 Apr 2025 17:44:51 +0000 (+0200)
Subject: The comment should refer `ossl_quic_stream_has_recv_buffer()`
X-Git-Tag: openssl-3.6.0-alpha1~567
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e8df1d12455939d01e21b4650a966e4eb7549436;p=thirdparty%2Fopenssl.git

The comment should refer `ossl_quic_stream_has_recv_buffer()`
and `ossl_quic_stream_has_send_buffer()` explicitly.

This small tweak allows to find those functions more easily.

Reviewed-by: Neil Horman <nhorman@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/27438)
---

diff --git a/include/internal/quic_stream_map.h b/include/internal/quic_stream_map.h
index 76834e74343..d98f813261f 100644
--- a/include/internal/quic_stream_map.h
+++ b/include/internal/quic_stream_map.h
@@ -137,16 +137,17 @@ struct quic_stream_st {
      *
      * DO NOT test these pointers (sstream, rstream) for NULL. Determine the
      * state of the send or receive stream part first using the appropriate
-     * function; then the invariant of that state guarantees that sstream or
-     * rstream either is or is not NULL respectively, therefore there is no
-     * valid use case for testing these pointers for NULL. In particular, a
-     * stream with a send part can still have sstream as NULL, and a stream with
-     * a receive part can still have rstream as NULL. QUIC_SSTREAM and
-     * QUIC_RSTREAM are stream buffer resource management objects which exist
-     * only when they need to for buffer management purposes. The existence or
-     * non-existence of a QUIC_SSTREAM or QUIC_RSTREAM object does not
-     * correspond with whether a stream's respective send or receive part
-     * logically exists or not.
+     * function (ossl_quic_stream_has_send_buffer() resp.
+     * ossl_quic_stream_has_recv_buffer()  ; then the invariant of that state
+     * guarantees that sstream or rstream either is or is not NULL respectively,
+     * therefore there is no valid use case for testing these pointers for NULL.
+     * In particular, stream with a send part can still have sstream as NULL,
+     * and a stream with a receive part can still have rstream as NULL.
+     * QUIC_SSTREAM and QUIC_RSTREAM are stream buffer resource management
+     * objects which exist only when they need to for buffer management
+     * purposes. The existence or non-existence of a QUIC_SSTREAM or
+     * QUIC_RSTREAM object does not correspond with whether a stream's
+     * respective send or receive part logically exists or not.
      */
     QUIC_SSTREAM    *sstream;   /* NULL if RX-only */
     QUIC_RSTREAM    *rstream;   /* NULL if TX only */