From: Stefan Eissing Date: Thu, 12 Jan 2023 09:46:21 +0000 (+0100) Subject: tests: document the cfilter debug logging options X-Git-Tag: curl-7_88_0~140 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d6b5d9f4ae65552788f81fbb5da7046423b37586;p=thirdparty%2Fcurl.git tests: document the cfilter debug logging options Closes #10283 --- diff --git a/tests/README.md b/tests/README.md index 9b58a66733..86597d8beb 100644 --- a/tests/README.md +++ b/tests/README.md @@ -158,7 +158,36 @@ SPDX-License-Identifier: curl All logs are generated in the log/ subdirectory (it is emptied first in the runtests.pl script). They remain in there after a test run. + +### Log Verbosity + A curl build with `--enable-debug` offers more verbose output in the logs. + This applies not only for test cases, but also when running it standalone + with `curl -v`. While a curl debug built is + ***not suitable for production***, it is often helpful in tracking down + problems. + + Sometimes, one needs detailed logging of operations, but does not want + to drown in output. The newly introduced *connection filters* allows one to + dynamically increase log verbosity for a particular *filter type*. Example: + + CURL_DEBUG=ssl curl -v https://curl.se + + will make the `ssl` connection filter log more details. One may do that for + every filter type and also use a combination of names, separated by `,` or + space. + + CURL_DEBUG=ssl,http/2 curl -v https://curl.se + + The order of filter type names is not relevant. Names used here are + case insensitive. Note that these names are implementation internals and + subject to change. + + Some, likely stable names are `tcp`, `ssl`, `http/2`. For a current list, + one may search the sources for `struct Curl_cftype` definitions and find + the names there. Also, some filters are only available with certain build + options, of course. + ### Test input files All test cases are put in the `data/` subdirectory. Each test is stored in