Report: Edit the chapters' titles

Change-Id: I23cedb3ad0f188e9c7570f549e397f4c42404fab
Signed-off-by: Tibor Frank <tifrank@cisco.com>

diff --git a/docs/report/csit_framework_documentation/index.rst b/docs/report/csit_framework_documentation/index.rst
index 0b3228d..82031e3 100644 (file)
--- a/docs/report/csit_framework_documentation/index.rst
+++ b/docs/report/csit_framework_documentation/index.rst
@@ -1,5 +1,5 @@
-CSIT Framework Documentation
-============================
+CSIT Framework
+==============
 
 .. toctree::
 

diff --git a/docs/report/detailed_test_results/dpdk_performance_results/index.rst b/docs/report/detailed_test_results/dpdk_performance_results/index.rst
index 963e31b..3d1f635 100644 (file)
--- a/docs/report/detailed_test_results/dpdk_performance_results/index.rst
+++ b/docs/report/detailed_test_results/dpdk_performance_results/index.rst
@@ -1,5 +1,5 @@
-DPDK Performance
-================
+DPDK Throughput
+===============
 
 .. toctree::
 

diff --git a/docs/report/detailed_test_results/vpp_mrr_results/index.rst b/docs/report/detailed_test_results/vpp_mrr_results/index.rst
index ace7ef8..d691367 100644 (file)
--- a/docs/report/detailed_test_results/vpp_mrr_results/index.rst
+++ b/docs/report/detailed_test_results/vpp_mrr_results/index.rst
@@ -1,5 +1,5 @@
-VPP Performance MRR
-===================
+VPP MRR
+=======
 
 .. toctree::
 

diff --git a/docs/report/detailed_test_results/vpp_performance_results/index.rst b/docs/report/detailed_test_results/vpp_performance_results/index.rst
index 5d2ee11..7578234 100644 (file)
--- a/docs/report/detailed_test_results/vpp_performance_results/index.rst
+++ b/docs/report/detailed_test_results/vpp_performance_results/index.rst
@@ -1,5 +1,5 @@
-VPP Performance NDR/PDR
-=======================
+VPP Throughput
+==============
 
 .. toctree::
 

diff --git a/docs/report/dpdk_performance_tests/test_environment.rst b/docs/report/dpdk_performance_tests/test_environment.rst
index 1c2a580..e1eb8fa 100644 (file)
--- a/docs/report/dpdk_performance_tests/test_environment.rst
+++ b/docs/report/dpdk_performance_tests/test_environment.rst
@@ -9,10 +9,6 @@
 
 .. include:: ../introduction/test_environment_sut_calib_skx.rst
 
-.. include:: ../introduction/test_environment_sut_meltspec_hsw.rst
-
-.. include:: ../introduction/test_environment_sut_meltspec_skx.rst
-
 .. include:: ../introduction/test_environment_sut_conf_1.rst
 
 .. include:: ../introduction/test_environment_sut_conf_3.rst

diff --git a/docs/report/introduction/introduction.rst b/docs/report/introduction/introduction.rst
index 9990d47..c15df8d 100644 (file)
--- a/docs/report/introduction/introduction.rst
+++ b/docs/report/introduction/introduction.rst
@@ -1,5 +1,5 @@
-Introduction
-============
+Report Structure
+================
 
 FD.io |csit-release| report contains system performance and functional
 testing data of |vpp-release|. `PDF version of this report`_ is

diff --git a/docs/report/introduction/report_history.rst b/docs/report/introduction/report_history.rst
index aeb6848..eef74fe 100644 (file)
--- a/docs/report/introduction/report_history.rst
+++ b/docs/report/introduction/report_history.rst
@@ -4,29 +4,32 @@ Document History
 +---------+--------------------------------------------------------------------+
 | Version | Change                                                             |
 +=========+====================================================================+
-| .w47    | 1. Automatic wrapping of long test names in graphs added.          |
-|         | 2. Data and time format in the header changed.                     |
-|         | 3. Versioning changed.                                             |
+| .w47    | 1. Added automated wrapping of long test names in graphs.          |
+|         | 2. Changed data and time format in the header.                     |
+|         | 3. Changed versioning.                                             |
 |         | 4. Added more test runs:                                           |
 |         |                                                                    |
-|         |    a. HoneyComb Functional,                                        |
+|         |    a. HoneyComb Functional.                                        |
 |         |    b. VPP on 3n-hsw testbed.                                       |
 |         |                                                                    |
-|         | 5. 3n-skx and 2n-skx comparisons added to Report:                  |
+|         | 5. Added 3n-skx and 2n-skx comparisons to Report:                  |
 |         |                                                                    |
 |         |    a. VPP Performance Tests:                                       |
 |         |       :ref:`vpp_compare_current_vs_previous_release`               |
 |         |    b. DPDK Performance Tests:                                      |
 |         |       :ref:`dpdk_compare_current_vs_previous_release`              |
 |         |                                                                    |
