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/dpdk | |
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/dpdk')
4 files changed, 90 insertions, 70 deletions
diff --git a/tests/dpdk/perf/10ge2p1x710-eth-l2xcbase-testpmd-ndrpdr.robot b/tests/dpdk/perf/10ge2p1x710-eth-l2xcbase-testpmd-ndrpdr.robot index b556c7f1af..c808d4f148 100644 --- a/tests/dpdk/perf/10ge2p1x710-eth-l2xcbase-testpmd-ndrpdr.robot +++ b/tests/dpdk/perf/10ge2p1x710-eth-l2xcbase-testpmd-ndrpdr.robot @@ -27,22 +27,27 @@ | | Test Template | Local Template | -| Documentation | *Raw results L2 routing test cases* -| ... | *[Top] Network Topologies:* TG-DUT1-DUT2-TG 3-node circular topology\ -| ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 for L2 frame forwarding. -| ... | *[Cfg] DUT configuration:* DUT1 and DUT2 run the DPDK testpmd\ -| ... | application and use the io forwarding mode. DUT1 and DUT2 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, 254 flows per flow-group) with\ -| ... | all packets containing Ethernet header,IPv4 header with static payload.\ +| Documentation | **Raw results L2 routing test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-DUT2-TG 3-node circular \ +| ... | topology with single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 for L2 frame forwarding. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 and DUT2 run the DPDK testpmd \ +| ... | application and use the io forwarding mode. 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, 254 flows per flow-group) with all \ +| ... | packets containing Ethernet header, IPv4 header with static payload \ | ... | MAC addresses are matching MAC addresses of the TG node interfaces. *** Variables *** @@ -61,9 +66,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L2 frame forwarding config.\ +| | ... | - **[Cfg]** DUT runs L2 frame forwarding 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} | ${phy_cores} | ${rxq}=${None} | | diff --git a/tests/dpdk/perf/10ge2p1x710-ethip4-ip4base-l3fwd-ndrpdr.robot b/tests/dpdk/perf/10ge2p1x710-ethip4-ip4base-l3fwd-ndrpdr.robot index ea4483fcd1..a99a7f6be2 100644 --- a/tests/dpdk/perf/10ge2p1x710-ethip4-ip4base-l3fwd-ndrpdr.robot +++ b/tests/dpdk/perf/10ge2p1x710-ethip4-ip4base-l3fwd-ndrpdr.robot @@ -27,22 +27,27 @@ | | Test Template | Local Template | -| Documentation | *Raw results IPv4 routing test cases* -| ... | *[Top] Network Topologies:* TG-DUT1-DUT2-TG 3-node circular topology\ -| ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 for L3 IPv4 routing. -| ... | *[Cfg] DUT configuration:* DUT1 and DUT2 run the DPDK l3fwd application\ -| ... | DUT1 and DUT2 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\ +| Documentation | **Raw results IPv4 routing test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-DUT2-TG 3-node circular \ +| ... | topology with single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 for L3 IPv4 routing. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 and DUT2 run the DPDK l3fwd \ +| ... | application. 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, 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. *** Variables *** @@ -61,9 +66,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L3 IPv4 routing config.\ +| | ... | - **[Cfg]** DUT runs L3 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} | ${phy_cores} | ${rxq}=${None} | | diff --git a/tests/dpdk/perf/2n1l-10ge2p1x710-eth-l2xcbase-testpmd-ndrpdr.robot b/tests/dpdk/perf/2n1l-10ge2p1x710-eth-l2xcbase-testpmd-ndrpdr.robot index aa62fe54fb..467db2ece8 100644 --- a/tests/dpdk/perf/2n1l-10ge2p1x710-eth-l2xcbase-testpmd-ndrpdr.robot +++ b/tests/dpdk/perf/2n1l-10ge2p1x710-eth-l2xcbase-testpmd-ndrpdr.robot @@ -27,22 +27,27 @@ | | Test Template | Local Template | -| Documentation | *Raw results L2 routing test cases* -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **Raw results L2 routing test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 for L2 frame forwarding. -| ... | *[Cfg] DUT configuration:* DUT1 run the DPDK testpmd\ -| ... | application and use the io forwarding mode. 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 L3 flow-groups\ -| ... | (flow-group per direction, 254 flows per flow-group) with\ -| ... | all packets containing Ethernet header,IPv4 header with static payload.\ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 for L2 frame forwarding. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 run the DPDK testpmd \ +| ... | application and use the io forwarding mode. 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 L3 flow-groups \ +| ... | (flow-group per direction, 254 flows per flow-group) with all \ +| ... | packets containing Ethernet header, IPv4 header with static payload \ | ... | MAC addresses are matching MAC addresses of the TG node interfaces. *** Variables *** @@ -61,9 +66,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L2 frame forwarding config.\ +| | ... | - **[Cfg]** DUT runs L2 frame forwarding 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} | ${phy_cores} | ${rxq}=${None} | | diff --git a/tests/dpdk/perf/2n1l-10ge2p1x710-ethip4-ip4base-l3fwd-ndrpdr.robot b/tests/dpdk/perf/2n1l-10ge2p1x710-ethip4-ip4base-l3fwd-ndrpdr.robot index fe9734a036..ce96f2f459 100644 --- a/tests/dpdk/perf/2n1l-10ge2p1x710-ethip4-ip4base-l3fwd-ndrpdr.robot +++ b/tests/dpdk/perf/2n1l-10ge2p1x710-ethip4-ip4base-l3fwd-ndrpdr.robot @@ -27,22 +27,27 @@ | | Test Template | Local Template | -| Documentation | *Raw results IPv4 routing test cases* -| ... | *[Top] Network Topologies:* TG-DUT1-TG 3-node circular topology\ +| Documentation | **Raw results IPv4 routing test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 3-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 for L3 IPv4 routing. -| ... | *[Cfg] DUT configuration:* DUT1 run the DPDK l3fwd application\ -| ... | 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 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\ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 for L3 IPv4 routing. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 run the DPDK l3fwd application \ +| ... | 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 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. *** Variables *** @@ -61,9 +66,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L3 IPv4 routing config.\ +| | ... | - **[Cfg]** DUT runs L3 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} | ${phy_cores} | ${rxq}=${None} | | |