CSIT-612 Report: Minimization of hand-crafted content.

- replace dynamic text content and links by variables.

Change-Id: I1a7ec371fc80af3c9dd416bf91dd2c639097cf1e
Signed-off-by: Peter Mikus <pmikus@cisco.com>

3 files changed, 21 insertions, 23 deletions

diff --git a/docs/report/vpp_functional_tests/documentation.rst b/docs/report/vpp_functional_tests/documentation.rst
index d34877b0b3..e0f180c3ec 100644
--- a/docs/report/vpp_functional_tests/documentation.rst
+++ b/docs/report/vpp_functional_tests/documentation.rst
@@ -1,7 +1,6 @@
 Documentation

 =============

 

-`CSIT VPP Functional Tests Documentation

-<https://docs.fd.io/csit/rls1704/doc/tests.func.html>`_ contains detailed

+`CSIT VPP Functional Tests Documentation`_ contains detailed

 functional description and input parameters for each test case.

 

diff --git a/docs/report/vpp_functional_tests/overview.rst b/docs/report/vpp_functional_tests/overview.rst
index 0fa15a5472..a6de3f3282 100644
--- a/docs/report/vpp_functional_tests/overview.rst
+++ b/docs/report/vpp_functional_tests/overview.rst
@@ -132,7 +132,7 @@ Functional Tests Naming
 -----------------------

 

 CSIT |release| follows a common structured naming convention for all

-performance and system functional tests, introduced in CSIT rls1701.

+performance and system functional tests, introduced in CSIT |release-1|.

 

 The naming should be intuitive for majority of the tests. Complete

 description of CSIT test naming convention is provided on `CSIT test naming

diff --git a/docs/report/vpp_functional_tests/test_environment.rst b/docs/report/vpp_functional_tests/test_environment.rst
index fc7c63351a..8add53189c 100644
--- a/docs/report/vpp_functional_tests/test_environment.rst
+++ b/docs/report/vpp_functional_tests/test_environment.rst
@@ -30,14 +30,14 @@ SUT Configuration - VIRL Guest VM
 Configuration of the SUT VMs is defined in file

 

    /csit/resources/tools/virl/topologies/double-ring-nested.xenial.virl

-   

+

 - List of SUT VM interfaces:::

 

     <interface id="0" name="GigabitEthernet0/4/0"/>

     <interface id="1" name="GigabitEthernet0/5/0"/>

     <interface id="2" name="GigabitEthernet0/6/0"/>

     <interface id="3" name="GigabitEthernet0/7/0"/>

-    

+

 - Number of 2MB hugepages: 1024

 

 - Maximum number of memory map areas: 20000

@@ -47,25 +47,24 @@ Configuration of the SUT VMs is defined in file
 SUT Configuration - VIRL Guest OS Linux

 ---------------------------------------

 

-In CSIT terminology, the VM operating system for both SUTs that VPP 17.01 has

+In CSIT terminology, the VM operating system for both SUTs that |vpp-release| has

 been tested with, is the following:

 

-**#. ubuntu-16.04.1_2016-12-19_1.6**

+**#. |virl-image-ubuntu|**

 

-This image implies Ubuntu 16.04.1 LTS, current as of 2016/12/19 (that is,

+This image implies Ubuntu 16.04.1 LTS, current as of yyyy-mm-dd (that is,

 package versions are those that would have been installed by a "apt-get update",

-"apt-get upgrade" on December 19), produced by CSIT disk image build scripts

-version 1.6.

+"apt-get upgrade" on that day), produced by CSIT disk image build scripts.

 

 The exact list of installed packages and their versions (including the Linux

 kernel package version) are included in CSIT source repository:

 

-  resources/tools/disk-image-builder/ubuntu/lists/ubuntu-16.04.1_2016-12-19_1.6

+  resources/tools/disk-image-builder/ubuntu/lists/|virl-image-ubuntu|

 

 A replica of this VM image can be built by running the "build.sh" script in CSIT

 repository resources/tools/disk-image-builder/ubuntu.

 

-**#. centos-7.3-1611_2017-01-24_1.2**

+**#. |virl-image-centos|**

 

 The Centos7.3 image is ready to be used but no tests running on it now.

 Corresponding Jenkins jobs are under preparation.

@@ -73,7 +72,7 @@ Corresponding Jenkins jobs are under preparation.
 The exact list of installed packages and their versions (including the Linux

 kernel package version) are included in CSIT source repository:

 

-  resources/tools/disk-image-builder/ubuntu/lists/centos-7.3-1611_2017-01-24_1.2

+  resources/tools/disk-image-builder/ubuntu/lists/|virl-image-centos|

 

 A replica of this VM image can be built by running the "build.sh" script in CSIT

 repository resources/tools/disk-image-builder/centos.

@@ -106,7 +105,7 @@ Port configuration of DUTs is defined in topology file that is generated per
 VIRL simulation based on the definition stored in file

 

    /csit/resources/tools/virl/topologies/double-ring-nested.xenial.yaml

-   

+

 Example of DUT nodes configuration:::

 

     DUT1:

@@ -224,7 +223,7 @@ Example of DUT nodes configuration:::
 

 **VPP Version**

 

-17.01-release_amd64

+|vpp-release|

 

 **VPP Installed Packages**

 ::

@@ -235,13 +234,13 @@ Example of DUT nodes configuration:::
     |/ Err?=(none)/Reinst-required (Status,Err: uppercase=bad)

     ||/ Name           Version       Architecture Description

     +++-==============-=============-============-=============================================

-    ii  vpp            17.01-release amd64        Vector Packet Processing--executables

-    ii  vpp-dbg        17.01-release amd64        Vector Packet Processing--debug symbols

-    ii  vpp-dev        17.01-release amd64        Vector Packet Processing--development support

-    ii  vpp-dpdk-dev   17.01-release amd64        Vector Packet Processing--development support

-    ii  vpp-dpdk-dkms  17.01-release amd64        DPDK 2.1 igb_uio_driver

-    ii  vpp-lib        17.01-release amd64        Vector Packet Processing--runtime libraries

-    ii  vpp-plugins    17.01-release amd64        Vector Packet Processing--runtime plugins

+    ii  vpp            17.07-release amd64        Vector Packet Processing--executables

+    ii  vpp-dbg        17.07-release amd64        Vector Packet Processing--debug symbols

+    ii  vpp-dev        17.07-release amd64        Vector Packet Processing--development support

+    ii  vpp-dpdk-dev   17.07-release amd64        Vector Packet Processing--development support

+    ii  vpp-dpdk-dkms  17.07-release amd64        DPDK 2.1 igb_uio_driver

+    ii  vpp-lib        17.07-release amd64        Vector Packet Processing--runtime libraries

+    ii  vpp-plugins    17.07-release amd64        Vector Packet Processing--runtime plugins

 

 **VPP Startup Configuration**

 

@@ -439,5 +438,5 @@ Example of TG node configuration:::
 **Traffic generator**

 

 Functional tests utilize Scapy as a traffic generator. There was used Scapy

-v2.3.1 for VPP 17.01 tests.

+v2.3.1 for |vpp-release| tests.