mirror of
https://github.com/sharkdp/hyperfine.git
synced 2026-11-19 19:01:31 +00:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ef68fef336 |
No files matched your search
+1
-1
@@ -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"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -84,7 +84,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
|
||||||
|
|||||||
+24
-5
@@ -3,7 +3,8 @@
|
|||||||
hyperfine \- command\-line benchmarking tool
|
hyperfine \- command\-line benchmarking tool
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B hyperfine
|
.B hyperfine
|
||||||
.RB [ \-ihVN ]
|
.RB [ \-hVN ]
|
||||||
|
.RB [ \-\-ignore\-failure[=MODE] ]
|
||||||
.RB [ \-\-warmup
|
.RB [ \-\-warmup
|
||||||
.IR NUM ]
|
.IR NUM ]
|
||||||
.RB [ \-\-min\-runs
|
.RB [ \-\-min\-runs
|
||||||
@@ -14,6 +15,10 @@ hyperfine \- command\-line benchmarking tool
|
|||||||
.IR NUM ]
|
.IR NUM ]
|
||||||
.RB [ \-\-setup
|
.RB [ \-\-setup
|
||||||
.IR CMD ]
|
.IR CMD ]
|
||||||
|
.RB [ \-\-reference
|
||||||
|
.IR CMD ]
|
||||||
|
.RB [ \-\-reference\-name
|
||||||
|
.IR NAME ]
|
||||||
.RB [ \-\-prepare
|
.RB [ \-\-prepare
|
||||||
.IR CMD ]
|
.IR CMD ]
|
||||||
.RB [ \-\-conclude
|
.RB [ \-\-conclude
|
||||||
@@ -109,6 +114,16 @@ for compiling your software or with the provided parameters, or to do any
|
|||||||
other work that should happen once before a series of benchmark runs,
|
other work that should happen once before a series of benchmark runs,
|
||||||
not every time as would happen with the \fB\-\-prepare\fR option.
|
not every time as would happen with the \fB\-\-prepare\fR option.
|
||||||
.HP
|
.HP
|
||||||
|
\fB\-\-reference\fR \fICMD\fP
|
||||||
|
.IP
|
||||||
|
Benchmark \fICMD\fP as the reference for the relative comparison of results.
|
||||||
|
If this option is not specified, the fastest command is used as the reference.
|
||||||
|
.HP
|
||||||
|
\fB\-\-reference\-name\fR \fINAME\fP
|
||||||
|
.IP
|
||||||
|
Give a meaningful \fINAME\fP to the reference command.
|
||||||
|
Requires \fB\-\-reference\fR.
|
||||||
|
.HP
|
||||||
\fB\-p\fR, \fB\-\-prepare\fR \fICMD...\fP
|
\fB\-p\fR, \fB\-\-prepare\fR \fICMD...\fP
|
||||||
.IP
|
.IP
|
||||||
Execute \fICMD\fP before each timing run. This is useful for clearing disk caches,
|
Execute \fICMD\fP before each timing run. This is useful for clearing disk caches,
|
||||||
@@ -184,11 +199,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.
|
||||||
@@ -207,9 +222,13 @@ things like "sleep 0.1; sleep 0.2" are not possible without a shell.
|
|||||||
.IP
|
.IP
|
||||||
An alias for '\-\-shell=none'.
|
An alias for '\-\-shell=none'.
|
||||||
.HP
|
.HP
|
||||||
\fB\-i\fR, \fB\-\-ignore\-failure\fR
|
\fB\-i\fR, \fB\-\-ignore\-failure\fR[=\fIMODE\fP]
|
||||||
.IP
|
.IP
|
||||||
Ignore non\-zero exit codes of the benchmarked programs.
|
Ignore failures of the benchmarked programs. Without a value or with
|
||||||
|
\fBall\-non\-zero\fR, all non\-zero exit codes are ignored.
|
||||||
|
Alternatively, provide a comma\-separated list of exit codes to ignore,
|
||||||
|
for example \fB\-\-ignore\-failure=1,2\fR.
|
||||||
|
An explicit value must be attached to the option with an equals sign.
|
||||||
.HP
|
.HP
|
||||||
\fB\-\-style\fR \fITYPE\fP
|
\fB\-\-style\fR \fITYPE\fP
|
||||||
.IP
|
.IP
|
||||||
|
|||||||
+2
-2
@@ -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"
|
||||||
),
|
),
|
||||||
|
|||||||
Reference in new issue
Block a user