From 3fd1e6a7aee12e6878d7e039f947ea81140b4f5a Mon Sep 17 00:00:00 2001 From: Dominic Hamon Date: Fri, 13 Sep 2024 10:06:24 +0100 Subject: [PATCH] add dry run docs --- docs/user_guide.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/user_guide.md b/docs/user_guide.md index e3826209..64566f1f 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -167,6 +167,13 @@ line interface or by setting environment variables before execution. For every prevails). A complete list of CLI options is available running benchmarks with the `--help` switch. +### Dry runs + +To confirm that benchmarks can run successfully without needing to wait for +multiple repetitions and iterations, the `--benchmark_dry_run` flag can be +used. This will run the benchmarks as normal, but for 1 iteration and 1 +repetition only. + ## Running a Subset of Benchmarks