diff options
| author | Martin Hořeňovský | 2021-12-18 19:59:23 +0100 |
|---|---|---|
| committer | Martin Hořeňovský | 2021-12-18 20:50:03 +0100 |
| commit | 840acedf62b2dabb98bf4ab372a7582131d6b530 (patch) | |
| tree | 2246182676b827884962a1a62ed216a14de0d992 /docs/command-line.md | |
| parent | 9f2dca5384a6a8f9f37a7dc2d998cac616545592 (diff) | |
| download | catch3-840acedf62b2dabb98bf4ab372a7582131d6b530.tar.gz | |
Implement warning for unmatched test specs
Diffstat (limited to 'docs/command-line.md')
| -rw-r--r-- | docs/command-line.md | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/command-line.md b/docs/command-line.md index 40195eb4..37199c44 100644 --- a/docs/command-line.md +++ b/docs/command-line.md @@ -212,14 +212,22 @@ This option transforms tabs and newline characters into ```\t``` and ```\n``` re ## Warnings <pre>-w, --warn <warning name></pre> -Enables reporting of suspicious test runs. There is currently only one -available warning. +You can think of Catch2's warnings as the equivalent of `-Werror` (`/WX`) +flag for C++ compilers. It turns some suspicious occurences, like a section +without assertions, into errors. Because these might be intended, warnings +are not enabled by default, but user can opt in. + +There are currently two warnings implemented: ``` - NoAssertions // Fail test case / leaf section if no assertions - // (e.g. `REQUIRE`) is encountered. + NoAssertions // Fail test case / leaf section if no assertions + // (e.g. `REQUIRE`) is encountered. + UnmatchedTestSpec // Fail test run if any of the CLI test specs did + // not match any tests. ``` +> `UnmatchedTestSpec` was introduced in Catch2 X.Y.Z. + <a id="reporting-timings"></a> ## Reporting timings |