docs: ASCII typography and style normalization across all repo text

Replace every em dash with real punctuation (rewrites, not hyphen swaps)
in docs, code comments, scripts, configs, and the port records; convert
en dashes, curly quotes, ellipsis glyphs, arrows, and section signs to
ASCII; drop machine-writing tell phrases from living docs. ADR titles
now use a colon. The M2 bring-up DTS model string carried an em dash
into the patch series and its record echoes; fixed at both, and the full
series re-verified to apply cleanly onto pristine 6.18.46. One comment
in freshness.h deliberately names the em dash glyph the UI renders as
the unknown mark; that is data, kept as prose naming it.

Verified: cargo tests (sim, config-lint, rs485-bridge), shellcheck,
both driver MC/DC harnesses, patches-apply.
This commit is contained in:
BFE Engineering
2026-08-31 12:31:27 -06:00
parent 80d9a9539b
commit 42fb386f60
111 changed files with 1261 additions and 1261 deletions
+6 -6
View File
@@ -1,4 +1,4 @@
# ADR 0006 QEMU Device Simulator
# ADR 0006: QEMU Device Simulator
**Status:** Accepted (2026-08-29).
@@ -6,7 +6,7 @@
The two existing simulators cannot test the *device*: `lvglsim` (flare-edge)
is an SDL rendering harness, and `sim/` models registers behind driver seams.
Init ordering, the daemons as real processes, networking/enrollment against
FLARE, OTA, and the watchdog were testable only on a bench panel flare-edge's
FLARE, OTA, and the watchdog were testable only on a bench panel; flare-edge's
fault suite marks five scenarios "HIL, human prompts", its Playwright e2e needs
a live panel on the LAN, and its OTA desk test stops at "reached APPLYING".
@@ -14,12 +14,12 @@ Two ways to emulate the panel were considered:
1. **A custom RV1106 QEMU board model.** Nothing exists upstream or in the
community, so this means writing VOP/CRU/GRF/eMMC/HPMCU device models from
scratch and maintaining them against QEMU months of work that duplicates
scratch and maintaining them against QEMU: months of work that duplicates
what `sim/` already models in Rust. It still could not run the boot chain:
BootROM is mask ROM and the DDR-init/idblock stages are closed rkbin blobs.
2. **The generic `-M virt` machine, entering at `-kernel zImage`.** The
forward-ported 6.18.46 config is multi_v7-derived and already carries
`ARCH_VIRT` plus the full virtio set the canonical RV1106 zImage boots
`ARCH_VIRT` plus the full virtio set; the canonical RV1106 zImage boots
virt **unmodified** (verified 2026-08-29). Peripherals become virtio
substitutes; SoC-block behavior stays in `sim/`, bridged in (the RS485
chardev bridge) rather than re-modeled.
@@ -28,11 +28,11 @@ Two ways to emulate the panel were considered:
Option 2. `qemu/` holds the harness: `qemu-system-arm -M virt,highmem=off
-cpu cortex-a7 -smp 1 -m 256M` (the RV1106G3's shape), one canonical kernel
image plus an optional additive config fragment (`qemu/configs/virt.fragment`
via the `WARDEN_KCONFIG_FRAGMENT` hook PCI/pci-serial/i6300esb/WireGuard/
via the `WARDEN_KCONFIG_FRAGMENT` hook: PCI/pci-serial/i6300esb/WireGuard/
virtio-gpu/virtio-input; the RV1106 build is byte-identical with the variable
unset). The VM carries the device's real 12-partition `blkdevparts=` A/B
layout on a virtio disk and populates the `/dev/block/by-name/` contract.
The name is `qemu/`, not any variant of "sim" the wikis already warn that
The name is `qemu/`, not any variant of "sim"; the wikis already warn that
"sim" is two different things.
Notable mechanics: `highmem=off` because the non-LPAE 32-bit kernel cannot