Documentation
¶
Overview ¶
Command perftool orchestrates vix's performance benchmarks. It is the single entry point behind the perf Makefile targets:
perftool gen-corpus generate/validate the on-disk benchmark corpora perftool run run benchmarks, write perf/results/<commit>.txt, compare (no commit) perftool baseline run benchmarks and write perf/results/baseline.txt (commit it yourself) perftool smoke run every benchmark once (-benchtime=1x) to guard against breakage perftool gate verify perf/results/<HEAD>.txt exists and the tree is clean; exit 1 if not perftool record commit new perf/results/*.txt files (used by `make release`)
The reusable, unit-tested logic (corpus shapes, the release gate, the previous-result picker) lives in internal/perf; this file is the git / go-test / benchstat glue around it.
Source Files
Click to show internal directories.
Click to hide internal directories.