-|         | 6. Title of this chapter changed to "Document History"             |
+|         | 6. Changed title of this chapter to "Document History"             |
 |         |                                                                    |
 +---------+--------------------------------------------------------------------+
 | .w46    | 1. dot1q KVM VMs vhost-user tests added to                         |
 |         |    :ref:`KVM_VMs_vhost`.                                           |
 |         |                                                                    |
 |         | 2. Added number of test runs used to generate data for all graphs  |
-|         |    (throughput, speedup multi-core and latency).                   |
+|         |                                                                    |
+|         |    a. :ref:`VPP_Packet_Throughput`                                 |
+|         |    b. :ref:`throughput_speedup_multi_core`                         |
+|         |    c. :ref:`VPP_Packet_Latency`                                    |
 |         |                                                                    |
 |         | 3. Added more test runs:                                           |
 |         |                                                                    |

diff --git a/docs/report/introduction/test_environment_sut_calib_hsw.rst b/docs/report/introduction/test_environment_sut_calib_hsw.rst
index 62de7f6..b814988 100644 (file)
--- a/docs/report/introduction/test_environment_sut_calib_hsw.rst
+++ b/docs/report/introduction/test_environment_sut_calib_hsw.rst
@@ -221,3 +221,5 @@ L1/L2/LLC Latency
     Writer Numa Node     0       1
                 0        -   107.7
                 1    106.6       -
+
+.. include:: ../introduction/test_environment_sut_meltspec_hsw.rst

diff --git a/docs/report/introduction/test_environment_sut_calib_skx.rst b/docs/report/introduction/test_environment_sut_calib_skx.rst
index 61d2a7a..2e00e6f 100644 (file)
--- a/docs/report/introduction/test_environment_sut_calib_skx.rst
+++ b/docs/report/introduction/test_environment_sut_calib_skx.rst
@@ -211,3 +211,5 @@ L1/L2/LLC Latency
     Writer Numa Node        0       1
                 0           -   177.9
                 1       177.6       -
+
+.. include:: ../introduction/test_environment_sut_meltspec_skx.rst

diff --git a/docs/report/introduction/test_environment_sut_meltspec_hsw.rst b/docs/report/introduction/test_environment_sut_meltspec_hsw.rst
index 0e68e57..71787f0 100644 (file)
--- a/docs/report/introduction/test_environment_sut_meltspec_hsw.rst
+++ b/docs/report/introduction/test_environment_sut_meltspec_hsw.rst
@@ -1,5 +1,5 @@
-SPECTRE - MELTDOWN Checks - Haswell
------------------------------------
+Spectre and Meltdown Checks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Following section displays the output of a running shell script to tell if
 system is vulnerable against the several "speculative execution" CVEs that were

diff --git a/docs/report/introduction/test_environment_sut_meltspec_skx.rst b/docs/report/introduction/test_environment_sut_meltspec_skx.rst
index 5d3f719..443a7fd 100644 (file)
--- a/docs/report/introduction/test_environment_sut_meltspec_skx.rst
+++ b/docs/report/introduction/test_environment_sut_meltspec_skx.rst
@@ -1,5 +1,5 @@
-SPECTRE - MELTDOWN Checks - Skylake
------------------------------------
+Spectre and Meltdown Checks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Following section displays the output of a running shell script to tell if
 system is vulnerable against the several "speculative execution" CVEs that were

diff --git a/docs/report/introduction/test_scenarios_overview.rst b/docs/report/introduction/test_scenarios_overview.rst
index ccd5e82..7519e4f 100644 (file)
--- a/docs/report/introduction/test_scenarios_overview.rst
+++ b/docs/report/introduction/test_scenarios_overview.rst
@@ -1,5 +1,5 @@
-Test Scenarios Overview
-=======================
+Test Scenarios
+==============
 
 FD.io |csit-release| report includes multiple test scenarios of VPP
 centric applications, topologies and use cases. In addition it also

diff --git a/docs/report/test_configuration/vpp_mrr_configuration/index.rst b/docs/report/test_configuration/vpp_mrr_configuration/index.rst
index 93cbbab..ca181ce 100644 (file)
--- a/docs/report/test_configuration/vpp_mrr_configuration/index.rst
+++ b/docs/report/test_configuration/vpp_mrr_configuration/index.rst
@@ -1,5 +1,5 @@
-VPP Performance MRR
-===================
+VPP MRR
+=======
 
 .. toctree::
 

