docs: point the known-gaps list at the TODO folder, and un-stale its first item

Item 1 said the broker reads none of the container or pointer configuration.
That was true and is not: the settings are parsed beside Policy and a switched-off
container host reports itself unavailable with the key named. The item now
records what actually matters about it -- that containers are off on the
deployment machine because no window can be put in one -- and the section links
docs/TODO/, where each open problem has its impact written down.

The TODO folder itself landed in the previous commit by accident (a `git add -A
docs` swept it in with the scroll work); this commit only makes it findable.
This commit is contained in:
Hermenix committed 2026-10-03 19:06:17 +00:00
1 parent 6b395305e0
commit 7e0544ed70
2 files changed
+18 -13

No files matched your search

+12 -13
View File
@@ -268,20 +268,19 @@ is below. These are defects in code this branch does not own; they are recorded
here because the checks are written against the contract and therefore trip
over them.
1. **The broker reads none of the container or pointer configuration.**
`nix/module.nix` renders `sessions.containers.{max,mode,workspaceBase}` and
`sessions.pointer.{leaseTtl,leaseMax}` into the generated TOML as PLAN §10
names them, and `hhstreamd/policy.py:policy_from_dict` reads only
`[defaults]` and `[apps]`. `hhstreamd/__main__.py:serve` builds its
`ManagerConfig` from command-line flags that have no counterpart for any of
those numbers either, so the broker runs on its own defaults (band 1000,
4 slots, 1280x720, lease 30 s / 300 s).
The deep versions of these — the issue, more than one idea, and why each one
matters — live in [`docs/TODO/`](docs/TODO/README.md). Update the file there
when one closes, so this list stays a description of what is still true.
Those defaults agree with the module's, so a deployment that leaves the
options alone behaves as documented; one that changes them is ignored.
`vm-pointer` prints the module's `leaseTtl` beside the TTL the broker
reports, so the discrepancy is visible in the build log rather than
inferred. The fix is in `policy.py` and `__main__.py`, not here.
1. **The container host can be switched off, and the broker now honours it.**
*(This item previously read "the broker reads none of the container or
pointer configuration." That is fixed: `policy.py` parses those settings
beside `Policy`, read in `__main__`, and a host that is switched off reports
itself unavailable with the reason naming the key — so a disabled machine
cannot be mistaken for one whose compositor is down. The reason it matters is
what follows.)* Containers are consequently **off on the deployment machine**:
no window can be put in one yet, and enabling them quarantines every
allowlisted app. That join is the first item in `docs/TODO/`.
2. **`session start --no-container` is refused, not honoured.** PLAN §9 lists
the flag; `docs/CONTRACT-sessions.md` §4 leaves `start` unchanged, and
+6
View File
@@ -21,6 +21,12 @@ machine cannot be mistaken for one whose compositor is down.
## Ideas
0. **This is already recorded from the other side**, in `README.dev.md` item 4:
a window rule only binds for an application that reads the environment, and
the fix proposed there is a per-app `--app-id` in the allowlist — a policy
change. Idea 1 below sidesteps the question instead of answering it, because
it needs nothing from the application at all.
1. **Adopt windows by the pid the compositor already reports.** *(recommended)*
`hyprctl clients -j` gives each client's pid, and the broker already knows each
session's pid — so the join is a lookup, and **no app has to take part**. No