Skip to content

Commit 567c38c

Browse files
westgatewestgate
authored andcommitted
S185: Doc refresh — align all root/subdocs to S184, fix stale session tags and metadata
Made-with: Cursor
1 parent 4525830 commit 567c38c

8 files changed

Lines changed: 18 additions & 18 deletions

File tree

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ToadStool Environment Configuration
2-
# Updated: S171 (April 1, 2026)
2+
# Updated: S184 (April 5, 2026)
33
#
44
# All values have sensible defaults. Only override what you need.
55
# Copy this file to .env and customize for your environment.

DEBT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -738,7 +738,7 @@ dependencies, works on every GPU, ships with the crate, testable in CI without h
738738
|----|-------------|----------|-------|
739739
| D-NPU | ~~NpuDispatch trait~~ | **RESOLVED S94** | `toadstool-core::npu_dispatch` — generic `NpuDispatch` trait + `AkidaNpuDispatch` adapter |
740740
| D-RING | ~~ring C FFI in dev-deps~~ | **RESOLVED S97** | `reqwest` removed from integration-tests; `zstd``ruzstd` (pure Rust) |
741-
| D-COV | Test coverage → 90% | Medium | **~84-85% line coverage** (185K lines, llvm-cov). **21,853 tests passing** (S180). Target 90%. Remaining gaps: hardware-dependent paths (V4L2/VFIO), specialty runtimes. Push ongoing. |
741+
| D-COV | Test coverage → 90% | Medium | **~84-85% line coverage** (185K lines, llvm-cov). **21,853 tests passing** (S184). Target 90%. Remaining gaps: hardware-dependent paths (V4L2/VFIO), specialty runtimes. Push ongoing. |
742742
| D-DOCS | ~~Fill missing_docs warnings~~ | **RESOLVED S159** | All 694+ missing doc warnings filled across 58 crates. `clippy --workspace -D warnings` passes. |
743743
| D-SOV | ~~Sovereignty: primal-name → capability~~ | **RESOLVED S94b** | All production callers migrated to `get_socket_path_for_capability()`. Deprecated definitions retained for fallback only. |
744744
| D-WC | ~~Wildcard re-exports remaining~~ | **RESOLVED S132** | 4 high-traffic crates narrowed to explicit exports (constants, distributed, ipc, universal_adapter). Remaining wildcards justified (15+ items all used, or private submodule re-exports). |

DOCUMENTATION.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ToadStool Documentation Hub
22

3-
**Last Updated**: April 4, 2026 — S180
3+
**Last Updated**: April 5, 2026 — S184
44

55
---
66

@@ -30,7 +30,7 @@ These root documents were **fully resolved** and **fossilized** in wateringHole
3030

3131
---
3232

33-
## Current State (S180 — April 4, 2026)
33+
## Current State (S184 — April 5, 2026)
3434

3535
**Post-budding, dependency-sovereign, IPC-first, fully concurrent.** barraCuda is a separate primal at `ecoPrimals/barraCuda/`. ToadStool is the hardware infrastructure layer — GPU/NPU/CPU discovery, capability probing, workload orchestration, and shader dispatch.
3636

@@ -39,7 +39,7 @@ These root documents were **fully resolved** and **fossilized** in wateringHole
3939
- **glowPlug/ember subsystem** — toadStool-native hardware lifecycle (absorbed from coralReef). `toadstool-glowplug`, `toadstool-ember`, `toadstool-hw-safe` crates.
4040
- **~59 unsafe blocks** — 48 in containment zones (`hw-safe`, `v4l2::ioctl`), 11 in consumer/driver code. 23 crates forbid, 20 deny `unsafe_code`.
4141
- **ecoBin v3.0** — Zero C FFI deps. Crypto delegated to BearDog. HTTP delegated to Songbird.
42-
- **Capability-based discovery** — Primals discover each other by capability, not name. Self-knowledge principle. S176-180: deprecated primal-named APIs removed, env_config evolved to capability names, production log/error strings evolved to capability-first.
42+
- **Capability-based discovery** — Primals discover each other by capability, not name. Self-knowledge principle. S176-184: deprecated primal-named APIs removed, env_config evolved to capability names, all production log/error strings evolved to capability-first. Zero primal-name strings remaining in production macros.
4343
- **Fully concurrent tests** — All tests run with `--test-threads=8`. Zero `#[serial]`. Zero fixed sleeps in non-chaos tests.
4444
- **AGPL-3.0-only** — All Cargo.toml + all .rs files aligned. `deny.toml` enforced.
4545

NEXT_STEPS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ syntax fixed in 3 server files. Test suite fully unblocked.
3333

3434
### P1: Test Coverage → 90% (D-COV) — Ongoing (S164)
3535

36-
**~80-85% line coverage** (lib-only, 185K lines instrumented). **21,853 tests** (S180, 0 failures). Target 90%.
36+
**~80-85% line coverage** (lib-only, 185K lines instrumented). **21,853 tests** (S184, 0 failures). Target 90%.
3737

