Report 1908.2: Improve headers and legend in comparison tables.

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

diff --git a/docs/report/introduction/report_history.rst b/docs/report/introduction/report_history.rst
index 3029094..c9ae66a 100644 (file)
--- a/docs/report/introduction/report_history.rst
+++ b/docs/report/introduction/report_history.rst
@@ -6,6 +6,9 @@ FD.io CSIT-1908.2 Report history and per .[ww] revision changes are listed below
 +----------------+------------------------------------------------------------+
 | .[ww] Revision | Changes                                                    |
 +================+============================================================+
+| .21            | Improved headers and legend in comparison tables.          |
+|                |                                                            |
++----------------+------------------------------------------------------------+
 | .20            | Initial version                                            |
 |                |                                                            |
 +----------------+------------------------------------------------------------+

diff --git a/resources/tools/presentation/conf.py b/resources/tools/presentation/conf.py
index ec8f54d..b9833b9 100644 (file)
--- a/resources/tools/presentation/conf.py
+++ b/resources/tools/presentation/conf.py
@@ -46,7 +46,7 @@ source_suffix = [u'.rst', u'.md']
 master_doc = u'index'
 
 # General information about the project.
-report_week = u'20'
+report_week = u'21'
 project = u'FD.io CSIT-1908.2.{week}'.format(week=report_week)
 copyright = u'2020, FD.io'
 author = u'FD.io CSIT'

diff --git a/resources/tools/presentation/generator_tables.py b/resources/tools/presentation/generator_tables.py
index 08c9d55..a9d13df 100644 (file)
--- a/resources/tools/presentation/generator_tables.py
+++ b/resources/tools/presentation/generator_tables.py
@@ -667,8 +667,7 @@ def table_soak_vs_ndr(table, input_data):
             f"Percentage change calculated for mean values.\n"
             u"Stdev(Diff): "
             u"Standard deviation of percentage change calculated for mean "
-            u"values.\n"
-            u":END"
+            u"values."
         )
     except (AttributeError, KeyError) as err:
         logging.error(f"The model is invalid, missing parameter: {repr(err)}")
@@ -1756,8 +1755,6 @@ def table_comparison(table, input_data):
     with open(txt_file_name, u'a', encoding='utf-8') as txt_file:
         txt_file.write(legend)
         txt_file.write(footnote)
