docs(bgp-policy): re-point the cli.js anchors at the code they name #2086

Merged
jaylouisw merged 1 commit from docs/1119-0417 into main 2026-11-19 04:39:12 +00:00
Owner

docs/BGP-POLICY.md cites engine/cli.js by line in its "The anchors" table and twice again in §9. All eight cli.js pointers had rotted:

cited actually there is
cli.js:1581-1599 config-mode BGP dispatch 1605-1623 the router bgp / no router bgp / no neighbor / neighbor / bgp branches
cli.js:1597 _bgp(tokens.slice(1)) for neighbor 1621
cli.js:2633 _bgp(tokens) 2722 _bgp() definition
cli.js:2702 this._dnsZone 2791 the assignment in _dns(), the sticky-context precedent
cli.js:6914 _help() 6997 _help() definition
cli.js:998, :1198 % Incomplete command style 1538, 1652 ip dhcp pool <name> and ip name-server …

The bgp.js:, simulator.js: and test/ anchors in the same tables were re-checked line by line and are still exact, so no other number moved. No code touched: the code is right, the citations were not.

Gates: syntax-check 436 files OK; check-control-bytes clean; docs-show-commands 7/7 (59 forms, 118 commands, 74 refusals — unchanged); docs-cli-transcript 4/4; help-completeness 8/8 (102 advertised commands); no-form-help-key 81/81; doc-catalog-counts 43/43; doc-citations 11/11. check-doc-citations: 356 citations, 19 judged, 2 suspects before → 0 after.

`docs/BGP-POLICY.md` cites `engine/cli.js` by line in its "The anchors" table and twice again in §9. All eight cli.js pointers had rotted: | cited | actually there | is | |---|---|---| | `cli.js:1581-1599` config-mode BGP dispatch | 1605-1623 | the `router bgp` / `no router bgp` / `no neighbor` / `neighbor` / `bgp` branches | | `cli.js:1597` `_bgp(tokens.slice(1))` for `neighbor` | 1621 | | | `cli.js:2633` `_bgp(tokens)` | 2722 | `_bgp()` definition | | `cli.js:2702` `this._dnsZone` | 2791 | the assignment in `_dns()`, the sticky-context precedent | | `cli.js:6914` `_help()` | 6997 | `_help()` definition | | `cli.js:998`, `:1198` `% Incomplete command` style | 1538, 1652 | `ip dhcp pool <name>` and `ip name-server …` | The `bgp.js:`, `simulator.js:` and `test/` anchors in the same tables were re-checked line by line and are still exact, so no other number moved. No code touched: the code is right, the citations were not. Gates: `syntax-check` 436 files OK; `check-control-bytes` clean; `docs-show-commands` 7/7 (59 forms, 118 commands, 74 refusals — unchanged); `docs-cli-transcript` 4/4; `help-completeness` 8/8 (102 advertised commands); `no-form-help-key` 81/81; `doc-catalog-counts` 43/43; `doc-citations` 11/11. `check-doc-citations`: 356 citations, 19 judged, **2 suspects before → 0 after**.
docs(bgp-policy): the anchor table points at the code it names again
All checks were successful
CI / Classify the change (pull_request) Successful in 11s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 10s
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 58s
CI / Test (Node 22) (pull_request) Successful in 1m1s
CI / Test (Node 18) (pull_request) Successful in 1m5s
CI / Arm auto-merge (pull_request) Successful in 3s
cb0a974f3a
The 'The anchors' table and the two inline references in §9 cite engine/cli.js by
line, and cli.js has grown since they were written: every one of the eight
pointed at something else.

  cli.js:1581-1599 config-mode BGP dispatch -> 1605-1623 (router bgp /
      no router bgp / no neighbor / neighbor / bgp branches)
  cli.js:1597 the neighbor -> _bgp(tokens.slice(1)) route -> 1621
  cli.js:2633 _bgp(tokens)                    -> 2722
  cli.js:2702 this._dnsZone sticky context    -> 2791 (the assignment in _dns())
  cli.js:6914 _help()                         -> 6997
  cli.js:998 / :1198 % Incomplete command examples -> 1538 (ip dhcp pool)
      and 1652 (ip name-server), the two config-mode lines that carry the shape

The bgp.js, simulator.js and test/ anchors in the same tables were re-checked and
are still exact, so only the cli.js citations moved. check-doc-citations now
reports 0 suspects (it judged 19 of 356 citations); before this it named both
cli.js:6914 rows as 83 lines off _help().
forgejo-actions scheduled this pull request to auto merge when all checks succeed 2026-11-19 04:30:29 +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!2086
No description provided.