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 --- ...ip4--ethip4udpgeneve-16tun-ip4base-ndrpdr.robot | 51 ++++++++++++---------- 1 file changed, 28 insertions(+), 23 deletions(-) (limited to 'tests/vpp/perf/ip4_tunnels/2n1l-10ge2p1x710-ethip4--ethip4udpgeneve-16tun-ip4base-ndrpdr.robot') diff --git a/tests/vpp/perf/ip4_tunnels/2n1l-10ge2p1x710-ethip4--ethip4udpgeneve-16tun-ip4base-ndrpdr.robot b/tests/vpp/perf/ip4_tunnels/2n1l-10ge2p1x710-ethip4--ethip4udpgeneve-16tun-ip4base-ndrpdr.robot index 68ac42d623..e99117ba82 100644 --- a/tests/vpp/perf/ip4_tunnels/2n1l-10ge2p1x710-ethip4--ethip4udpgeneve-16tun-ip4base-ndrpdr.robot +++ b/tests/vpp/perf/ip4_tunnels/2n1l-10ge2p1x710-ethip4--ethip4udpgeneve-16tun-ip4base-ndrpdr.robot @@ -28,29 +28,34 @@ | | Test Template | Local Template | -| Documentation | *RFC2544: Pkt throughput GENEVE tunnel L3 mode performance -| ... | test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology +| Documentation | **RFC2544: Pkt throughput GENEVE tunnel L3 mode performance \ +| ... | test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 between TG-if1 and DUT1-if1 and\ -| ... | Eth-IPv4-UDP-GENEVE-Eth-IPv4 between DUT1-if2 and TG-if2 for IPv4\ -| ... | routing over GENEVE tunnels. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with IPv4 routing over\ -| ... | ${n_tunnels} GENEVE tunnels and ${${4} * ${n_tunnels}} static IPv4 /24\ -| ... | route entries. DUT1 is 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 DUT1. TG traffic profile -| ... | contains two L3 flow-groups (flow-group per direction, 1 flow per -| ... | flow-group) with all packets containing Ethernet header, IPv4 header -| ... | with IP protocol=61 and static payload. MAC addresses are matching MAC +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 between TG-if1 and \ +| ... | DUT1-if1 and Eth-IPv4-UDP-GENEVE-Eth-IPv4 between DUT1-if2 and TG-if2 \ +| ... | for IPv4 routing over GENEVE tunnels. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with IPv4 routing \ +| ... | over ${n_tunnels} GENEVE tunnels and ${${4} ** ${n_tunnels}} static \ +| ... | IPv4 /24 route entries. DUT1 is 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 DUT1. TG traffic profile \ +| ... | contains two L3 flow-groups (flow-group per direction, 1 flow 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, RFC791, RFC768, -| ... | RFC8926. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC2544, RFC791, \ +| ... | RFC768 and RFC8926. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | geneve_plugin.so @@ -81,9 +86,9 @@ | Local Template | | | | [Documentation] -| | ... | [Cfg] DUT runs GENEVE ${gen_mode} mode configuration. +| | ... | - **[Cfg]** DUT runs GENEVE ${gen_mode} mode configuration. \ | | ... | 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