doc: *.md formatting fixes in the benchmark dir

doc: *.md formatting fixes in the benchmark dir · nodejs/node@f3f5a89

@@ -30,8 +30,6 @@ install.packages("ggplot2")

3030install.packages("plyr")3131```323233-[wrk]: https://github.com/wg/wrk34-3533## Running benchmarks36343735### Running individual benchmarks

@@ -43,7 +41,7 @@ conclusions about the performance.

4341Individual benchmarks can be executed by simply executing the benchmark script4442with node.454346-```44+```console4745$ node benchmark/buffers/buffer-tostring.js48464947buffers/buffer-tostring.js n=10000000 len=0 arg=true: 62710590.393305704

@@ -65,7 +63,7 @@ measured in ops/sec (higher is better).**

6563Furthermore you can specify a subset of the configurations, by setting them in6664the process arguments:676568-```66+```console6967$ node benchmark/buffers/buffer-tostring.js len=102470687169buffers/buffer-tostring.js n=10000000 len=1024 arg=true: 3498295.68561504

@@ -78,7 +76,7 @@ Similar to running individual benchmarks, a group of benchmarks can be executed

7876by using the `run.js` tool. Again this does not provide the statistical7977information to make any conclusions.807881-```79+```console8280$ node benchmark/run.js arrays83818482arrays/var-int.js

@@ -98,7 +96,7 @@ arrays/zero-int.js n=25 type=Buffer: 90.49906662339653

9896```999710098It is possible to execute more groups by adding extra process arguments.101-```99+```console102100$ node benchmark/run.js arrays buffers103101```104102

@@ -119,13 +117,13 @@ First build two versions of node, one from the master branch (here called

119117120118The `compare.js` tool will then produce a csv file with the benchmark results.121119122-```120+```console123121$ node benchmark/compare.js --old ./node-master --new ./node-pr-5134 string_decoder > compare-pr-5134.csv124122```125123126124For analysing the benchmark results use the `compare.R` tool.127125128-```126+```console129127$ cat compare-pr-5134.csv | Rscript benchmark/compare.R130128131129

                                                                                      improvement significant      p.value

@@ -159,16 +157,14 @@ _For the statistically minded, the R script performs an [independent/unpaired

159157same for both versions. The significant field will show a star if the p-value160158is less than `0.05`._161159162-[t-test]: https://en.wikipedia.org/wiki/Student%27s_t-test#Equal_or_unequal_sample_sizes.2C_unequal_variances163-164160The `compare.R` tool can also produce a box plot by using the `--plot filename`165161option. In this case there are 48 different benchmark combinations, thus you166162may want to filter the csv file. This can be done while benchmarking using the167163`--set` parameter (e.g. `--set encoding=ascii`) or by filtering results168164afterwards using tools such as `sed` or `grep`. In the `sed` case be sure to169165keep the first line since that contains the header information.170166171-```167+```console172168$ cat compare-pr-5134.csv | sed '1p;/encoding=ascii/!d' | Rscript benchmark/compare.R --plot compare-plot.png173169174170 improvement significant p.value

@@ -190,15 +186,15 @@ example to analyze the time complexity.

190186To do this use the `scatter.js` tool, this will run a benchmark multiple times191187and generate a csv with the results.192188193-```189+```console194190$ node benchmark/scatter.js benchmark/string_decoder/string-decoder.js > scatter.csv195191```196192197193After generating the csv, a comparison table can be created using the198194`scatter.R` tool. Even more useful it creates an actual scatter plot when using199195the `--plot filename` option.200196201-```197+```console202198$ cat scatter.csv | Rscript benchmark/scatter.R --xaxis chunk --category encoding --plot scatter-plot.png --log203199204200aggregating variable: inlen

@@ -229,7 +225,7 @@ can be solved by filtering. This can be done while benchmarking using the

229225afterwards using tools such as `sed` or `grep`. In the `sed` case be230226sure to keep the first line since that contains the header information.231227232-```228+```console233229

$ cat scatter.csv | sed -E '1p;/([^,]+, ){3}128,/!d' | Rscript benchmark/scatter.R --xaxis chunk --category encoding --plot scatter-plot.png --log

234230235231chunk encoding mean confidence.interval

@@ -290,3 +286,6 @@ function main(conf) {

290286bench.end(conf.n);291287}292288```289+290+[wrk]: https://github.com/wg/wrk291+[t-test]: https://en.wikipedia.org/wiki/Student%27s_t-test#Equal_or_unequal_sample_sizes.2C_unequal_variances