From: Maciek Konstantynowicz <mkonstan@cisco.com>
Date: Wed, 4 Sep 2019 11:11:54 +0000 (+0100)
Subject: docs: report packet_throughput_graphs text formatting fixes.
X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=commitdiff_plain;h=90731c9f2abca45f4fe2d8fd4d09d2edf8ba363a

docs: report packet_throughput_graphs text formatting fixes.

Change-Id: Ibea6e70e2fcf9cfeb7627ee1cbcfa6e177c0b2c6
Signed-off-by: Maciek Konstantynowicz <mkonstan@cisco.com>
(cherry picked from commit 32605fc1b4ff207776b6ff3f6a1975f77d8e4629)
---

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 aae566e9e4..145948ba43 100644
--- a/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst
+++ b/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst
@@ -20,7 +20,7 @@ per testbed type in `test_select_list_{testbed_type}.md
 
 Graphs are split into sections as follows:
 
-#. **Level-1: VPP packet path and lookup types**
+#. **Header 1**: VPP packet path and lookup types
 
    - **L2 Ethernet Switching**: L2 bridge-doman, L2 cross-connect and L2 patch
    - **IPv4 Routing**: IPv4 routing with /32 prefixes
@@ -32,47 +32,67 @@ Graphs are split into sections as follows:
    - **IPsec IPv4 Routing**: IPsec encryption/decryption with IPv4 routing
    - **Virtual Topology System**: VXLAN configurations with L2 bridge-domains
 
-#. **Level-2: testbeds and NIC models**
+#. **Header 2**: testbeds and NIC models
+
+   - section name format:
+
+     - {**testbed_type**}-{**nic_model**}
 
-   - section name format: {**testbed_type**}-{**nic_model**}
    - **testbed_type**:
+
      - 2n-skx: 2-node Xeon Skylake
      - 3n-skx: 3-node Xeon Skylake
      - 3n-hsw: 3-node Xeon Haswell
      - 3n-tsh: 3-node Arm TaiShan
      - 2n-dnv: 2-node Atom Denverton
      - 3n-dnv: 3-node Atom Denverton
+
    - **nic_model**:
+
      - xxv710: xxv710 2p25GE Intel (Fortville)
      - x710: x710 4p10GE Intel (Fortville)
      - xl710: xl710 2p40GE Intel (Fortville)
      - x520: x520 2p10GE Intel (Niantic)
      - x553: x553 2p10GE Intel (Niantic)
 
-#. **Level-3: test group names**
+#. **Header 3**: test group names
+
+   - section name format:
+
+     - {**frame_size**}-{**worker_thread_core_cfg**}-{**vpp_functionality**}-{**vpp_lookup_type**}-{**baseline_scale**}-{**nic_driver**}
 
-   - section name format: {**frame_size**}-{**worker_thread_core_cfg**}-{**vpp_functionality**}-{**vpp_lookup_type**}-{**baseline_scale**}-{**nic_driver**}
    - **frame_size**:
-    - 64b: 64 byte frames, smallest frame size for untagged IPv4 packets
-    - 78b: 78 byte frames, smallest frame size for untagged IPv6 packets
-    - 114b: VXLAN encapsulated L2 frames
-    - imix: a sequence of (7x64B, 4x570, 1x1518) byte frames
+
+     - 64b: 64 byte frames, smallest frame size for untagged IPv4 packets
+     - 78b: 78 byte frames, smallest frame size for untagged IPv6 packets
+     - 114b: VXLAN encapsulated L2 frames
+     - imix: a sequence of (7x64B, 4x570, 1x1518) byte frames
+
    - **worker_thread_core_cfg**:
+
      - 1t1c: 1 worker thread on 1 core, hyper-threading not used
      - 2t1c: 2 worker threads on 1 core, hyper-threading used
+
    - **vpp_functionality** (optional):
+
      - features: including input-acl, output-acl, macip-iacl, nat44
      - srv6: srv6 encap/decap, proxy
      - link-bonding: L2 link aggregation with 1 or 2 bonded links
      - ipsec: IPsec encryption/decryption with different ciphers
      - vts: Virtual Topology System specific tests
+
    - **vpp_lookup_type**:
+
      - l2switching, ip4routing, ip6routing, ip4tunnel, vhost, memif
+
    - **baseline_scale**:
+
      - base: baseline tests with less than 10 forwarding entries
      - scale: scale tests with up to 2 million forwarding entries
      - base-scale: both baseline and scale tests grouped together
+
    - **nic_driver**:
+
      - avf: VPP native avf driver for Intel Fortville NICs
      - i40e: dpdk poll mode driver for Intel Fortville NICs
      - ixgbe: dpdk poll mode driver for Intel Niantic NICs
@@ -109,9 +129,10 @@ Additional information about graph data:
 .. note::
 
     Test results have been generated by
+    `FD.io test executor vpp performance job 2n-skx`_
+    `FD.io test executor vpp performance job 3n-skx`_,
     `FD.io test executor vpp performance job 3n-hsw`_,
-    `FD.io test executor vpp performance job 3n-skx`_ and
-    `FD.io test executor vpp performance job 2n-skx`_ with RF
+    `FD.io test executor vpp performance job 3n-tsh`_ and with RF
     result files csit-vpp-perf-|srelease|-\*.zip
     `archived here <../../_static/archive/>`_.
     Required per test case data set size is **10**, but for VPP tests