From 443efd8da87bf670c85fc5b42ec01b8346b99ea5 Mon Sep 17 00:00:00 2001 From: Hermenix Date: Sun, 11 Oct 2026 03:06:08 +0000 Subject: [PATCH] docs(dev): register vm-keyboard and vm-keyboard-de where a reader looks MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The keyboard checks were in `README.dev.md`'s `checks/` layout listing and nowhere else: not in the table of what each check proves, and not in the one-at-a-time `nix build -L` list that the same section tells you to use instead of `nix flake check`. So the two checks this branch adds were invisible exactly where someone goes to find out what is gated and how to run it, while `vm-stream-firewall` (from main) was in all three places. Four lines, no behaviour. The table rows state what each run actually asserts, taken from `checks/vm-keyboard.nix`'s header and its `expectations` attrset rather than paraphrased: * `vm-keyboard` -- the uploaded keymap reaching a real compositor, `pointer acquire` leaving the aimed window holding the keyboard and not merely the cursor, and `hhs-keyboard-target` decoding `hello` from the keymap it was forwarded. The mutation is named, because it is the point of the victim decoding rather than counting keycodes: a driver that stopped uploading a keymap leaves every key arriving as `sym=?`. * `vm-keyboard-de` -- why one file is exposed twice, which is that `sessions.keyboard.layout` reaches the keymap only through `--xkb-layout` on the driver unit and a single-layout run cannot tell that path from a hardcoded `us`. The three differences it pins: keysym `y`'s evdev code (21 against 44), the forwarded `symbols=` name, and `ü` going from exit 2 to `udiaeresis`. Both rows say `yes` under "Needs a VM", and the build lines sit between `vm-pointer` and `vm-stream-firewall` so the list keeps the order the layout listing and `checks/default.nix` already use. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01PjpHyir6hxyjdw2o1RwQmn --- README.dev.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.dev.md b/README.dev.md index 714dd1f..d56722a 100644 --- a/README.dev.md +++ b/README.dev.md @@ -48,6 +48,8 @@ and the pointer driver. | `vm-ipc` | the **compositor's IPC**: both sockets exist at the names `docs/CONTRACT-sessions.md` §5 freezes and fit inside `sun_path`, `hyprctl` answers, the broker's own `HyprlandIPC` reaches it, and a subscriber on the **event** socket receives an `openwindow` for a window the test creates | yes | | `vm-containers` | one `hh-*` output per session at the container mode, the application's window on it, a second window of the same application beside it, an unmatched window **quarantined**, `grim -o` capturing that container alone, and teardown removing the output and freeing its workspace slot | yes | | `vm-pointer` | the **lease and the driver**: a version-2 virtual pointer, a warp that lands where it was aimed *as the application reports it*, a click delivered as one press and one release, a contended acquire refused with BUSY, an expired lease swept with its held button lifted, and a broker restart that leaves the lock free, the bookmark intact and the driver reachable | yes | +| `vm-keyboard` | the **keymap, the focus and a decoded symbol**: the keymap the driver uploads reaching a real compositor, `pointer acquire` leaving the aimed window holding the *keyboard* and not merely the cursor, and `hhs-keyboard-target` decoding `hello` from the keymap it was **forwarded** — so a driver that stopped uploading one arrives as `sym=?` and goes red | yes | +| `vm-keyboard-de` | the same file with `sessions.keyboard.layout = "de"`, because that option reaches the uploaded keymap through exactly one path — `--xkb-layout` on the driver unit — and a single-layout check cannot tell that path from a hardcoded `us`: keysym `y`'s evdev code swaps (21 against 44), the forwarded `symbols=` name with it, and `ü` goes from exit 2 to `udiaeresis` | yes | | `vm-stream-firewall` | the stream's **port**: the guest's own running firewall accepts the configured port and not the module's default, a peer outside the guest reaches it, and is refused on a port beside it that was never opened | yes | All of them at once: @@ -70,6 +72,8 @@ nix build -L .#checks.x86_64-linux.vm-sessions nix build -L .#checks.x86_64-linux.vm-ipc nix build -L .#checks.x86_64-linux.vm-containers nix build -L .#checks.x86_64-linux.vm-pointer +nix build -L .#checks.x86_64-linux.vm-keyboard +nix build -L .#checks.x86_64-linux.vm-keyboard-de nix build -L .#checks.x86_64-linux.vm-stream-firewall ```