docs: name options by the path an operator can set, not by cfg.*
`cfg` is whatever the reading module bound it to. It does not exist in a NixOS configuration, so a sentence naming an option as `cfg.<name>` is correct about behaviour and unusable as an instruction — the reader has to go find the real path. The four sites in docs/networking/gateway.md this was filed for: cfg.sshPort -> services.hyperhive.swarm.forge.sshPort cfg.dashboardPort -> services.hyperhive.c0re.dashboardPort cfg.frontend (x2) -> services.hyperhive.c0re.frontend Sweeping docs/ for the pattern rather than the ticket's line numbers found five more, in four other files: approvals.md cfg.hyperhiveFlake -> services.hyperhive.c0re.hyperhiveFlake matrix.md cfg.registrationTokenFile -> services.hyperhive.deploy.matrix.registrationTokenFile matrix.md cfg.gatewayHost -> services.hyperhive.swarm.matrix.gatewayHost conventions.md cfg.dashboardPort -> services.hyperhive.c0re.dashboardPort gotchas.md cfg.dashboardPort -> services.hyperhive.c0re.dashboardPort matrix.md is the clearest case for doing this at all: its two `cfg.` references resolve to *different* option trees — `deploy.matrix` and `swarm.matrix` — so the shorthand is ambiguous even within one file. Each path is read off the `mkOption` that declares it plus the `options.services.hyperhive.*` root it sits under, with the indentation checked so a nested block cannot have been missed. `cfg.frontend` is declared in hive-c0re, not the gateway: the gateway module binds `cfg = config.services.hyperhive.gateway`, which has no `frontend`. Deliberately unchanged: docs/networking/snapshot-store.md:136, where `cfg.port` sits inside a ```nix block quoting module source. `cfg` is correct there, and rewriting it would make the snippet wrong. Closes #4193.
This commit is contained in:
parent
f918cea957
commit
3f878408f0
5 changed files with 10 additions and 9 deletions
|
|
@ -11,7 +11,7 @@ exist because something already went wrong without them.
|
|||
- `MAX_AGENT_NAME` in `hive-c0re/src/lifecycle/mod.rs` enforces the cap.
|
||||
- Per-agent web UI port = `WEB_PORT_BASE + FNV1a(name) % WEB_PORT_RANGE`
|
||||
(8100..8999) for every agent; dashboard
|
||||
`cfg.dashboardPort` (default 7000).
|
||||
`services.hyperhive.c0re.dashboardPort` (default 7000).
|
||||
|
||||
## Hive identity (label + domain + display names)
|
||||
|
||||
|
|
|
|||
|
|
@ -193,7 +193,7 @@ agent (different hash → different port) and rebuilding. No state
|
|||
file, no probing, no port-allocation drift — the value is
|
||||
reproducible from just the name. Every agent hashes into
|
||||
8100..8999 via the same FNV-1a; dashboard
|
||||
at `cfg.dashboardPort` (default 7000).
|
||||
at `services.hyperhive.c0re.dashboardPort` (default 7000).
|
||||
|
||||
### Restart races on TCP bind
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue