From 4ed2c91772188619781d86dc686a911374893733 Mon Sep 17 00:00:00 2001 From: Tibor Frank Date: Mon, 19 Nov 2018 11:18:34 +0100 Subject: Report: Edit the chapters' titles Change-Id: I23cedb3ad0f188e9c7570f549e397f4c42404fab Signed-off-by: Tibor Frank --- docs/report/introduction/introduction.rst | 4 ++-- docs/report/introduction/report_history.rst | 17 ++++++++++------- .../introduction/test_environment_sut_calib_hsw.rst | 2 ++ .../introduction/test_environment_sut_calib_skx.rst | 2 ++ .../introduction/test_environment_sut_meltspec_hsw.rst | 4 ++-- .../introduction/test_environment_sut_meltspec_skx.rst | 4 ++-- docs/report/introduction/test_scenarios_overview.rst | 4 ++-- 7 files changed, 22 insertions(+), 15 deletions(-) (limited to 'docs/report/introduction') 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 -- cgit 1.2.3-korg