From e82ebbd96e2ba73276e2f1b6d7f9c2d8a9442c3f Mon Sep 17 00:00:00 2001 From: Viliam Luc Date: Thu, 28 Oct 2021 15:05:53 +0200 Subject: 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 Change-Id: I1ac1099d38935971d47491dde905715345d3935c --- ...thip4--ethip4udpgeneve-1tun-ip4base-scapy.robot | 38 ++++++++++++---------- ...e2p1x710-ethip4vxlan-l2bdbasemaclrn-scapy.robot | 26 ++++++++------- ...1l-10ge2p1x710-ethip4vxlan-l2xcbase-scapy.robot | 24 ++++++++------ ...2n1l-10ge2p1x710-ethip4lisp-ip4base-scapy.robot | 30 +++++++++-------- ...l-10ge2p1x710-ethip4lispgpe-ip4base-scapy.robot | 30 +++++++++-------- ...l-10ge2p1x710-ethip4lispgpe-ip6base-scapy.robot | 30 +++++++++-------- 6 files changed, 101 insertions(+), 77 deletions(-) (limited to 'tests/vpp/device/ip4_tunnels') diff --git a/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4--ethip4udpgeneve-1tun-ip4base-scapy.robot b/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4--ethip4udpgeneve-1tun-ip4base-scapy.robot index 157040a385..c601f31304 100644 --- a/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4--ethip4udpgeneve-1tun-ip4base-scapy.robot +++ b/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4--ethip4udpgeneve-1tun-ip4base-scapy.robot @@ -28,24 +28,28 @@ | | Test Template | Local Template | -| Documentation | *L2BD with GENEVE L3 mode test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **L2BD with GENEVE L3 mode test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 between TG-if1 and DUT1-if1 and\ -| ... | Eth-IPv4-UDP-GENEVE-Eth-IPv4 between DUT1-if2 and TG-if2 for IPv4\ -| ... | routing over GENEVE tunnel. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with IPv4 routing over\ -| ... | GENEVE tunnel and 4 static IPv4 /24 route entries.\ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 between TG-if1 and \ +| ... | DUT1-if1 and Eth-IPv4-UDP-GENEVE-Eth-IPv4 between DUT1-if2 and TG-if2 \ +| ... | for IPv4 routing over GENEVE tunnel. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with IPv4 routing \ +| ... | over GENEVE tunnel and 4 static IPv4 /24 route entries. \ | ... | DUT1 is tested with ${nic_name}. -| ... | *[Ver] TG verification:* Test Eth-IPv4 packet is sent by TG-if1 on link\ -| ... | to DUT1-if1; on receive by TG-if2 the encapsulated packet is verified\ -| ... | for correctness and its outer and inner IPv4 and MAC addresses, UDP\ -| ... | ports and GENEVE vni and protocol number. Then test\ -| ... | Eth-IPv4-UDP-GENEVE-Eth-IPv4 packet is sent by TG-if2 on link to\ -| ... | DUT1-if2; on receive by TG-if1 decapsulated packet is verified for\ +| ... | +| ... | - **[Ver] TG verification:** Test Eth-IPv4 packet is sent by TG-if1 on \ +| ... | link to DUT1-if1; on receive by TG-if2 the encapsulated packet is \ +| ... | verified for correctness and its outer and inner IPv4 and MAC \ +| ... | addresses, UDP ports and GENEVE vni and protocol number. Then test. \ +| ... | Eth-IPv4-UDP-GENEVE-Eth-IPv4 packet is sent by TG-if2 on link to \ +| ... | DUT1-if2; on receive by TG-if1 decapsulated packet is verified for \ | ... | correctness and its IPv4 and MAC addresses -| ... | *[Ref] Applicable standard specifications:* RFC791, RFC768, RFC8926. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC791, RFC768, RFC8926. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | geneve_plugin.so @@ -75,9 +79,9 @@ | Local Template | | | | [Documentation] -| | ... | [Cfg] DUT runs GENEVE ${gen_mode} mode configuration. +| | ... | - **[Cfg]** DUT runs GENEVE ${gen_mode} mode configuration. \ | | ... | Each DUT uses ${phy_cores} physical core(s) for worker threads. -| | ... | [Ver] Measure NDR and PDR values using MLRsearch algorithm.\ +| | ... | - **[Ver]** Measure NDR and PDR values using MLRsearch algorithm. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer or string (IMIX_v4_1). diff --git a/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-scapy.robot b/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-scapy.robot index c79d7f1039..aa0ed3058d 100644 --- a/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-scapy.robot +++ b/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-scapy.robot @@ -26,19 +26,23 @@ | | Test Template | Local Template | -| Documentation | *L2BD with VXLANoIPv4 test cases* -| -| ... | *[Top] Network topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **L2BD with VXLANoIPv4 test cases** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet encapsulations:* Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 on\ +| ... | +| ... | - **[Enc] Packet encapsulations:** Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 on \ | ... | TG-DUT. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with L2 bridge-domain\ -| ... | switching combined with MAC learning enable.\ +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with L2 \ +| ... | cross-connect switching.combined with MAC learning enable. \ | ... | VXLAN tunnels are configured on links betwen TG and DUT. -| ... | *[Ver] TG verification:* Test Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 packet is\ -| ... | sent by TG on link to DUT1; on receive TG verifies packets for\ -| ... | correctness and their IPv4 src-addr, dst-addr and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC7348. +| ... | +| ... | - **[Ver] TG verification:** Test Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 \ +| ... | packet is sent by TG on link to DUT1; on receive TG verifies packets \ +| ... | for correctness and their IPv4 src-addr, dst-addr and MAC addresses. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC7348. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -56,7 +60,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Ver] Make TG send VXLAN encapsulated Ethernet frame; verify\ +| | ... | - **[Ver]** Make TG send VXLAN encapsulated Ethernet frame; verify \ | | ... | all packets are received. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4vxlan-l2xcbase-scapy.robot b/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4vxlan-l2xcbase-scapy.robot index 93cedb6273..dcf48e8147 100644 --- a/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4vxlan-l2xcbase-scapy.robot +++ b/tests/vpp/device/ip4_tunnels/2n1l-10ge2p1x710-ethip4vxlan-l2xcbase-scapy.robot @@ -26,18 +26,22 @@ | | Test Template | Local Template | -| Documentation | *L2XC with VXLANoIPv4 test cases* -| -| ... | *[Top] Network topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **L2XC with VXLANoIPv4 test cases** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet encapsulations:* Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 on\ +| ... | +| ... | - **[Enc] Packet encapsulations:** Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 on \ | ... | TG-DUT. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with L2 cross-connect.\ +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with L2 \ | ... | VXLAN tunnels are configured on links betwen TG and DUT. -| ... | *[Ver] TG verification:* Test Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 packet is\ -| ... | sent by TG on link to DUT1; on receive TG verifies packets for\ -| ... | correctness and their IPv4 src-addr, dst-addr and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC7348. +| ... | +| ... | - **[Ver] TG verification:** Test Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 \ +| ... | packet is sent by TG on link to DUT1; on receive TG verifies packets \ +| ... | for correctness and their IPv4 src-addr, dst-addr and MAC addresses. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC7348. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -55,7 +59,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Ver] Make TG send VXLAN encapsulated Ethernet frame; verify\ +| | ... | - **[Ver]** Make TG send VXLAN encapsulated Ethernet frame; verify \ | | ... | all packets are received. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lisp-ip4base-scapy.robot b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lisp-ip4base-scapy.robot index 35343edd18..efaab06a0a 100644 --- a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lisp-ip4base-scapy.robot +++ b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lisp-ip4base-scapy.robot @@ -27,21 +27,25 @@ | | Test Template | Local Template | -| Documentation | *ip4-lisp-ip4 encapsulation test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node\ -| ... | circular topology with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4-LISP-IPv4-ICMPv4\ -| ... | on DUT1-TG, Eth-IPv4-ICMPv4 on TG-DUTn for IPv4 routing\ +| Documentation | **ip4-lisp-ip4 encapsulation test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node \ +| ... | circular with single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4-LISP-IPv4-ICMPv4 \ +| ... | on DUT1-TG, Eth-IPv4-ICMPv4 on TG-DUTn for IPv4 routing \ | ... | over LISPoIPv4 tunnel. -| ... | *[Cfg] DUT configuration:* DUT is configured with IPv4\ -| ... | routing and static routes. LISPoIPv4 tunnel is\ +| ... | +| ... | - **[Cfg] DUT configuration:** DUT is configured with IPv4. \ +| ... | routing and static routes. LISPoIPv4 tunnel is \ | ... | configured between DUT1 and TG2. -| ... | *[Ver] TG verification:* Test ICMPv4 Echo Request packets\ -| ... | are sent by TG on if1 link to DUT1; on receive TG verifies\ -| ... | packets for correctness and their IPv4 src-addr, dst-addr\ +| ... | +| ... | - **[Ver] TG verification:** Test ICMPv4 Echo Request packets \ +| ... | are sent by TG on if1 link to DUT1; on receive TG verifies \ +| ... | packets for correctness and their IPv4 src-addr, dst-addr \ | ... | and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC6830. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC6830. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | lisp_plugin.so @@ -59,7 +63,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure LISP.\ +| | ... | - **[Cfg]** On DUT1 configure LISP. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer diff --git a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip4base-scapy.robot b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip4base-scapy.robot index 6ae9cf4321..80d69476e6 100644 --- a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip4base-scapy.robot +++ b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip4base-scapy.robot @@ -27,21 +27,25 @@ | | Test Template | Local Template | -| Documentation | *ip4-lispgpe-ip4 encapsulation test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node\ -| ... | circular topology with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4-LISPGPE-IPv4-ICMPv4\ -| ... | on DUT1-TG, Eth-IPv4-ICMPv4 on TG-DUTn for IPv4\ +| Documentation | **ip4-lispgpe-ip4 encapsulation test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node \ +| ... | circular with single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4-LISPGPE-IPv4-ICMPv4 \ +| ... | on DUT1-TG, Eth-IPv4-ICMPv4 on TG-DUTn for IPv4. \ | ... | routing over LISPoIPv4 tunnel. -| ... | *[Cfg] DUT configuration:* DUT1 and TG(if2) are configured\ -| ... | with IPv4 routing and static routes. LISPoIPv4 tunnel is\ +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 and TG(if2) are configured \ +| ... | with IPv4 routing and static routes. LISPoIPv4 tunnel is \ | ... | configured between DUT1 and TG. -| ... | *[Ver] TG verification:* Test ICMPv4 Echo Request packets\ -| ... | are sent in TG->DUT(if1); On receive TG(if2) verifies packets\ -| ... | for correctness and their IPv4 src-addr, dst-addr and\ +| ... | +| ... | - **[Ver] TG verification:** Test ICMPv4 Echo Request packets \ +| ... | are sent in TG->DUT(if1); On receive TG(if2) verifies packets \ +| ... | for correctness and their IPv4 src-addr, dst-addr and \ | ... | MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC6830. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC6830. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | lisp_plugin.so @@ -60,7 +64,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure LISP. +| | ... | - **[Cfg]** On DUT1 configure LISP. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer diff --git a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip6base-scapy.robot b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip6base-scapy.robot index 07ad9da61a..588e00af99 100644 --- a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip6base-scapy.robot +++ b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip6base-scapy.robot @@ -27,21 +27,25 @@ | | Test Template | Local Template | -| Documentation | *ip4-lispgpe-ip6 encapsulation test cases* -| -| ... | *[Top] Network Topologies:* TG(if1)-DUT1-TG(if2) 2-node\ -| ... | circular topology with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4-LISPGPE-IPv6-ICMPv6\ -| ... | on DUT1-TG(if2),Eth-IPv6-ICMPv6 on TG-DUTn for IPv6\ +| Documentation | **ip4-lispgpe-ip6 encapsulation test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG(if1)-DUT1-TG(if2) 2-node \ +| ... | circular with single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4-LISPGPE-IPv6-ICMPv6 \ +| ... | on DUT1-TG(if2),Eth-IPv6-ICMPv6 on TG-DUTn for IPv6 \ | ... | routing over LISPoIPv4 tunnel. -| ... | *[Cfg] DUT configuration:* DUT1 and TG(if2) are configured\ -| ... | with IPv6 routing and static routes. LISPoIPv4 tunnel is\ +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 and TG(if2) are configured \ +| ... | with IPv6 routing and static routes. LISPoIPv4 tunnel is \ | ... | configured between DUT1 and TG(if2). -| ... | *[Ver] TG verification:* Test ICMPv6 Echo Request packets\ -| ... | are sent in if1 by TG on links to DUT1; on receive\ -| ... | TG verifies packets for correctness and their IPv6 src-addr,\ +| ... | +| ... | - **[Ver] TG verification:** Test ICMPv6 Echo Request packets \ +| ... | are sent in if1 by TG on links to DUT1; on receive \ +| ... | TG verifies packets for correctness and their IPv6 src-addr, \ | ... | dst-addr and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC6830. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC6830. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | lisp_plugin.so @@ -61,7 +65,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure LISPGPE\ +| | ... | - **[Cfg]** On DUT1 configure LISPGPE. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer -- cgit 1.2.3-korg