QUIC QLOG: Minor doc updates
authorHugo Landau <hlandau@openssl.org>
Thu, 1 Feb 2024 10:31:25 +0000 (10:31 +0000)
committerHugo Landau <hlandau@openssl.org>
Fri, 2 Feb 2024 11:50:30 +0000 (11:50 +0000)
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22037)

doc/designs/quic-design/qlog.md
doc/man7/openssl-qlog.pod
include/internal/json_enc.h

index b21d1fd8c6b06e0d87e3b1eacf0c75eb586d6b76..00474aaa9603106cf54309e2f60665c76e49c1a5 100644 (file)
@@ -118,17 +118,17 @@ The syntax works as follows:
 - Partial wildcard matches are not supported at this time.
 
 Each term is applied in sequence, therefore later items in the filter override
-earlier items. In the example above, for example, all events are enabled, then
-the `quic:version_information` event is disabled, then all events are disabled,
-then the `quic:packet_sent` event is reenabled.
+earlier items. In the example above, for example, all event types are enabled,
+then the `quic:version_information` event is disabled, then all event types are
+disabled, then the `quic:packet_sent` event is reenabled.
 
 Some examples of more normal filters include:
 
-- `*` (or `+*`): enable all events
+- `*` (or `+*`): enable all event types
 
-- `quic:version_information quic:packet_sent`: enable some events explicitly
+- `quic:version_information quic:packet_sent`: enable some event types explicitly
 
-- `* -quic:version_information`: enable all events except certain events
+- `* -quic:version_information`: enable all event types except certain ones
 
 See also
 --------
index 01022a5dcd9f428591445b5ee7772472c8789794..2fcfe5a5c85f7d53102fc7a1a1fbb2ff52662a25 100644 (file)
@@ -161,9 +161,9 @@ Partial wildcard matches are not supported at this time.
 =head2 Default Configuration
 
 If the B<OSSL_QFILTER> environment variable is not set or set to the empty
-string, this is equivalent to enabling all events (i.e., it is equivalent to a
-filter of C<*>). Note that the B<QLOGDIR> environment variable must also be set
-to enable qlog.
+string, this is equivalent to enabling all event types (i.e., it is equivalent
+to a filter of C<*>). Note that the B<QLOGDIR> environment variable must also be
+set to enable qlog.
 
 =head1 FORMAT STABILITY
 
index 3b4672aee19eb945cb444488367c9beec0b0f88c..df84c2d0086d1857211fbf366daaf5e251225d82 100644 (file)
@@ -84,7 +84,7 @@ void ossl_json_cleanup(OSSL_JSON_ENC *json);
  * Resets a JSON encoder, as though it has just been initialised, allowing it
  * to be used again for new output syntactically unrelated to any previous
  * output. This is similar to calling ossl_json_cleanup followed by
- * ossl_json_init but may allow internal buffers, etc. to be reused.
+ * ossl_json_init but may allow internal buffers to be reused.
  *
  * If the JSON encoder has entered an error state, this function MAY allow
  * recovery from this error state, in which case it will return 1. If this