summaryrefslogtreecommitdiff
path: root/benchmark/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'benchmark/README.md')
-rw-r--r--benchmark/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/benchmark/README.md b/benchmark/README.md
index 8a46fea..a70aedf 100644
--- a/benchmark/README.md
+++ b/benchmark/README.md
@@ -18,6 +18,23 @@ benchmark-driver benchmark/*.yml -e /path/to/ruby -e '/path/to/ruby --jit'
benchmark-driver benchmark/*.yml --rbenv '2.5.1;2.6.0-preview2 --jit'
```
+See also:
+
+```console
+$ benchmark-driver --help
+Usage: benchmark-driver [options] [YAML|RUBY]
+ -r, --runner [TYPE] Specify runner type: ips, time, memory, once (default: ips)
+ -o, --output [TYPE] Specify output type: compare, simple, markdown, record (default: compare)
+ -e, --executables [EXECS] Ruby executables (e1::path1,arg1,...; e2::path2,arg2;...)
+ --rbenv [VERSIONS] Ruby executables in rbenv (x.x.x,arg1,...;y.y.y,arg2,...;...)
+ --repeat-count [NUM] Try benchmark NUM times and use the fastest result or the worst memory usage
+ --repeat-result [TYPE] Yield "best", "average" or "worst" result with --repeat-count (default: best)
+ --bundler Install and use gems specified in Gemfile
+ --filter [REGEXP] Filter out benchmarks with given regexp
+ --run-duration [SECONDS] Warmup estimates loop_count to run for this duration (default: 3)
+ -v, --verbose Verbose mode. Multiple -v options increase visilibity (max: 2)
+```
+
## make benchmark
Using `make benchmark`, `make update-benchmark-driver` automatically downloads