Skip to content

Commit 04b0e85

Browse files
committed
docs: add benchmarking section
1 parent 91964c5 commit 04b0e85

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

MAINTAINERS.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,28 @@ This compiles the extension in release mode using Cargo. The resulting
2525
shared library is placed under
2626
`ext/native_tracer/target/release/` and is loaded by `src/native_trace.rb`.
2727

28-
## Running tests and benchmarks
28+
## Running tests
2929

3030
Execute the full test suite with:
3131

3232
```bash
3333
just test
3434
```
3535

36+
3637
The tests run several sample programs from `test/programs` and compare
3738
the generated traces with the fixtures under `test/fixtures`.
3839

39-
Benchmarks can be executed with:
40+
## Benchmarking
41+
42+
Run the heavy\_work benchmark with:
4043

4144
```bash
4245
just bench heavy_work
4346
```
4447

45-
Passing a second argument writes a report instead of printing the runtime:
48+
Provide a path as a second argument to write a report instead of
49+
printing the runtime:
4650

4751
```bash
4852
just bench heavy_work reports/bench.svg

0 commit comments

Comments
 (0)