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 --- ...thip4udp-ip4base-iacl50sf-100flows-ndrpdr.robot | 49 ++++++++++++---------- 1 file changed, 27 insertions(+), 22 deletions(-) (limited to 'tests/vpp/perf/ip4/10ge2p1x710-ethip4udp-ip4base-iacl50sf-100flows-ndrpdr.robot') diff --git a/tests/vpp/perf/ip4/10ge2p1x710-ethip4udp-ip4base-iacl50sf-100flows-ndrpdr.robot b/tests/vpp/perf/ip4/10ge2p1x710-ethip4udp-ip4base-iacl50sf-100flows-ndrpdr.robot index 917ec78ffe..5d8d8d3ea1 100644 --- a/tests/vpp/perf/ip4/10ge2p1x710-ethip4udp-ip4base-iacl50sf-100flows-ndrpdr.robot +++ b/tests/vpp/perf/ip4/10ge2p1x710-ethip4udp-ip4base-iacl50sf-100flows-ndrpdr.robot @@ -27,26 +27,31 @@ | | Test Template | Local Template | -| Documentation | *RFC2544: Packet throughput IPv4 test cases with ACL* -| -| ... | *[Top] Network Topologies:* TG-DUT1-DUT2-TG 3-node circular topology\ -| ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4-UDP for IPv4 routing. -| ... | *[Cfg] DUT configuration:* DUT1 and DUT2 are configured with IPv4\ -| ... | routing and one static IPv4 /24 route entries. Required ACL rules are\ -| ... | applied to input paths of both DUT1 intefaces. DUT1 and DUT2 are tested\ -| ... | with ${nic_name}.\ -| ... | *[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 DUTs. TG traffic profile\ -| ... | contains two L3 flow-groups (flow-group per direction, ${flows_per_dir}\ -| ... | 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: Packet throughput IPv4 test cases with ACL** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-DUT2-TG 3-node circular \ +| ... | topology with single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4-UDP for IPv4 routing. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 and DUT2 are configured with IPv4. \ +| ... | routing and one static IPv4 /24 route entries. Required ACL rules are \ +| ... | applied to input paths of both DUT1 intefaces. \ +| ... | DUT1 and DUT2 are tested with ${nic_name}. +| ... | +| ... | - **[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 DUTs. TG traffic profile \ +| ... | contains two L3 flow-groups (flow-group per direction, \ +| ... | ${flows_per_dir} 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 | acl_plugin.so @@ -80,9 +85,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs IPv4 routing config. +| | ... | - **[Cfg]** DUT runs IPv4 routing config. \ | | ... | 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). -- cgit 1.2.3-korg