diff options
author | Viliam Luc <vluc@cisco.com> | 2021-10-28 15:05:53 +0200 |
---|---|---|
committer | Tibor Frank <tifrank@cisco.com> | 2021-12-13 10:57:25 +0000 |
commit | e82ebbd96e2ba73276e2f1b6d7f9c2d8a9442c3f (patch) | |
tree | 8548662c60534211b7eb34f2f2881636ec3797b9 /tests/vpp/perf/vts | |
parent | f87931f3c85fe71bb3124e787168abafc5874c54 (diff) |
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 <vluc@cisco.com>
Change-Id: I1ac1099d38935971d47491dde905715345d3935c
Diffstat (limited to 'tests/vpp/perf/vts')
3 files changed, 72 insertions, 57 deletions
diff --git a/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-aclpermit-2vhostvr1024-1vm-ndrpdr.robot b/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-aclpermit-2vhostvr1024-1vm-ndrpdr.robot index 355daf8c4a..6072b5371a 100644 --- a/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-aclpermit-2vhostvr1024-1vm-ndrpdr.robot +++ b/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-aclpermit-2vhostvr1024-1vm-ndrpdr.robot @@ -27,30 +27,35 @@ | | Test Template | Local Template | -| Documentation | *RFC2544: Packet throughput L2BD test cases with VXLANoIPv4 -| ... | and vhost* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology +| Documentation | **RFC2544: Packet throughput L2BD test cases with \ +| ... | VXLANoIPv4 and vhost** +| ... | +| ... | - **[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. \ | ... | Eth-IPv4-VXLAN-Eth-IPv4 is applied on link from/to TG. -| ... | *[Cfg] DUT configuration:* DUTs are configured with L2 bridge- +| ... | +| ... | - **[Cfg] DUT configuration:** DUTs are configured with L2 bridge- \ | ... | domain and MAC learning enabled. Qemu VNFs are connected \ | ... | to VPP via vhost-user interfaces. Guest is running VPP l2xc \ | ... | interconnecting vhost-user interfaces, rxd/txd=1024. DUTs 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, 253 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 +| ... | +| ... | - **[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, 253 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, RFC7348. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC2544, RFC7348. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | acl_plugin.so @@ -75,9 +80,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L2BD switching config. +| | ... | - **[Cfg]** DUT runs L2BD switching 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 - L2 Frame Size [B]. Type: integer diff --git a/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-aclpermitreflect-2vhostvr1024-1vm-ndrpdr.robot b/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-aclpermitreflect-2vhostvr1024-1vm-ndrpdr.robot index 68053e1161..a38d5b8d55 100644 --- a/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-aclpermitreflect-2vhostvr1024-1vm-ndrpdr.robot +++ b/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-aclpermitreflect-2vhostvr1024-1vm-ndrpdr.robot @@ -27,30 +27,35 @@ | | Test Template | Local Template | -| Documentation | *RFC2544: Packet throughput L2BD test cases with VXLANoIPv4 -| ... | and vhost* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology +| Documentation | **RFC2544: Packet throughput L2BD test cases with \ +| ... | VXLANoIPv4 and vhost** +| ... | +| ... | - **[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. \ | ... | Eth-IPv4-VXLAN-Eth-IPv4 is applied on link from/to TG. -| ... | *[Cfg] DUT configuration:* DUTs are configured with L2 bridge- +| ... | +| ... | - **[Cfg] DUT configuration:** DUTs are configured with L2 bridge- \ | ... | domain and MAC learning enabled. Qemu VNFs are connected \ | ... | to VPP via vhost-user interfaces. Guest is running VPP l2xc \ | ... | interconnecting vhost-user interfaces, rxd/txd=1024. DUTs 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, 253 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 +| ... | +| ... | - **[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, 253 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, RFC7348. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC2544, RFC7348. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | acl_plugin.so @@ -75,9 +80,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L2BD switching config. +| | ... | - **[Cfg]** DUT runs L2BD switching 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 - L2 Frame Size [B]. Type: integer diff --git a/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-noacl-2vhostvr1024-1vm-ndrpdr.robot b/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-noacl-2vhostvr1024-1vm-ndrpdr.robot index 0cb40dfb3c..c62b53a72d 100644 --- a/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-noacl-2vhostvr1024-1vm-ndrpdr.robot +++ b/tests/vpp/perf/vts/2n1l-10ge2p1x710-ethip4vxlan-l2bdbasemaclrn-eth-iacldstbase-noacl-2vhostvr1024-1vm-ndrpdr.robot @@ -27,30 +27,35 @@ | | Test Template | Local Template | -| Documentation | *RFC2544: Packet throughput L2BD test cases with VXLANoIPv4 -| ... | and vhost* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology +| Documentation | **RFC2544: Packet throughput L2BD test cases with \ +| ... | VXLANoIPv4 and vhost** +| ... | +| ... | - **[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. \ | ... | Eth-IPv4-VXLAN-Eth-IPv4 is applied on link from/to TG. -| ... | *[Cfg] DUT configuration:* DUTs are configured with L2 bridge- +| ... | +| ... | - **[Cfg] DUT configuration:** DUTs are configured with L2 bridge- \ | ... | domain and MAC learning enabled. Qemu VNFs are connected \ | ... | to VPP via vhost-user interfaces. Guest is running VPP l2xc \ | ... | interconnecting vhost-user interfaces, rxd/txd=1024. DUTs 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, 253 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 +| ... | +| ... | - **[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, 253 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, RFC7348. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC2544, RFC7348. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -75,9 +80,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L2BD switching config. +| | ... | - **[Cfg]** DUT runs L2BD switching 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 - L2 Frame Size [B]. Type: integer |