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 --- ...l-10ge2p1x710-dot1q-l2bdbasemaclrn-ndrpdr.robot | 55 ++++++++++++---------- 1 file changed, 30 insertions(+), 25 deletions(-) (limited to 'tests/vpp/perf/l2/2n1l-10ge2p1x710-dot1q-l2bdbasemaclrn-ndrpdr.robot') diff --git a/tests/vpp/perf/l2/2n1l-10ge2p1x710-dot1q-l2bdbasemaclrn-ndrpdr.robot b/tests/vpp/perf/l2/2n1l-10ge2p1x710-dot1q-l2bdbasemaclrn-ndrpdr.robot index c69dcfe59e..468f4eed29 100644 --- a/tests/vpp/perf/l2/2n1l-10ge2p1x710-dot1q-l2bdbasemaclrn-ndrpdr.robot +++ b/tests/vpp/perf/l2/2n1l-10ge2p1x710-dot1q-l2bdbasemaclrn-ndrpdr.robot @@ -26,28 +26,33 @@ | | Test Template | Local Template | -| Documentation | *RFC2544: Pkt throughput L2BD with IEEE 802.1Q test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology with\ -| ... | single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Dot1q-IPv4 for L2 switching of IPv4.\ -| ... | IEEE 802.1Q tagging is applied on both links TG-DUT1 . -| ... | *[Cfg] DUT configuration:* DUT1 is configured with:\ -| ... | 2 VLAN subinterfaces (VID 100 and 200),\ -| ... | 1 L2 BD with the 2 VLAN subinterfaces,\ -| ... | DUT1 tested with ${nic_name} with VF enabled. -| ... | *[Ver] TG verification:* TG finds and reports throughput NDR (Non Drop\ -| ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\ -| ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\ -| ... | of packets transmitted. NDR and PDR are discovered for different\ -| ... | Ethernet L2 frame sizes using MLRsearch library.\ -| ... | Test packets are\ -| ... | generated by TG on links to DUT1. TG traffic profile contains two L3\ -| ... | flow-groups (flow-group per direction, 254 flows per flow-group) with\ -| ... | all packets containing Ethernet header, IPv4 header with IP protocol=61\ -| ... | and static payload. MAC addresses are matching MAC addresses of the TG\ -| ... | node interfaces. -| ... | *[Ref] Applicable standard specifications:* RFC2544. +| Documentation | **RFC2544: Pkt throughput L2BD with IEEE 802.1Q test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ +| ... | with single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Dot1q-IPv4 for L2 switching \ +| ... | of IPv4. IEEE 802.1Q tagging is applied on both links TG-DUT1. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with: \ +| ... | 2 VLAN subinterfaces (VID 100 and 200), \ +| ... | 1 L2 BD with the 2 VLAN subinterfaces. \ +| ... | DUT1 is tested with ${nic_name} with VF enabled. +| ... | +| ... | - **[Ver] TG verification:** TG finds and reports throughput NDR (Non \ +| ... | Drop Rate) with zero packet loss tolerance and throughput PDR \ +| ... | (Partial Drop Rate) with non-zero packet loss tolerance (LT) \ +| ... | expressed in percentage of packets transmitted. NDR and PDR are \ +| ... | discovered for different Ethernet L2 frame sizes using MLRsearch \ +| ... | library. +| ... | Test packets are \ +| ... | generated by TG on links to DUT1. TG traffic profile contains two L3 \ +| ... | flow-groups (flow-group per direction, 254 flows per flow-group) with \ +| ... | all packets containing Ethernet header, IPv4 header with IP \ +| ... | protocol=61 and static payload. MAC addresses are matching MAC \ +| ... | addresses of the TG node interfaces. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC2544. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -66,9 +71,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L2BD with VLAN with ${phy_cores} physical core(s) for\ -| | ... | worker threads. -| | ... | [Ver] Measure NDR and PDR values using MLRsearch algorithm.\ +| | ... | - **[Cfg]** DUT runs L2BD with VLAN with ${phy_cores} physical \ +| | ... | core(s) for worker threads. +| | ... | - **[Ver]** Measure NDR and PDR values using MLRsearch algorithm. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer or string (IMIX_v4_1). -- cgit 1.2.3-korg