From: Hugo Landau Date: Thu, 1 Feb 2024 10:31:25 +0000 (+0000) Subject: QUIC QLOG: Minor doc updates X-Git-Tag: openssl-3.3.0-alpha1~177 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1aeab15f46c79792e1f6ac270ec46840f70f48cc;p=thirdparty%2Fopenssl.git QUIC QLOG: Minor doc updates Reviewed-by: Matt Caswell Reviewed-by: Neil Horman (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 b21d1fd8c6b..00474aaa960 100644 --- a/doc/designs/quic-design/qlog.md +++ b/doc/designs/quic-design/qlog.md @@ -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 -------- diff --git a/doc/man7/openssl-qlog.pod b/doc/man7/openssl-qlog.pod index 01022a5dcd9..2fcfe5a5c85 100644 --- a/doc/man7/openssl-qlog.pod +++ b/doc/man7/openssl-qlog.pod @@ -161,9 +161,9 @@ Partial wildcard matches are not supported at this time. =head2 Default Configuration If the B 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 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 environment variable must also be +set to enable qlog. =head1 FORMAT STABILITY diff --git a/include/internal/json_enc.h b/include/internal/json_enc.h index 3b4672aee19..df84c2d0086 100644 --- a/include/internal/json_enc.h +++ b/include/internal/json_enc.h @@ -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