aboutsummaryrefslogtreecommitdiffstats
path: root/tests/vpp/perf/ip4/2n1l-10ge2p1x710-ethip4tcp-nat44ed-h16384-p63-s1032192-tput-ndrpdr.robot
diff options
context:
space:
mode:
authorViliam Luc <vluc@cisco.com>2021-10-28 15:05:53 +0200
committerTibor Frank <tifrank@cisco.com>2021-12-13 10:57:25 +0000
commite82ebbd96e2ba73276e2f1b6d7f9c2d8a9442c3f (patch)
tree8548662c60534211b7eb34f2f2881636ec3797b9 /tests/vpp/perf/ip4/2n1l-10ge2p1x710-ethip4tcp-nat44ed-h16384-p63-s1032192-tput-ndrpdr.robot
parentf87931f3c85fe71bb3124e787168abafc5874c54 (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/ip4/2n1l-10ge2p1x710-ethip4tcp-nat44ed-h16384-p63-s1032192-tput-ndrpdr.robot')
-rw-r--r--tests/vpp/perf/ip4/2n1l-10ge2p1x710-ethip4tcp-nat44ed-h16384-p63-s1032192-tput-ndrpdr.robot42
1 files changed, 24 insertions, 18 deletions
diff --git a/tests/vpp/perf/ip4/2n1l-10ge2p1x710-ethip4tcp-nat44ed-h16384-p63-s1032192-tput-ndrpdr.robot b/tests/vpp/perf/ip4/2n1l-10ge2p1x710-ethip4tcp-nat44ed-h16384-p63-s1032192-tput-ndrpdr.robot
index 1a044f91f8..edc2629706 100644
--- a/tests/vpp/perf/ip4/2n1l-10ge2p1x710-ethip4tcp-nat44ed-h16384-p63-s1032192-tput-ndrpdr.robot
+++ b/tests/vpp/perf/ip4/2n1l-10ge2p1x710-ethip4tcp-nat44ed-h16384-p63-s1032192-tput-ndrpdr.robot
@@ -27,24 +27,30 @@
| Test Template | Local Template
|
| # TODO CSIT-1765: Unify suite Documentation.
-| Documentation | *TPUT on lightweight TCP transactions with NAT44ED*
-|
-| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\
+| Documentation | **TPUT on lightweight TCP transactions with NAT44ED**
+| ... |
+| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \
| ... | with single links between nodes.
-| ... | *[Enc] Packet Encapsulations:* Eth-IPv4-TCP for IPv4 routing.
-| ... | *[Cfg] DUT configuration:* DUT1 is configured with IPv4\
-| ... | routing 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 client and server ASTF programs, generating packets containing\
-| ... | Ethernet header, IPv4 header, TCP header and static payload.\
+| ... |
+| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4-TCP for IPv4 routing.
+| ... |
+| ... | - **[Cfg] DUT configuration:** DUT1 is configured with IPv4. \
+| ... | routing and two static IPv4 /24 route entries. DUT1 is 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 client and server ASTF programs, generating packets \
+| ... | containing Ethernet header, IPv4 header, TCP header 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 | nat_plugin.so
@@ -91,9 +97,9 @@
*** Keywords ***
| Local Template
| | [Documentation]
-| | ... | [Cfg] DUT runs NAT44 ${nat_mode} configuration.\
+| | ... | - **[Cfg]** DUT runs NAT44 ${nat_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).