diff options
author | Viliam Luc <vluc@cisco.com> | 2021-10-28 15:05:53 +0200 |
---|---|---|
committer | Tibor Frank <tifrank@cisco.com> | 2021-12-13 10:57:25 +0000 |
commit | e82ebbd96e2ba73276e2f1b6d7f9c2d8a9442c3f (patch) | |
tree | 8548662c60534211b7eb34f2f2881636ec3797b9 /tests/vpp/device/ip6 | |
parent | f87931f3c85fe71bb3124e787168abafc5874c54 (diff) |
doc: fixing documentation structure
When building documentation using sphinx we see ~1200 similar warnings [0]
[0] - https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-verify-tox-master-ubuntu2004-x86_64/3289/doc_verify.log.gz
These warning are harmless and can be fixed later
Signed-off-by: Viliam Luc <vluc@cisco.com>
Change-Id: I1ac1099d38935971d47491dde905715345d3935c
Diffstat (limited to 'tests/vpp/device/ip6')
5 files changed, 75 insertions, 53 deletions
diff --git a/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-adlalwlistbase-scapy.robot b/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-adlalwlistbase-scapy.robot index 05718e6d35..56c2e3127b 100644 --- a/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-adlalwlistbase-scapy.robot +++ b/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-adlalwlistbase-scapy.robot @@ -25,18 +25,22 @@ | | Test Template | Local Template | -| Documentation | *ADL Security IPv6 allowlist test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology \ +| Documentation | **ADL Security IPv6 allowlist test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv6 on all links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with IPv6 routing and \ -| ... | static routes. ADL security allowlists are applied on DUT1 ingress \ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv6 on all links. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with IPv6 routing \ +| ... | and static routes. ADL security allowlists are applied on DUT1 ingress \ | ... | interface from TG. -| ... | *[Ver] TG verification:* Test IPv6 packets are sent in one direction \ -| ... | by TG on link to DUT1; on receive TG verifies packets for correctness \ -| ... | and drops as applicable. -| ... | *[Ref] Applicable standard specifications:* +| ... | +| ... | - **[Ver] TG verification:** Test IPv6 packets are sent in one \ +| ... | direction by TG on link to DUT1; on receive TG verifies packets for \ +| ... | correctness and drops as applicable. +| ... | +| ... | - **[Ref] Applicable standard specifications:** *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | adl_plugin.so @@ -54,7 +58,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Ver] Make TG send IPv6 on its interface to DUT1; \ +| | ... | - **[Ver]** Make TG send IPv6 on its interface to DUT1; \ | | ... | verify received IPv6 pkts are correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-adlblklistbase-scapy.robot b/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-adlblklistbase-scapy.robot index 2ff2a760d7..a76389362c 100644 --- a/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-adlblklistbase-scapy.robot +++ b/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-adlblklistbase-scapy.robot @@ -25,18 +25,22 @@ | | Test Template | Local Template | -| Documentation | *ADL Security IPv6 allowlist test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology \ +| Documentation | **ADL Security IPv6 allowlist test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv6 on all links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with IPv6 routing and \ -| ... | static routes. ADL security allowlists are applied on DUT1 ingress \ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv6 on all links. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with IPv6 routing \ +| ... | and static routes. ADL security allowlists are applied on DUT1 ingress \ | ... | interface from TG. -| ... | *[Ver] TG verification:* Test IPv6 packets are sent in one direction \ -| ... | by TG on link to DUT1; on receive TG verifies packets for correctness \ -| ... | and drops as applicable. -| ... | *[Ref] Applicable standard specifications:* +| ... | +| ... | - **[Ver] TG verification:** Test IPv6 packets are sent in one \ +| ... | direction by TG on link to DUT1; on receive TG verifies packets for \ +| ... | correctness and drops as applicable. +| ... | +| ... | - **[Ref] Applicable standard specifications:** *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | adl_plugin.so @@ -54,7 +58,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Ver] Make TG send IPv6 on its interface to DUT1; \ +| | ... | - **[Ver]** Make TG send IPv6 on its interface to DUT1; \ | | ... | verify received IPv6 pkts are correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-iacldstbase-scapy.robot b/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-iacldstbase-scapy.robot index 273a8feb92..67f8ef3441 100644 --- a/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-iacldstbase-scapy.robot +++ b/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-iacldstbase-scapy.robot @@ -25,18 +25,22 @@ | | Test Template | Local Template | -| Documentation | *IPv6 iAcl whitelist test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **IPv6 iAcl whitelist test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv6 on all links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with IPv6 routing and \ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv6 on all links. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with IPv6 routing \ | ... | static routes. IPv6 iAcl security whitelist is applied on DUT1 ingress \ | ... | interface from TG. -| ... | *[Ver] TG verification:* Test IPv6 packets are sent in one direction \ -| ... | by TG on link to DUT1; on receive TG verifies packets for correctness \ -| ... | and drops as applicable. -| ... | *[Ref] Applicable standard specifications:* +| ... | +| ... | - **[Ver] TG verification:** Test IPv6 packets are sent in one \ +| ... | direction by TG on link to DUT1; on receive TG verifies packets for \ +| ... | correctness and drops as applicable. +| ... | +| ... | - **[Ref] Applicable standard specifications:** *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -54,7 +58,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Ver] Make TG send IPv6 on its interface to DUT1; \ +| | ... | - **[Ver]** Make TG send IPv6 on its interface to DUT1; \ | | ... | verify received IPv6 pkts are correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-ipolicemarkbase-scapy.robot b/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-ipolicemarkbase-scapy.robot index 2c9673c913..3dfc12151d 100644 --- a/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-ipolicemarkbase-scapy.robot +++ b/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-ipolicemarkbase-scapy.robot @@ -25,17 +25,22 @@ | | Test Template | Local Template | -| Documentation | *IPv4 policer test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **IPv4 policer test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv6 on all links. -| ... | *[Cfg] DUT configuration:* On DUT1 configure interfaces IPv6 adresses, \ -| ... | and static ARP record on the second interface. On DUT1 configure 2R3C \ -| ... | color-aware policer on the first interface. -| ... | *[Ver] TG verification:* Test packet is sent from TG on the first link \ -| ... | to DUT1. Packet is received on TG on the second link from DUT1. -| ... | *[Ref] Applicable standard specifications:* RFC2474, RFC2697, RFC2698. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv6 on all links. +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 configure interfaces IPv6 \ +| ... | addresses and static ARP record on the second interface. On DUT1 \ +| ... | configure 2R3C color-aware policer on the first interface. +| ... | +| ... | - **[Ver] TG verification:** Test packet is sent from TG on the first \ +| ... | link to DUT1. Packet is received on TG on the second link from DUT1. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC2474, RFC2697, \ +| ... | RFC2698. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -56,7 +61,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Ver] Test packet is sent from TG on the first link to DUT1. \ +| | ... | - **[Ver]** Test packet is sent from TG on the first link to DUT1. \ | | ... | Packet is received on TG on the second link from DUT1. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-scapy.robot b/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-scapy.robot index 46b9978316..c838264af9 100644 --- a/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-scapy.robot +++ b/tests/vpp/device/ip6/2n1l-10ge2p1x710-ethip6-ip6base-scapy.robot @@ -25,18 +25,23 @@ | | Test Template | Local Template | -| Documentation | *IPv6 routing test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology \ +| Documentation | **IPv6 routing test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv6 for IPv6 routing on \ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv6 for IPv6 routing on \ | ... | both links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with IPv6 routing and \ +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with IPv6 routing \ | ... | two static IPv6 /64 route entries. -| ... | *[Ver] TG verification:* Test IPv6 packet is sent in one direction \ -| ... | by TG on links to DUT1; on receive TG verifies packet for correctness \ -| ... | and their IPv6 src-addr, dst-addr and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC2460, RFC4443, RFC4861 +| ... | +| ... | - **[Ver] TG verification:** Test IPv6 packet is sent in one \ +| ... | direction by TG on links to DUT1; on receive TG verifies packet for \ +| ... | correctness and their IPv6 src-addr, dst-addr and MAC addresses. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC2460, RFC4443, \ +| ... | RFC4861. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -54,7 +59,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Ver] Make TG send IPv6 packet routed over DUT1 interfaces;\ +| | ... | - **[Ver]** Make TG send IPv6 packet routed over DUT1 interfaces. \ | | ... | Make TG verify IPv6 packet is correct. | | | | ... | *Arguments:* |