From f460a7d8f91095386b3b44af978b70eafbe75122 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?= Date: Sat, 30 Jun 2018 12:31:46 +0200 Subject: [PATCH] Fix documentation of CATCH_CONFIG_FAST_COMPILE Related to issue #1279 --- docs/command-line.md | 4 +++- docs/configuration.md | 11 +++++++---- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/command-line.md b/docs/command-line.md index 9a095a04..94705ef3 100644 --- a/docs/command-line.md +++ b/docs/command-line.md @@ -124,7 +124,9 @@ The JUnit reporter is an xml format that follows the structure of the JUnit XML ## Breaking into the debugger 
-b, --break
-In some IDEs (currently XCode and Visual Studio) it is possible for Catch to break into the debugger on a test failure. This can be very helpful during debug sessions - especially when there is more than one path through a particular test. +Under most debuggers Catch2 is capable of automatically breaking on a test +failure. This allows the user to see the current state of the test during +failure. ## Showing results for successful tests diff --git a/docs/configuration.md b/docs/configuration.md index 81bf292a..276f7b8c 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -153,11 +153,14 @@ these toggles can be disabled by using `_NO_` form of the toggle, e.g. `CATCH_CONFIG_NO_WINDOWS_SEH`. ### `CATCH_CONFIG_FAST_COMPILE` -Defining this flag speeds up compilation of test files by ~20%, by making 2 changes: -* The `-b` (`--break`) flag no longer makes Catch break into debugger in the same stack frame as the failed test, but rather in a stack frame *below*. -* Non-exception family of macros ({`REQUIRE`,`CHECK`}{`_`,`_FALSE`, `_THAT`}, no longer use local try-catch block. This disables exception translation, but should not lead to false negatives. +This compile-time flag speeds up compilation of assertion macros by ~20%, +by disabling the generation of assertion-local try-catch blocks for +non-exception family of assertion macros ({`REQUIRE`,`CHECK`}{``,`_FALSE`, `_THAT`}). +This disables translation of exceptions thrown under these assertions, but +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, or the behaviour of setting `-b` flag and throwing unexpected exceptions will be unpredictable. +`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.