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 --- ...x710-ethip4-ip4base-eth-2memif-1dcr-scapy.robot | 31 +++++++++++++--------- ...hip4-l2bdbasemaclrn-eth-2memif-1dcr-scapy.robot | 28 ++++++++++--------- ...710-ethip4-l2xcbase-eth-2memif-1dcr-scapy.robot | 30 ++++++++++++--------- 3 files changed, 51 insertions(+), 38 deletions(-) (limited to 'tests/vpp/device/container_memif') diff --git a/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-ip4base-eth-2memif-1dcr-scapy.robot b/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-ip4base-eth-2memif-1dcr-scapy.robot index ffb12e1bbb..0ae1ecb776 100644 --- a/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-ip4base-eth-2memif-1dcr-scapy.robot +++ b/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-ip4base-eth-2memif-1dcr-scapy.robot @@ -25,20 +25,25 @@ | | Test Template | Local Template | -| Documentation | *IPv4 routing test cases with memif interface* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology with \ -| ... | 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. Container is connected to VPP via \ -| ... | Memif interface. Container is running same VPP version as running on \ -| ... | DUT. -| ... | *[Ver] TG verification:* Test IPv4 packets with IP protocol=61 are \ +| Documentation | **IPv4 routing test cases with memif interface** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ +| ... | with 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. Container is connected to VPP \ +| ... | via Memif interface. Container is running same VPP version as running \ +| ... | on DUT. +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packets with IP protocol=61 are \ | ... | sent in one direction by TG on links to DUT1 and via container; on \ | ... | receive TG verifies packets for correctness and their IPv4 src-addr, \ | ... | dst-addr and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC791, RFC826, RFC792 +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC791, RFC826, RFC792 *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | memif_plugin.so @@ -59,8 +64,8 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Ver] Make TG send IPv4 packet in both directions between two\ -| | ... | of its interfaces to be routed by DUT to and from docker; verify\ +| | ... | - **[Ver]** Make TG send IPv4 packet in both directions between two \ +| | ... | of its interfaces to be routed by DUT to and from docker; verify \ | | ... | all packets are received. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-eth-2memif-1dcr-scapy.robot b/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-eth-2memif-1dcr-scapy.robot index fdcea357ef..5b2c0a8747 100644 --- a/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-eth-2memif-1dcr-scapy.robot +++ b/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-eth-2memif-1dcr-scapy.robot @@ -25,20 +25,24 @@ | | Test Template | Local Template | -| Documentation | *L2 bridge-domain test cases with memif interface* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology \ +| Documentation | **L2 bridge-domain test cases with memif interface** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 for L2 switching of IPv4.\ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 for L2 switching of IPv4. \ | ... | Both apply to all links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with L2 bridge-domain \ -| ... | switching. Container is connected to VPP via Memif interface. \ -| ... | Container is running same VPP version as running on DUT. -| ... | *[Ver] TG verification:* Test IPv4 packets with IP protocol=61\ +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with L2 \ +| ... | bridge-domain switching. Container is connected to VPP via Memif \ +| ... | interface. Container is running same VPP version as running on DUT. +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packets with IP protocol=61 \ | ... | are sent in both directions by TG on links to DUT1 and via container; \ -| ... | on receive TG verifies packets for correctness and their IPv4 \ +| ... | 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 | memif_plugin.so @@ -59,8 +63,8 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Ver] Make TG send IPv4 packets in both directions between two\ -| | ... | of its interfaces to be switched by DUT to and from docker; verify\ +| | ... | - **[Ver]** Make TG send IPv4 packets in both directions between two \ +| | ... | of its interfaces to be switched by DUT to and from docker; verify \ | | ... | all packets are received. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-l2xcbase-eth-2memif-1dcr-scapy.robot b/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-l2xcbase-eth-2memif-1dcr-scapy.robot index 1d09d87762..82e9264b4b 100644 --- a/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-l2xcbase-eth-2memif-1dcr-scapy.robot +++ b/tests/vpp/device/container_memif/2n1l-10ge2p1x710-ethip4-l2xcbase-eth-2memif-1dcr-scapy.robot @@ -25,19 +25,23 @@ | | Test Template | Local Template | -| Documentation | *L2 cross-connect test cases with memif interface* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology with \ -| ... | single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 for L2 switching of IPv4. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with L2 cross-connect \ -| ... | (L2XC) switching. Container is connected to VPP via Memif interface. \ -| ... | Container is running same VPP version as running on DUT. -| ... | *[Ver] TG verification:* Test IPv4 packets with IP protocol=61 \ +| Documentation | **L2 cross-connect test cases with memif interface** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ +| ... | with single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 for L2 switching of IPv4. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with L2 cross-\ +| ... | connect (L2XC) switching. Container is connected to VPP via Memif \ +| ... | interface. Container is running same VPP version as running on DUT. +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packets with IP protocol=61 \ | ... | are sent in both directions by TG on links to DUT1 and via container; \ -| ... | on receive TG verifies packets for correctness and their IPv4 \ +| ... | 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 | memif_plugin.so @@ -58,8 +62,8 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Ver] Make TG send IPv4 packets in both directions between two\ -| | ... | of its interfaces to be switched by DUT to and from docker; verify\ +| | ... | - **[Ver]** Make TG send IPv4 packets in both directions between two \ +| | ... | of its interfaces to be switched by DUT to and from docker; verify \ | | ... | all packets are received. | | | | ... | *Arguments:* -- cgit 1.2.3-korg