Skip to content

Commit b05e911

Browse files
committed
fixup! fixup! doc: add more context about benchmark tests and envs used
1 parent 241b50f commit b05e911

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

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

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -742,26 +742,24 @@ only a single configuration per benchmark executes.
742742
While this dramatically reduces execution time, it provides limited coverage
743743
and cannot guarantee that all configurations function properly.
744744

745-
This PR introduce the usage of new env `NODE_RUN_ALL_BENCH_TESTS`, that can be set to all becnhmark configs run in tests to try coverage more scenarios when benchmarks can fails.
746-
this PR as well document how to write benchmark tests, and give more details about the envs
745+
This PR introduces the usage of a new environment variable `NODE_RUN_ALL_BENCH_TESTS`, which can be set to run all benchmark configurations in tests to cover more scenarios where benchmarks might fail.
746+
This PR also documents how to write benchmark tests and provides more details about the environment variables:
747747

748-
- NODE_RUN_ALL_BENCH_TESTS
749-
- NODEJS_BENCHMARK_ZERO_ALLOWED
748+
* NODE_RUN_ALL_BENCH_TESTS
749+
* NODEJS_BENCHMARK_ZERO_ALLOWED
750750

751-
Some benchmarks tests was introduced as well for benchmark groups
751+
Benchmark tests were added for the following groups:
752752

753-
- abort_controller
754-
- error
755-
- https
756-
- perf_hooks
757-
- permission
758-
- sqlite
759-
- test_runner
760-
- websocket
753+
* abort_controller
754+
* error
755+
* https
756+
* perf_hooks
757+
* permission
758+
* sqlite
759+
* test_runner
760+
* websocket
761761

762-
and some incosistent test files was renamed
762+
Additionally, some inconsistent test files were renamed:
763763

764764
test/benchmark/test-benchmark-async-hooks.js → test/benchmark/test-benchmark-async_hooks.js
765765
test/benchmark/test-benchmark-child-process.js → test/benchmark/test-benchmark-child_process.js
766-
767-

0 commit comments

Comments
 (0)