aboutsummaryrefslogtreecommitdiffstats
path: root/docs/report/vpp_functional_tests/overview.rst
diff options
context:
space:
mode:
authorPeter Mikus <pmikus@cisco.com>2017-08-02 11:34:42 +0200
committerPeter Mikus <pmikus@cisco.com>2017-08-02 12:37:32 +0200
commitbbcaa22c4425c32c3e3d2bcde434cdefc6b9a992 (patch)
tree79744d45bf4b5cb937f57d93fc9982605ded1e91 /docs/report/vpp_functional_tests/overview.rst
parent1a65bb060fb464ea0113ec082af66fce481c7773 (diff)
CSIT-744 Update report content for proper parsing
Follow the good practices for formatting. Update the content of release report RST files to use the proper directives like :cite:, :footnote:, :abbr:, :captions: etc.With these markings we will be able to format output in proper way and style it in various sphinx output builders. Change-Id: Ibbb538d43c3bd364a6acdcc990097a477f49de00 Signed-off-by: Peter Mikus <pmikus@cisco.com>
Diffstat (limited to 'docs/report/vpp_functional_tests/overview.rst')
-rw-r--r--docs/report/vpp_functional_tests/overview.rst20
1 files changed, 8 insertions, 12 deletions
diff --git a/docs/report/vpp_functional_tests/overview.rst b/docs/report/vpp_functional_tests/overview.rst
index e8f8460d34..fda35072ef 100644
--- a/docs/report/vpp_functional_tests/overview.rst
+++ b/docs/report/vpp_functional_tests/overview.rst
@@ -5,14 +5,12 @@ Tested Virtual Topologies
-------------------------
CSIT VPP functional tests are executed on virtualized topologies created using
-Virtual Internet Routing Lab (VIRL) simulation platform contributed by Cisco.
-VIRL runs on physical baremetal servers hosted by LF FD.io project. Majority
-of the tests are executed in the three node logical test topology - Traffic
-Generator (TG) node and two Systems Under Test (SUT) nodes connected in a
-loop. Some tests use two node logical test topology - TG node and SUT1 node.
-Both logical test topologies are shown in the figures below.
-
-::
+:abbr:`VIRL (Virtual Internet Routing Lab)` simulation platform contributed by
+Cisco. VIRL runs on physical baremetal servers hosted by LF FD.io project.
+Majority of the tests are executed in the three node logical test topology -
+Traffic Generator (TG) node and two Systems Under Test (SUT) nodes connected in
+a loop. Some tests use two node logical test topology - TG node and SUT1 node.
+Both logical test topologies are shown in the figures below.::
+------------------------+ +------------------------+
| | | |
@@ -68,9 +66,7 @@ For the test cases that require DUT (VPP) to communicate with VM over the
vhost-user interfaces, a nested VM is created on SUT1 and/or SUT2 for the
duration of these particular test cases only. DUT (VPP) test topology with VM
is shown in the figure below including the applicable packet flow thru the VM
-(marked in the figure with ``***``).
-
-::
+(marked in the figure with ``***``).::
+------------------------+ +------------------------+
| +----------+ | | +----------+ |
@@ -135,7 +131,7 @@ CSIT |release| follows a common structured naming convention for all
performance and system functional tests, introduced in CSIT |release-1|.
The naming should be intuitive for majority of the tests. Complete
-description of CSIT test naming convention is provided on
+description of CSIT test naming convention is provided on
`CSIT test naming wiki page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.
Here few illustrative examples of the new naming usage for functional test