From: Hugo Landau <hlandau@openssl.org>
Date: Tue, 23 Jan 2024 16:24:59 +0000 (+0000)
Subject: Minor updates
X-Git-Tag: openssl-3.3.0-alpha1~195
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ae300c0d5e8f39329a44236c6e6bf364f42cd771;p=thirdparty%2Fopenssl.git

Minor updates

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22037)
---

diff --git a/doc/designs/quic-design/qlog.md b/doc/designs/quic-design/qlog.md
index 77e05843b42..b21d1fd8c6b 100644
--- a/doc/designs/quic-design/qlog.md
+++ b/doc/designs/quic-design/qlog.md
@@ -29,13 +29,11 @@ code. An example call site will look something like this:
 Output Format
 -------------
 
-The output format will always be the JSON-SEQ qlog variant. This has the
-advantage that each event simply involves concatenating another record to an
-output log file and does not require nesting of syntactic constructs between
-events.
+The output format is always the JSON-SEQ qlog variant. This has the advantage
+that each event simply involves concatenating another record to an output log
+file and does not require nesting of syntactic constructs between events.
 
-Writing to files or to multi-file directories, or to arbitrary BIO sinks, will
-be supported.
+Output is written to a directory containing multiple qlog files.
 
 Basic Usage
 -----------
diff --git a/doc/man7/openssl-qlog.pod b/doc/man7/openssl-qlog.pod
index 3888a3654bd..01022a5dcd9 100644
--- a/doc/man7/openssl-qlog.pod
+++ b/doc/man7/openssl-qlog.pod
@@ -6,11 +6,10 @@ openssl-qlog - OpenSSL qlog tracing functionality
 
 =head1 DESCRIPTION
 
-OpenSSL 3.3 and later feature unstable support for generating logs in the
-qlog logging format, which can be used to obtain diagnostic data for QUIC
-connections. The data generated includes information on packets sent and
-received and the frames contained within them, as well as loss detection and
-other events.
+OpenSSL has unstable support for generating logs in the qlog logging format,
+which can be used to obtain diagnostic data for QUIC connections. The data
+generated includes information on packets sent and received and the frames
+contained within them, as well as loss detection and other events.
 
 The qlog output generated by OpenSSL can be used to obtain diagnostic
 visualisations of a given QUIC connection using tools such as B<qvis>.
@@ -236,6 +235,10 @@ functionality.
 
 L<openssl-quic(7)>, L<openssl-env(7)>
 
+=head1 HISTORY
+
+This functionality was added in OpenSSL 3.3.
+
 =head1 COPYRIGHT
 
 Copyright 2024 The OpenSSL Project Authors. All Rights Reserved.
diff --git a/ssl/quic/json_enc.c b/ssl/quic/json_enc.c
index e5cf50066f6..06da2adf885 100644
--- a/ssl/quic/json_enc.c
+++ b/ssl/quic/json_enc.c
@@ -451,7 +451,7 @@ void ossl_json_object_begin(OSSL_JSON_ENC *json)
     json->state = STATE_PRE_KEY;
 }
 
-/* End a JSON obejct. Must be matched with a call to ossl_json_object_begin(). */
+/* End a JSON object. Must be matched with a call to ossl_json_object_begin(). */
 void ossl_json_object_end(OSSL_JSON_ENC *json)
 {
     composite_end(json, 0, '}');
@@ -464,7 +464,7 @@ void ossl_json_array_begin(OSSL_JSON_ENC *json)
     json->state = STATE_PRE_ITEM;
 }
 
-/* End a JSON array. Must be matched with a call to ossl_json_array_end(). */
+/* End a JSON array. Must be matched with a call to ossl_json_array_begin(). */
 void ossl_json_array_end(OSSL_JSON_ENC *json)
 {
     composite_end(json, 1, ']');