mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2024-11-27 05:21:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

QUIC QLOG: Minor doc updates

Browse Source 
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22037)
This commit is contained in:
Hugo Landau 2024-02-01 10:31:25 +00:00
parent c71bde1e47
commit 1aeab15f46
3 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/designs/quic-design/qlog.md
View 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
--------

6
doc/man7/openssl-qlog.pod
View 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

2
include/internal/json_enc.h
View 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