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.
2026-08-31 12:31:27 -06:00
parent 80d9a9539b
commit 42fb386f60
111 changed files with 1261 additions and 1261 deletions
@@ -1,17 +1,17 @@
 # The Device Simulator

 A QEMU virtual machine that boots the real forward-ported kernel and real
-userspace: the 86 Panel — init, daemons, networking, OTA, watchdog, display —
+userspace: the 86 Panel (init, daemons, networking, OTA, watchdog, display)
 developed and tested with no board attached. The third simulator in the stack
 (three-way split: root README), deliberately not named "sim": it runs the
-whole machine above the kernel entry point on real binaries — bring your own,
+whole machine above the kernel entry point on real binaries: bring your own,
 or drop prebuilt payloads in `payload/`. Decision record: ADR-0006.

 ## The Boundary

 There is no RV1106 machine model in QEMU and everything below the kernel is
 closed rkbin blobs plus mask ROM, so the VM **enters at `-kernel zImage`** on
-`-M virt,highmem=off` (single Cortex-A7, 256M — the RV1106G3's shape).
+`-M virt,highmem=off` (single Cortex-A7, 256M: the RV1106G3's shape).

 | Emulated / substituted | Not emulated (stays bench / `sim/` territory) |
 |---|---|
@@ -28,7 +28,7 @@ closed rkbin blobs plus mask ROM, so the VM **enters at `-kernel zImage`** on
 **"Boots/works under emulation" is never evidence of "works on silicon."**
 The VM narrows which claims need a panel; on-device claims still need
 on-device evidence. Conversely, the VM is the first environment that runs
-production binaries on a non-RV1106 memory map — it found flare-edge #106
+production binaries on a non-RV1106 memory map: it found flare-edge #106
 (fatal SIGBUS in flared's HPMCU probe) and #107 (Y2038 time_t truncation)
 on its first two boots of real userspace.

@@ -54,7 +54,7 @@ bash qemu/run.sh --kernel $HOME/kbuild-out/linux-6.18.46/arch/arm/boot/zImage --
 ```

 Payload: drop static musl armv7 binaries into `qemu/payload/` (see its
-README) — `warden-flared`, `warden-modbus`, and `warden-ui` (the LVGL
+README); `warden-flared`, `warden-modbus`, and `warden-ui` (the LVGL
 fbdev+evdev build from flare-edge `tools/build-ui-vm.sh`) are started by
 stage-2 init when present.

@@ -64,12 +64,12 @@ All take the virt-fragment `<zImage>`; `FLARE_EDGE=<checkout>` where noted.

 | Scenario | Needs | Proves |
 |---|---|---|
-| `boot-smoke.sh` | — | sentinel-asserting boot; runs in CI inside kernel-build |
+| `boot-smoke.sh` | - | sentinel-asserting boot; runs in CI inside kernel-build |
 | `portal-scenario.sh` | `FLARE_EDGE` | real flared against the desk mock portal: authenticated check-in, desired-state pull, signed tier-1 `.wfw` download; verify/stage/APPLYING as a dry run (no `WARDEN_FW_ALLOW_APPLY`) |
 | `ota-apply.sh` | `FLARE_EDGE` | the FULL apply: the `.wfw`'s bootable rootfs payload is written to rootfs_b (`run.sh --allow-apply` gates it per boot), the AvbABData in `misc` flips, and slot `_b` boots the applied version |
-| `ui-shot.sh` | — | display+touch, headless: QMP-screendumps the 720x720 UI, taps the Metrics tab via `input-send-event`, asserts the frame changed (`qmp.py` is the QMP client) |
-| `real-image-boot.sh` | matched `rootfs.img` + `oem.img` | an ACTUAL flare-edge build (placed by `mkimage.sh --rootfs-image/--oem-image`) boots its own init chain to getty; binaries predating known fixes reproduce their bugs faithfully — a time machine for field issues |
-| watchdog (`run.sh --watchdog`) | — | arm `/dev/watchdog`, don't pet: the VM resets ~30 s later (verified) |
+| `ui-shot.sh` | - | display+touch, headless: QMP-screendumps the 720x720 UI, taps the Metrics tab via `input-send-event`, asserts the frame changed (`qmp.py` is the QMP client) |
+| `real-image-boot.sh` | matched `rootfs.img` + `oem.img` | an ACTUAL flare-edge build (placed by `mkimage.sh --rootfs-image/--oem-image`) boots its own init chain to getty; binaries predating known fixes reproduce their bugs faithfully, a time machine for field issues |
+| watchdog (`run.sh --watchdog`) | - | arm `/dev/watchdog`, don't pet: the VM resets ~30 s later (verified) |

 Scenario fine print:

@@ -77,18 +77,18 @@ Scenario fine print:
  harness (ADR-0006 boundary); the VM exports `WARDEN_HARD_RESET=0` so
  flared's post-apply reset surfaces as a reported error, not a /dev/mem
  fault.
- Touch injection holds 200 ms — an instantaneous press+release lands inside
+- Touch injection holds 200 ms: an instantaneous press+release lands inside
  one LVGL poll and never clicks.
 - Watchdog + a flared payload don't mix: flared pets only while the UI
  heartbeat is fresh.

 ## Gotchas

- AF_UNIX socket paths cap at ~108 chars — keep `--rs485`/`--qmp` paths short.
+- AF_UNIX socket paths cap at ~108 chars; keep `--rs485`/`--qmp` paths short.
 - A serial port that is closed discards incoming bytes: hold ONE fd open
  across write and read when scripting the guest side of the RS485 bridge.
- `highmem=off` and `-global virtio-mmio.force-legacy=false` are load-bearing
-  (32-bit ECAM reach; virtio-1-only gpu/input) — both live ONLY in run.sh,
+- `highmem=off` and `-global virtio-mmio.force-legacy=false` are required
+  (32-bit ECAM reach; virtio-1-only gpu/input); both live ONLY in run.sh,
  which every script (boot smoke included) delegates to.
 - Never pass `earlyprintk`: DEBUG_UART_PHYS is the RV1106's 0xff4c0000.