[spp] [PATCH 2/3] doc: update section headings

Ferruh Yigit ferruh.yigit at intel.com
Thu Feb 23 16:58:42 CET 2017


Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>
---
 docs/setup_guide.md | 49 +++++++++++++++++++++++++++++++++----------------
 1 file changed, 33 insertions(+), 16 deletions(-)

diff --git a/docs/setup_guide.md b/docs/setup_guide.md
index 0b35b47..c7934cb 100644
--- a/docs/setup_guide.md
+++ b/docs/setup_guide.md
@@ -1,7 +1,8 @@
-Sample usage of the application :
+Sample usage of the application
+===============================
 
 Compilation
-===========
+-----------
 Change to DPDK directory
 Set RTE_SDK variable to current folder
 Set RTE_TARGET variable to any valid target.
@@ -11,20 +12,20 @@ Change to SPP directory
 Compile SPP: "make"
 
 Start Controller
-================
+----------------
 python spp.py -p 5555 -s 6666
 
 Start spp_primary
-=================
+-----------------
 sudo ./src/primary/src/primary/x86_64-native-linuxapp-gcc/spp_primary -c 0x02 -n 4 --socket-mem 512,512 --huge-dir=/dev/hugepages --proc-type=primary -- -p 0x03 -n 4 -s 192.168.122.1:5555
 
 Start spp_nfv
-=============
+-------------
 sudo ./src/nfv/src/nfv/x86_64-native-linuxapp-gcc/spp_nfv -c 0x06 -n 4 --proc-type=secondary -- -n 1 -s 192.168.122.1:6666
 sudo ./src/nfv/src/nfv/x86_64-native-linuxapp-gcc/spp_nfv 0x0A -n 4 --proc-type=secondary -- -n 1 -s 192.168.122.1:6666
 
 Start VM (QEMU)
-===============
+---------------
 Common qemu command line:
 sudo ./x86_64-softmmu/qemu-system-x86_64 -cpu host -enable-kvm -object memory-backend-file,id=mem,size=2048M,mem-path=/dev/hugepages,share=on -numa node,memdev=mem -mem-prealloc -hda /home/dpdk/debian_wheezy_amd64_standard.qcow2 -m 2048 -smp cores=4,threads=1,sockets=1 -device e1000,netdev=net0,mac=DE:AD:BE:EF:00:01 -netdev tap,id=net0 -nographic -vnc :2
 
@@ -32,20 +33,24 @@ To start spp_vm "qemu-ifup" script required, please copy docs/qemu-ifup to host
 
 Vhost interface is supported to communicate between guest and host:
 
-* vhost interface
------------------
+vhost interface
+~~~~~~~~~~~~~~~~~
   - spp should do a "sec x:add vhost y" before starting the VM. x: vnf number, y: vhost port id.
   - Needs vhost argument for qemu:
     sudo ./x86_64-softmmu/qemu-system-x86_64 -cpu host -enable-kvm -object memory-backend-file,id=mem,size=2048M,mem-path=/dev/hugepages,share=on -numa node,memdev=mem -mem-prealloc -hda /home/dpdk/debian_wheezy_amd64_standard.qcow2 -m 2048 -smp cores=4,threads=1,sockets=1 -device e1000,netdev=net0,mac=DE:AD:BE:EF:00:01 -netdev tap,id=net0 -chardev socket,id=chr0,path=/tmp/sock0 -netdev vhost-user,id=net1,chardev=chr0,vhostforce -device virtio-net-pci,netdev=net1 -nographic -vnc :2
 
 
 Start spp_vm (Inside the VM)
-============================
+----------------------------
 sudo ./src/vm/src/vm/x86_64-native-linuxapp-gcc/spp_vm -c 0x03 -n 4 --proc-type=primary -- -p 0x01 -n 1 -s 192.168.122.1:6666
 
 
 
+Test Setups
+===========
+
 Test Setup 1: Single NFV
+------------------------
 
                                                                         __
                                     +--------------+                      |
@@ -68,18 +73,21 @@ Test Setup 1: Single NFV
                               |                           |
                               :                           v
 
-Configuration for L2fwd:-
+Configuration for L2fwd
+~~~~~~~~~~~~~~~~~~~~~~~
 spp > sec 0;patch 0 1
 spp > sec 0;patch 1 0
 spp > sec 0;forward
 
-Configuration for loopback:-
+Configuration for loopback
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 spp > sec 0;patch 0 0
 spp > sec 0;patch 1 1
 spp > sec 0;forward
 
 
 Test Setup 2: Dual NFV
+----------------------
 
                                                                         __
                          +--------------+          +--------------+       |
@@ -102,7 +110,8 @@ Test Setup 2: Dual NFV
                               |                           |
                               :                           v
 
-Configuration for L2fwd:-
+Configuration for L2fwd
+~~~~~~~~~~~~~~~~~~~~~~~
 spp > sec 0;patch 0 1
 spp > sec 1;patch 1 0
 spp > sec 0;forward
@@ -130,7 +139,8 @@ spp > sec 1;forward
                               |                           |
                               v                           v
 
-Configuration for loopback:-
+Configuration for loopback
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 spp > sec 0;patch 0 0
 spp > sec 1;patch 1 1
 spp > sec 0;forward
@@ -138,6 +148,7 @@ spp > sec 1;forward
 
 
 Test Setup 3: Dual NFV with ring pmd
+------------------------------------
 
                                                                         __
                        +----------+      ring        +----------+         |
@@ -160,7 +171,8 @@ Test Setup 3: Dual NFV with ring pmd
                               |                           |
                               :                           v
 
-Configuration for Uni directional L2fwd:-
+Configuration for Uni directional L2fwd
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 spp > sec 0;add ring 0
 spp > sec 1;add ring 0
 spp > sec 0;patch 0 2
@@ -193,7 +205,8 @@ spp > sec 1;forward
                               |                           |
                               v                           v
 
-Configuration for L2fwd:-
+Configuration for L2fwd
+~~~~~~~~~~~~~~~~~~~~~~~
 spp > sec 0;add ring 0
 spp > sec 0;add ring 1
 spp > sec 1;add ring 0
@@ -207,6 +220,7 @@ spp > sec 1;forward
 
 
 Test Setup 4: Single NFV with VM through vhost pmd
+--------------------------------------------------
 
                                                    __
                           +----------------------+   |
@@ -246,6 +260,8 @@ sec 0 = spp_nfv
 sec 1 = spp_vm
 
 
+Configuration for Uni directional L2fwd
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 [rm –rf /tmp/sock0]
 spp > sec 0;add vhost 0
 [start VM]
@@ -257,7 +273,8 @@ spp > sec 0;forward
 
 
 
-Optimizing qemu performance:-
+Optimizing qemu performance
+---------------------------
 First find out the PID for qemu-system-x86 process
 ps ea
    PID TTY      STAT   TIME COMMAND
-- 
2.9.3



More information about the spp mailing list