Commit adf5c84
doc: clean up writing-and-running-benchmarks.md
PR-URL: #61345
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>1 parent 5a984b9 commit adf5c84
1 file changed
Lines changed: 11 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -28,7 +28,7 @@ which need to be included in the global Windows `PATH`. | |||
| 28 | 28 | ||
| 29 | 29 | If you are using Nix, all the required tools are already listed in the | |
| 30 | 30 | `benchmarkTools` argument of the `shell.nix` file, so you can skip those | |
| 31 | - prerequesites. | ||
| 31 | + prerequisites. | ||
| 32 | 32 | ||
| 33 | 33 | ### HTTP benchmark requirements | |
| 34 | 34 | ||
@@ -47,24 +47,29 @@ By default, `wrk` will be used as the benchmarker. If it is not available, | |||
| 47 | 47 | `autocannon` will be used in its place. When creating an HTTP benchmark, the | |
| 48 | 48 | benchmarker to be used should be specified by providing it as an argument: | |
| 49 | 49 | ||
| 50 | - `node benchmark/run.js --set benchmarker=autocannon http` | ||
| 51 | - | ||
| 52 | - `node benchmark/http/simple.js benchmarker=autocannon` | ||
| 50 | + ```bash | ||
| 51 | + node benchmark/run.js --set benchmarker=autocannon http | ||
| 52 | + node benchmark/http/simple.js benchmarker=autocannon | ||
| 53 | + ``` | ||
| 53 | 54 | ||
| 54 | 55 | #### HTTPS benchmark requirements | |
| 55 | 56 | ||
| 56 | 57 | To run the `https` benchmarks, one of `autocannon` or `wrk` benchmarkers must | |
| 57 | 58 | be used. | |
| 58 | 59 | ||
| 59 | - `node benchmark/https/simple.js benchmarker=autocannon` | ||
| 60 | + ```bash | ||
| 61 | + node benchmark/https/simple.js benchmarker=autocannon | ||
| 62 | + ``` | ||
| 60 | 63 | ||
| 61 | 64 | #### HTTP/2 benchmark requirements | |
| 62 | 65 | ||
| 63 | 66 | To run the `http2` benchmarks, the `h2load` benchmarker must be used. The | |
| 64 | 67 | `h2load` tool is a component of the `nghttp2` project and may be installed | |
| 65 | 68 | from [nghttp2.org][] or built from source. | |
| 66 | 69 | ||
| 67 | - `node benchmark/http2/simple.js benchmarker=h2load` | ||
| 70 | + ```bash | ||
| 71 | + node benchmark/http2/simple.js benchmarker=h2load | ||
| 72 | + ``` | ||
| 68 | 73 | ||
| 69 | 74 | ### Benchmark analysis requirements | |
| 70 | 75 | ||
0 commit comments