From 6b081f49c4fdfbc62c2d0484b448103d03c54958 Mon Sep 17 00:00:00 2001 From: ddidderr Date: Fri, 22 May 2026 06:43:25 +0200 Subject: [PATCH] docs: align gateway test command with cli help Use the canonical --interface flag in the README and MVP test guide so the handoff command matches lanparty-gateway --help. Keep --iface documented as the shorter accepted alias because the CLI and tests still support it. Test Plan: - ./target/release/lanparty-gateway --help - cargo test -p lanparty-gateway accepts_iface_alias_for_gateway_interface - git diff --check - git diff --cached --check Refs: MVP test handoff polish --- README.md | 2 +- TESTING.md | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2486804..9797f7f 100644 --- a/README.md +++ b/README.md @@ -173,7 +173,7 @@ cargo run -p lanparty-gateway -- \ --server-name lanparty-relay.local \ --relay-ca-cert relay-cert.der \ --room ROOM1 \ - --iface eth0 + --interface eth0 ``` The gateway first opens the wired LAN interface as an AF_PACKET socket with diff --git a/TESTING.md b/TESTING.md index 5c7ee52..649e1f1 100644 --- a/TESTING.md +++ b/TESTING.md @@ -90,11 +90,12 @@ sudo ./target/release/lanparty-gateway \ --server-name lanparty-relay.local \ --relay-ca-cert ./relay-cert.der \ --room ROOM1 \ - --iface eth0 + --interface eth0 ``` -Use the real wired LAN interface name for `--iface`. Do not use Wi-Fi. The -gateway fails before joining the relay if sysfs reports no Ethernet carrier. +Use the real wired LAN interface name for `--interface`. `--iface` is accepted +as a shorter alias. Do not use Wi-Fi. The gateway fails before joining the +relay if sysfs reports no Ethernet carrier. Expected gateway output: