docs(CLI): the two cli.js anchors point at the code that holds them again #2023

Merged
jaylouisw merged 1 commit from docs/1118-1947 into main 2026-11-18 20:08:13 +00:00
Owner

Both line citations in docs/CLI.md had been overtaken by code that landed above them.

converge passage - cites engine/cli.js:6389-6391 as the help index row that taught only the at form. Lines 6389-6391 are now the IPv6 running-config printer; the index row is engine/cli.js:6765 (converge [<ms> | at <ms>] - when each control plane finishes).

VRRP no passage - cites _ifaceMode() at engine/cli.js:1917-2028. 1917 is a closing brace and 1924 is _portReservesSubnet(); _ifaceMode(tokens) is defined at 1956 and the no vrrp branch it describes ends at 2069.

Re-verified against the engine: converge, converge at 10000 and converge 10000 are accepted, and converge 1000 wibble, converge at, converge wibble and converge -5 print exactly the lines the page quotes.

Gates: node scripts/syntax-check.js 421 files OK; docs-cli-transcript 4/4, docs-show-commands 7/7 (59 forms, 118 commands, 74 refusals), help-completeness 8/8 (102 rows), help-key-works-in-every-prompt 10/10, check-doc-citations 354 citations, 0 suspects.

Both line citations in `docs/CLI.md` had been overtaken by code that landed above them. **`converge` passage** - cites `engine/cli.js:6389-6391` as the `help` index row that taught only the `at` form. Lines 6389-6391 are now the IPv6 running-config printer; the index row is `engine/cli.js:6765` (`converge [<ms> | at <ms>] - when each control plane finishes`). **VRRP `no` passage** - cites `_ifaceMode()` at `engine/cli.js:1917-2028`. 1917 is a closing brace and 1924 is `_portReservesSubnet()`; `_ifaceMode(tokens)` is defined at 1956 and the `no vrrp` branch it describes ends at 2069. Re-verified against the engine: `converge`, `converge at 10000` and `converge 10000` are accepted, and `converge 1000 wibble`, `converge at`, `converge wibble` and `converge -5` print exactly the lines the page quotes. Gates: `node scripts/syntax-check.js` 421 files OK; docs-cli-transcript 4/4, docs-show-commands 7/7 (59 forms, 118 commands, 74 refusals), help-completeness 8/8 (102 rows), help-key-works-in-every-prompt 10/10, check-doc-citations 354 citations, 0 suspects.
docs(CLI): the two cli.js anchors point at the code that holds them again
All checks were successful
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 4s
CI / Classify the change (pull_request) Successful in 5s
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Test (Node 20) (pull_request) Successful in 52s
CI / Test (Node 22) (pull_request) Successful in 54s
CI / Test (Node 18) (pull_request) Successful in 58s
CI / Arm auto-merge (pull_request) Successful in 32s
6b8ba6b940
Both citations in docs/CLI.md had been overtaken by code that landed above them:

* the converge passage cites `engine/cli.js:6389-6391` as the `help` index row that
  taught only `converge at <ms>`. Those lines are now the IPv6 running-config printer;
  the index row lives at `engine/cli.js:6765` and names both forms.
* the VRRP `no` passage cites `_ifaceMode()` at `engine/cli.js:1917-2028`. Line 1917
  is the closing brace of another method and 1924 is `_portReservesSubnet()`; the
  handler starts at 1956 and its `no vrrp` branch ends at 2069.

Verified against engine/cli.js: `converge` accepts both spellings and refuses
`1000 wibble`, `at`, `wibble` and `-5` exactly as the page says.
forgejo-actions scheduled this pull request to auto merge when all checks succeed 2026-11-18 20:00:22 +00:00
jaylouisw deleted branch docs/1118-1947 2026-11-18 20:08:15 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jaylouisw/packetforge!2023
No description provided.