3838
**S164** expanded coverage with **+94 new tests** across 7 low-coverage files:
3939
- `resource_validator.rs` 20% → ~75% (+19 tests)
@@ -125,7 +125,7 @@ names directly. Deprecated API definitions retained for backward compatibility o
125125
- [x] **Clippy pedantic clean** -- `cargo clippy --workspace --all-targets -- -D warnings -W clippy::pedantic` zero warnings (S130+)
126126
- [x] **`#[expect]` evolution** -- production `#[allow]` evolved to `#[expect(lint, reason)]`; 3 stale suppressions removed (S131+)
127127
- [x] **Spring sync S131+** -- all 5 springs pinned to latest, SPRING_ABSORPTION_TRACKER updated (S131+)
128-
- [ ] **Test coverage target 90%** -- 21,853 tests (S180); ~80-85% line; mock hardware layers for V4L2/VFIO (MockV4l2Device, MockVfioDevice); push to 90% ongoing
128+
- [ ] **Test coverage target 90%** -- 21,853 tests (S184); ~80-85% line; mock hardware layers for V4L2/VFIO (MockV4l2Device, MockVfioDevice); push to 90% ongoing
129129
- [x] **C dep elimination** -- flate2 → rust_backend, procfs default features disabled (S129)
130130
- [x] **Capability-based ports** -- `resolve_capability_or_legacy_port()` with graceful legacy fallback (S129)
131131
- [x] **God file splits (round 4)** -- ipc/server.rs, container/lib.rs, ecosystem.rs, handler/mod.rs, nestgate/client.rs (S129)

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Nest = Tower + NestGate <- storage
4242
| `cargo fmt --all -- --check` | 0 diffs |
4343
| `cargo clippy --workspace --all-targets -- -D warnings` | 0 warnings |
4444
| `cargo doc --workspace --no-deps` | 0 warnings |
45-
| `cargo test --workspace` | **21,853 tests, 0 failures** (S180), 220 ignored (hardware-gated) |
45+
| `cargo test --workspace` | **21,853 tests, 0 failures** (S184), 220 ignored (hardware-gated) |
4646
| Doctests | All passing (common, core, server, cli, testing, display) |
4747
| Standalone clone test | Pull to any machine, `cargo test` works (GPU-optional, CPU fallback, device-lost resilient) |
4848
| `unsafe` blocks | **~59 actual** (48 in `hw-safe`/`v4l2::ioctl` containment zones, 11 in consumer/driver code); SAFETY-documented; **23 crates forbid, 20 deny** `unsafe_code` |
@@ -142,7 +142,7 @@ HDMI Tx V4L2 Rx Serial TransportRouter
142142
- **NestGate integration** -- real JSON-RPC `storage.artifact.store`/`retrieve` with graceful fallback
143143
- **Real-time events**: `compute.status` JSON-RPC polling or biomeOS/songbird coordination for event streaming
144144

145-
### JSON-RPC Methods (~67 dynamically built; S180)
145+
### JSON-RPC Methods (~67 dynamically built; S184)
146146

147147
Surface trimmed to hardware orchestration and IPC boundaries. **Removed from this repo** (S169): `inference.*` / Ollama-style AI (→ Squirrel), **`shader.compile.*`** (→ coralReef), **`science.*`** / **`ecology.*`** / **`discovery.*`** / **`deploy.*`** relays (→ biomeOS and peers). **Kept**: **`shader.dispatch`** (dispatch compiled binary to GPU; compile happens in coralReef).
148148

@@ -244,7 +244,7 @@ toadStool/
244244
| Clippy pedantic warnings | 0 (workspace-wide `clippy::pedantic` clean; `#[expect]` evolution S131+) |
245245
| Doc warnings | 0 |
246246
| Build warnings | 0 |
247-
| Workspace tests | **21,853** (S180), 0 failures |
247+
| Workspace tests | **21,853** (S184), 0 failures |
248248
| Full workspace test time | ~8m (8 threads, GPU crates have NVK resilience wrappers) |
249249
| `unsafe` blocks | **~59 actual** (48 in containment zones, 11 in consumer code); SAFETY-documented; **23 crates forbid, 20 deny** `unsafe_code` |
250250
| Production panics/unwraps | 0 blind `unwrap()`; infallible `expect()` only |
@@ -265,7 +265,7 @@ toadStool/
265265
**We are still evolving.** barraCuda (separate primal) owns all math and shaders. ToadStool focuses on hardware discovery, capability probing, and workload orchestration. All 5 spring handoffs absorbed.
266266

267267
### Active / Next
268-
- **Test coverage** -- pushing toward 90% target; 21,853 tests (S180); ~80-85% lib-only line (185K lines instrumented); remaining gap: hardware-dependent paths, specialty runtimes
268+
- **Test coverage** -- pushing toward 90% target; 21,853 tests (S184); ~80-85% lib-only line (185K lines instrumented); remaining gap: hardware-dependent paths, specialty runtimes
269269
- **DF64 / ComputeDispatch** -- transferred to barraCuda team (S93); toadStool serves hardware capabilities
270270
- **Sovereign compiler Phase 4+** -- register pressure estimation, loop software pipelining (barraCuda)
271271

