docs: five citations refreshed to the lines the code is on, and a call-site citation is no longer called stale #1664
No reviewers
Labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
jaylouisw/packetforge!1664
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "fix/1116-1235"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Closes no issue: the open queue is 21 device requests plus #1507 (a host decision for Jay), and this is the #1481 class - a citation that points at code which has moved.
Five stale line numbers, refreshed.
node scripts/check-doc-citations.jsreported seven suspects; five were real, and each new number was checked against the symbol before committing:_help()_help()openFlow()_deliver()serialize()setLinkLength()The seventh was the checker lying. docs/BGP-POLICY.md cites
test/bgp.test.js:452while namingmkPath(), and 452 is the line that calls mkPath() - defined at 49.judgeLine()only compared a citation to the definition, so a correct pointer was reported as "403 lines from mkPath() at line 49" on every run, and--strictcould never pass. A citation whose cited range calls the symbol it names is now judged correct; a range that calls nothing still has to be within the 40-line drift window, so the check is not blunted.test/doc-citations.test.jspins it: call-site accepted at 600 lines from the definition, no-call still a suspect at 590 lines, inside-drift and definition-line accepted, and the real BGP-POLICY citation judged against the real file.Gates: syntax-check 350 files OK; check-control-bytes clean; check-doc-citations 351 citations, 16 judged, 0 suspects; test/doc-citations.test.js 11 passed; scripts/run-tests.js 280 suites, 9926 assertions, 1 failure -
test/ping-count.test.js, which passes alone and is a concurrency artefact of--concurrency=4(CI runs the default serial).03377e5cbad671d9e4c2