Stop the README advertising DHCP and VRRP that the simulator never calls #1054
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!1054
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "fix/readme-protocols"
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?
The most-read file in the repository was the least accurate one.
grep -c dhcp engine/simulator.js→ 0.ip address dhcpsets a flag; no lease ever arrives.ip dhcp pool"engine/cli.js.vrrp"grep -c vrrp engine/cli.js→ 0. There is no such command.docs/SIMULATION.md§5.1 has documented DHCP as absent from the data path the whole time, with thegrep that proves it. The README was the only document claiming otherwise — and the only one a
newcomer reads first.
This is the same defect class as a switch whose description promises 10G SFP+ uplinks it lacks: a
document disagreeing with the hardware is a bug, not a preference. The cost is different — a wrong
README wastes a person's afternoon rather than a lab's cable.
What changed
engine/simulator.jsactually requires: ARP, IPv4, ICMP(echo + errors), traceroute, DNS, NAT, ACLs, OSPF, BGP, SCION, IPv6 SLAAC/RA, LLDP, STP, 802.1Q,
LACP.
ping ... at <ms>andconverge.#1052 VRRP), so the honesty is maintained by the same rule as every other exemption here: no gap
survives without a tracker.
The two gaps are filed as the wiring work they are, not as wishes. DHCP in particular is a complete,
tested library sitting one
requireaway from the data path.97 suites, 4740 assertions, all passing.
Closes #1053.