docs(bench,test): READMEs for benches/ and tests/

benches/README.md: catalog of the two bench families (cross-runtime
comparisons + the v0.5 run-queue shootout), how to run the shootout
(scripts/bench_rq.sh, SMARM_BENCH_* knobs, the --no-default-features dance,
summary.csv/RQCSV format), honest-numbers caveats (core count is the
experiment; striped losing at low thread counts is expected), and the
conventions for adding a bench.

tests/README.md: catalog grouped by layer (low-level units / feature areas /
regression+stress), the run matrix (debug-first — that's where the invariant
asserts live — three queue variants, release, loom, trace), why loom tests
live in src/ rather than tests/, and the house conventions: one runtime per
test, oversubscription on purpose, regression tests validated against the
reintroduced bug, odds-stacking for stochastic tests, ordering-not-duration
time assertions, and new-invariant = assert + loom model.

Also fixes a stale header in tests/mutex.rs that claimed 'loom::Mutex' —
it tests smarm::Mutex, and the old name is actively confusing now that loom
is real in this repo.

This commit is contained in:

Claude

2026-06-09 21:35:08 +00:00

parent 039703dbeb

commit a7ca6646d7

3 changed files with 211 additions and 1 deletions

									
										tests/mutex.rs
									
		+2
		-1
	
												View File
												
				@@ -1,4 +1,5 @@

				//! `loom::Mutex<T>` tests. All run under the scheduler because `lock()`

				//! `smarm::Mutex<T>` (the actor-blocking mutex) tests. All run under the

				//! scheduler because `lock()`

				//! needs to be able to park.

				use smarm::{run, spawn, yield_now, LockTimeout, Mutex};