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

Marvin Liu yong.liu at intel.com
Tue Apr 24 13:24:57 CEST 2018


v2: remove internal test plan modifications

Signed-off-by: Marvin Liu <yong.liu at intel.com>

diff --git a/test_plans/ddp_gtp_qregion_test_plan.rst b/test_plans/ddp_gtp_qregion_test_plan.rst
index 4a08e41..ced70ff 100644
--- a/test_plans/ddp_gtp_qregion_test_plan.rst
+++ b/test_plans/ddp_gtp_qregion_test_plan.rst
@@ -193,7 +193,9 @@ Test Case: Outer IPv6 dst controls GTP-C queue in queue region
     GTP_U_Header()/Raw('x'*20)
 	
 10. Send different outer src GTP-C packet, check pmd receives packet from 
-    same queue::
+    same queue
+
+.. code-block:: console
 
     p=Ether()/IPv6(src="1001:0db8:85a3:0000:0000:8a2e:0370:0002",
     dst="2001:0db8:85a3:0000:0000:8a2e:0370:0001")/
@@ -405,7 +407,9 @@ Test Case: Inner IP src controls GTP-U IPv4 queue in queue region
     IP(src="1.1.1.2",dst="2.2.2.2")/UDP()/Raw('x'*20)
 
 10. Send different dst GTP-U IPv4 packet, check pmd receives packet from same
-    queue::
+    queue
+
+.. code-block:: console
     
     p=Ether()/IP()/UDP(dport=2152)/GTP_U_Header(teid=30)/
     IP(src="1.1.1.1",dst="2.2.2.3")/UDP()/Raw('x'*20)
@@ -452,7 +456,9 @@ Test Case: Inner IP dst controls GTP-U IPv4 queue in queue region
     p=Ether()/IP()/UDP(dport=2152)/GTP_U_Header(teid=30)/
     IP(src="1.1.1.1",dst="2.2.2.3")/UDP()/Raw('x'*20)
 
-10. Send different src address, check pmd receives packet from same queue::
+10. Send different src address, check pmd receives packet from same queue
+
+.. code-block:: console
 
     p=Ether()/IP()/UDP(dport=2152)/GTP_U_Header(teid=30)/
     IP(src="1.1.1.2",dst="2.2.2.2")/UDP()/Raw('x'*20)
@@ -635,14 +641,14 @@ Test Case: Inner IPv6 src controls GTP-U IPv6 queue in queue region
     dst="2001:0db8:85a3:0000:0000:8a2e:0370:0001")/UDP()/Raw('x'*20)
 		
 10. Send different inner dst GTP-U IPv6 packet, check pmd receives packet 
-    from same queue::
+    from same queue
+
+.. code-block:: console
 
     p=Ether()/IP()/UDP(dport=2152)/GTP_U_Header(teid=30)/
     IPv6(src="1001:0db8:85a3:0000:0000:8a2e:0370:0001",
     dst="2001:0db8:85a3:0000:0000:8a2e:0370:0002)/UDP()/Raw('x'*20)
-	
 
-	
 Test Case: Inner IPv6 dst controls GTP-U IPv6 queue in queue region
 =========================================================================
 1. Check flow type to pctype mapping::
@@ -693,7 +699,9 @@ Test Case: Inner IPv6 dst controls GTP-U IPv6 queue in queue region
     dst="2001:0db8:85a3:0000:0000:8a2e:0370:0002")/UDP()/Raw('x'*20)
 
 10. Send different inner src GTP-U IPv6 packets, check pmd receives packet 
-    from same queue::
+    from same queue
+
+.. code-block:: console
 
     p=Ether()/IP()/UDP(dport=2152)/GTP_U_Header(teid=30)/
     IPv6(src="1001:0db8:85a3:0000:0000:8a2e:0370:0002",
diff --git a/test_plans/index.rst b/test_plans/index.rst
index 40984b2..875be3e 100644
--- a/test_plans/index.rst
+++ b/test_plans/index.rst
@@ -120,6 +120,13 @@ The following are the test plans for the DPDK DTS automated test system.
     qinq_filter_test_plan
     ddp_gtp_test_plan
     generic_flow_api_test_plan
+    ddp_gtp_qregion_test_plan
+    interrupt_pmd_kvm_test_plan
+    ipingre_test_plan
+    multi_vm_test_plan
+    runtime_queue_number_test_plan
+    vhost_multi_queue_qemu_test_plan
+    vhost_qemu_mtu_test_plan
 
     unit_tests_cmdline_test_plan
     unit_tests_crc_test_plan
diff --git a/test_plans/runtime_queue_number_test_plan.rst b/test_plans/runtime_queue_number_test_plan.rst
index f3353c9..fc07bb5 100644
--- a/test_plans/runtime_queue_number_test_plan.rst
+++ b/test_plans/runtime_queue_number_test_plan.rst
@@ -425,7 +425,9 @@ Test case: pass through VF to VM
  
 5. Bind VF to kernel driver i40evf, check the rxq and txq number.
    if set VF Max possible RX queues and TX queues to 2 by PF,
-   the VF rxq and txq number is 2::
+   the VF rxq and txq number is 2
+
+.. code-block:: console
 
     #ethtool -S eth0
     NIC statistics:
diff --git a/test_plans/vhost_multi_queue_qemu_test_plan.rst b/test_plans/vhost_multi_queue_qemu_test_plan.rst
index c2a7558..bb13a81 100644
--- a/test_plans/vhost_multi_queue_qemu_test_plan.rst
+++ b/test_plans/vhost_multi_queue_qemu_test_plan.rst
@@ -85,7 +85,8 @@ flow:
 TG --> NIC --> Vhost --> Virtio--> Vhost --> NIC --> TG
 
 1. Bind one port to igb_uio, then launch testpmd by below command, 
-   ensure the vhost using 2 queues: 
+   ensure the vhost using 2 queues::
+
     rm -rf vhost-net*
     ./testpmd -c 0xe -n 4 --socket-mem 1024,1024 \
     --vdev 'eth_vhost0,iface=vhost-net,queues=2' -- \
@@ -106,7 +107,7 @@ TG --> NIC --> Vhost --> Virtio--> Vhost --> NIC --> TG
     -vnc :2 -daemonize
 
 3. On VM, bind virtio net to igb_uio and run testpmd,
-   using one queue for testing at first  ::
+   using one queue for testing at first::
  
     ./testpmd -c 0x7 -n 3 -- -i --rxq=1 --txq=1 --tx-offloads=0x0 \
     --rss-ip --nb-cores=1
@@ -114,6 +115,7 @@ TG --> NIC --> Vhost --> Virtio--> Vhost --> NIC --> TG
     testpmd>start
 
 4. Use scapy send packet::
+
     #scapy
     >>>pk1= [Ether(dst="52:54:00:00:00:01")/IP(dst="1.1.1.1")/UDP()/("X"*64)]
     >>>pk2= [Ether(dst="52:54:00:00:00:01")/IP(dst="1.1.1.7")/UDP()/("X"*64)]
@@ -159,7 +161,8 @@ flow:
 TG --> NIC --> Vhost --> Virtio--> Vhost --> NIC --> TG
 
 1. Bind one port to igb_uio, then launch testpmd by below command, 
-   ensure the vhost using 2 queues: 
+   ensure the vhost using 2 queues::
+
     rm -rf vhost-net*
     ./testpmd -c 0xe -n 4 --socket-mem 1024,1024 \
     --vdev 'eth_vhost0,iface=vhost-net,queues=2' -- \
@@ -180,7 +183,7 @@ TG --> NIC --> Vhost --> Virtio--> Vhost --> NIC --> TG
     -vnc :2 -daemonize
 
 3. On VM, bind virtio net to igb_uio and run testpmd,
-   using one queue for testing at first  ::
+   using one queue for testing at first::
  
     ./testpmd -c 0x7 -n 4 -- -i --rxq=2 --txq=2 \
     --tx-offloads=0x0 --rss-ip --nb-cores=2
@@ -188,6 +191,7 @@ TG --> NIC --> Vhost --> Virtio--> Vhost --> NIC --> TG
     testpmd>start
  
 4. Use scapy send packet::
+
     #scapy
     >>>pk1= [Ether(dst="52:54:00:00:00:01")/IP(dst="1.1.1.1")/UDP()/("X"*64)]
     >>>pk2= [Ether(dst="52:54:00:00:00:01")/IP(dst="1.1.1.7")/UDP()/("X"*64)]
diff --git a/test_plans/virtio_1.0_test_plan.rst b/test_plans/virtio_1.0_test_plan.rst
index 69f6794..265c586 100644
--- a/test_plans/virtio_1.0_test_plan.rst
+++ b/test_plans/virtio_1.0_test_plan.rst
@@ -44,8 +44,7 @@ test with virtio0.95 to ensure they can co-exist. Besides, we need test virtio
 
 
 Test Case 1: test_func_vhost_user_virtio1.0-pmd with different tx-offloads
-=======================================================================
-
+==========================================================================
 Note: For virtio1.0 usage, we need use qemu version >2.4, such as 2.4.1 or 2.5.0.
 
 1. Launch the Vhost sample by below commands, socket-mem is set for the vhost sample to use, need ensure that the PCI port located socket has the memory. In our case, the PCI BDF is 81:00.0, so we need assign memory for socket1.::
-- 
1.9.3



More information about the dts mailing list