[dts] [PATCH] test_plans: fix doc build warnings

Marvin Liu yong.liu at intel.com
Wed Jan 10 23:35:19 CET 2018
Previous message: [dts] [PATCH] conf: remove qga related setting
Next message: [dts] [PATCH V2] add multi queue qemu test suite
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
Signed-off-by: Marvin Liu <yong.liu at intel.com>

diff --git a/test_plans/ddp_gtp_test_plan.rst b/test_plans/ddp_gtp_test_plan.rst
index 3dcba1b..3e6c954 100644
--- a/test_plans/ddp_gtp_test_plan.rst
+++ b/test_plans/ddp_gtp_test_plan.rst
@@ -30,9 +30,9 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-================
-DDP GTP-C/GTP-U 
-================
+===============================
+Fortville DDP GTP-C/GTP-U Tests
+===============================
 
 FVL6 supports DDP (Dynamic Device Personalization) to program analyzer/parser
 via AdminQ. Profile can be used to update FVL configuration tables via MMIO
diff --git a/test_plans/distributor_test_plan.rst b/test_plans/distributor_test_plan.rst
index e627faa..106936d 100644
--- a/test_plans/distributor_test_plan.rst
+++ b/test_plans/distributor_test_plan.rst
@@ -30,9 +30,10 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-==================
-Packet distributor
-==================
+============================================
+Sample Application Tests: Packet distributor
+============================================
+
 Packet Distributor library is a library designed to be used for dynamic
 load balancing of traffic while supporting single packet at a time operation.
 When using this library, the logical cores in use are to be considered in
diff --git a/test_plans/dynamic_flowtype_test_plan.rst b/test_plans/dynamic_flowtype_test_plan.rst
index 39054b1..d7eab5f 100644
--- a/test_plans/dynamic_flowtype_test_plan.rst
+++ b/test_plans/dynamic_flowtype_test_plan.rst
@@ -30,9 +30,9 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-========================================
-Dynamic mapping of Flow Types to PCTYPEs
-========================================
+========================================================
+Fortville Dynamic Mapping of Flow Types to PCTYPEs Tests
+========================================================
 
 More protocols can be added dynamically using dynamic device personalization 
 profiles (DDP).
diff --git a/test_plans/efd_test_plan.rst b/test_plans/efd_test_plan.rst
index a6b5e3d..d6962e7 100644
--- a/test_plans/efd_test_plan.rst
+++ b/test_plans/efd_test_plan.rst
@@ -30,9 +30,9 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-========================
-Elastic Flow Distributor
-========================
+==================================================
+Sample Application Tests: Elastic Flow Distributor
+==================================================
 
 Description
 -----------
diff --git a/test_plans/index.rst b/test_plans/index.rst
index ac1959a..40984b2 100644
--- a/test_plans/index.rst
+++ b/test_plans/index.rst
@@ -110,6 +110,16 @@ The following are the test plans for the DPDK DTS automated test system.
     vmdq_test_plan
     vm_power_manager_test_plan
     vxlan_test_plan
+    ixgbe_vf_get_extra_queue_information_test_plan
+    queue_region_test_plan
+    inline_ipsec_test_plan
+    sw_eventdev_pipeline_sample_test_plan
+    dynamic_flowtype_test_plan
+    vf_kernel_test_plan
+    multiple_pthread_test_plan
+    qinq_filter_test_plan
+    ddp_gtp_test_plan
+    generic_flow_api_test_plan
 
     unit_tests_cmdline_test_plan
     unit_tests_crc_test_plan
@@ -137,12 +147,6 @@ The following are the test plans for the DPDK DTS automated test system.
     skeleton_test_plan
     timer_test_plan
     vxlan_sample_test_plan
