3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2025-11-04 05:59:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated command line docs with -w and -d

Browse Source
This commit is contained in:
Phil Nash
2013-11-07 10:35:40 +00:00
parent 93a945cee9
commit 0d4894e4bf
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/command-line.md
View File

@@ -10,6 +10,8 @@ Note that options are described according to the following pattern:
<a href="#output"> ` -o, --out`</a><br />
<a href="#name"> ` -n, --name`</a><br />
<a href="#nothrow"> ` -e, --nothrow`</a><br />
<a href="#warn"> ` -w, --warn`</a><br />
<a href="#durations">` -d, --durations`</a><br />
<a href="#usage"> ` -h, -?, --help`</a><br />
<a id="test"></a>
@@ -126,6 +128,20 @@ These can be a nuisance in certain debugging environments that may break when ex
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="warn"></a>
## Warnings
<pre>-w, --warn &lt;warning name></pre>
Enables reporting of warnings (only one, at time of this writing). If a warning is issued it fails the test.
The ony available warning, presently, is ```NoAssertions```. This warning fails a test case, or (leaf) section if no assertions (```REQUIRE```/ ```CHECK``` etc) are encountered.
<a id="durations"></a>
## Reporting timings
<pre>-d, --durations &lt;yes/no></pre>
When set to ```yes``` Catch will report the duration of each test case, in milliseconds. Note that it does this regardless of whether a test case passes or fails. Note, also, the certain reporters (e.g. Junit) always report test case durations regardless of this option being set or not.
<a id="usage"></a>
## Usage
<pre>-h, -?, --help</pre>