CSIT-744 Update report content for proper parsing

[csit.git] / docs / report / vpp_performance_tests / csit_release_notes.rst

diff --git a/docs/report/vpp_performance_tests/csit_release_notes.rst b/docs/report/vpp_performance_tests/csit_release_notes.rst
index 0ee3e82..c9e62e8 100644 (file)
--- a/docs/report/vpp_performance_tests/csit_release_notes.rst
+++ b/docs/report/vpp_performance_tests/csit_release_notes.rst
@@ -6,18 +6,18 @@ Changes in CSIT |release|
 \r
 #. Test environment changes in VPP data plane performance tests:\r
 \r
-   - Further characterization and optimizations of VPP vhost-user and VM\r
-     test methodology and test environment;\r
+   - Further characterization and optimizations of VPP vhost-user and VM test\r
+     methodology and test environment;\r
 \r
      - Tests with varying Qemu virtio queue (a.k.a. vring) sizes:\r
        [vr256] default 256 descriptors, [vr1024] 1024 descriptors to\r
        optimize for packet throughput;\r
 \r
-     - Tests with varying Linux CFS (Completely Fair Scheduler)\r
-       settings: [cfs] default settings, [cfsrr1] CFS RoundRobin(1)\r
-       policy applied to all data plane threads handling test packet\r
-       path including all VPP worker threads and all Qemu testpmd\r
-       poll-mode threads;\r
+     - Tests with varying Linux :abbr:`CFS (Completely Fair Scheduler)`\r
+       settings: [cfs] default settings, [cfsrr1] :abbr:`CFS (Completely Fair\r
+       Scheduler)` RoundRobin(1) policy applied to all data plane threads\r
+       handling test packet path including all VPP worker threads and all Qemu\r
+       testpmd poll-mode threads;\r
 \r
      - Resulting test cases are all combinations with [vr256,vr1024] and\r
        [cfs,cfsrr1] settings;\r
@@ -28,8 +28,8 @@ Changes in CSIT |release|
 #. Code updates and optimizations in CSIT performance framework:\r
 \r
    - Complete CSIT framework code revision and optimizations as descried\r
-     on CSIT wiki page\r
-     `Design_Optimizations <https://wiki.fd.io/view/CSIT/Design_Optimizations>`_.\r
+     on CSIT wiki page `Design_Optimizations\r
+     <https://wiki.fd.io/view/CSIT/Design_Optimizations>`_.\r
 \r
    - For more detail see the :ref:`CSIT Framework Design <csit-design>` section\r
      in this report;\r
@@ -85,14 +85,14 @@ Changes in CSIT |release|
 Performance Improvements\r
 ------------------------\r
 \r
-Substantial improvements in measured packet throughput have been\r
-observed in a number of CSIT |release| tests listed below, with relative\r
-increase  of double-digit percentage points. Relative improvements for\r
-this release are calculated against the test results listed in CSIT\r
-|release-1| report. The comparison is calculated between the mean values\r
-based on collected and archived test results' samples for involved VPP\r
-releases. Standard deviation has been also listed for CSIT |release|.\r
-VPP-16.09 and VPP-17.01 numbers are provided for reference.\r
+Substantial improvements in measured packet throughput have been observed in a\r
+number of CSIT |release| tests listed below, with relative increase of\r
+double-digit percentage points. Relative improvements for this release are\r
+calculated against the test results listed in CSIT |release-1| report. The\r
+comparison is calculated between the mean values based on collected and\r
+archived test results' samples for involved VPP releases. Standard deviation\r
+has been also listed for CSIT |release|. VPP-16.09 and VPP-17.01 numbers are\r
+provided for reference.\r
 \r
 NDR Throughput\r
 ~~~~~~~~~~~~~~\r
@@ -121,10 +121,10 @@ Measured improvements are in line with VPP code optimizations listed in
 Other Performance Changes\r
 -------------------------\r
 \r
-Other changes in measured packet throughput, with either minor relative\r
-increase or decrease, have been observed in a number of CSIT |release|\r
-tests listed below. Relative changes are calculated against the test\r
-results listed in CSIT |release-1| report.\r
+Other changes in measured packet throughput, with either minor relative increase\r
+or decrease, have been observed in a number of CSIT |release| tests listed\r
+below. Relative changes are calculated against the test results listed in CSIT\r
+|release-1| report.\r
 \r
 NDR Throughput\r
 ~~~~~~~~~~~~~~\r