doc: add introduce about cli options

PR-URL: https://github.com/nodejs/node/pull/18475
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
pull/18515/merge
Weijia Wang 2018-01-31 17:57:05 +08:00
parent f02b74dfdb
commit bc51428bf8
1 changed files with 11 additions and 0 deletions

View File

@ -184,6 +184,17 @@ The `compare.js` tool will then produce a csv file with the benchmark results.
$ node benchmark/compare.js --old ./node-master --new ./node-pr-5134 string_decoder > compare-pr-5134.csv
```
*Tips: there are some useful options of `benchmark/compare.js`. For example, if you want to compare the benchmark of a single script instead of a whole module, you can use the `--filter` option:*
```console
--new ./new-node-binary new node binary (required)
--old ./old-node-binary old node binary (required)
--runs 30 number of samples
--filter pattern string to filter benchmark scripts
--set variable=value set benchmark variable (can be repeated)
--no-progress don't show benchmark progress indicator
```
For analysing the benchmark results use the `compare.R` tool.
```console