aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTibor Frank <tifrank@cisco.com>2018-11-19 11:18:34 +0100
committerTibor Frank <tifrank@cisco.com>2018-11-19 16:27:50 +0100
commit4ed2c91772188619781d86dc686a911374893733 (patch)
treeb9ef1cae286683e61861ca6ca04c605fade29c1c /docs
parent99f42ea79d4b76384b5011a196667d3e0a94bf78 (diff)
Report: Edit the chapters' titles
Change-Id: I23cedb3ad0f188e9c7570f549e397f4c42404fab Signed-off-by: Tibor Frank <tifrank@cisco.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/report/csit_framework_documentation/index.rst4
-rw-r--r--docs/report/detailed_test_results/dpdk_performance_results/index.rst4
-rw-r--r--docs/report/detailed_test_results/vpp_mrr_results/index.rst4
-rw-r--r--docs/report/detailed_test_results/vpp_performance_results/index.rst4
-rw-r--r--docs/report/dpdk_performance_tests/test_environment.rst4
-rw-r--r--docs/report/introduction/introduction.rst4
-rw-r--r--docs/report/introduction/report_history.rst17
-rw-r--r--docs/report/introduction/test_environment_sut_calib_hsw.rst2
-rw-r--r--docs/report/introduction/test_environment_sut_calib_skx.rst2
-rw-r--r--docs/report/introduction/test_environment_sut_meltspec_hsw.rst4
-rw-r--r--docs/report/introduction/test_environment_sut_meltspec_skx.rst4
-rw-r--r--docs/report/introduction/test_scenarios_overview.rst4
-rw-r--r--docs/report/test_configuration/vpp_mrr_configuration/index.rst4
-rw-r--r--docs/report/test_configuration/vpp_performance_configuration/index.rst4
-rw-r--r--docs/report/test_operational_data/vpp_performance_operational_data/index.rst4
-rw-r--r--docs/report/vpp_performance_tests/http_server_performance/index.rst4
-rw-r--r--docs/report/vpp_performance_tests/packet_latency_graphs/index.rst2
-rw-r--r--docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst2
-rw-r--r--docs/report/vpp_performance_tests/test_environment.rst4
-rw-r--r--docs/report/vpp_performance_tests/throughput_speedup_multi_core/index.rst1
-rw-r--r--docs/tag_documentation.rst4
-rw-r--r--docs/vpp-device.rst4
22 files changed, 47 insertions, 43 deletions
diff --git a/docs/report/csit_framework_documentation/index.rst b/docs/report/csit_framework_documentation/index.rst
index 0b3228dc51..82031e38ae 100644
--- 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 963e31b4c4..3d1f6357d4 100644
--- 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 ace7ef8845..d69136757b 100644
--- 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 5d2ee1140e..75782341a4 100644
--- 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 1c2a580176..e1eb8fa874 100644
--- 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 9990d47d5d..c15df8d9bc 100644
--- 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 aeb6848b4f..eef74febda 100644
--- 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 62de7f6863..b8149889e7 100644
--- 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 61d2a7a06a..2e00e6fedc 100644
--- 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 0e68e57802..71787f0691 100644
--- 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 5d3f719cf6..443a7fd484 100644
--- 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 ccd5e820d7..7519e4feb8 100644
--- 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 93cbbabfcc..ca181cee1c 100644
--- 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 45886daf58..bd80a88fd1 100644
--- 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 29eb62ee26..99737d3d45 100644
--- 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 1a7c1d9901..58f4f44ef1 100644
--- 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 07d44db9b0..1cf4c66106 100644
--- 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 8020809f71..688bdd23a4 100644
--- 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 8f92c6ef20..68dfa964df 100644
--- 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 57f796b915..c56e55cc0e 100644
--- 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 33d38cfff9..34d3745cb6 100644
--- 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 86aa0461f8..c071771c71 100644
--- a/docs/vpp-device.rst
+++ b/docs/vpp-device.rst
@@ -1,5 +1,5 @@
-VPP_Device Integration Tests
-============================
+Integration Tests
+=================
Abstract
--------