docs(cli): a lost echo prints no timeout line, because the console stopped printing one #2208

Merged
jaylouisw merged 1 commit from docs/1119-2047 into main 2026-11-19 21:11:28 +00:00
Owner

docs/CLI.md's "Why an echo never came back" still showed the answer #2204 removed.

Untrue: two "after" transcripts in that section ended with Request timed out (seq 0) (and four such lines under the 4-echo ping), and two sentences claimed that line was still printed "only where the timeout really did expire" and that "the timeout line already said what happened".

Evidence: engine/cli.js _pingReplyLines() (around line 4434) prints the marks line and the success rate and nothing else - "There is deliberately no per-echo sentence after the rate" - and #2204 deleted the Request timed out (seq N) push along with the Reply from lines. Replaying both documented sessions against the engine prints:

Success rate is 0 percent (0/1)
% Echoes lost: 1 drop (no ARP reply from 10.0.0.99)
Success rate is 0 percent (0/4)
% Echoes lost: 4 drops ("peer port shut (r2 Gi0/0/0)" x4)

Fix (docs only): dropped the timeout lines from both transcripts (both replay byte for byte, prompt r1>), corrected the two prose claims to point at the . on the marks line, and added one sentence saying the per-echo timeout line is gone with the Reply from lines. The past-tense "the console printed the timeout and discarded it" example above them is left as history.

Guards, before and after: syntax-check 466 files OK / 466 OK; docs-cli-transcript 9 pass / 9 pass; docs-show-commands 7 / 7; no-form-help-key 81 / 81; help-completeness 8 / 8; doc-catalog-counts 43 / 43; doc citations 358 / 358.

`docs/CLI.md`'s "Why an echo never came back" still showed the answer #2204 removed. **Untrue:** two "after" transcripts in that section ended with `Request timed out (seq 0)` (and four such lines under the 4-echo ping), and two sentences claimed that line was still printed "only where the timeout really did expire" and that "the timeout line already said what happened". **Evidence:** `engine/cli.js` `_pingReplyLines()` (around line 4434) prints the marks line and the success rate and nothing else - "There is deliberately no per-echo sentence after the rate" - and #2204 deleted the `Request timed out (seq N)` push along with the `Reply from` lines. Replaying both documented sessions against the engine prints: ``` Success rate is 0 percent (0/1) % Echoes lost: 1 drop (no ARP reply from 10.0.0.99) ``` ``` Success rate is 0 percent (0/4) % Echoes lost: 4 drops ("peer port shut (r2 Gi0/0/0)" x4) ``` **Fix (docs only):** dropped the timeout lines from both transcripts (both replay byte for byte, prompt `r1>`), corrected the two prose claims to point at the `.` on the marks line, and added one sentence saying the per-echo timeout line is gone with the `Reply from` lines. The past-tense "the console printed the timeout and discarded it" example above them is left as history. Guards, before and after: syntax-check 466 files OK / 466 OK; docs-cli-transcript 9 pass / 9 pass; docs-show-commands 7 / 7; no-form-help-key 81 / 81; help-completeness 8 / 8; doc-catalog-counts 43 / 43; doc citations 358 / 358.
docs(cli): a lost echo prints no timeout line, because the console stopped printing one (#2204)
All checks were successful
CI / Classify the change (pull_request) Successful in 14s
PR rebase / Rebase onto main and arm auto-merge (pull_request) Successful in 13s
CI / Test (Node 18) (pull_request) Successful in 58s
CI / Server smoke test (pull_request) Has been skipped
CI / Docker build (pull_request) Has been skipped
CI / Test (Node 22) (pull_request) Successful in 52s
CI / Test (Node 20) (pull_request) Successful in 53s
CI / Arm auto-merge (pull_request) Successful in 3s
b63e049111
forgejo-actions scheduled this pull request to auto merge when all checks succeed 2026-11-19 20:52:10 +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!2208
No description provided.