From 22d2e1ae78ee7d3e028a70b063bd90fd1be5101d Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Sun, 1 Nov 2026 09:34:48 -0800 Subject: [PATCH] docs: fix the nix attribute names and paths the one flake renamed Only the commands and paths that named an attribute or file of the old flakes: the kde source filter list (nix/linux/root-crates.json), the Windows drift check (windows-default), the KWin effect install checks (linux-*-install), the module evaluation check on a Mac and the VM suites (legacyPackages..vm.NAME, which are also the heavyChecks for now), and the Windows e2e agent package (windows-komorebi-e2e-agent). docs/dev/flake.md has the full table. The history in docs/dev/unified-binaries.md keeps the names of the time it describes. On the rebase onto wip-cutover-all the coordinator edits of ARCHITECTURE-UNIFIED.md were kept and these two lines applied on top. Verified: not run (documentation). --- docs/dev/ARCHITECTURE-UNIFIED.md | 4 ++-- docs/linux/CONTRIBUTING.md | 6 +++--- docs/linux/dev/PLATFORM.md | 2 +- docs/linux/dev/vm-tests.md | 6 +++--- e2e/platforms/qemu_windows/README.md | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/dev/ARCHITECTURE-UNIFIED.md b/docs/dev/ARCHITECTURE-UNIFIED.md index cde55233..99e8946d 100644 --- a/docs/dev/ARCHITECTURE-UNIFIED.md +++ b/docs/dev/ARCHITECTURE-UNIFIED.md @@ -97,7 +97,7 @@ These are intentional, not leftovers; before "unifying" one, read the document n | Bar schema views | `schemas/windows/schema.bar.json`, `schemas/macos/schema.bar.json`; `crates/komorebi-bar-core/tests/schema_oracle.rs` pins size and hash; `komorebi-bar --schema` prints the view of the target OS | a changed bar configuration | `cargo test -p komorebi-bar-core`; Windows e2e scenario `bar` compares `--schema` byte for byte | | CLI docs | `docs/cli`, `docs/linux/cli`, `docs/macos/cli`; `crates/komorebic-core/tests/docs_cli.rs` and `platforms.rs` | a changed subcommand or help text | `cargo test -p komorebic-core`; `komorebic docgen --output DIR` regenerates | | Schema docs completeness | `check_schema_docs.py` (root; the macOS copy is archived in `docs/dev/old-ci/macos/`) | schema entries with no description | by hand | -| Drift of derivations | `nix eval .#packages.x86_64-linux.default.drvPath` and the check derivations | an unintended change of what nix builds | by hand (see build-and-test.md) | +| Drift of derivations | `nix eval .#packages.x86_64-linux.windows-default.drvPath` and the check derivations | an unintended change of what nix builds | by hand (see build-and-test.md) | | Backend contract | `komorebi-backend/src/contract.rs` | a backend that breaks a rule of the trait | `cargo test -p komorebi-backend` and each daemon's tests | | Runtime | Windows e2e (QEMU), KDE VM suites | real behaviour | tier 3 below | @@ -155,7 +155,7 @@ left out. The table is the original assessment. |---|---|---| | `fast-check` (+ its README) | runs only the checks that the touched paths need (tier 1 and 2), with persistent target dirs | yes: it is the quickest way to get the right gate for a change; needs its scratch paths made configurable (`FAST_CHECK_SCRATCH`, already an env var) | | `mac-check.sh` | macOS type-check through a fake C compiler | yes, merged into `fast-check` (it has hard-coded paths to a workspace) | -| `kde-closure-check` | fails when `nix/linux/root-crates.json` and the KDE cargo closure differ (the script in `tools/` still reads the old path `komorebi-for-kde/nix/root-crates.json`) | yes: it protects the KDE source filter; run after any dependency change in the KDE tree or the crates it uses | +| `kde-closure-check` | fails when `nix/linux/root-crates.json` and the KDE cargo closure differ | yes: it protects the KDE source filter; run after any dependency change in the KDE tree or the crates it uses | | `lite-env` | env vars for builds without debug info | optional (one `.env` file) | | `gate-lock` | host-wide FIFO lock so heavy gates and timing-sensitive e2e do not overlap | host policy; commit only if more than one person shares a build host | | `e2e-needed` | says whether a diff touches anything the Windows e2e binaries are built from (decides whether the e2e gate is owed) | yes, next to `fast-check` | diff --git a/docs/linux/CONTRIBUTING.md b/docs/linux/CONTRIBUTING.md index 662dcd47..999fae0f 100644 --- a/docs/linux/CONTRIBUTING.md +++ b/docs/linux/CONTRIBUTING.md @@ -68,7 +68,7 @@ with a scenario in [`nix/linux/tests/nixos-module.nix`](../../nix/linux/tests/ni the `nixos-module-eval` check: each scenario is a real NixOS system that is evaluated and never built, and its checks read the assertions, the unit and the options it evaluates to. It runs on a Mac too, with `nix build -.#checks.aarch64-darwin.nixos-module-eval`. A change to what the unit does in a +.#legacyPackages.aarch64-darwin.heavyChecks.linux-nixos-module-eval`. A change to what the unit does in a session also changes the VM suite `module`, which logs in to Plasma on a machine with the module and checks the daemon the unit runs. Every other VM suite runs on machines built with the module too. @@ -138,8 +138,8 @@ and checks the files it installs, and for a patched package that the patch is in them: ```sh -nix build .#checks.x86_64-linux.kde-rounded-corners-komorebi-install -nix build .#checks.x86_64-linux.kwin-effect-geometry-change-komorebi-install +nix build .#checks.x86_64-linux.linux-kde-rounded-corners-komorebi-install +nix build .#checks.x86_64-linux.linux-kwin-effect-geometry-change-komorebi-install ``` ## Plasma guests to develop in diff --git a/docs/linux/dev/PLATFORM.md b/docs/linux/dev/PLATFORM.md index 1e019b02..e691b6af 100644 --- a/docs/linux/dev/PLATFORM.md +++ b/docs/linux/dev/PLATFORM.md @@ -876,7 +876,7 @@ RDP](#rendering-in-virtual-machines-and-over-rdp). Measured on 2026-10-28 on the machine `run-kde` is written for: Windows 11, a Ryzen 9 5900X (24 threads for WSL 2), 31 GB of memory for WSL 2, NixOS-WSL with `nestedVirtualization=true` and `/dev/kvm` writable by the build users, so the suites ran under KVM inside Hyper-V. These are the -wall times of `nix build .#checks.x86_64-linux.vm-NAME` from a warm store, the boot of the machine +wall times of `nix build .#legacyPackages.x86_64-linux.vm.NAME` from a warm store, the boot of the machine included. Another VM was running for some of the non-timing suites, and none was for the timing ones. diff --git a/docs/linux/dev/vm-tests.md b/docs/linux/dev/vm-tests.md index d5164e7b..b4c09f6d 100644 --- a/docs/linux/dev/vm-tests.md +++ b/docs/linux/dev/vm-tests.md @@ -9,7 +9,7 @@ they are laid out, how to run them, and how to add one. | Where | How | Accelerator | |---|---|---| -| CI, `x86_64-linux` | `nix build -L .#checks.x86_64-linux.vm-NAME` | KVM | +| CI, `x86_64-linux` | `nix build -L .#legacyPackages.x86_64-linux.vm.NAME` | KVM | | CI, `x86_64-linux`, the weekly canary | the same, with nixpkgs moved to the tip of nixpkgs-unstable | KVM | | A Linux machine with KVM | `just vm NAME` | KVM | | A Mac | `just vm NAME`, which runs `scripts/linux/vm-mac` | HVF | @@ -394,7 +394,7 @@ the fake and fails on KDE has found a bug in the fake, the library or the daemon the test: ```sh - E2E_ONLY=stacks,monocle nix build --impure .#checks.x86_64-linux.vm-core-e2e -L + E2E_ONLY=stacks,monocle nix build --impure .#legacyPackages.x86_64-linux.vm.core-e2e -L ``` A step that is left out returns `None`, so a suite that uses what a step returned must run that @@ -407,7 +407,7 @@ it builds it elsewhere and passes the store path, evaluating with `--impure`: ```sh KOMOREBI_RECORDER=$(nix build ~/komorebi-recorder#komorebi-recorder --no-link --print-out-paths) \ - nix build --impure .#checks.x86_64-linux.vm-core-lock -L + nix build --impure .#legacyPackages.x86_64-linux.vm.core-lock -L ``` `core-e2e` and `core-lock` then record the session without video (`komorebi_vm.recorder`), print diff --git a/e2e/platforms/qemu_windows/README.md b/e2e/platforms/qemu_windows/README.md index 52f546dc..dfe45e19 100644 --- a/e2e/platforms/qemu_windows/README.md +++ b/e2e/platforms/qemu_windows/README.md @@ -22,7 +22,7 @@ when the agent needs more in the image, or when the 90-day evaluation runs out (about 20 minutes, more under load): ```sh -nix build .#komorebi-e2e-agent -o agent +nix build .#windows-komorebi-e2e-agent -o agent build-base.sh win11.iso agent/bin/komorebi-e2e-agent.exe base ```