Soft Patch Panel
 help / color / mirror / Atom feed
From: ogawa.yasufumi@lab.ntt.co.jp
To: ferruh.yigit@intel.com, spp@dpdk.org, nakamura.hiroyuki@po.ntt-tx.co.jp
Cc: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Subject: [spp] [PATCH 08/28] docs: fix bug spp_vf howto_use guide
Date: Mon,  5 Feb 2018 11:39:01 +0900	[thread overview]
Message-ID: <20180205023921.7775-8-ogawa.yasufumi@lab.ntt.co.jp> (raw)
In-Reply-To: <20180205023921.7775-1-ogawa.yasufumi@lab.ntt.co.jp>

From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/howto_use.rst | 41 ++++++++----------------------------
 1 file changed, 9 insertions(+), 32 deletions(-)

diff --git a/docs/guides/spp_vf/gsg/howto_use.rst b/docs/guides/spp_vf/gsg/howto_use.rst
index 1db3ebf..e5983fb 100644
--- a/docs/guides/spp_vf/gsg/howto_use.rst
+++ b/docs/guides/spp_vf/gsg/howto_use.rst
@@ -32,30 +32,9 @@
 How to Use
 ==========
 
-SPP_VF
-------
-
-``SPP_VF`` is a SR-IOV like network functionality for NFV.
-
-.. image:: images/spp_vf_overview.svg
-   :height: 550 em
-   :width: 550 em
-
-Environment
------------
-
-* Ubuntu 16.04
-* qemu-kvm 2.7 or later
-* DPDK v17.11 or later
-
-Launch SPP
-----------
-
-Before launching spp, you need to setup DPDK, virsh, etc. described at
-:doc:`build`.
 
 SPP Controller
-~~~~~~~~~~~~~~
+--------------
 
 First, run SPP Controller with port numbers for spp primary and secondary.
 
@@ -65,7 +44,7 @@ First, run SPP Controller with port numbers for spp primary and secondary.
 
 
 SPP Primary
-~~~~~~~~~~~
+-----------
 
 SPP primary allocates and manages resources for secondary processes.
 You need to run SPP primary before secondary processes.
@@ -94,7 +73,7 @@ Then, spp primary can be launched like this.
       -- -p 0x03 -n 9 -s 127.0.0.1:5555
 
 SPP Secondary
-~~~~~~~~~~~~~
+-------------
 
 spp secondary processes(``spp_vf``) can be launched with two kinds of
 options, like primary process.
@@ -104,9 +83,9 @@ DPDK, the other is ``spp_vf``.
 
 ``spp_vf`` specific options are:
 
-  * --client-id    : client id
-  * -s             : IPv4 address and port for spp secondary
-  * --vhost-client : vhost-user client enable setting
+  * --client-id: client id
+  * -s: IPv4 address and port for spp secondary
+  * --vhost-client: vhost-user client enable setting
 
 ``spp_vf`` can be launched like this.
 
@@ -120,7 +99,7 @@ If ``--vhost-client`` option is specified, then ``vhost-user`` act as
 the client, otherwise the server.
 For reconnect feature from SPP to VM, ``--vhost-client`` option can be
 used. This reconnect features requires QEMU 2.7 (or later).
-See also `DPDK documentation <http://dpdk.org/doc/guides/sample_app_ug/vhost.html>_.
+See also `DPDK documentation <http://dpdk.org/doc/guides/sample_app_ug/vhost.html>`_.
 
 VM
 --
@@ -138,8 +117,7 @@ Additional Network Configurations
 To enable processes running on the VM to communicate through spp,
 it is required additional network configurations on host and guest VMs.
 
-Guest VMs
-"""""""""
+(1) Guest VMs
 
 .. code-block:: console
 
@@ -149,8 +127,7 @@ Guest VMs
     # Disable offload for vhost interface
     $ sudo ethtool -K [IF_NAME] tx off
 
-Host2
-"""""
+(2) Host2
 
 .. code-block:: console
 
-- 
2.13.1

  parent reply	other threads:[~2018-02-05  2:39 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-02-05  2:38 [spp] [PATCH 01/28] docs: change doc structure to add spp_vf ogawa.yasufumi
2018-02-05  2:38 ` [spp] [PATCH 02/28] docs: add indexes for spp_vf ogawa.yasufumi
2018-02-05  2:38 ` [spp] [PATCH 03/28] docs: add spp_vf overview ogawa.yasufumi
2018-02-05  2:38 ` [spp] [PATCH 04/28] docs: add spp_vf design section ogawa.yasufumi
2018-02-05  2:38 ` [spp] [PATCH 05/28] docs: add spp_vf gsg section ogawa.yasufumi
2018-02-05  2:38 ` [spp] [PATCH 06/28] docs: add spp_vf explanation section ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 07/28] docs: add image for sample usage ogawa.yasufumi
2018-02-05  2:39 ` ogawa.yasufumi [this message]
2018-02-05  2:39 ` [spp] [PATCH 09/28] docs: fix link warning ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 10/28] docs: add overview image for spp_vf usercase1 ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 11/28] docs: add config " ogawa.yasufumi
2018-02-06 15:34   ` Ferruh Yigit
2018-02-07  0:10     ` Yasufumi Ogawa
2018-02-07 15:42       ` Ferruh Yigit
2018-02-07  0:26   ` ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 12/28] docs: add numref attribute for sphinx ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 13/28] docs: add usecase section in spp_vf ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 14/28] docs: add ssh login usecase for spp_vf ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 15/28] docs: add labels for using sphinx ref directive ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 16/28] docs: update spp_vf overview image ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 17/28] docs: update spp_vf command index ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 18/28] docs: add spp_vf primary command section ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 19/28] docs: add spp_vf secondary " ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 20/28] docs: add spp_vf common " ogawa.yasufumi
2018-02-05  2:39 ` [spp] [PATCH 21/28] docs: fix bug spp_vf command index ogawa.yasufumi
2018-02-07 15:44 ` [spp] [PATCH 01/28] docs: change doc structure to add spp_vf Ferruh Yigit

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180205023921.7775-8-ogawa.yasufumi@lab.ntt.co.jp \
    --to=ogawa.yasufumi@lab.ntt.co.jp \
    --cc=ferruh.yigit@intel.com \
    --cc=nakamura.hiroyuki@po.ntt-tx.co.jp \
    --cc=spp@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).