]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
QUIC QLOG: Clarify filter docs
authorHugo Landau <hlandau@openssl.org>
Mon, 22 Jan 2024 14:41:44 +0000 (14:41 +0000)
committerHugo Landau <hlandau@openssl.org>
Fri, 2 Feb 2024 11:50:03 +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

index b04d56f402202bbd4d6e20908930f1ccc1952369..33d21913212a42f713ce8a8c7525389a4397ff9c 100644 (file)
@@ -98,10 +98,10 @@ wildcard            = "*"
 name                = 1*(ALPHA / DIGIT / "_" / "-")
 ```
 
-Here is an example filter:
+Here is a (somewhat nonsensical) example filter:
 
 ```text
--quic:version_information quic:packet_sent -* +*
++* -quic:version_information -* quic:packet_sent
 ```
 
 The syntax works as follows:
@@ -118,3 +118,16 @@ The syntax works as follows:
 - `-quic:version_information` disables a specific event type.
 
 - 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.
+
+Some examples of more normal filters include:
+
+- `*` (or `+*`): enable all events
+
+- `quic:version_information quic:packet_sent`: enable some events explicitly
+
+- `* -quic:version_information`: enable all events except certain events