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

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorMartin Hořeňovský2020-01-28 20:48:32 +0100
committerMartin Hořeňovský2020-01-28 20:48:32 +0100
commitddd0e7218d884fca75dc2e6413ccb94851b3f264 (patch)
tree3bbd477f8267563d46092894f4ed5286473597fe /docs
parent49e000b505d69a150d82e6ebf43458a0d5e9bc8a (diff)
downloadcatch3-ddd0e7218d884fca75dc2e6413ccb94851b3f264.tar.gz
Remove the !hide special tag
Diffstat (limited to 'docs')
-rw-r--r--docs/cmake-integration.md2
-rw-r--r--docs/release-notes.md2
-rw-r--r--docs/test-cases-and-sections.md2
3 files changed, 4 insertions, 2 deletions
diff --git a/docs/cmake-integration.md b/docs/cmake-integration.md
index 57073c40..6ae798db 100644
--- a/docs/cmake-integration.md
+++ b/docs/cmake-integration.md
@@ -160,7 +160,7 @@ ParseAndAddCatchTests(foo)
* `PARSE_CATCH_TESTS_VERBOSE` -- When `ON`, the script prints debug
messages. Defaults to `OFF`.
* `PARSE_CATCH_TESTS_NO_HIDDEN_TESTS` -- When `ON`, hidden tests (tests
-tagged with any of `[!hide]`, `[.]` or `[.foo]`) will not be registered.
+tagged with either of `[.]` or `[.foo]`) will not be registered.
Defaults to `OFF`.
* `PARSE_CATCH_TESTS_ADD_FIXTURE_IN_TEST_NAME` -- When `ON`, adds fixture
class name to the test name in CTest. Defaults to `ON`.
diff --git a/docs/release-notes.md b/docs/release-notes.md
index de6fe30b..baf34a2d 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -49,6 +49,8 @@
* `SectionInfo` no longer contains section description as a member (#1319)
* You can still write `SECTION("ShortName", "Long and wordy description")`, but the description is thrown away
* The description type now must be a `const char*` or implicitly convertible to it
+* The `[!hide]` tag has been removed.
+ * Use `[.]` or `[.foo]` instead.
### Fixes
* The `INFO` macro no longer contains superfluous semicolon (#1456)
diff --git a/docs/test-cases-and-sections.md b/docs/test-cases-and-sections.md
index c30f9f50..e9308c5e 100644
--- a/docs/test-cases-and-sections.md
+++ b/docs/test-cases-and-sections.md
@@ -50,7 +50,7 @@ Tag names are not case sensitive and can contain any ASCII characters. This mean
All tag names beginning with non-alphanumeric characters are reserved by Catch. Catch defines a number of "special" tags, which have meaning to the test runner itself. These special tags all begin with a symbol character. Following is a list of currently defined special tags and their meanings.
-* `[!hide]` or `[.]` - causes test cases to be skipped from the default list (i.e. when no test cases have been explicitly selected through tag expressions or name wildcards). The hide tag is often combined with another, user, tag (for example `[.][integration]` - so all integration tests are excluded from the default run but can be run by passing `[integration]` on the command line). As a short-cut you can combine these by simply prefixing your user tag with a `.` - e.g. `[.integration]`. Because the hide tag has evolved to have several forms, all forms are added as tags if you use one of them.
+* `[.]` - causes test cases to be skipped from the default list (i.e. when no test cases have been explicitly selected through tag expressions or name wildcards). The hide tag is often combined with another, user, tag (for example `[.][integration]` - so all integration tests are excluded from the default run but can be run by passing `[integration]` on the command line). As a short-cut you can combine these by simply prefixing your user tag with a `.` - e.g. `[.integration]`.
* `[!throws]` - lets Catch know that this test is likely to throw an exception even if successful. This causes the test to be excluded when running with `-e` or `--nothrow`.