From b4a7fe9a20e5134a99218a334c02f38594bfea19 Mon Sep 17 00:00:00 2001 From: Laurence Tratt Date: Mon, 15 Apr 2019 10:18:58 +0100 Subject: [PATCH] Document the --quality switch. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index cfe5db5..dc2527f 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,13 @@ bin/warmup_stats --html --output-table table.html -l javascript -v V8 -u "`uname bin/warmup_stats --html --output-table table.html results.json.bz2 ``` +By default, `warmup_stats` produces high quality statistics, which can take +considerable time. If you want to quickly experiment with things, you can use +the `--quality low` switch: this makes `warmup_stats` run considerably quicker, +but does lead to lower quality (and thus less reliable) statistics being +produced. Although the differences are often fairly minor, we do not encourage +the use of `--quality low` when formally publishing benchmark results. + ## Creating diffs Benchmarking is often performed in order to test whether a change in a given