diff options
| author | Daniel Feist | 2022-04-23 23:14:49 +0200 |
|---|---|---|
| committer | GitHub | 2022-04-23 23:14:49 +0200 |
| commit | 291b35b389b8e6d7b560cf7e43b6c72c4b73e522 (patch) | |
| tree | d2dc107dbe6d2d5965ce63941b7d4a2fe123bd07 /docs/command-line.md | |
| parent | f526ff0fc37ae00ff2c0dc8f6550bf8209c30afc (diff) | |
| download | catch3-291b35b389b8e6d7b560cf7e43b6c72c4b73e522.tar.gz | |
Added --skip-benchmarks command-line option. (#2408)
Closes #2392
Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
Diffstat (limited to 'docs/command-line.md')
| -rw-r--r-- | docs/command-line.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/command-line.md b/docs/command-line.md index f8ac6374..0faeee16 100644 --- a/docs/command-line.md +++ b/docs/command-line.md @@ -19,6 +19,7 @@ [Specify a seed for the Random Number Generator](#specify-a-seed-for-the-random-number-generator)<br> [Identify framework and version according to the libIdentify standard](#identify-framework-and-version-according-to-the-libidentify-standard)<br> [Wait for key before continuing](#wait-for-key-before-continuing)<br> +[Skip benchmarks](#skip-benchmarks)<br> [Specify the number of benchmark samples to collect](#specify-the-number-of-benchmark-samples-to-collect)<br> [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> @@ -62,6 +63,7 @@ Click one of the following links to take you straight to that option - or scroll <a href="#rng-seed"> ` --rng-seed`</a><br /> <a href="#libidentify"> ` --libidentify`</a><br /> <a href="#wait-for-keypress"> ` --wait-for-keypress`</a><br /> +<a href="#skip-benchmarks"> ` --skip-benchmarks`</a><br /> <a href="#benchmark-samples"> ` --benchmark-samples`</a><br /> <a href="#benchmark-resamples"> ` --benchmark-resamples`</a><br /> <a href="#benchmark-confidence-interval"> ` --benchmark-confidence-interval`</a><br /> @@ -370,6 +372,16 @@ See [The LibIdentify repo for more information and examples](https://github.com/ Will cause the executable to print a message and wait until the return/ enter key is pressed before continuing - either before running any tests, after running all tests - or both, depending on the argument. +<a id="skip-benchmarks"></a> +## Skip all benchmarks +<pre>--skip-benchmarks</pre> + +> [Introduced](https://github.com/catchorg/Catch2/issues/2408) in Catch X.Y.Z. + +This flag tells Catch2 to skip running all benchmarks. Benchmarks in this +case mean code blocks in `BENCHMARK` and `BENCHMARK_ADVANCED` macros, not +test cases with the `[!benchmark]` tag. + <a id="benchmark-samples"></a> ## Specify the number of benchmark samples to collect <pre>--benchmark-samples <# of samples></pre> |