-
-    distributor_test_plan.rst
-    efd_test_plan.rst
-    multiple_pthread_test_plan.rst
-    ptpclient_test_plan.rst
-    qinq_filter_test_plan.rst
-    vf_kernel_test_plan.rst
-    ddp_gtp_test_plan.rst
-    generic_flow_api_test_plan.rst
+    ptpclient_test_plan
+    distributor_test_plan
+    efd_test_plan
diff --git a/test_plans/inline_ipsec_test_plan.rst b/test_plans/inline_ipsec_test_plan.rst
index 8725284..9bec8cc 100644
--- a/test_plans/inline_ipsec_test_plan.rst
+++ b/test_plans/inline_ipsec_test_plan.rst
@@ -30,9 +30,10 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-======================
-Inline IPsec Test Plan
-======================
+==========================
+Niantic Inline IPsec Tests
+==========================
+
 This test plan describe the method of validation inline hardware acceleration
 of symmetric crypto processing of IPsec flows on Intel® 82599 10 GbE
 Controller (IXGBE) within the cryptodev framework.
@@ -136,15 +137,17 @@ Start ipsec-secgw with two 82599 ports and assign port 1 to unprotected mode::
 	"crypto_null" --log-level 8 --socket-mem 1024,1 -- -p 0xf -P -u 
 	0x2 --config="(0,0,20),(1,0,21)" -f ./enc.cfg
 
-Use scapy to listen on unprotected port
-sniff(iface='%s',count=1,timeout=10)
+Use scapy to listen on unprotected port::
+
+    sniff(iface='%s',count=1,timeout=10)
 	
 Use scapy send burst(32) normal packets with dst ip (192.168.105.0) to protected port.
 
-Check burst esp packets received from unprotected port.
-tcpdump -Xvvvi ens802f1
-tcpdump: listening on ens802f1, link-type EN10MB (Ethernet), capture size 262144 bytes
-06:10:25.674233 IP (tos 0x0, ttl 64, id 0, offset 0, flags [none], proto ESP (50), length 108)
+Check burst esp packets received from unprotected port::
+
+    tcpdump -Xvvvi ens802f1
+    tcpdump: listening on ens802f1, link-type EN10MB (Ethernet), capture size 262144 bytes
+    06:10:25.674233 IP (tos 0x0, ttl 64, id 0, offset 0, flags [none], proto ESP (50), length 108)
     172.16.1.5 > 172.16.2.5: ESP(spi=0x000003ed,seq=0x9), length 88
         0x0000:  4500 006c 0000 0000 4032 1f36 ac10 0105  E..l.... at 2.6....
         0x0010:  ac10 0205 0000 03ed 0000 0009 0000 0000  ................
@@ -156,7 +159,7 @@ tcpdump: listening on ens802f1, link-type EN10MB (Ethernet), capture size 262144
 
 Check esp packets' format is correct.
 
-See decrypted packets on scapy output
+See decrypted packets on scapy output::
 
     ###[ IP ]###
       version   = 4
@@ -179,6 +182,7 @@ See decrypted packets on scapy output
 Test Case: IPSec Encryption with Jumboframe
 ===========================================
 Start ipsec-secgw with two 82599 ports and assign port 1 to unprotected mode::
+
 	sudo ./build/ipsec-secgw -l 20,21 -w 83:00.0 -w 83:00.1 --vdev 
 	"crypto_null" --log-level 8 --socket-mem 1024,1 -- -p 0xf -P -u 
 	0x2 --config="(0,0,20),(1,0,21)" -f ./enc.cfg
@@ -283,6 +287,7 @@ Start ipsec-secgw with two 82599 ports and assign port 1 to unprotected mode::
 	sudo ./build/ipsec-secgw -l 20,21 -w 83:00.0 -w 83:00.1 --vdev 
 	"crypto_null" --log-level 8 --socket-mem 1024,1 -- -p 0xf -P -u 
 	0x2 --config="(0,0,20),(1,0,21)" -f ./dec.cfg
+
 Default frame size is 1518, Send two burst(1000) esp packets to unprotected port.
 
 First one will produce an error "IPSEC_ESP: failed crypto op" in the IPsec application, 
