[spp] [PATCH 1/3] docs: add how to install qemu 2.7

[spp] [PATCH 1/3] docs: add how to install qemu 2.7

[x-fn-spp]

From: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>

This commit adds instruction about how to install qemu 2.7 in case
user does not have the version of qemu.

Signed-off-by: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/build.rst | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index 573d6be..93132d4 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -37,7 +37,7 @@ Environment
 -----------
 
 * Ubuntu 16.04
-* qemu-kvm 2.7 or later
+* qemu-kvm 2.7 or later(if you use vhost reconnect feature described in 3.2.3)
 * DPDK v17.11 or later
 
 
@@ -165,6 +165,18 @@ Then, bind it with PCI_Number.
 
 virsh setup
 -----------
+First of all, please check version of qemu-kvm.
+
+.. code-block:: console
+
+ $ qemu-system-x86_64 --version
+
+If your system does not have qemu-kvm or the version of qemu is less than 2.7,
+then please install qemu following the instruction of https://wiki.qemu.org/index.php/Hosts/Linux
+to install qemu 2.7.
+You may need to install libvirt-bin, virtinst, bridge-utils packages via ``apt-get`` install to run ``virt-install``.
+
+
 ``virsh`` is a command line interface that can be used to create, destroy, stop start and edit VMs and configure. After create an image file, you can setup it with ``virt-install``.
 
 .. code-block:: console
-- 
2.7.4

[spp] [PATCH 2/3] docs: correct incorrect SPP git URL

[x-fn-spp]

From: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>

This commit correct incorrect SPP git URL.

Signed-off-by: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/build.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index 93132d4..e7a2a17 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -136,8 +136,8 @@ Clone SPP in any directory and compile it.
 .. code-block:: console
 
     $ cd /path/to/spp_home/
-    $ git clone https://github.com/ntt-ns/Soft-Patch-Panel.git
-    export SPP_HOME=/path/to/spp_home/Soft-Patch-Panel
+    $ git clone http://dpdk.org/git/apps/spp
+    $ export SPP_HOME=/path/to/spp_home/spp
     $ cd $SPP_HOME
     $ make
 
-- 
2.7.4

[spp] [PATCH 3/3] docs:delete unsupported SPP VF Secondary Command

[x-fn-spp]

From: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>

This commit delete unsupported SPP VF Secondary Command.

Signed-off-by: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/commands/secondary.rst | 102 ------------------------------
 1 file changed, 102 deletions(-)

diff --git a/docs/guides/spp_vf/commands/secondary.rst b/docs/guides/spp_vf/commands/secondary.rst
index 564e9af..19e594c 100644
--- a/docs/guides/spp_vf/commands/secondary.rst
+++ b/docs/guides/spp_vf/commands/secondary.rst
@@ -282,105 +282,3 @@ before running ``flush`` command.
 .. code-block:: console
 
     spp > sec 1;cancel
-
-
-add
----
-
-Add a PMD to the secondary with resource ID.
-
-Adding ring 0 by
-
-.. code-block:: console
-
-    spp> sec 1;add ring 0
-    recv:7:{addring0}
-
-Or adding vhost 0 by
-
-.. code-block:: console
-
-    spp> sec 1;add vhost 0
-    recv:7:{addvhost0}
-
-
-patch
-------
-
-Create a path between two ports, source and destination ports.
-Port ID is referred by status sub commnad.
-This command just creates path and does not start forwarding.
-
-.. code-block:: console
-
-    spp > sec 1;patch 0 2
-    recv:7:{patch02}
-
-
-forward
--------
-
-Start forwarding.
-
-.. code-block:: console
-
-    spp > sec 1;forward
-    recv:7:{start forwarding}
-
-Running status is changed from ``Idling`` to ``Running`` by
-executing it.
-
-.. code-block:: console
-
-    spp > sec 1;status
-    recv:7:{Client ID 1 Running
-    1
-    port id: 0,on,PHY,outport: none
-    port id: 1,on,PHY,outport: none
-    }
-
-
-stop
-----
-
-Stop forwarding.
-
-.. code-block:: console
-
-    spp > sec 1;stop
-    recv:7:{start forwarding}
-
-Running status is changed from ``Running`` to ``Idling`` by
-executing it.
-
-.. code-block:: console
-
-    spp > sec 1;status
-    recv:7:{Client ID 1 Running
-    1
-    port id: 0,on,PHY,outport: none
-    port id: 1,on,PHY,outport: none
-    }
-
-
-del
----
-
-Delete PMD added by ``add`` subcommand from the secondary.
-
-.. code-block:: console
-
-    spp> sec 1;del ring 0
-    recv:7:{delring0}
-
-
-exit
-----
-
-Terminate the secondary. For terminating all secondaries, use ``bye sec``
-command instead of it.
-
-.. code-block:: console
-
-    spp> sec 1;exit
-    recv:7:{delring0}
-- 
2.7.4

