Skip to content

Commit 18a586a

Browse files
TrottMylesBorins
authored andcommitted
doc: edit the benchmark guide
These are minor typographical and style improvements to the guide for writing and running benchmarks. PR-URL: #12041 Reviewed-By: Nikolai Vavilov <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 5e3d429 commit 18a586a

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

doc/guides/writing-and-running-benchmarks.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -22,29 +22,28 @@ which need to be included in the global Windows `PATH`.
2222

2323
### HTTP Benchmark Requirements
2424

25-
Most of the HTTP benchmarks require a benchmarker to be installed, this can be
25+
Most of the HTTP benchmarks require a benchmarker to be installed. This can be
2626
either [`wrk`][wrk] or [`autocannon`][autocannon].
2727

2828
`Autocannon` is a Node.js script that can be installed using
2929
`npm install -g autocannon`. It will use the Node.js executable that is in the
30-
path, hence if you want to compare two HTTP benchmark runs make sure that the
30+
path. Hence if you want to compare two HTTP benchmark runs, make sure that the
3131
Node.js version in the path is not altered.
3232

3333
`wrk` may be available through your preferred package manager. If not, you can
3434
easily build it [from source][wrk] via `make`.
3535

36-
By default `wrk` will be used as benchmarker. If it is not available
37-
`autocannon` will be used in it its place. When creating a HTTP benchmark you
38-
can specify which benchmarker should be used. You can force a specific
39-
benchmarker to be used by providing it as an argument, e. g.:
36+
By default, `wrk` will be used as the benchmarker. If it is not available,
37+
`autocannon` will be used in its place. When creating an HTTP benchmark, you can
38+
specify which benchmarker should be used by providing it as an argument:
4039

4140
`node benchmark/run.js --set benchmarker=autocannon http`
4241

4342
`node benchmark/http/simple.js benchmarker=autocannon`
4443

4544
### Benchmark Analysis Requirements
4645

47-
To analyze the results `R` should be installed. Check you package manager or
46+
To analyze the results, `R` should be installed. Use your package manager or
4847
download it from https://www.r-project.org/.
4948

5049
The R packages `ggplot2` and `plyr` are also used and can be installed using
@@ -56,9 +55,8 @@ install.packages("ggplot2")
5655
install.packages("plyr")
5756
```
5857

59-
In the event you get a message that you need to select a CRAN mirror first.
60-
61-
You can specify a mirror by adding in the repo parameter.
58+
In the event you get a message that you need to select a CRAN mirror first, you
59+
can specify a mirror by adding in the repo parameter.
6260

6361
If we used the "http://cran.us.r-project.org" mirror, it could look something
6462
like this:

0 commit comments

Comments
 (0)