3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-11-26 15:26:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add a notice that benchmarking supports needs opt-in

Browse Source
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
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/benchmarks.md
View File

@ -1,6 +1,10 @@
<a id="top"></a> <a id="top"></a>
# Authoring benchmarks # 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 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 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. the way Catch runs your code will be very helpful when writing your benchmarks.