3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-12-23 03:43:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added docs for --invisibles

Browse Source 
also reordered command line docs jump list to match order listed when getting usage from Catch itself.
This commit is contained in:
Phil Nash 2014-12-16 18:38:40 +00:00
parent f5c9859131
commit 7abc9fa8b7
1 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/command-line.md
View File

@ -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. 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="#specifying-which-tests-to-run"> ` <test-spec> ...`</a><br />
<a href="#choosing-a-reporter-to-use"> ` -r, --reporter`</a><br /> <a href="#usage"> ` -h, -?, --help`</a><br />
<a href="#breaking-into-the-debugger"> ` -b, --break`</a><br /> <a href="#listing-available-tests-tags-or-reporters"> ` -l, --list-tests`</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="#listing-available-tests-tags-or-reporters"> ` -t, --list-tags`</a><br /> <a href="#listing-available-tests-tags-or-reporters"> ` -t, --list-tags`</a><br />
<a href="#sending-output-to-a-file"> ` -o, --out`</a><br /> <a href="#showing-results-for-successful-tests"> ` -s, --success`</a><br />
<a href="#naming-a-test-run"> ` -n, --name`</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="#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="#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="#warnings"> ` -w, --warn`</a><br />
<a href="#reporting-timings"> ` -d, --durations`</a><br /> <a href="#reporting-timings"> ` -d, --durations`</a><br />
<a href="#input-file"> ` -f, --input-file`</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> </br>
<a href="#usage"> ` -h, -?, --help`</a><br />
<a id="specifying-which-tests-to-run"></a> <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. 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> <a id="warnings"></a>
## Warnings ## Warnings
<pre>-w, --warn &lt;warning name></pre> <pre>-w, --warn &lt;warning name></pre>