Commit 18ec44f6 authored by Petr Machata's avatar Petr Machata Committed by David S. Miller

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: default avatarPetr Machata <petrm@mellanox.com>
Reviewed-by: default avatarIdo Schimmel <idosch@mellanox.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 54818c4c
...@@ -46,6 +46,8 @@ Guidelines for Writing Tests ...@@ -46,6 +46,8 @@ Guidelines for Writing Tests
o Where possible, reuse an existing topology for different tests instead o Where possible, reuse an existing topology for different tests instead
of recreating the same topology. of recreating the same topology.
o Tests that use anything but the most trivial topologies should include
an ASCII art showing the topology.
o Where possible, IPv6 and IPv4 addresses shall conform to RFC 3849 and o Where possible, IPv6 and IPv4 addresses shall conform to RFC 3849 and
RFC 5737, respectively. RFC 5737, respectively.
o Where possible, tests shall be written so that they can be reused by o Where possible, tests shall be written so that they can be reused by
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment