Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs/command-line.md
diff options
context:
space:
mode:
authorkhyperia2020-01-27 15:43:27 +0100
committerMartin Hořeňovský2020-02-16 15:44:23 +0100
commit3c7e737a7bcf2d2059b1db2a5a221f76806ae8b0 (patch)
treebcbf40fe8e4914c8ecc3a585066933bf871652c7 /docs/command-line.md
parente880da93bd335e59a0d4b00bfcb9f06ab4b7c847 (diff)
downloadcatch3-3c7e737a7bcf2d2059b1db2a5a221f76806ae8b0.tar.gz
Allow configuring of benchmark warmup time
Diffstat (limited to 'docs/command-line.md')
-rw-r--r--docs/command-line.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/command-line.md b/docs/command-line.md
index 742d84b6..7ec2fbb3 100644
--- a/docs/command-line.md
+++ b/docs/command-line.md
@@ -24,6 +24,7 @@
[Specify the number of resamples for bootstrapping](#specify-the-number-of-resamples-for-bootstrapping)<br>
[Specify the confidence-interval for bootstrapping](#specify-the-confidence-interval-for-bootstrapping)<br>
[Disable statistical analysis of collected benchmark samples](#disable-statistical-analysis-of-collected-benchmark-samples)<br>
+[Specify the amount of time in milliseconds spent on warming up each test](#specify-the-amount-of-time-in-milliseconds-spent-on-warming-up-each-test)<br>
[Usage](#usage)<br>
[Specify the section to run](#specify-the-section-to-run)<br>
[Filenames as tags](#filenames-as-tags)<br>
@@ -64,6 +65,7 @@ Click one of the following links to take you straight to that option - or scroll
<a href="#benchmark-resamples"> ` --benchmark-resamples`</a><br />
<a href="#benchmark-confidence-interval"> ` --benchmark-confidence-interval`</a><br />
<a href="#benchmark-no-analysis"> ` --benchmark-no-analysis`</a><br />
+<a href="#benchmark-warmup-time"> ` --benchmark-warmup-time`</a><br />
<a href="#use-colour"> ` --use-colour`</a><br />
</br>
@@ -317,6 +319,14 @@ Must be between 0 and 1 and defaults to 0.95.
When this flag is specified no bootstrapping or any other statistical analysis is performed.
Instead the user code is only measured and the plain mean from the samples is reported.
+<a id="benchmark-warmup-time"></a>
+## Specify the amount of time in milliseconds spent on warming up each test
+<pre>--benchmark-warmup-time</pre>
+
+> [Introduced](https://github.com/catchorg/Catch2/pull/1844) in Catch X.Y.Z.
+
+Configure the amount of time spent warming up each test.
+
<a id="usage"></a>
## Usage
<pre>-h, -?, --help</pre>