docs(CLI): show interfaces status inactive is not a command - the port's own status line is where inactive is reported #1597

Merged
jaylouisw merged 1 commit from docs/1116-0345 into main 2026-11-16 04:56:43 +00:00
Owner

The paragraph under Reading show ip interface brief said that the device "lists such ports under show interfaces status inactive". There is no such command, and the console says so in its own words:

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

inactive exists only as a reason on a port's own show interfaces block — status: down (inactive) — which the same paragraph already lists. The sentence now says that, and stops advertising a spelling the parser refuses.

Second drift fixed by the same line: the guard paragraph (## Every show form on this page is typed by a test) claims "47 forms, 94 commands today". test/docs-show-commands.test.js enumerated 48 forms and typed 96 commands, because it read this phantom row as a form. With the row gone the measured counts are 47 and 94 again and the sentence is true — no edit to the test was needed.

Guards (before → after):

guard before after
test/doc-catalog-counts.test.js 24 passed 24 passed
test/docs-show-commands.test.js 7 passed, 48 forms / 96 commands 7 passed, 47 forms / 94 commands
test/help-completeness.test.js 8 passed 8 passed
test/help-key-works-in-every-prompt.test.js 9 passed 9 passed
scripts/syntax-check.js 333 files OK 333 files OK
scripts/check-control-bytes.js clean clean

Not fixed here (code, not docs): docs-show-commands accepts any refusal that is a sentence longer than 12 characters and does not begin % Invalid show / % Unrecognized / % Unknown show. "this console has no show interfaces status inactive" is a complaint about the command, not about the device, so the phantom row passed the guard ever since #1568.

The paragraph under *Reading `show ip interface brief`* said that the device "lists such ports under `show interfaces status inactive`". There is no such command, and the console says so in its own words: ``` r1#show interfaces status inactive % `status inactive` is a view, not a port: this console has no `show interfaces status inactive`. `show interfaces` prints every port's status and protocol, one block each. ``` `inactive` exists only as a reason on a port's own `show interfaces` block — `status: down (inactive)` — which the same paragraph already lists. The sentence now says that, and stops advertising a spelling the parser refuses. **Second drift fixed by the same line:** the guard paragraph (`## Every `show` form on this page is typed by a test`) claims "47 forms, 94 commands today". `test/docs-show-commands.test.js` enumerated 48 forms and typed 96 commands, because it read this phantom row as a form. With the row gone the measured counts are 47 and 94 again and the sentence is true — no edit to the test was needed. Guards (before → after): | guard | before | after | |---|---|---| | `test/doc-catalog-counts.test.js` | 24 passed | 24 passed | | `test/docs-show-commands.test.js` | 7 passed, 48 forms / 96 commands | 7 passed, 47 forms / 94 commands | | `test/help-completeness.test.js` | 8 passed | 8 passed | | `test/help-key-works-in-every-prompt.test.js` | 9 passed | 9 passed | | `scripts/syntax-check.js` | 333 files OK | 333 files OK | | `scripts/check-control-bytes.js` | clean | clean | Not fixed here (code, not docs): `docs-show-commands` accepts any refusal that is a sentence longer than 12 characters and does not begin `% Invalid show` / `% Unrecognized` / `% Unknown show`. "this console has no `show interfaces status inactive`" is a complaint about the command, not about the device, so the phantom row passed the guard ever since #1568.
docs(CLI): show interfaces status inactive is not a command, and the port's own status line is where inactive is reported (#1568)
Some checks failed
PR rebase / Rebase onto main and arm auto-merge (pull_request) Failing after 10m43s
CI / Classify the change (pull_request) Failing after 10m46s
CI / Test (Node 18) (pull_request) Has been cancelled
CI / Test (Node 20) (pull_request) Has been cancelled
CI / Test (Node 22) (pull_request) Has been cancelled
CI / Server smoke test (pull_request) Has been cancelled
CI / Docker build (pull_request) Has been cancelled
68f07b2996
The paragraph under *Reading `show ip interface brief`* said the device "lists such
ports under `show interfaces status inactive`". The console has no such view and says
so itself:

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

`inactive` exists only as a reason inside a port's `show interfaces` block, which the
same paragraph already lists. So the sentence now says that, and the phantom spelling
leaves the page.

Removing it also puts the guard paragraph's count back in step with the test that
enforces it (`test/docs-show-commands.test.js`): 47 forms, 94 commands, as that
paragraph claims — the phantom had made it 48 and 96 without the number being told.
jaylouisw force-pushed docs/1116-0345 from 68f07b2996
Some checks failed
PR rebase / Rebase onto main and arm auto-merge (pull_request) Failing after 10m43s
CI / Classify the change (pull_request) Failing after 10m46s
CI / Test (Node 18) (pull_request) Has been cancelled
CI / Test (Node 20) (pull_request) Has been cancelled
CI / Test (Node 22) (pull_request) Has been cancelled
CI / Server smoke test (pull_request) Has been cancelled
CI / Docker build (pull_request) Has been cancelled
to a8c2a69a7c
Some checks failed
CI / Classify the change (pull_request) Successful in 32s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Failing after 11m29s
CI / Docker build (pull_request) Failing after 14m26s
CI / Server smoke test (pull_request) Failing after 14m27s
CI / Test (Node 22) (pull_request) Failing after 14m31s
CI / Test (Node 20) (pull_request) Failing after 14m36s
CI / Test (Node 18) (pull_request) Failing after 14m40s
2026-11-16 04:56:14 +00:00
Compare
jaylouisw scheduled this pull request to auto merge when all checks succeed 2026-11-16 04:56:17 +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!1597
No description provided.