README advertises DHCP client/server and VRRP; the simulator requires neither #1053

Closed
opened 2026-11-08 08:22:54 +00:00 by jaylouisw · 0 comments
Owner

The most-read file in the repository was the least accurate one. Its protocol table listed DHCP
client + server and VRRP; its CLI row listed ip dhcp pool and vrrp. None of that exists in the
path a packet walks:

$ grep -c "dhcp" engine/simulator.js
0
$ grep -c "vrrp" engine/simulator.js engine/cli.js
engine/simulator.js:0
engine/cli.js:0

docs/SIMULATION.md §5.1 has documented DHCP as absent from the data path the whole time, with the
grep that proves it. The README was the only document claiming otherwise — and the only one a
newcomer reads first.

This is the same class of defect as a switch whose description promises 10G SFP+ uplinks it does not
have: a document disagreeing with the hardware is a bug, not a preference. The difference is that a
wrong README wastes a person's afternoon rather than a lab's cable.

What is needed

  • The protocol list should name only what engine/simulator.js actually requires.
  • A stated "What this does not model yet" section, with an issue number for each gap, so the honesty
    is maintained by the same rule as every other exemption in this repository.
  • DHCP and VRRP tracked as the wiring work they are (#1051, #1052), not as features.
The most-read file in the repository was the least accurate one. Its protocol table listed DHCP client + server and VRRP; its CLI row listed `ip dhcp pool` and `vrrp`. None of that exists in the path a packet walks: ``` $ grep -c "dhcp" engine/simulator.js 0 $ grep -c "vrrp" engine/simulator.js engine/cli.js engine/simulator.js:0 engine/cli.js:0 ``` `docs/SIMULATION.md` §5.1 has documented DHCP as absent from the data path the whole time, with the grep that proves it. The README was the only document claiming otherwise — and the only one a newcomer reads first. This is the same class of defect as a switch whose description promises 10G SFP+ uplinks it does not have: a document disagreeing with the hardware is a bug, not a preference. The difference is that a wrong README wastes a person's afternoon rather than a lab's cable. ## What is needed - The protocol list should name only what `engine/simulator.js` actually requires. - A stated "What this does not model yet" section, with an issue number for each gap, so the honesty is maintained by the same rule as every other exemption in this repository. - DHCP and VRRP tracked as the wiring work they are (#1051, #1052), not as features.
Sign in to join this conversation.
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#1053
No description provided.