docs(simulation): the LAG table cites the DNS resolver and the BGP candidates #2303

Merged
jaylouisw merged 1 commit from docs/1120-1917 into main 2026-11-20 19:38:04 +00:00
Owner

What was untrue

docs/SIMULATION.md §2.3 (Link aggregation) carried the line numbers engine/lag.js and engine/simulator.js had when #2024 wrote the table. Every anchor has since moved:

row cited what is actually there now
LAG hashing engine/simulator.js:2024-2045, engine/lag.js:232 BGP candidate bookkeeping; hashFrame()'s fnv1a() call
hash policies engine/lag.js:197 inside fnv1a()
STP one edge per bundle engine/simulator.js:315-334 the DNS resolver's A-record loop
no hairpin engine/simulator.js:1970 BGP connected-prefix origination
mode engine/lag.js:313-322/346/87 carryingMembers(), negotiationVerdict() body, bundleIdFromName()
minLinks engine/lag.js:64-67 portChannelIfaceName()
eight active links engine/lag.js:81-89 bundleIdFromName()

Evidence from the code

  • selectMember() — engine/lag.js:264; called at engine/simulator.js:3707 beside the lag event (:3712).
  • HASH_POLICIES engine/lag.js:94, fnv1a() :194, hashFrame() :229.
  • computeStp() groups members under _logicalPortName() — engine/simulator.js:907-919.
  • _egressRefusal() answers 'bundle' (no hairpin) — engine/simulator.js:3758-3763.
  • negotiationVerdict() :345, memberSuspension() :378, maxMembers() :119, minLinks normalisation :154-160, MAX_ACTIVE_LINKS :113 with carryingMembers() :284, activeMembers() :300, standbyMembers() :305.

No prose claim changed; only the anchors, and each now names the symbol so the next move is findable.

Guards

  • node scripts/syntax-check.js — 494 files, all OK.
  • scripts/check-doc-citations.js — before 361 citations / 22 judged / 2 suspects; after 364 / 23 / 2 (the two suspects are the pre-existing docs/BGP-POLICY.md:77,827 42-line drift).
  • test/docs-show-commands.test.js 7 passed; test/docs-cli-transcript.test.js 9 passed; test/help-completeness.test.js 8 passed; help-key-is-not-a-value 40, no-form-help-key 81; doc-catalog-counts 43; check-control-bytes clean.

Not done

The two docs/BGP-POLICY.md _help() suspects were left alone — separate page, separate item.

## What was untrue `docs/SIMULATION.md` §2.3 (Link aggregation) carried the line numbers `engine/lag.js` and `engine/simulator.js` had when #2024 wrote the table. Every anchor has since moved: | row | cited | what is actually there now | |---|---|---| | LAG hashing | `engine/simulator.js:2024-2045`, `engine/lag.js:232` | BGP candidate bookkeeping; `hashFrame()`'s `fnv1a()` call | | hash policies | `engine/lag.js:197` | inside `fnv1a()` | | STP one edge per bundle | `engine/simulator.js:315-334` | the DNS resolver's A-record loop | | no hairpin | `engine/simulator.js:1970` | BGP connected-prefix origination | | `mode` | `engine/lag.js:313-322/346/87` | `carryingMembers()`, `negotiationVerdict()` body, `bundleIdFromName()` | | `minLinks` | `engine/lag.js:64-67` | `portChannelIfaceName()` | | eight active links | `engine/lag.js:81-89` | `bundleIdFromName()` | ## Evidence from the code - `selectMember()` — `engine/lag.js:264`; called at `engine/simulator.js:3707` beside the `lag` event (`:3712`). - `HASH_POLICIES` `engine/lag.js:94`, `fnv1a()` `:194`, `hashFrame()` `:229`. - `computeStp()` groups members under `_logicalPortName()` — `engine/simulator.js:907-919`. - `_egressRefusal()` answers `'bundle'` (no hairpin) — `engine/simulator.js:3758-3763`. - `negotiationVerdict()` `:345`, `memberSuspension()` `:378`, `maxMembers()` `:119`, `minLinks` normalisation `:154-160`, `MAX_ACTIVE_LINKS` `:113` with `carryingMembers()` `:284`, `activeMembers()` `:300`, `standbyMembers()` `:305`. No prose claim changed; only the anchors, and each now names the symbol so the next move is findable. ## Guards - `node scripts/syntax-check.js` — 494 files, all OK. - `scripts/check-doc-citations.js` — before 361 citations / 22 judged / 2 suspects; after 364 / 23 / 2 (the two suspects are the pre-existing `docs/BGP-POLICY.md:77,827` 42-line drift). - `test/docs-show-commands.test.js` 7 passed; `test/docs-cli-transcript.test.js` 9 passed; `test/help-completeness.test.js` 8 passed; `help-key-is-not-a-value` 40, `no-form-help-key` 81; `doc-catalog-counts` 43; `check-control-bytes` clean. ## Not done The two `docs/BGP-POLICY.md` `_help()` suspects were left alone — separate page, separate item.
docs(simulation): the LAG table cites the DNS resolver and the BGP candidates
All checks were successful
CI / Classify the change (pull_request) Successful in 23s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 25s
CI / Server smoke and Docker build (pull_request) Has been skipped
CI / Test (Node 22) (pull_request) Successful in 1m7s
CI / Test (Node 20) (pull_request) Successful in 1m9s
CI / Test (Node 18) (pull_request) Successful in 1m13s
CI / Arm auto-merge (pull_request) Successful in 5s
46d15bbc74
docs/SIMULATION.md §2.3 cited the line numbers engine/lag.js and
engine/simulator.js carried when #2024 wrote the table. Later commits inserted
code above every anchor, so the citations now point at unrelated code:
engine/simulator.js:2024-2045 is BGP candidate bookkeeping, engine/simulator.js
315-334 is the DNS resolver and 1970 is BGP prefix origination, and
engine/lag.js:64-67 is portChannelIfaceName(), not the minLinks normalisation.

Each citation now names the symbol and its current line: selectMember() at
lag.js:264, called from simulator.js:3704-3717 with the lag event;
HASH_POLICIES/fnv1a()/hashFrame() at lag.js:94/194/229; computeStp()'s LAG
grouping at simulator.js:907-919; _egressRefusal()'s bundle answer at
3758-3763; negotiationVerdict()/memberSuspension()/maxMembers() at
lag.js:345/378/119; minLinks at 154-160; MAX_ACTIVE_LINKS with
carryingMembers()/activeMembers()/standbyMembers() at 113/284/300/305.
forgejo-actions scheduled this pull request to auto merge when all checks succeed 2026-11-20 19:23:17 +00:00
jaylouisw deleted branch docs/1120-1917 2026-11-20 19:38:06 +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!2303
No description provided.