cabletest/docs/README.md

cabletest docs

Project knowledge that moves and versions with the repo.

General:

• goals.md — what cabletest is for and what it must output.
• state.md — where things are now: committed vs stashed, the box and what's in it, bringup progress, open items. All current-placement state lives here and only here.
• hardware.md — host rules: interface conventions, tuning, how to run.
• measurement.md — how to measure correctly; performance results and dead ends.
• open-questions.md — the open problems, with their current answers.

Per-device (each directory: device doc + its datasheets):

• nics/ — the transport rule, the comparison table, and one directory per NIC: x520, connectx-5, x710, e810, wx1820.
• modules/ — module inventory, media-lies table, the shared IEEE register set, RollBall protocol, cable-length physics, and one directory per module: fs, wiitek, fibergaga.