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
Updated command line docs with -w and -d
- Commit
0d4894e4bf46d3549062294ac20f14881194eba6- Author
- Phil Nash ·
- Parents
93a945cee9d4
Changes
docs/command-line.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/command-line.md b/docs/command-line.md index d0e6152f..8a13d3f9 100644 --- a/docs/command-line.md +++ b/docs/command-line.md @@ -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 <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 <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>