Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

selftests: forwarding: README: Require diagrams

ASCII art diagrams are well suited for presenting the topology that a
test uses while being easy to embed directly in the test file iteslf.
They make the information very easy to grasp even for simple topologies,
and for more complex ones they are almost essential, as figuring out the
interconnects from the script itself proves to be difficult.

Therefore state the requirement for topology ASCII art in README.

Signed-off-by: Petr Machata <petrm@mellanox.com>
Reviewed-by: Ido Schimmel <idosch@mellanox.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

authored by

Petr Machata and committed by
David S. Miller
18ec44f6 54818c4c

+2
+2
tools/testing/selftests/net/forwarding/README
··· 46 46 47 47 o Where possible, reuse an existing topology for different tests instead 48 48 of recreating the same topology. 49 + o Tests that use anything but the most trivial topologies should include 50 + an ASCII art showing the topology. 49 51 o Where possible, IPv6 and IPv4 addresses shall conform to RFC 3849 and 50 52 RFC 5737, respectively. 51 53 o Where possible, tests shall be written so that they can be reused by