diff --git a/test_plans/ixgbe_vf_get_extra_queue_information_test_plan.rst b/test_plans/ixgbe_vf_get_extra_queue_information_test_plan.rst
index 4942910..e621eeb 100644
--- a/test_plans/ixgbe_vf_get_extra_queue_information_test_plan.rst
+++ b/test_plans/ixgbe_vf_get_extra_queue_information_test_plan.rst
@@ -30,9 +30,9 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-=======================================================
-Improve ixgbe_get_vf_queue to include extra information
-=======================================================
+==========================================================
+Niantic ixgbe_get_vf_queue Include Extra Information Tests
+==========================================================
 
 Description
 ===========
diff --git a/test_plans/macsec_for_ixgbe_test_plan.rst b/test_plans/macsec_for_ixgbe_test_plan.rst
index 597531d..401723e 100644
--- a/test_plans/macsec_for_ixgbe_test_plan.rst
+++ b/test_plans/macsec_for_ixgbe_test_plan.rst
@@ -30,9 +30,9 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-=====================================================
-Niantic: Media Access Control Security (MACsec) Tests
-=====================================================
+====================================================
+Niantic Media Access Control Security (MACsec) Tests
+====================================================
 
 Description
 ===========
diff --git a/test_plans/ptpclient_test_plan.rst b/test_plans/ptpclient_test_plan.rst
index 7e349b5..0ee0f1e 100644
--- a/test_plans/ptpclient_test_plan.rst
+++ b/test_plans/ptpclient_test_plan.rst
@@ -30,9 +30,9 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-===============
-EEE1588 Sample 
-===============
+==================================
+Sample Application Tests: IEEE1588
+==================================
 
 The PTP (Precision Time Protocol) client sample application is a simple 
 example of using the DPDK IEEE1588 API to communicate with a PTP master 
diff --git a/test_plans/qinq_filter_test_plan.rst b/test_plans/qinq_filter_test_plan.rst
index fc2aef8..e180341 100644
--- a/test_plans/qinq_filter_test_plan.rst
+++ b/test_plans/qinq_filter_test_plan.rst
@@ -30,9 +30,9 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-===============================   
-Cloud filters for QinQ steering
-===============================
+===============================================
+Fortville Cloud filters for QinQ steering Tests
+===============================================
 This document provides test plan for testing the function of Fortville:
 QinQ filter function
 
diff --git a/test_plans/queue_region_test_plan.rst b/test_plans/queue_region_test_plan.rst
index af80f50..20ac496 100644
--- a/test_plans/queue_region_test_plan.rst
+++ b/test_plans/queue_region_test_plan.rst
@@ -30,9 +30,9 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-======================================
-API to configure queue regions for RSS
-======================================
+===========================================
+Fortville Configure RSS Queue Regions Tests
+===========================================
 Description
 ===========
 
diff --git a/test_plans/sw_eventdev_pipeline_sample_test_plan.rst b/test_plans/sw_eventdev_pipeline_sample_test_plan.rst
index c837bcc..1da0dc1 100644
--- a/test_plans/sw_eventdev_pipeline_sample_test_plan.rst
+++ b/test_plans/sw_eventdev_pipeline_sample_test_plan.rst
@@ -29,6 +29,7 @@
    STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
+
 ===============================
 Eventdev Pipeline SW PMD Tests
 ===============================
diff --git a/test_plans/vf_kernel_test_plan.rst b/test_plans/vf_kernel_test_plan.rst
index b8f08d5..8c150be 100644
--- a/test_plans/vf_kernel_test_plan.rst
+++ b/test_plans/vf_kernel_test_plan.rst
@@ -30,9 +30,9 @@
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    OF THE POSSIBILITY OF SUCH DAMAGE.
 
-===========================
-VFD as SRIOV Policy Manager
-===========================
+=================================
+VFD as SRIOV Policy Manager Tests
+=================================
 
 VFD is SRIOV Policy Manager (daemon) running on the host allowing
 configuration not supported by kernel NIC driver, supports ixgbe and
-- 
1.9.3
Previous message: [dts] [PATCH] conf: remove qga related setting
Next message: [dts] [PATCH V2] add multi queue qemu test suite
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
More information about the dts mailing list