From 5c6b302591e24e51f710f6f153604bd4fd9717f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Joly?= Date: Sun, 10 Oct 2021 19:26:13 +0000 Subject: [PATCH] Document different increase pattern for -P Document values of `-P` increasing as powers of 2 and following other patterns. Fixes #403 --- src/app.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/app.rs b/src/app.rs index 3f995fc..f1cf577 100644 --- a/src/app.rs +++ b/src/app.rs @@ -113,7 +113,11 @@ fn build_app() -> App<'static, 'static> { "Perform benchmark runs for each value in the range MIN..MAX. Replaces the \ string '{VAR}' in each command by the current parameter value.\n\n \ Example: hyperfine -P threads 1 8 'make -j {threads}'\n\n\ - This performs benchmarks for 'make -j 1', 'make -j 2', …, 'make -j 8'.", + This performs benchmarks for 'make -j 1', 'make -j 2', …, 'make -j 8'.\n\n\ + To have the value increase following different patterns, use shell arithmetics.\n\n \ + Example: hyperfine -P size 0 3 'sleep $((2**{size}))'\n\n\ + This performs benchmarks with power of 2 increases: 'sleep 1', 'sleep 2', 'sleep 4', …\n\ + The exact syntax may vary depending on your shell and OS." ), ) .arg(