Document reference commands and selective failures in the man page

CHANGELOG.md

@@ -247,7 +247,7 @@ Package authors: note that Hyperfine now comes with a set of shell completion fi
   necessarily required numeric arguments.
 
   ``` bash
-  hyperfine --parameter-list compiler "g++,clang++" \
+  hyperfine --parameter-list compiler "gcc,clang" \
       "{compiler} -O2 main.cpp"
   ```
 

README.md

@@ -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`
 option:
 ```
-hyperfine -L compiler g++,clang++ '{compiler} -O2 main.cpp'
+hyperfine -L compiler gcc,clang '{compiler} -O2 main.cpp'
 ```
 
 ### Intermediate shell

doc/hyperfine.1

@@ -3,7 +3,8 @@
 hyperfine \- command\-line benchmarking tool
 .SH SYNOPSIS
 .B hyperfine
-.RB [ \-ihVN ]
+.RB [ \-hVN ]
+.RB [ \-\-ignore\-failure[=MODE] ]
 .RB [ \-\-warmup
 .IR NUM ]
 .RB [ \-\-min\-runs
@@ -14,6 +15,10 @@ hyperfine \- command\-line benchmarking tool
 .IR NUM ]
 .RB [ \-\-setup
 .IR CMD ]
+.RB [ \-\-reference
+.IR CMD ]
+.RB [ \-\-reference\-name
+.IR NAME ]
 .RB [ \-\-prepare
 .IR CMD ]
 .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,
 not every time as would happen with the \fB\-\-prepare\fR option.
 .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
 .IP
 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
 Example:
 .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
 .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
 The option can be specified multiple times to run benchmarks for all
 possible parameter combinations.
@@ -207,9 +222,13 @@ things like "sleep 0.1; sleep 0.2" are not possible without a shell.
 .IP
 An alias for '\-\-shell=none'.
 .HP
-\fB\-i\fR, \fB\-\-ignore\-failure\fR
+\fB\-i\fR, \fB\-\-ignore\-failure\fR[=\fIMODE\fP]
 .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
 \fB\-\-style\fR \fITYPE\fP
 .IP

src/cli.rs

@@ -194,8 +194,8 @@ fn build_command() -> Command {
                 .help(
                     "Perform benchmark runs for each value in the comma-separated list VALUES. \
                      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\
-                     This performs benchmarks for 'g++ -O2 main.cpp' and 'clang++ -O2 main.cpp'.\n\n\
+                     .\n\nExample:  hyperfine -L compiler gcc,clang '{compiler} -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 \
                      possible parameter combinations.\n"
                 ),