From 03ffc1014cb854ea29565d24f3c6c4e133f7c10e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?= Date: Sun, 14 Jul 2019 15:49:17 +0200 Subject: [PATCH] Add a notice that benchmarking supports needs opt-in --- 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 @@ # 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.