Re: [spp] [PATCH 1/3] docs: add how to install qemu 2.7

[Yasufumi Ogawa]

On 2018/06/08 18:01, x-fn-spp@sl.ntt-tx.co.jp wrote:
> From: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>
> 
> This commit adds instruction about how to install qemu 2.7 in case
> user does not have the version of qemu.
Hiroyuki,

Thank you for revising docs for vhost usages. It looks to help user's understanding.

However, some of descriptions are inappropriate for the RST Guidelines.
https://dpdk.org/doc/guides/contributing/documentation.html#rst-guidelines

 > +.. code-block:: console
 > +
 > + $ qemu-system-x86_64 --version
It should be indented at least 3 spaces, and 4 spaces is better for conventional. Could you make sure to use 4 spaces for indenting?

 > +then please install qemu following the instruction of https://wiki.qemu.org/index.php/Hosts/Linux
 > +to install qemu 2.7.
 > +You may need to install libvirt-bin, virtinst, bridge-utils packages via ``apt-get`` install to run ``virt-install``.
 > +
 > +
 >   ``virsh`` is a command line interface that can be used to create, destroy, stop start and edit VMs and configure. After 
create an image file, you can setup it with ``virt-install``.
Line length should be less than 80 chars. First, third and final lines exceed to the limitation.

Thanks,
Yasufumi
> 
> Signed-off-by: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>
> Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
> ---
>   docs/guides/spp_vf/gsg/build.rst | 14 +++++++++++++-
>   1 file changed, 13 insertions(+), 1 deletion(-)
> 
> diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
> index 573d6be..93132d4 100644
> --- a/docs/guides/spp_vf/gsg/build.rst
> +++ b/docs/guides/spp_vf/gsg/build.rst
> @@ -37,7 +37,7 @@ Environment
>   -----------
>   
>   * Ubuntu 16.04
> -* qemu-kvm 2.7 or later
> +* qemu-kvm 2.7 or later(if you use vhost reconnect feature described in 3.2.3)
>   * DPDK v17.11 or later
>   
>   
> @@ -165,6 +165,18 @@ Then, bind it with PCI_Number.
>   
>   virsh setup
>   -----------
> +First of all, please check version of qemu-kvm.
> +
> +.. code-block:: console
> +
> + $ qemu-system-x86_64 --version
> +
> +If your system does not have qemu-kvm or the version of qemu is less than 2.7,
> +then please install qemu following the instruction of https://wiki.qemu.org/index.php/Hosts/Linux
> +to install qemu 2.7.
> +You may need to install libvirt-bin, virtinst, bridge-utils packages via ``apt-get`` install to run ``virt-install``.
> +
> +
>   ``virsh`` is a command line interface that can be used to create, destroy, stop start and edit VMs and configure. After create an image file, you can setup it with ``virt-install``.
>   
>   .. code-block:: console
> 


-- 
Yasufumi Ogawa
NTT Network Service Systems Labs

Re: [spp] [PATCH 2/3] docs: correct incorrect SPP git URL

[Yasufumi Ogawa]

On 2018/06/08 18:01, x-fn-spp@sl.ntt-tx.co.jp wrote:
> From: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>
> 
> This commit correct incorrect SPP git URL.
> 
> Signed-off-by: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>
> Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
> ---
>   docs/guides/spp_vf/gsg/build.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
> index 93132d4..e7a2a17 100644
> --- a/docs/guides/spp_vf/gsg/build.rst
> +++ b/docs/guides/spp_vf/gsg/build.rst
> @@ -136,8 +136,8 @@ Clone SPP in any directory and compile it.
>   .. code-block:: console
>   
>       $ cd /path/to/spp_home/
> -    $ git clone https://github.com/ntt-ns/Soft-Patch-Panel.git
> -    export SPP_HOME=/path/to/spp_home/Soft-Patch-Panel
> +    $ git clone http://dpdk.org/git/apps/spp
> +    $ export SPP_HOME=/path/to/spp_home/spp
I am not sure it is a mistake or not. Do you mean the path of SPP_HOME is not '/path/to/spp_home/spp' but '/path/to/spp_home', 
right?

Thanks,
>       $ cd $SPP_HOME
>       $ make
>   
> 

Re: [spp] [PATCH 3/3] docs:delete unsupported SPP VF Secondary Command

[Yasufumi Ogawa]

