Reference documents

The pages of this book explain and show. The exact definition of every key, field, option and decision lives in documents next to the code, and they are linked here rather than copied, so there is one place to be right.

Using it

Document	What it defines
The command line	Every command and option, and the exit codes.
The Python package	`run`, `start`, `asyncio`, the builder, the result types, the tables.
The pytest plugin	The fixtures, the marker, and how a test fails.
Doctor and clean	What `doctor` checks, `--timers`, and `clean`.
Permissions	The rights a run needs, and a CI.
Troubleshooting	Starting from the message.

The scenario and the result

Document	What it defines
The scenario format	Every key of the file.
The profile library	The named links and the sources of their values.
Programs of your own	`kind: command`: readiness, shutdown, limits.
Results	Every field of `result.json` and the files of a run.
Statistics	Sets of runs, intervals and what a bound means.
Reports	Markdown, JUnit and HTML.

How it works and what it promises

Document	What it tells
Architecture	The crates, the backend and the agents.
Coverage	What each backend reproduces exactly, in part, or not at all.
Testing	The kinds of test, where they run, coverage and mutation tests.
Fidelity	How the Kernel backend was checked against the kernel.
Decisions	Every decision that is hard to undo, with its reasons.
Features	The ledger of what exists and what is planned.
Versioning	What a version number promises.
Security	Reporting a problem, and the risk of a scenario that runs code.