CLI.md: a deleted-VLAN port is reported on its own line, not under a view the console does not have #1587

Closed
jaylouisw wants to merge 1 commit from docs/1116-0245 into main
Owner

docs/CLI.md told the reader that after a VLAN is deleted, the device lists its ports under show interfaces status inactive. There is no such view.

Evidence from the code � engine/cli.js (interface-view keywords, #1443/#1449) refuses the phrase by name:

% `status inactive` is a view, not a port: this console has no `show interfaces status inactive`. `show interfaces` prints every port status and protocol, one block each.

What the engine actually does � reproduced on an Aruba 2530-48:

sw1(config)# no vlan 22
VLAN 22 removed
1 is now inactive: its access VLAN no longer exists (vlan 22 brings it back)
sw1# show interfaces 1
1 (ethernet, 100M), MAC 02:00:00:00:00:00
  status: down (inactive), protocol: down

The inactive state is on the port's own line in show interfaces � which is what the paragraph now says.

The invented form was also a promise the page never kept: every backticked show in docs/CLI.md is typed by test/docs-show-commands.test.js, and it passed only because the answer is a legitimate refusal (a device fact), not a syntax complaint. That is exactly the blind spot this one slipped through. Removing the form returns the page to the numbers the guard prints today � 47 forms, 94 commands, 58 refusals � so the guard paragraph in the same file is true again.

Guards: syntax-check.js 333 files OK; docs-show-commands 7/7 (47 forms, 94 commands, 58 refusals); help-completeness 8/8; show-view-phrase 48/48; doc-catalog-counts 24/24; document-stamp 31/31.

Docs only.

`docs/CLI.md` told the reader that after a VLAN is deleted, the device lists its ports under `show interfaces status inactive`. There is no such view. **Evidence from the code** � `engine/cli.js` (interface-view keywords, #1443/#1449) refuses the phrase by name: ``` % `status inactive` is a view, not a port: this console has no `show interfaces status inactive`. `show interfaces` prints every port status and protocol, one block each. ``` **What the engine actually does** � reproduced on an Aruba 2530-48: ``` sw1(config)# no vlan 22 VLAN 22 removed 1 is now inactive: its access VLAN no longer exists (vlan 22 brings it back) sw1# show interfaces 1 1 (ethernet, 100M), MAC 02:00:00:00:00:00 status: down (inactive), protocol: down ``` The `inactive` state is on the port's own line in `show interfaces` � which is what the paragraph now says. The invented form was also a promise the page never kept: every backticked `show` in `docs/CLI.md` is typed by `test/docs-show-commands.test.js`, and it passed only because the answer is a legitimate refusal (a device fact), not a syntax complaint. That is exactly the blind spot this one slipped through. Removing the form returns the page to the numbers the guard prints today � 47 forms, 94 commands, 58 refusals � so the guard paragraph in the same file is true again. Guards: `syntax-check.js` 333 files OK; `docs-show-commands` 7/7 (47 forms, 94 commands, 58 refusals); `help-completeness` 8/8; `show-view-phrase` 48/48; `doc-catalog-counts` 24/24; `document-stamp` 31/31. Docs only.
CLI.md: a deleted-VLAN port is reported on its own line, not under show interfaces status inactive
Some checks failed
CI / Classify the change (pull_request) Successful in 27s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Failing after 15m24s
CI / Test (Node 18) (pull_request) Successful in 1m36s
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 1m36s
CI / Test (Node 22) (pull_request) Successful in 1m38s
1efcce41f1
#1568 told the reader the device lists inactive ports under `show interfaces status
inactive`. The console has no such view: engine/cli.js refuses it by name
(#1443/#1449), answering "% `status inactive` is a view, not a port: this console
has no `show interfaces status inactive`". Reproduced against an Aruba 2530-48:
`no vlan 22` says "1 is now inactive", and `show interfaces 1` prints
"status: down (inactive)".

The sentence also made the form a promise docs/CLI.md never kept: every backticked
`show` on the page is typed by test/docs-show-commands.test.js, which tolerated it
only because the answer counts as a legitimate refusal. Removing the invented form
returns the page to the 47 forms / 94 commands / 58 refusals that the guard reports
today, so the guard paragraph is true again.
jaylouisw closed this pull request 2026-11-16 07:01:17 +00:00
Author
Owner

Superseded - closing rather than rebasing.

main already carries this correction: f49da6c5 docs(CLI): show interfaces status inactive is not a command - the port's own status line is where inactive is reported (#1597). Rebasing this branch onto origin/main conflicts on exactly the sentence it changes, and main's version says strictly more (it also states the console refuses the invented view by name).

Evidence: git rebase origin/main -> one conflict in docs/CLI.md at the "beats the cable tests" sentence; main reads "...and that is reported on the port's own status: line and nowhere else. There is no filtered table of 'inactive ports' to ask for...". Nothing in this PR survives the comparison. docs-show-commands on main: 7/7 passing, so page and guard agree as merged.

Superseded - closing rather than rebasing. `main` already carries this correction: **`f49da6c5`** *docs(CLI): `show interfaces status inactive` is not a command - the port's own status line is where `inactive` is reported (#1597)*. Rebasing this branch onto `origin/main` conflicts on exactly the sentence it changes, and main's version says strictly more (it also states the console refuses the invented view by name). Evidence: `git rebase origin/main` -> one conflict in `docs/CLI.md` at the "beats the cable tests" sentence; main reads "...and that is reported on the port's own `status:` line and nowhere else. There is no filtered table of 'inactive ports' to ask for...". Nothing in this PR survives the comparison. `docs-show-commands` on main: 7/7 passing, so page and guard agree as merged.
Some checks failed
CI / Classify the change (pull_request) Successful in 27s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Failing after 15m24s
CI / Test (Node 18) (pull_request) Successful in 1m36s
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 1m36s
CI / Test (Node 22) (pull_request) Successful in 1m38s

Pull request closed

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!1587
No description provided.