catch3
Progmasoft Catch3: an independently maintained C++17 test framework with a parallel runner, property checks, snapshots and structured results.
Clonegit clone https://git.progmasoft.com/catch3
Added docs for --invisibles
- Commit
7abc9fa8b7d9788681f7eb582bde23eb984f5a8c- Author
- Phil Nash ·
- Parents
f5c985913198
Changes
docs/command-line.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/command-line.md b/docs/command-line.md index 7e412f38..d1d4bd4a 100644 --- a/docs/command-line.md +++ b/docs/command-line.md @@ -2,15 +2,18 @@ Catch works quite nicely without any command line options at all - but for those Click one of the followings links to take you straight to that option - or scroll on to browse the available options. <a href="#specifying-which-tests-to-run"> ` <test-spec> ...`</a><br /> -<a href="#choosing-a-reporter-to-use"> ` -r, --reporter`</a><br /> -<a href="#breaking-into-the-debugger"> ` -b, --break`</a><br /> -<a href="#showing-results-for-successful-tests"> ` -s, --success`</a><br /> -<a href="#aborting-after-a-certain-number-of-failures"> ` -a, --abort`</a><br /> -<a href="#listing-available-tests-tags-or-reporters"> ` -l, --list`</a><br /> +<a href="#usage"> ` -h, -?, --help`</a><br /> +<a href="#listing-available-tests-tags-or-reporters"> ` -l, --list-tests`</a><br /> <a href="#listing-available-tests-tags-or-reporters"> ` -t, --list-tags`</a><br /> +<a href="#showing-results-for-successful-tests"> ` -s, --success`</a><br /> +<a href="#breaking-into-the-debugger"> ` -b, --break`</a><br /> +<a href="#eliding-assertions-expected-to-throw"> ` -e, --nothrow`</a><br /> +<a href="#invisibles"> ` -i, --invisibles`</a><br /> <a href="#sending-output-to-a-file"> ` -o, --out`</a><br /> +<a href="#choosing-a-reporter-to-use"> ` -r, --reporter`</a><br /> <a href="#naming-a-test-run"> ` -n, --name`</a><br /> -<a href="#eliding-assertions-expected-to-throw"> ` -e, --nothrow`</a><br /> +<a href="#aborting-after-a-certain-number-of-failures"> ` -a, --abort`</a><br /> +<a href="#aborting-after-a-certain-number-of-failures"> ` -x, --abortx`</a><br /> <a href="#warnings"> ` -w, --warn`</a><br /> <a href="#reporting-timings"> ` -d, --durations`</a><br /> <a href="#input-file"> ` -f, --input-file`</a><br /> @@ -24,7 +27,6 @@ Click one of the followings links to take you straight to that option - or scrol </br> -<a href="#usage"> ` -h, -?, --help`</a><br /> <a id="specifying-which-tests-to-run"></a> @@ -145,6 +147,13 @@ Sometimes exceptions are expected outside of one of the assertions that tests fo When running with this option any throw checking assertions are skipped so as not to contribute additional noise. Be careful if this affects the behaviour of subsequent tests. +<a id="invisibles"></a> +## Make whitespace visible +<pre>-i, --invisibles</pre> + +If a string comparison fails due to differences in whitespace - especially leading or trailing whitespace - it can be hard to see what's going on. +This option transforms tabs and newline characters into ```\t``` and ```\n``` respectively when printing. + <a id="warnings"></a> ## Warnings <pre>-w, --warn <warning name></pre>