Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorMartin Hořeňovský2021-12-18 19:59:23 +0100
committerMartin Hořeňovský2021-12-18 20:50:03 +0100
commit840acedf62b2dabb98bf4ab372a7582131d6b530 (patch)
tree2246182676b827884962a1a62ed216a14de0d992 /docs
parent9f2dca5384a6a8f9f37a7dc2d998cac616545592 (diff)
downloadcatch3-840acedf62b2dabb98bf4ab372a7582131d6b530.tar.gz
Implement warning for unmatched test specs
Diffstat (limited to 'docs')
-rw-r--r--docs/command-line.md16
-rw-r--r--docs/release-notes.md1
2 files changed, 13 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 &lt;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
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 3eecf8f8..5b3e5c65 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -173,6 +173,7 @@ new design.
* When deferred tu runtime, it behaves like `CHECK`, and not like `REQUIRE`.
* You can have multiple tests with the same name, as long as other parts of the test identity differ (#1915, #1999, #2175)
* Test identity includes test's name, test's tags and and test's class name if applicable.
+* Added new warning, `UnmatchedTestSpec`, to error on test specs with no matching tests
### Fixes