docs(cli): the NAT static rule takes udp as well as tcp - six spellings, not five #2191
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!2191
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "docs/1119-1817"
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(section Which side of the translation a port is on) said "Five spellings create a rule" and gave one port-forwarding row,ip nat inside source static <local> <global> tcp <port>. The console acceptsudp <port>as well, which makes six.Evidence from the code
engine/cli.js:5472- the usage string isstatic <local> <global> [tcp|udp <port>].engine/cli.js:5487- the refusal prints the same[tcp|udp <port>]shape.engine/cli.js:5489- only a word that is neithertcpnorudpis rejected.Measured at a console (generic router):
The same rule is printed by
show ip nat rulesand byshow running-config.docs/SIMULATION.md(section 5.2 table) already documentedip nat inside source static ... [tcp|udp <port>]; only the CLI page was behind. The code's own usage line is the truth here, so the doc moves to it - no code change in this PR.Change
udp <port>row; both port-forwarding rows now say which protocol they carry.Guards
node scripts/syntax-check.js- 461 files, all OK.test/docs-cli-transcript.test.js- 9 passed / 0 failed (before and after).test/docs-show-commands.test.js- 7 passed / 0 failed (before and after).test/help-completeness.test.js- 8 passed / 0 failed (before and after).test/no-form-help-key.test.js- 81,test/help-key-is-not-a-value.test.js- 40,test/help-key-works-in-every-prompt.test.js- all pass (before and after).No documented transcript changed, so none needed re-typing.