Add a notice that benchmarking supports needs opt-in

This commit is contained in:
Martin Hořeňovský 2019-07-14 15:49:17 +02:00
parent 87739ad3fe
commit 03ffc1014c
No known key found for this signature in database
GPG Key ID: DE48307B8B0D381A

View File

@ -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.