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 --- ...1x710-ethip4-ip4base-eth-2vhost-1vm-scapy.robot | 30 ++++++++++++--------- ...thip4-l2bdbasemaclrn-eth-2vhost-1vm-scapy.robot | 29 ++++++++++++-------- ...x710-ethip4-l2xcbase-eth-2vhost-1vm-scapy.robot | 31 +++++++++++++--------- ...1x710-ethip6-ip6base-eth-2vhost-1vm-scapy.robot | 27 +++++++++++-------- 4 files changed, 71 insertions(+), 46 deletions(-) (limited to 'tests/vpp/device/vm_vhost') diff --git a/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-ip4base-eth-2vhost-1vm-scapy.robot b/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-ip4base-eth-2vhost-1vm-scapy.robot index 7d9cce5d2f..88b105e25a 100644 --- a/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-ip4base-eth-2vhost-1vm-scapy.robot +++ b/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-ip4base-eth-2vhost-1vm-scapy.robot @@ -25,19 +25,25 @@ | | Test Template | Local Template | -| Documentation | *IPv4 routing test cases with vhost user interface* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology with \ -| ... | VM and single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 for IPv4 routing on both links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with IPv4 routing and \ -| ... | two static IPv4 /24 route entries. Qemu Guest is connected to VPP via \ -| ... | vhost-user interfaces. Guest is running VPP ip4 interconnecting \ +| Documentation | **IPv4 routing test cases with vhost user interface** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ +| ... | with VM and single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 for IPv4 routing on both \ +| ... | links. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with IPv4 routing \ +| ... | and two static IPv4 /24 route entries. Qemu Guest is connected to VPP \ +| ... | via vhost-user interfaces. Guest is running VPP ip4 interconnecting \ | ... | vhost-user interfaces. -| ... | *[Ver] TG verification:* Test IPv4 packet with IP protocol=61 is sent \ -| ... | in one direction by TG on links to DUT1; on receive TG verifies packet \ -| ... | for correctness and their IPv4 src-addr, dst-addr and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC791, RFC826, RFC792 +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packet with IP protocol=61 is \ +| ... | sent in one direction by TG on links to DUT1; on receive TG verifies \ +| ... | packet for correctness and their IPv4 src-addr, dst-addr and MAC \ +| ... | addresses. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC791, RFC826, RFC792 *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so diff --git a/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-eth-2vhost-1vm-scapy.robot b/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-eth-2vhost-1vm-scapy.robot index 165d16e202..338914dddb 100644 --- a/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-eth-2vhost-1vm-scapy.robot +++ b/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-eth-2vhost-1vm-scapy.robot @@ -26,21 +26,25 @@ | | Test Template | Local Template | -| Documentation | *L2 bridge-domain test cases with vhost user interface* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology with \ -| ... | VM and single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 for L2 switching of IPv4. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with two L2 \ +| Documentation | **L2 bridge-domain test cases with vhost user interface** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ +| ... | with VM and single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 for L2 switching of IPv4. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with two L2 \ | ... | bridge-domains (L2BD) switching combined with MAC learning enabled. \ | ... | Qemu Guest is connected to VPP via vhost-user interfaces. Guest is \ | ... | configured with VPP l2 cross-connect interconnecting vhost-user \ | ... | interfaces. -| ... | *[Ver] TG verification:* Test IPv4 packets with IP protocol=61 are \ -| ... | sent in both directions by TG on links to DUT1 via VM; on receive TG \ +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packets with IP protocol=61 are \ +| ... | sent in both directions by TG on links to DUT1 via VM; on receive TG. \ | ... | verifies packets for correctness and their IPv4 src-addr, dst-addr \ | ... | and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC792 +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC792 *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -62,10 +66,13 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Top] TG=DUT=VM. [Enc] Eth-IPv4. [Cfg] On DUT1 configure \ +| | ... | - **[Top]** TG=DUT=VM. +| | ... | - **[Enc]** Eth-IPv4. +| | ... | - **[Cfg]** On DUT1 configure \ | | ... | two L2BDs with MAC learning, each with vhost-user i/f to local \ | | ... | VM and i/f to TG; configure VPP in VM to loop pkts back betwen its \ -| | ... | two virtio i/fs. [Ver] Make TG verify IPv4 packets are switched \ +| | ... | two virtio i/fs. +| | ... | - **[Ver]** Make TG verify IPv4 packets are switched \ | | ... | thru DUT1 and VM in both directions and are correct on receive. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-l2xcbase-eth-2vhost-1vm-scapy.robot b/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-l2xcbase-eth-2vhost-1vm-scapy.robot index 4f8df594a3..734b162eb9 100644 --- a/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-l2xcbase-eth-2vhost-1vm-scapy.robot +++ b/tests/vpp/device/vm_vhost/ethip4/2n1l-10ge2p1x710-ethip4-l2xcbase-eth-2vhost-1vm-scapy.robot @@ -25,20 +25,24 @@ | | Test Template | Local Template | -| Documentation | *L2 cross-connect test cases with vhost user interface* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology with \ -| ... | VM and single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 for L2 switching of IPv4. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with L2 cross-connect \ +| Documentation | **L2 cross-connect test cases with vhost user interface** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ +| ... | with VM and single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 for L2 switching of IPv4. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with L2 \ | ... | (L2XC) switching. Qemu Guest is connected to VPP via vhost-user \ -| ... | interfaces. Guest is configured with VPP l2 cross-connect \ +| ... | interfaces. Guest is configured with VPP l2 cross-connect. \ | ... | interconnecting vhost-user interfaces. -| ... | *[Ver] TG verification:* Test IPv4 packets with IP protocol=61 are \ -| ... | sent in both directions by TG on links to DUT1 via VM; on receive TG \ +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packets with IP protocol=61 are \ +| ... | sent in both directions by TG on links to DUT1 via VM; on receive TG. \ | ... | verifies packets for correctness and their IPv4 src-addr, dst-addr \ | ... | and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC792 +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC792 *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -60,9 +64,12 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Top] TG=DUT=VM. [Enc] Eth-IPv4. [Cfg] On DUT configure \ +| | ... | - **[Top]** TG=DUT=VM. +| | ... | - **[Enc]** Eth-IPv4. +| | ... | - **[Cfg]** On DUT configure \ | | ... | two L2 cross-connects (L2XC), each with one untagged interface \ -| | ... | to TG and untagged i/f to local VM over vhost-user. [Ver] Make \ +| | ... | to TG and untagged i/f to local VM over vhost-user. +| | ... | - **[Ver]** Make \ | | ... | TG send IPv4 packets in both directions between two of its \ | | ... | i/fs to be switched by DUT to and from VM; verify all packets \ | | ... | are received. [Ref] diff --git a/tests/vpp/device/vm_vhost/ethip6/2n1l-10ge2p1x710-ethip6-ip6base-eth-2vhost-1vm-scapy.robot b/tests/vpp/device/vm_vhost/ethip6/2n1l-10ge2p1x710-ethip6-ip6base-eth-2vhost-1vm-scapy.robot index 33313e06ad..e1ce837eb1 100644 --- a/tests/vpp/device/vm_vhost/ethip6/2n1l-10ge2p1x710-ethip6-ip6base-eth-2vhost-1vm-scapy.robot +++ b/tests/vpp/device/vm_vhost/ethip6/2n1l-10ge2p1x710-ethip6-ip6base-eth-2vhost-1vm-scapy.robot @@ -25,19 +25,25 @@ | | Test Template | Local Template | -| Documentation | *IPv4 routing test cases with vhost user interface* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology with \ -| ... | VM and single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv6 for IPv6 routing on both links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with IPv6 routing and \ +| Documentation | **IPv4 routing test cases with vhost user interface** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ +| ... | with VM and single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv6 for IPv6 routing on both \ +| ... | links. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with IPv6 routing \ | ... | two static IPv6 /64 route entries. Qemu Guest is connected to VPP via \ | ... | vhost-user interfaces. Guest is running VPP ip6 interconnecting \ | ... | vhost-user interfaces. -| ... | *[Ver] TG verification:* Test IPv6 packets are sent in one direction \ -| ... | 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:* RFC2460, RFC4443, RFC4861 +| ... | +| ... | - **[Ver] TG verification:** Test IPv6 packets are sent in one \ +| ... | direction 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:** RFC2460, RFC4443, \ +| ... | RFC4861. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -91,7 +97,6 @@ | | ... | ${TG_pf1}[0] | ${TG_pf1_mac}[0] | ${DUT1_vf1_mac}[0] | | ... | ${TG_pf2}[0] | ${DUT1_vf2_mac}[0] | ${TG_pf2_mac}[0] - *** Test Cases *** | 78B-0c-ethip6-ip6base-eth-2vhost-1vm-scapy | | [Tags] | 78B | 0C -- cgit 1.2.3-korg