Compare commits

..
Author SHA1 Message Date
David Peter fa89267547 Describe the default benchmark duration as an estimate 2026-10-02 11:29:15 +02:00
4 changed files with 9 additions and 8 deletions

No files matched your search

+1 -1
View File
@@ -247,7 +247,7 @@ Package authors: note that Hyperfine now comes with a set of shell completion fi
necessarily required numeric arguments. necessarily required numeric arguments.
``` bash ``` bash
hyperfine --parameter-list compiler "g++,clang++" \ hyperfine --parameter-list compiler "gcc,clang" \
"{compiler} -O2 main.cpp" "{compiler} -O2 main.cpp"
``` ```
+4 -3
View File
@@ -33,8 +33,9 @@ hyperfine 'sleep 0.3'
``` ```
Hyperfine will automatically determine the number of runs to perform for each command. By default, Hyperfine will automatically determine the number of runs to perform for each command. By default,
it will perform *at least* 10 benchmarking runs and measure for at least 3 seconds. To change this, it will perform *at least* 10 benchmarking runs and estimate a run count targeting roughly
you can use the `-r`/`--runs` option: 3 seconds, including shell overhead and preparation and conclusion commands. To set an exact
number of runs, you can use the `-r`/`--runs` option:
```sh ```sh
hyperfine --runs 5 'sleep 0.3' hyperfine --runs 5 'sleep 0.3'
``` ```
@@ -84,7 +85,7 @@ This runs `sleep 0.3`, `sleep 0.5` and `sleep 0.7`.
For non-numeric parameters, you can also supply a list of values with the `-L`/`--parameter-list` For non-numeric parameters, you can also supply a list of values with the `-L`/`--parameter-list`
option: option:
``` ```
hyperfine -L compiler g++,clang++ '{compiler} -O2 main.cpp' hyperfine -L compiler gcc,clang '{compiler} -O2 main.cpp'
``` ```
### Intermediate shell ### Intermediate shell
+2 -2
View File
@@ -184,11 +184,11 @@ Replaces the string '{\fIVAR\fP}' in each command by the current parameter value
.RS .RS
Example: Example:
.RS .RS
\fBhyperfine\fR \fB\-L\fR compiler g++,clang++ '{compiler} \-O2 main.cpp' \fBhyperfine\fR \fB\-L\fR compiler gcc,clang '{compiler} \-O2 main.cpp'
.RE .RE
.RE .RE
.IP .IP
This performs benchmarks for 'g++ \-O2 main.cpp' and 'clang++ \-O2 main.cpp'. This performs benchmarks for 'gcc \-O2 main.cpp' and 'clang \-O2 main.cpp'.
.IP .IP
The option can be specified multiple times to run benchmarks for all The option can be specified multiple times to run benchmarks for all
possible parameter combinations. possible parameter combinations.
+2 -2
View File
@@ -194,8 +194,8 @@ fn build_command() -> Command {
.help( .help(
"Perform benchmark runs for each value in the comma-separated list VALUES. \ "Perform benchmark runs for each value in the comma-separated list VALUES. \
Replaces the string '{VAR}' in each command by the current parameter value\ Replaces the string '{VAR}' in each command by the current parameter value\
.\n\nExample: hyperfine -L compiler g++,clang++ '{compiler} -O2 main.cpp'\n\n\ .\n\nExample: hyperfine -L compiler gcc,clang '{compiler} -O2 main.cpp'\n\n\
This performs benchmarks for 'g++ -O2 main.cpp' and 'clang++ -O2 main.cpp'.\n\n\ This performs benchmarks for 'gcc -O2 main.cpp' and 'clang -O2 main.cpp'.\n\n\
The option can be specified multiple times to run benchmarks for all \ The option can be specified multiple times to run benchmarks for all \
possible parameter combinations.\n" possible parameter combinations.\n"
), ),