On 2018/06/08 18:01, x-fn-spp@sl.ntt-tx.co.jp wrote:
> From: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>
> 
> This commit delete unsupported SPP VF Secondary Command.
This patch looks good and has no problems, but subject is not appropriate. Space should be added after 'docs:'. Could you think 
to change the subject to "docs: delete unsupported SPP VF commands" simply.

Thanks
> 
> Signed-off-by: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>
> Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
> ---
>   docs/guides/spp_vf/commands/secondary.rst | 102 ------------------------------
>   1 file changed, 102 deletions(-)
> 
> diff --git a/docs/guides/spp_vf/commands/secondary.rst b/docs/guides/spp_vf/commands/secondary.rst
> index 564e9af..19e594c 100644
> --- a/docs/guides/spp_vf/commands/secondary.rst
> +++ b/docs/guides/spp_vf/commands/secondary.rst
> @@ -282,105 +282,3 @@ before running ``flush`` command.
>   .. code-block:: console
>   
>       spp > sec 1;cancel
> -
> -
> -add
> ----
> -
> -Add a PMD to the secondary with resource ID.
> -
> -Adding ring 0 by
> -
> -.. code-block:: console
> -
> -    spp> sec 1;add ring 0
> -    recv:7:{addring0}
> -
> -Or adding vhost 0 by
> -
> -.. code-block:: console
> -
> -    spp> sec 1;add vhost 0
> -    recv:7:{addvhost0}
> -
> -
> -patch
> -------
> -
> -Create a path between two ports, source and destination ports.
> -Port ID is referred by status sub commnad.
> -This command just creates path and does not start forwarding.
> -
> -.. code-block:: console
> -
> -    spp > sec 1;patch 0 2
> -    recv:7:{patch02}
> -
> -
> -forward
> --------
> -
> -Start forwarding.
> -
> -.. code-block:: console
> -
> -    spp > sec 1;forward
> -    recv:7:{start forwarding}
> -
> -Running status is changed from ``Idling`` to ``Running`` by
> -executing it.
> -
> -.. code-block:: console
> -
> -    spp > sec 1;status
> -    recv:7:{Client ID 1 Running
> -    1
> -    port id: 0,on,PHY,outport: none
> -    port id: 1,on,PHY,outport: none
> -    }
> -
> -
> -stop
> -----
> -
> -Stop forwarding.
> -
> -.. code-block:: console
> -
> -    spp > sec 1;stop
> -    recv:7:{start forwarding}
> -
> -Running status is changed from ``Running`` to ``Idling`` by
> -executing it.
> -
> -.. code-block:: console
> -
> -    spp > sec 1;status
> -    recv:7:{Client ID 1 Running
> -    1
> -    port id: 0,on,PHY,outport: none
> -    port id: 1,on,PHY,outport: none
> -    }
> -
> -
> -del
> ----
> -
> -Delete PMD added by ``add`` subcommand from the secondary.
> -
> -.. code-block:: console
> -
> -    spp> sec 1;del ring 0
> -    recv:7:{delring0}
> -
> -
> -exit
> -----
> -
> -Terminate the secondary. For terminating all secondaries, use ``bye sec``
> -command instead of it.
> -
> -.. code-block:: console
> -
> -    spp> sec 1;exit
> -    recv:7:{delring0}
>

Re: [spp] [PATCH 2/3] docs: correct incorrect SPP git URL

[Yasufumi Ogawa]

On 2018/06/08 18:01, x-fn-spp@sl.ntt-tx.co.jp wrote:
> From: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>
> 
> This commit correct incorrect SPP git URL.
> 
> Signed-off-by: Hiroyuki Nakamura <nakamura.hiroyuki@po.ntt-tx.co.jp>
> Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
> ---
>   docs/guides/spp_vf/gsg/build.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
> index 93132d4..e7a2a17 100644
> --- a/docs/guides/spp_vf/gsg/build.rst
> +++ b/docs/guides/spp_vf/gsg/build.rst
> @@ -136,8 +136,8 @@ Clone SPP in any directory and compile it.
>   .. code-block:: console
>   
>       $ cd /path/to/spp_home/
I think that users may be confused for what is 'spp_home' and where is it. You should add an explanation about it if you need to 
move to 'spp_home' dir.
> -    $ git clone https://github.com/ntt-ns/Soft-Patch-Panel.git
> -    export SPP_HOME=/path/to/spp_home/Soft-Patch-Panel
> +    $ git clone http://dpdk.org/git/apps/spp
> +    $ export SPP_HOME=/path/to/spp_home/spp
I think it is no good naming because 'spp_home' is not '$SPP_HOME'. Could you change it to be consistent?

Thanks,
>       $ cd $SPP_HOME
>       $ make
>   
> 


-- 
Yasufumi Ogawa
NTT Network Service Systems Labs