-        if legend or footnote:
-            txt_file.write(u"\n:END")
 
     # Generate html table:
     _tpc_generate_html_table(

diff --git a/resources/tools/presentation/run_report.sh b/resources/tools/presentation/run_report.sh
index 219e860..22f521a 100755 (executable)
--- a/resources/tools/presentation/run_report.sh
+++ b/resources/tools/presentation/run_report.sh
@@ -38,7 +38,7 @@ export PYTHONPATH=`pwd`:`pwd`/../../../:`pwd`/../../libraries/python
 python pal.py \
     --specification specification.yaml \
     --release ${RELEASE} \
-    --week "20" \
+    --week "21" \
     --logging INFO \
     --force
 

diff --git a/resources/tools/presentation/specification.yaml b/resources/tools/presentation/specification.yaml
index 416fd8e..cfb599d 100644 (file)
--- a/resources/tools/presentation/specification.yaml
+++ b/resources/tools/presentation/specification.yaml
@@ -1081,10 +1081,10 @@
     - title: "1904"
       data-set: "vpp-performance-changes-3n-skx-h1"
       tag: "NIC_Intel-X710"
-    - title: "1908.1"
+    - title: "1908.1-2"
       data-set: "vpp-performance-changes-3n-skx-ref"
       tag: "NIC_Intel-XXV710"
-    - title: "1908.2"
+    - title: "1908.2-2"
       data-set: "vpp-performance-changes-3n-skx-cmp"
       tag: "NIC_Intel-XXV710"
   comparisons:
@@ -1092,9 +1092,9 @@
       reference: 2
       compare: 3
   legend:
-    - "Legend to Table"
-    - "1904, 1908.1, 1908.2 - VPP versions tested."
-    - "Diff - difference between 1908.1 and 1908.2 VPP version."
+    - "Legend to Table:"
+    - 'YYMM.V-E - tested VPP version (YY year, MM month, V minor version) and CSIT test environment version (E environment version, "2" for 2020-03-27).'
+    - "Diff - difference between 1908.1-2 and 1908.2-2 VPP version."
 
 # VPP Performance Changes 3n-skx 2t1c ndr
 - type: "table"
@@ -1107,10 +1107,10 @@
     - title: "1904"
       data-set: "vpp-performance-changes-3n-skx-h1"
       tag: "NIC_Intel-X710"
-    - title: "1908.1"
+    - title: "1908.1-2"
       data-set: "vpp-performance-changes-3n-skx-ref"
       tag: "NIC_Intel-XXV710"
-    - title: "1908.2"
+    - title: "1908.2-2"
       data-set: "vpp-performance-changes-3n-skx-cmp"
       tag: "NIC_Intel-XXV710"
   comparisons:
@@ -1118,9 +1118,9 @@
       reference: 2
       compare: 3
   legend:
-    - "Legend to Table"
-    - "1904, 1908.1, 1908.2 - VPP versions tested."
-    - "Diff - difference between 1908.1 and 1908.2 VPP version."
+    - "Legend to Table:"
+    - 'YYMM.V-E - tested VPP version (YY year, MM month, V minor version) and CSIT test environment version (E environment version, "2" for 2020-03-27).'
+    - "Diff - difference between 1908.1-2 and 1908.2-2 VPP version."
 
 # VPP Performance Changes 2n-skx 2t1c pdr
 - type: "table"
@@ -1133,10 +1133,10 @@
     - title: "1904"
       data-set: "vpp-performance-changes-2n-skx-h1"
       tag: "NIC_Intel-X710"
-    - title: "1908.1"
+    - title: "1908.1-2"
       data-set: "vpp-performance-changes-2n-skx-ref"
       tag: "NIC_Intel-XXV710"
-    - title: "1908.2"
+    - title: "1908.2-2"
       data-set: "vpp-performance-changes-2n-skx-cmp"
       tag: "NIC_Intel-XXV710"
   comparisons:
@@ -1144,9 +1144,9 @@
       reference: 2
       compare: 3
   legend:
-    - "Legend to Table"
-    - "1904, 1908.1, 1908.2 - VPP versions tested."
-    - "Diff - difference between 1908.1 and 1908.2 VPP version."
+    - "Legend to Table:"
+    - 'YYMM.V-E - tested VPP version (YY year, MM month, V minor version) and CSIT test environment version (E environment version, "2" for 2020-03-27).'
+    - "Diff - difference between 1908.1-2 and 1908.2-2 VPP version."
 
 # VPP Performance Changes 2n-skx 2t1c ndr
 - type: "table"
@@ -1159,10 +1159,10 @@
     - title: "1904"
       data-set: "vpp-performance-changes-2n-skx-h1"
       tag: "NIC_Intel-X710"
-    - title: "1908.1"
+    - title: "1908.1-2"
       data-set: "vpp-performance-changes-2n-skx-ref"
       tag: "NIC_Intel-XXV710"
-    - title: "1908.2"
+    - title: "1908.2-2"
       data-set: "vpp-performance-changes-2n-skx-cmp"
       tag: "NIC_Intel-XXV710"
   comparisons:
@@ -1170,9 +1170,9 @@
       reference: 2
       compare: 3
   legend:
-    - "Legend to Table"
-    - "1904, 1908.1, 1908.2 - VPP versions tested."
-    - "Diff - difference between 1908.1 and 1908.2 VPP version."
+    - "Legend to Table:"
+    - 'YYMM.V-E - tested VPP version (YY year, MM month, V minor version) and CSIT test environment version (E environment version, "2" for 2020-03-27).'
+    - "Diff - difference between 1908.1-2 and 1908.2-2 VPP version."
 
 # VPP Performance Changes 2n-clx 2t1c pdr
 - type: "table"