From: Hugo Landau <hlandau@openssl.org>
Date: Thu, 15 Dec 2022 07:06:55 +0000 (+0000)
Subject: QUIC: Minor comment and editorial fixes
X-Git-Tag: openssl-3.2.0-alpha1~1472
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=81b6b43c4a56e4158ee4059fc03c10f970423506;p=thirdparty%2Fopenssl.git

QUIC: Minor comment and editorial fixes

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

diff --git a/doc/designs/quic-design/congestion-control.md b/doc/designs/quic-design/congestion-control.md
index 7881ca98716..d5bb4a1d795 100644
--- a/doc/designs/quic-design/congestion-control.md
+++ b/doc/designs/quic-design/congestion-control.md
@@ -178,8 +178,8 @@ struct ossl_cc_method_st {
     size_t (*get_bytes_in_flight_max)(OSSL_CC_DATA *ccdata);
 
     /*
-     * Returns the time at which the CC will next release more budget
-     * for sending, or ossl_time_infinite().
+     * Returns the next time at which the CC will release more budget for
+     * sending, or ossl_time_infinite().
      */
     OSSL_TIME (*get_next_credit_time)(OSSL_CC_DATA *ccdata);
 
diff --git a/include/internal/quic_cc.h b/include/internal/quic_cc.h
index 6cf78913f1a..8e318e33ff4 100644
--- a/include/internal/quic_cc.h
+++ b/include/internal/quic_cc.h
@@ -84,8 +84,8 @@ typedef struct ossl_cc_method_st {
     uint64_t (*get_bytes_in_flight_max)(OSSL_CC_DATA *ccdata);
 
     /*
-     * Returns the time at which the CC will next release more budget
-     * for sending, or ossl_time_infinite().
+     * Returns the next time at which the CC will release more budget for
+     * sending, or ossl_time_infinite().
      */
     OSSL_TIME (*get_next_credit_time)(OSSL_CC_DATA *ccdata);
 
diff --git a/include/internal/quic_channel.h b/include/internal/quic_channel.h
index 9c1adfd667a..31e218cb2fb 100644
--- a/include/internal/quic_channel.h
+++ b/include/internal/quic_channel.h
@@ -81,7 +81,6 @@ void ossl_quic_channel_free(QUIC_CHANNEL *ch);
  * code (e.g. ossl_quic_channel_raise_protocol_error), others are for very
  * specific use by particular components only (e.g.
  * ossl_quic_channel_on_handshake_confirmed).
- *
  */
 
 /*
diff --git a/include/internal/quic_record_rx.h b/include/internal/quic_record_rx.h
index 2a8a5bca102..a72fb249728 100644
--- a/include/internal/quic_record_rx.h
+++ b/include/internal/quic_record_rx.h
@@ -247,8 +247,8 @@ typedef struct ossl_qrx_pkt_st {
  *
  * On success, *pkt points to a OSSL_QRX_PKT structure. The structure should be
  * freed when no longer needed by calling ossl_qrx_pkt_release(). The structure
- * is refcounted; to gain extra references, call ossl_qrx_pkt_ref(). This will
- * cause a corresponding number of calls to ossl_qrx_pkt_release() to be
+ * is refcounted; to gain extra references, call ossl_qrx_pkt_up_ref(). This
+ * will cause a corresponding number of calls to ossl_qrx_pkt_release() to be
  * ignored.
  *
  * The resources referenced by (*pkt)->hdr, (*pkt)->hdr->data and (*pkt)->peer
diff --git a/include/internal/quic_record_tx.h b/include/internal/quic_record_tx.h
index 4a011d535b3..d010a2f64a3 100644
--- a/include/internal/quic_record_tx.h
+++ b/include/internal/quic_record_tx.h
@@ -244,8 +244,8 @@ size_t ossl_qtx_get_unflushed_pkt_count(OSSL_QTX *qtx);
 
 /*
  * Change the BIO being used by the QTX. May be NULL if actual transmission is
- * not currently required. Does not ref the BIO; the caller is responsible for
- * ensuring the lifetime of the BIO exceeds the lifetime of the QTX.
+ * not currently required. Does not up-ref the BIO; the caller is responsible
+ * for ensuring the lifetime of the BIO exceeds the lifetime of the QTX.
  */
 void ossl_qtx_set_bio(OSSL_QTX *qtx, BIO *bio);
 
diff --git a/ssl/quic/quic_impl.c b/ssl/quic/quic_impl.c
index e59e6d85373..d94dacfe7e1 100644
--- a/ssl/quic/quic_impl.c
+++ b/ssl/quic/quic_impl.c
@@ -1077,7 +1077,7 @@ static int quic_read_again(void *arg)
         /* got at least one byte, the SSL_read op can finish now */
         return 1;
 
-    return 0; /* did not write anything, keep trying */
+    return 0; /* did not read anything, keep trying */
 }
 
 static int quic_read(SSL *s, void *buf, size_t len, size_t *bytes_read, int peek)