Skip to content

Commit d34e9ed

Browse files
committed
docs(bench): README 指向 SPEC.md 与 matrix.json —— 三份文档各答一个问题
1 parent 733279d commit d34e9ed

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

bench/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ Each `mcpp=<path>` engine labels itself from the version that binary reports
2626
"did this release get faster?" is answered — by running both, not by emulating
2727
one of them in the harness.
2828

29+
### The three documents, and which one to read
30+
31+
| file | answers |
32+
|---|---|
33+
| **this file** | *how* a timing is taken, and what is deliberately not controlled |
34+
| [`SPEC.md`](SPEC.md) | *what* is measured: the six axes, why cmake is the baseline, what a cell being undefined means |
35+
| [`matrix.json`](matrix.json) | *which* cells CI runs — the single source, read by `.github/workflows/bench.yml` |
36+
37+
The cell list appears in exactly one of those. A matrix written down twice is a
38+
matrix that disagrees with itself, and the disagreement is silent: both copies
39+
keep looking right. `tests/e2e/233_bench_matrix.sh` is what keeps it that way.
40+
2941
---
3042

3143
## 1. What is measured

0 commit comments

Comments
 (0)