diff options
| author | Martin Hořeňovský | 2017-02-17 14:25:08 +0100 |
|---|---|---|
| committer | Martin Hořeňovský | 2017-02-17 14:25:08 +0100 |
| commit | 8cd413572a5223f14c88aacd2539e2d4e2e3acc3 (patch) | |
| tree | 68ffb7db6f4a33265097fbdfd31d6c9a883d3816 /docs | |
| parent | 90b3946e9c0d25e9f63453d558485ca5bb1fa7ac (diff) | |
| parent | 30e4dbef1c2a4742a85f5d57c84107631cce9c6c (diff) | |
| download | catch3-8cd413572a5223f14c88aacd2539e2d4e2e3acc3.tar.gz | |
Merge branch 'dev-windows-leakdetection'
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index 4cedc72c..9c9c1c0d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -76,6 +76,7 @@ All C++11 support can be disabled with `CATCH_CONFIG_NO_CPP11` CATCH_CONFIG_WINDOWS_SEH // Enable SEH handling on Windows CATCH_CONFIG_FAST_COMPILE // Sacrifices some (extremely minor) features for compilation speed CATCH_CONFIG_POSIX_SIGNALS // Enable handling POSIX signals + CATCH_CONFIG_WINDOWS_CRTDBG // Enable leak checking using Windows's CRT Debug Heap Currently Catch enables `CATCH_CONFIG_WINDOWS_SEH` only when compiled with MSVC, because some versions of MinGW do not have the necessary Win32 API support. @@ -83,6 +84,8 @@ At this moment, `CATCH_CONFIG_FAST_COMPILE` changes only the behaviour of the `- `CATCH_CONFIG_POSIX_SIGNALS` is on by default, except when Catch is compiled under `Cygwin`, where it is disabled by default (but can be force-enabled by defining `CATCH_CONFIG_POSIX_SIGNALS`). +`CATCH_CONFIG_WINDOWS_CRTDBG` is off by default. If enabled, Windows's CRT is used to check for memory leaks, and displays them after the tests finish running. _Note that this instrumentation is only done when Catch supplies its own main._ + Just as with the C++11 conformance toggles, these toggles can be disabled by using `_NO_` form of the toggle, e.g. `CATCH_CONFIG_NO_WINDOWS_SEH`. # Windows header clutter |