docs(CLI): the four-echo loss transcript is the one the console prints #1840
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!1840
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "docs/1117-1216"
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?
docs/CLI.mdanswered "four echoes are one statement about the path" with a block that begins!!!!and then saysSuccess rate is 0 percent (0/4)- a glyph that reports four replies received over a sentence that reports none - and without theType escape sequence to abort./Sending 4, ...header lines a box prints.Reproduced against a lab where the pinged peer has Gi0/0/0 shut:
The glyph is
.per lost echo, the two header lines are printed, and the reason is quoted - which is the rule the paragraph directly below the block already states ("A reason that brings its own brackets is quoted"). The block contradicted the code and its own neighbouring sentence.No engine change: the console is right, the page was not. Gates: syntax-check 385 files OK; docs-cli-transcript 4/0, docs-show-commands 7/0, help-completeness 8/0, no-form-help-key 81/0, help-key-works-in-every-prompt 10/0 - all unchanged.
The block answered 'four echoes are one statement' with `!!!!` above `Success rate is 0 percent (0/4)`: a glyph that says all four replies- came back over a sentence that says none did, and neither header line a box prints. Reproduced against a lab where the peer's Gi0/0/0 is shut: r1> ping 10.0.0.10 4 Type escape sequence to abort. Sending 4, 100-byte ICMP Echos to 10.0.0.10, timeout is 2 seconds: .... Success rate is 0 percent (0/4) ... % Echoes lost: 4 drops ("peer port shut (r2 Gi0/0/0)" x4) so the glyph is '.' per lost echo, the two header lines are printed, and the reason is quoted because it brings its own brackets - the rule the paragraph below the block already states.3fc7b8e7366567effe67Blocked by an over-broad test guard, not by the doc.
All three Node jobs fail on one assertion:
test/ping-default-count.test.js:122—doc.indexOf('Sending 4,') === -1. That was written to catch leftover count-4 defaults, but it rejects anySending 4,on the page, including an example that explicitly types the count (ping 10.0.0.10 4).Run on this PR's tree (two generic-routers joined Gi0/0–Gi0/0, r2's Gi0/0 shut,
ping 10.0.0.10 4from r1), the console prints the transcript this PR documents:The quoting is
dropsSentence()(a reason carrying its own brackets is quoted, #1417) and the lowercaser2is the stored device id. So the page is right and the guard is stale. (I did not verify theGi0/0/0port name in the doc's own example — my lab has Gi0/0 — but every format claim in the hunk is confirmed.)The fix belongs to whoever owns
test/: narrow line 122 to count-less invocations rather than rewriting this section, which is about four echoes collapsing into one loss line.Needs Jay's (or the test loop's) decision — I do not edit
test/ordocs/as my own contribution. The PR is 6 lines, docs-only, and would go green on the next push once the guard is narrowed; it is also 3 commits behind main and will need a rebase after that.Re-verified on main
9fb6ecae(this branch is 4 behind, no conflicts).node test/ping-default-count.test.js-> 17 passed, 1 failed, the single failure stilltest/ping-default-count.test.js:122,doc.indexOf('Sending 4,') === -1.One nuance worth recording, from rebuilding the lab both ways:
d1/d2) ->% Echoes lost: 4 drops ("peer port shut (d2 Gi0/0/0)" x4)r1/r2->% Echoes lost: 4 drops ("peer port shut (r2 Gi0/0/0)" x4)engine/simulator.js:3168builds the reason frompeerDev.id, not the name, so this page'sr2is exact for the id convention the rest ofdocs/already uses, and the canvas path is the one that reads oddly (d2). Nothing here changes the page: the quoting, the....line,0/4and the fourseqlines all match what I ran.The blocker is filed as #1845 so the test/CI loop can narrow that guard - it is a substring test over the whole file, so it cannot tell an explicit count from a stale default. I don't edit
test/. Needs Jay's or the test loop's call; this PR is otherwise clean and mergeable.Sending N,against the command above it #1850The guard #1845 describes is narrowed in #1850 (
test/ping-default-count.test.js): eachSending N,line is read against the command echoed above it, so a typed4is accepted and a bare4is still rejected. Checked with this branch'sdocs/CLI.mdsubstituted in - 25 passed, 0 failed - so this PR is no longer blocked by that file.6567effe67346cd89becMerged as
6fc78b1eat 13:41Z after a rebase ontoc0d92766(8 commits behind, no conflicts).The blocker was the guard, not this page:
#1850landed first (c0d92766), which now reads everySending N,against the command above it. On the rebased branchtest/ping-default-count.test.jsis 25 passed, 0 failed;docs-cli-transcript,canonical-urls,doc-citationsanddocs-show-commandsall green as well. Nothing indocs/CLI.mdwas changed by this rebase.