Progmasoft Git

catch3

Progmasoft Catch3: an independently maintained C++17 test framework with a parallel runner, property checks, snapshots and structured results.

Clonegit clone https://git.progmasoft.com/catch3

Add a notice that benchmarking supports needs opt-in

Commit
03ffc1014cb854ea29565d24f3c6c4e133f7c10e
Author
Martin Hořeňovský ·
Parents
87739ad3feed

Files · Download .tar.gz

Changes

 docs/benchmarks.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/benchmarks.md b/docs/benchmarks.md
index 43bd2884..bb999367 100644
--- a/docs/benchmarks.md
+++ b/docs/benchmarks.md
@@ -1,6 +1,10 @@
 <a id="top"></a>
 # Authoring benchmarks
 
+_Note that benchmarking support is disabled by default and to enable it,
+you need to define `CATCH_CONFIG_ENABLE_BENCHMARKING`. For more details,
+see the [compile-time configuration documentation](configuration.md#top)._
+
 Writing benchmarks is not easy. Catch simplifies certain aspects but you'll
 always need to take care about various aspects. Understanding a few things about
 the way Catch runs your code will be very helpful when writing your benchmarks.