docs(CLI): the help-coverage guard types 102 rows, not the 100 the page quotes #1875
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!1875
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "docs/1117-1716"
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?
What was untrue
docs/CLI.md, sectionhelpis an index, and a test reads it out of the parser, said the hand-written list intest/help-completeness.test.jsholds 100 rows: "Every row in it is typed at a real device and must be accepted - 100 of them now".The list holds 102. The count was last set in
d00d312c(98 -> 100) whenlease infinitesplit the pool row (#1776). Since then79a6cc94(#1869) added two rows -['ip routing', 'config', ROUTER]and['no ip routing', 'config', ROUTER]- and the guard has printed 102 ever since.Evidence from the code
node test/help-completeness.test.jsprints102 advertised commands are all accepted, where the number isadvertised.length(test/help-completeness.test.js:288).^\s*\[rows inside theconst advertised = [...]literal gives 102, the twoip routingrows included.engine/cli.js:563carries the verb ({ modes: ['config'], match: ['ip', 'routing'], syntax: 'no ip routing', ... }) andengine/cli.js:6042lists it inhelp, so the rows are real commands, not doc rows ahead of the parser.What changed
One sentence: 100 to 102, with the two rows named and their PR (#1869), plus a clause saying the number is a reading because the guard prints it.
Guards (before / after)
node scripts/syntax-check.js- 391 files OK / 391 files OKnode scripts/check-control-bytes.js- clean / cleantest/docs-show-commands.test.js) - 7 passed / 7 passed (54 forms, 108 commands, 66 refusals)test/docs-cli-transcript.test.js) - 4 passed / 4 passedtest/help-completeness.test.js) - 8 passed / 8 passed (102 advertised rows typed)Docs-only diff; no engine or test file touched.
a2b4d21e9021b321d4b4