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 --- ...e2p1x710-ethip4-loadbalancer-l3dsr-ndrpdr.robot | 43 ++++++++++++---------- ...2p1x710-ethip4-loadbalancer-maglev-ndrpdr.robot | 43 ++++++++++++---------- ...ge2p1x710-ethip4-loadbalancer-nat4-ndrpdr.robot | 43 ++++++++++++---------- 3 files changed, 72 insertions(+), 57 deletions(-) (limited to 'tests/vpp/perf/lb') diff --git a/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-l3dsr-ndrpdr.robot b/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-l3dsr-ndrpdr.robot index 25dec68045..ebda8a2ea6 100644 --- a/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-l3dsr-ndrpdr.robot +++ b/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-l3dsr-ndrpdr.robot @@ -26,25 +26,30 @@ | | Test Template | Local Template | -| Documentation | *RFC2544: Pkt throughput loadbalancer l3dsr test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **RFC2544: Pkt throughput loadbalancer l3dsr test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4-UDP for LoadBalancer l3dsr. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with LoadBalancer\ -| ... | l3dsr and one static IPv4 /24 route entries. DUT1 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 DUT. TG traffic profile\ -| ... | contains two L4 flow-groups (l3dsr use flow-group is only from TG\ -| ... | to DUT, 6 flows for flow-group) with all packets containing Ethernet\ -| ... | header, IPv4 header with IP protocol=17 and static payload. MAC\ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4-UDP for LoadBalancer l3dsr. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with LoadBalancer \ +| ... | l3dsr and one static IPv4 /24 route entries. DUT1 tested with \ +| ... | 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 DUT. TG traffic profile \ +| ... | contains two L4 flow-groups (l3dsr use flow-group is only from TG \ +| ... | to DUT, 6 flows for flow-group) with all packets containing Ethernet \ +| ... | header, IPv4 header with IP protocol=17 and static payload. MAC \ | ... | addresses are matching MAC addresses of the TG node interfaces. -| ... | *[Ref] Applicable standard specifications:* RFC2544. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC2544. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | lb_plugin.so @@ -64,9 +69,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs LoadBalancer l3dsr config.\ +| | ... | - **[Cfg]** DUT runs LoadBalancer l3dsr 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). diff --git a/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-maglev-ndrpdr.robot b/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-maglev-ndrpdr.robot index 2c58df9f44..3edefd9891 100644 --- a/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-maglev-ndrpdr.robot +++ b/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-maglev-ndrpdr.robot @@ -26,25 +26,30 @@ | | Test Template | Local Template | -| Documentation | *RFC2544: Pkt throughput loadbalancer maglev test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **RFC2544: Pkt throughput loadbalancer maglev test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4-UDP for LoadBalancer maglev. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with LoadBalancer\ -| ... | maglev and one static IPv4 /24 route entries. DUT1 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 DUT. TG traffic profile\ -| ... | contains two L4 flow-groups (maglev use flow-group is only from TG\ -| ... | to DUT, 6 flows for flow-group) with all packets containing Ethernet\ -| ... | header, IPv4 header with IP protocol=17 and static payload. MAC\ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4-UDP for LoadBalancer maglev. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with LoadBalancer \ +| ... | maglev and one static IPv4 /24 route entries. DUT1 tested with \ +| ... | 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 DUT. TG traffic profile \ +| ... | contains two L4 flow-groups (maglev use flow-group is only from TG \ +| ... | to DUT, 6 flows for flow-group) with all packets containing Ethernet \ +| ... | header, IPv4 header with IP protocol=17 and static payload. MAC \ | ... | addresses are matching MAC addresses of the TG node interfaces. -| ... | *[Ref] Applicable standard specifications:* RFC2544. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC2544. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | lb_plugin.so @@ -64,9 +69,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs LoadBalancer maglev config.\ +| | ... | - **[Cfg]** DUT runs LoadBalancer maglev 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). diff --git a/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-nat4-ndrpdr.robot b/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-nat4-ndrpdr.robot index ba0ebd021e..20620ed210 100644 --- a/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-nat4-ndrpdr.robot +++ b/tests/vpp/perf/lb/2n1l-10ge2p1x710-ethip4-loadbalancer-nat4-ndrpdr.robot @@ -26,25 +26,30 @@ | | Test Template | Local Template | -| Documentation | *RFC2544: Pkt throughput loadbalancer nat4 test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **RFC2544: Pkt throughput loadbalancer nat4 test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4-UDP for LoadBalancer nat4. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with LoadBalancer\ -| ... | nat4 and two static IPv4 /24 route entries. DUT1 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 L4 flow-groups (flow-group per direction, 6 flows per\ -| ... | flow-group) with all packets containing Ethernet header, IPv4 header\ -| ... | with IP protocol=17 and static payload. MAC addresses are matching MAC\ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4-UDP for LoadBalancer nat4. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with LoadBalancer \ +| ... | nat4 and two static IPv4 /24 route entries. DUT1 tested with \ +| ... | 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 L4 flow-groups (flow-group per direction, 6 flows per \ +| ... | flow-group) with all packets containing Ethernet header, IPv4 header \ +| ... | with IP protocol=17 and static payload. MAC addresses are matching MAC \ | ... | addresses of the TG node interfaces. -| ... | *[Ref] Applicable standard specifications:* RFC2544. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC2544. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | lb_plugin.so @@ -63,9 +68,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs LoadBalancer nat4 config.\ +| | ... | - **[Cfg]** DUT runs LoadBalancer nat4 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