diff options
Diffstat (limited to 'benchmark')
| -rw-r--r-- | benchmark/README.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/benchmark/README.md b/benchmark/README.md index 538cf50afd..a9c4eef850 100644 --- a/benchmark/README.md +++ b/benchmark/README.md @@ -27,17 +27,17 @@ benchmark-driver benchmark/*.yml 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) +Usage: benchmark-driver [options] RUBY|YAML... + -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) + --filter REGEXP Filter out benchmarks with given regexp + --run-duration SECONDS Warmup estimates loop_count to run for this duration (default: 3) + --timeout SECONDS Timeout ruby command execution with timeout(1) -v, --verbose Verbose mode. Multiple -v options increase visilibity (max: 2) ``` |