diff --git a/docs/report/test_configuration/vpp_performance_configuration/index.rst b/docs/report/test_configuration/vpp_performance_configuration/index.rst
index 45886da..bd80a88 100644 (file)
--- a/docs/report/test_configuration/vpp_performance_configuration/index.rst
+++ b/docs/report/test_configuration/vpp_performance_configuration/index.rst
@@ -1,5 +1,5 @@
-VPP Performance NDR/PDR
-=======================
+VPP Throughput
+==============
 
 .. toctree::
 

diff --git a/docs/report/test_operational_data/vpp_performance_operational_data/index.rst b/docs/report/test_operational_data/vpp_performance_operational_data/index.rst
index 29eb62e..99737d3 100644 (file)
--- a/docs/report/test_operational_data/vpp_performance_operational_data/index.rst
+++ b/docs/report/test_operational_data/vpp_performance_operational_data/index.rst
@@ -1,5 +1,5 @@
-VPP Performance NDR/PDR
-=======================
+VPP Throughput
+==============
 
 .. toctree::
 

diff --git a/docs/report/vpp_performance_tests/http_server_performance/index.rst b/docs/report/vpp_performance_tests/http_server_performance/index.rst
index 1a7c1d9..58f4f44 100644 (file)
--- a/docs/report/vpp_performance_tests/http_server_performance/index.rst
+++ b/docs/report/vpp_performance_tests/http_server_performance/index.rst
@@ -28,8 +28,8 @@
 
     </script>
 
-HTTP/TCP Performance
-====================
+HTTP and TCP-IP
+===============
 
 Performance graphs are generated by multiple executions of the same
 performance tests across physical testbeds hosted LF FD.io labs: 3n-hsw.

diff --git a/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst b/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
index 07d44db..1cf4c66 100644 (file)
--- a/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
+++ b/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
@@ -1,4 +1,6 @@
 
+.. _VPP_Packet_Latency:
+
 .. raw:: latex
 
     \clearpage

diff --git a/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst b/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst
index 8020809..688bdd2 100644 (file)
--- a/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst
+++ b/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst
@@ -1,4 +1,6 @@
 
+.. _VPP_Packet_Throughput:
+
 .. raw:: latex
 
     \clearpage

diff --git a/docs/report/vpp_performance_tests/test_environment.rst b/docs/report/vpp_performance_tests/test_environment.rst
index 8f92c6e..68dfa96 100644 (file)
--- a/docs/report/vpp_performance_tests/test_environment.rst
+++ b/docs/report/vpp_performance_tests/test_environment.rst
@@ -9,10 +9,6 @@
 
 .. include:: ../introduction/test_environment_sut_calib_skx.rst
 
-.. include:: ../introduction/test_environment_sut_meltspec_hsw.rst
-
-.. include:: ../introduction/test_environment_sut_meltspec_skx.rst
-
 .. include:: ../introduction/test_environment_sut_conf_1.rst
 
 .. include:: ../introduction/test_environment_sut_conf_2.rst

diff --git a/docs/report/vpp_performance_tests/throughput_speedup_multi_core/index.rst b/docs/report/vpp_performance_tests/throughput_speedup_multi_core/index.rst
index 57f796b..c56e55c 100644 (file)
--- a/docs/report/vpp_performance_tests/throughput_speedup_multi_core/index.rst
+++ b/docs/report/vpp_performance_tests/throughput_speedup_multi_core/index.rst
@@ -1,3 +1,4 @@
+
 .. _throughput_speedup_multi_core:
 
 .. raw:: latex

diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst
index 33d38cf..34d3745 100644 (file)
--- a/docs/tag_documentation.rst
+++ b/docs/tag_documentation.rst
@@ -1,5 +1,5 @@
-CSIT TAGs Descriptions
-======================
+CSIT TAGs
+=========
 
 All CSIT test cases are labelled with Robot Framework tags used to allow for
 easy test case type identification, test case grouping and selection for

diff --git a/docs/vpp-device.rst b/docs/vpp-device.rst
index 86aa046..c071771 100644 (file)
--- a/docs/vpp-device.rst
+++ b/docs/vpp-device.rst
@@ -1,5 +1,5 @@
-VPP_Device Integration Tests
-============================
+Integration Tests
+=================
 
 Abstract
 --------

diff --git a/resources/tools/presentation/doc/pal_lld.rst b/resources/tools/presentation/doc/pal_lld.rst
index 5e15dbe..28cb892 100644 (file)
--- a/resources/tools/presentation/doc/pal_lld.rst
+++ b/resources/tools/presentation/doc/pal_lld.rst
@@ -1,5 +1,5 @@
-Presentation and Analytics Layer
-================================
+Presentation and Analytics
+==========================
 
 Overview
 --------