docs: say what <spaceKey> is in the upgrade recipe - #1602
Conversation
…path An operator substituting the plain space name gets a path that does not exist. Measured: with the file absent the offset reads 0 and the wait burns its full timeout before saying anything, so it fails loudly rather than false-passing, but a 60 second silence on a typo is avoidable. spaceKey is lowercase hex of the name's UTF-8 bytes (auth-paths.ts:47), which exists so that `alpha` and `Alpha` cannot alias on a case-insensitive filesystem. The worked example was produced by calling the product's own spaceKey rather than by reimplementing it: prod -> 70726f64, with a second name checked to confirm the reader discriminates. `cotal up` already prints the real path on its launch line (up.ts:1942), so the page now points there instead of leaving the reader to guess. Flagged as non-blocking in review of #1588; fixed rather than noted. Refs #1578
c2e1ea2 to
4910a8d
Compare
|
This PR explains a placeholder that should not be in the recipe at all. Measured in source: the manager log has no I merged #1588, so this defect is mine as much as anyone's. It is on What the code doesThe detached manager log is opened in exactly one place, with a constant name and no space segment:
That is corroborated by the reserved-children list, which carries the literal name as a canonical sibling: Where
|
|
Correction to my comment above. It read One small thing left in the PR body, not in the diff: it says the section watches |
Follow-up to #1588, which added
docs/UPGRADING.md. A reviewer on that PR flagged this as non-blocking; fixing it rather than noting it.The defect
The 0.48.2 to 0.49.0 section tells an operator to watch the manager log at
.cotal/auth/<spaceKey>/manager.log. It never said what<spaceKey>is, and theobvious substitution is wrong.
<spaceKey>is not the space name. It is lowercase hex of the name's UTF-8 bytes(
auth-paths.ts:47), which exists soalphaandAlphacannot alias on acase-insensitive filesystem.
What an operator hits today
Measured, not reasoned: with the file absent the offset capture reads 0 and the
wait burns its full 60 second timeout before saying anything.
So it fails loudly rather than passing falsely, which is why this is a follow-up
and not a blocker on the page itself. A minute of silence on a typo is still
avoidable.
The fix
Five lines in the existing step, plus the regenerated bundle.
The worked example was produced by calling the product's own
spaceKeyratherthan reimplementing it:
A second name was checked to confirm the reader discriminates rather than
returning a constant.
The page now also points at the launch line, because
cotal upalready printsthe real path (
up.ts:1942). Reading it beats deriving it.Scope
Two files: the page and the regenerated docs bundle. The bundle is generated,
never hand-edited; each added page line appears in it once, verified.
No other section changes. Nothing in the 0.49.0 answer set moves.
Refs #1578