Skip to content

Commit 258d5f7

Browse files
Theo-Steinertargos
authored andcommitted
benchmark: replace table in docs with description of file tree structure
The markdown table in `benchmark/README.md` has grown stale, no longer providing an overview over all existing benchmarks. As it has proven difficult to keep an exhaustive listing of available benchmarks up to date, this commit provides a description of how the directory is structured instead. PR-URL: #46991 Reviewed-By: Kohei Ueno <kohei.ueno119@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
1 parent 458671d commit 258d5f7

File tree

1 file changed

+14
-31
lines changed

1 file changed

+14
-31
lines changed

benchmark/README.md

+14-31
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,22 @@ directory, see [the guide on benchmarks](../doc/contributing/writing-and-running
99

1010
## Table of Contents
1111

12-
* [Benchmark directories](#benchmark-directories)
12+
* [File tree structure](#file-tree-structure)
1313
* [Common API](#common-api)
1414

15-
## Benchmark Directories
16-
17-
| Directory | Purpose |
18-
| --------------- | ---------------------------------------------------------------------------------------------------------------- |
19-
| assert | Benchmarks for the `assert` subsystem. |
20-
| buffers | Benchmarks for the `buffer` subsystem. |
21-
| child\_process | Benchmarks for the `child_process` subsystem. |
22-
| crypto | Benchmarks for the `crypto` subsystem. |
23-
| dgram | Benchmarks for the `dgram` subsystem. |
24-
| domain | Benchmarks for the `domain` subsystem. |
25-
| es | Benchmarks for various new ECMAScript features and their pre-ES2015 counterparts. |
26-
| events | Benchmarks for the `events` subsystem. |
27-
| fixtures | Benchmarks fixtures used in various benchmarks throughout the benchmark suite. |
28-
| fs | Benchmarks for the `fs` subsystem. |
29-
| http | Benchmarks for the `http` subsystem. |
30-
| http2 | Benchmarks for the `http2` subsystem. |
31-
| misc | Miscellaneous benchmarks and benchmarks for shared internal modules. |
32-
| module | Benchmarks for the `module` subsystem. |
33-
| net | Benchmarks for the `net` subsystem. |
34-
| path | Benchmarks for the `path` subsystem. |
35-
| perf\_hooks | Benchmarks for the `perf_hooks` subsystem. |
36-
| process | Benchmarks for the `process` subsystem. |
37-
| querystring | Benchmarks for the `querystring` subsystem. |
38-
| streams | Benchmarks for the `streams` subsystem. |
39-
| string\_decoder | Benchmarks for the `string_decoder` subsystem. |
40-
| timers | Benchmarks for the `timers` subsystem, including `setTimeout`, `setInterval`, .etc. |
41-
| tls | Benchmarks for the `tls` subsystem. |
42-
| url | Benchmarks for the `url` subsystem, including the legacy `url` implementation and the WHATWG URL implementation. |
43-
| util | Benchmarks for the `util` subsystem. |
44-
| vm | Benchmarks for the `vm` subsystem. |
15+
## File tree structure
16+
17+
### Directories
18+
19+
Benchmarks testing the performance of a single node submodule are placed into a
20+
directory with the corresponding name, so that they can be executed by submodule
21+
or individually.
22+
Benchmarks that span multiple submodules may either be placed into the `misc`
23+
directory or into a directory named after the feature they benchmark.
24+
E.g. benchmarks for various new ECMAScript features and their pre-ES2015
25+
counterparts are placed in a directory named `es`.
26+
Fixtures that are not specific to a certain benchmark but can be reused
27+
throughout the benchmark suite should be placed in the `fixtures` directory.
4528

4629
### Other Top-level files
4730

0 commit comments

Comments
 (0)