@@ -305,7 +305,7 @@ See [CHANGELOG.md](CHANGELOG.md) for full session-by-session detail.
305305

306306
| ID | Description | Status |
307307
|----|-------------|--------|
308-
| D-COV | Test coverage → 90% | Active -- 21,853 tests (S180); ~80-85% lib-only line (185K instrumented); remaining gap: hardware paths |
308+
| D-COV | Test coverage → 90% | Active -- 21,853 tests (S184); ~80-85% lib-only line (185K instrumented); remaining gap: hardware paths |
309309
| D-S20-003 | ~~neuralSpring `evolved/` migration~~ | **RESOLVED** -- neuralSpring V89 completed; `evolved/` removed |
310310
| D-S18-002 | ~~cubecl transitive `dirs-sys`~~ | **RESOLVED** -- cubecl removed; dirs-sys only via wasmtime-cache (feature-gated) |
311311

@@ -349,7 +349,7 @@ See [DEBT.md](DEBT.md) for full register and evolution paths.
349349

350350
---
351351

352-
**Last Updated**: April 4, 2026 — S180. **21,853** workspace tests, 0 failures. ~80-85% lib-only line coverage (target 90%). **~67 JSON-RPC methods** (`identity.get`, `health.liveness`). AGPL-3.0-only. Zero C FFI deps (ecoBin v3.0). **~59 unsafe blocks** (48 in hw-safe/ioctl containment zones, 11 in consumer code). **43 crates** with `unsafe_code` lint policy. IPC-first JSON-RPC (Unix sockets). Capability symlinks (`compute.sock`). Neural API naming (`capability.register`/`resolve`/`find`). Rust 1.85+ (edition 2024, MSRV). **S180**: Fixed blocking async I/O in platform detectors; smart-refactored 5 more files >640L; evolved primal-name strings in production logs/errors to capability-first. **Capability-based discovery compliant** per `CAPABILITY_BASED_DISCOVERY_STANDARD.md` v1.2.
352+
**Last Updated**: April 5, 2026 — S184. **21,853** workspace tests, 0 failures. ~80-85% lib-only line coverage (target 90%). **~67 JSON-RPC methods** (`identity.get`, `health.liveness`). AGPL-3.0-only. Zero C FFI deps (ecoBin v3.0). **~59 unsafe blocks** (48 in hw-safe/ioctl containment zones, 11 in consumer code). **43 crates** with `unsafe_code` lint policy. IPC-first JSON-RPC (Unix sockets). Capability symlinks (`compute.sock`). Neural API naming (`capability.register`/`resolve`/`find`). Rust 1.85+ (edition 2024, MSRV). **S176-184**: Deep debt evolution — zero blocking async I/O, zero primal-name log strings, 15+ large files smart-refactored, `#[allow→#[expect]` ratio flipped (40% allow / 60% expect), capability-first naming complete. **Capability-based discovery compliant** per `CAPABILITY_BASED_DISCOVERY_STANDARD.md` v1.2.
353353

354354
---
355355

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ToadStool Documentation
22

3-
**Updated**: April 3, 2026 -- S173
3+
**Updated**: April 5, 2026 -- S184
44

55
Primary documentation lives at the repository root. See [../DOCUMENTATION.md](../DOCUMENTATION.md) for the navigation hub. Session trackers archived to `ecoPrimals/infra/wateringHole/fossilRecord/toadstool/`.
66

docs/guides/TESTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Testing Guide
22

3-
**Last Updated**: March 29, 2026 — S164
3+
**Last Updated**: April 5, 2026 — S184
44

55
## Quick Status
66

77
| Metric | Status | Details |
88
|--------|--------|---------|
9-
| **Workspace Tests** | **21,853 (default features, S180)** | 0 failures, 222 intentional GPU ignores |
9+
| **Workspace Tests** | **21,853 (default features, S184)** | 0 failures, 220 intentional GPU ignores |
1010
| **Line Coverage** | **~80% (lib-only)** | ~185K production lines. Gap: hardware-dependent code (V4L2/VFIO/neuromorphic) |
1111
| **Clippy Pedantic** | **0 warnings** | Full workspace (`-D warnings`), in CI |
1212
| **BarraCuda Tests** | Separate primal | Budded to `ecoPrimals/barraCuda/` (S93) |

specs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,10 @@ toadStool picks the row. coralReef compiles for it. Springs never see the table.
115115
| Test coverage | Target 90%, current ~83% (llvm-cov) | 🔄 D-COV |
116116
| Mocks in production | 0 (all `#[cfg(test)]` gated) ||
117117

118-
### Key Numbers (S163)
118+
### Key Numbers (S184)
119119

120120
- **58 workspace crates**, 1,933+ `.rs` files, ~570K lines
121-
- **21,853 tests** (all features, S180, 0 failures)
121+
- **21,853 tests** (all features, S184, 0 failures)
122122
- **96+ JSON-RPC methods** (`domain.operation` semantic naming)
123123
- **3 hardware transports** — Display (DRM), Capture (V4L2), Serial
124124
- **VFIO interface** — BAR0, DMA, power management (nvpmu)

0 commit comments

Comments
 (0)