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-25 09:06:25 +0100
committerMartin Hořeňovský2020-01-25 09:07:36 +0100
commit6c3a5ef625eda76a2886e15950eca85ed6ebb411 (patch)
tree0991f6b6f17024c811b26f3dca46db089739a801 /docs
parentc770a9c8b5a1a079d7e4172a78107d0480ea67c5 (diff)
downloadcatch3-6c3a5ef625eda76a2886e15950eca85ed6ebb411.tar.gz
Remove CATCH_CONFIG_DISABLE_MATCHERS
Now that the recommended distribution and usage method is proper library, users can just avoid including the matcher headers to get basically the same effect.
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md6
-rw-r--r--docs/release-notes.md5
2 files changed, 4 insertions, 7 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 599bb9ae..4b7af698 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -146,7 +146,6 @@ by using `_NO_` in the macro, e.g. `CATCH_CONFIG_NO_CPP17_UNCAUGHT_EXCEPTIONS`.
CATCH_CONFIG_COUNTER // Use __COUNTER__ to generate unique names for test cases
CATCH_CONFIG_WINDOWS_SEH // Enable SEH handling on Windows
CATCH_CONFIG_FAST_COMPILE // Sacrifices some (rather minor) features for compilation speed
- CATCH_CONFIG_DISABLE_MATCHERS // Do not compile Matchers in this compilation unit
CATCH_CONFIG_POSIX_SIGNALS // Enable handling POSIX signals
CATCH_CONFIG_WINDOWS_CRTDBG // Enable leak checking using Windows's CRT Debug Heap
CATCH_CONFIG_DISABLE_STRINGIFICATION // Disable stringifying the original expression
@@ -183,11 +182,6 @@ should not lead to false negatives.
`CATCH_CONFIG_FAST_COMPILE` has to be either defined, or not defined,
in all translation units that are linked into single test binary.
-### `CATCH_CONFIG_DISABLE_MATCHERS`
-When `CATCH_CONFIG_DISABLE_MATCHERS` is defined, all mentions of Catch's Matchers are ifdef-ed away from the translation unit. Doing so will speed up compilation of that TU.
-
-_Note: If you define `CATCH_CONFIG_DISABLE_MATCHERS` in the same file as Catch's main is implemented, your test executable will fail to link if you use Matchers anywhere._
-
### `CATCH_CONFIG_DISABLE_STRINGIFICATION`
This toggle enables a workaround for VS 2017 bug. For details see [known limitations](limitations.md#visual-studio-2017----raw-string-literal-in-assert-fails-to-compile).
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 3939e5af..de6fe30b 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -50,11 +50,14 @@
* 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
-
### Fixes
* The `INFO` macro no longer contains superfluous semicolon (#1456)
* The `--list*` family of command line flags now return 0 on success (#1410, #1146)
+### Other changes
+* `CATCH_CONFIG_DISABLE_MATCHERS` no longer exists.
+ * If you do not want to use Matchers in a TU, do not include their header.
+
## 2.10.2