diff options
| author | khyperia | 2020-01-27 15:43:27 +0100 |
|---|---|---|
| committer | Martin Hořeňovský | 2020-02-16 15:27:21 +0100 |
| commit | e880da93bd335e59a0d4b00bfcb9f06ab4b7c847 (patch) | |
| tree | f22f39a1864fa5190c43c1512cc5151d9a3d560d /docs | |
| parent | 3e01d4b239dd14c97f53988c15362ae0c32406a2 (diff) | |
| download | catch3-e880da93bd335e59a0d4b00bfcb9f06ab4b7c847.tar.gz | |
Make CATCH_BREAK_INTO_DEBUGGER be user-configurable
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index f0dac1c9..38043a67 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -16,6 +16,7 @@ [Windows header clutter](#windows-header-clutter)<br> [Enabling stringification](#enabling-stringification)<br> [Disabling exceptions](#disabling-exceptions)<br> +[Overriding Catch's debug break (`-b`)](#overriding-catchs-debug-break--b)<br> Catch is designed to "just work" as much as possible. For most people the only configuration needed is telling Catch which source file should host all the implementation code (```CATCH_CONFIG_MAIN```). @@ -249,6 +250,18 @@ namespace Catch { } ``` +## Overriding Catch's debug break (`-b`) + +> [Introduced](https://github.com/catchorg/Catch2/pull/1846) in Catch X.Y.Z. + +You can override Catch2's break-into-debugger code by defining the +`CATCH_BREAK_INTO_DEBUGGER()` macro. This can be used if e.g. Catch2 does +not know your platform, or your platform is misdetected. + +The macro will be used as is, that is, `CATCH_BREAK_INTO_DEBUGGER();` +must compile and must break into debugger. + + --- [Home](Readme.md#top) |