Skip to content

Commit 1b6bdf5

Browse files
authored
docs: Add a README explaining the purpose of the benchmark suite
1 parent 841e102 commit 1b6bdf5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

test/benchmarks/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
This directory contains programs and fixtures used for manual performance testing of the tracer.
2+
3+
These benchmarks are **not** executed in CI because they may take longer to run than typical tests. Each program has a reference trace recorded using the current tracer implementation. When we experiment with alternative tracer implementations, we will compare their output with these fixtures to ensure compatibility.
4+
5+
The reference traces are stored via Git LFS so the repository stays lightweight. `run_benchmark.rb` verifies the SHA-256 hash of each fixture and downloads it with `git lfs` on demand if missing.
6+
7+
At the moment there is a single benchmark (`heavy_work`) that exercises a mixture of array and hash operations while computing prime numbers. More benchmarks will be added as we expand the suite.

0 commit comments

Comments
 (0)