[spp] [PATCH] docs: fix typos of command example

[spp] [PATCH] docs: fix typos of command example

[ogawa.yasufumi]

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

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/setup/howto_use.rst | 5 +++--
 docs/guides/setup/use_cases.rst | 6 ++++--
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/docs/guides/setup/howto_use.rst b/docs/guides/setup/howto_use.rst
index dc014aa..19f7074 100644
--- a/docs/guides/setup/howto_use.rst
+++ b/docs/guides/setup/howto_use.rst
@@ -53,7 +53,8 @@ SPP controller is implemented as a python script ``spp.py``.
 
 .. code-block:: console
 
-    $ python spp.py
+    $ cd /path/to/spp
+    $ python src/spp.py
     primary port : 5555
     secondary port : 6666
     Welcome to the spp.   Type help or ? to list commands.
@@ -67,7 +68,7 @@ Please refer help message for options.
 
 .. code-block:: console
 
-    $ ./src/spp.py -h
+    $ python src/spp.py -h
     usage: spp.py [-h] [-p PRI_PORT] [-s SEC_PORT] [-m MNG_PORT] [-ip IPADDR]
 
     SPP Controller
diff --git a/docs/guides/setup/use_cases.rst b/docs/guides/setup/use_cases.rst
index 1cd30a6..2c83fe0 100644
--- a/docs/guides/setup/use_cases.rst
+++ b/docs/guides/setup/use_cases.rst
@@ -260,6 +260,7 @@ First, add ``ring 0`` and ``ring 1`` to ``sec 1``.
 
     spp > sec 1;add ring 0
     spp > sec 1;add ring 1
+    spp > sec 1;status
     status: idling
     ports:
       - 'phy:0'
@@ -274,6 +275,7 @@ Then, add ``ring 0`` and ``ring 1`` to ``sec 2``.
 
     spp > sec 2;add ring 0
     spp > sec 2;add ring 1
+    spp > sec 2;status
     status: idling
     ports:
       - 'phy:0'
@@ -326,7 +328,7 @@ creation.
     sock0 ...
 
     # remove it if exist
-    $ rm /tmp/sock0
+    $ sudo rm /tmp/sock0
 
 Create ``/tmp/sock0`` from ``sec 1``.
 
@@ -480,7 +482,7 @@ and watch received packets on pktgen.
 
 .. code-block:: console
 
-    spp > sec 2;patch phy:1 pcap:2
+    spp > sec 2;patch pcap:2 phy:1
     spp > sec 2;forward
 
 After started forwarding, you can see that packet count is increased.
-- 
2.17.1

Re: [spp] [PATCH] docs: fix typos of command example

[Ferruh Yigit]

On 6/12/2018 12:16 PM, ogawa.yasufumi@lab.ntt.co.jp wrote:
> From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
> 
> Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>

Applied, thanks.

Re: [spp] [PATCH] docs: fix typos of command example

[Yasufumi Ogawa]

Hi Ferruh,

Many thnaks for your reviewing and maintaining for SPP. I am appreciate your cooperation because SPP has grown up and the number 
of contributors is increased gradually.

By the way, could you check remained patches for merging? If there are OK, I would like to fix to update for SPP 18.05. Here is 
a list of patches.

Thanks,
Yasufumi

- [PATCH v3 0/3] docs:improvement of document under VF directory
   docs: add how to install qemu 2.7
   docs: correct incorrect SPP git URL
   docs: delete unsupported SPP VF Secondary Command

- [PATCH 0/3] Introduce recipes as config
   recipes: add recipes directory
   recipes: update SPP usecases
   recipes: update SPP_VF usecases

- [PATCH 0/2] Update doc for inappropriate link
   docs: add label to index of command reference
   docs: update link of command reference

- [PATCH v2 00/15] Fix mistakes of SPP container documentation
   docs: add index of SPP container tool
   docs: add overview of SPP container
   docs: add overview image of SPP container
   docs: add getting started guide of SPP container
   docs: add image of example for gsg
   docs: add install guide for SPP container
   docs: add build image guide for SPP container
   docs: add manual for app container launchers
   docs: add use cases of SPP container
   docs: add usecase image of testing vhost
   docs: add usecase image of testing ring
   docs: add usecase image of pktgen and l2fwd
   docs: add usecase image of using less lcores
   docs: add usecase image of load balancer
   docs: add how to develop guide for SPP container

- [PATCH 00/15] Add SPP container tools
   tools/sppc: add SPP container build tool
   tools/sppc: add dockerfiles for DPDK
   tools/sppc: add dockerfiles for pktgen
   tools/sppc: add dockerfiles for SPP
   tools/sppc: add spp-primary app continer
   tools/sppc: add spp-nfv app continer
   tools/sppc: add spp-vm app continer
   tools/sppc: add l2fwd app continer
   tools/sppc: add testpmd app continer
   tools/sppc: add l3fwd app continer
   tools/sppc: add pktgen app continer
   tools/sppc: add load-balancer app continer
   tools/sppc: add helloworld app continer
   tools/sppc: add helper script for build
   tools/sppc: add spp launcher script

- [PATCH 0/7] patches for DPDK v18.05
   spp_nfv: fix deprecated use of rte_eth_dev_count
   spp_primary: fix deprecated use of rte_eth_dev_count
   spp_vm: fix deprecated use of rte_eth_dev_count
   spp_vf: fix deprecated use of rte_eth_dev_count
   spp_vm: fix changing spec of rte_mem_config
   shared: fix for updating API of DPDK v18.05
   spp_vm: add DALLOW_EXPERIMENTAL_API on CFLA

On 2018/06/27 20:00, Ferruh Yigit wrote:
> On 6/12/2018 12:16 PM, ogawa.yasufumi@lab.ntt.co.jp wrote:
>> From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
>>
>> Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
> 
> Applied, thanks.
> 
> 


-- 
Yasufumi Ogawa
NTT Network Service Systems Labs

Re: [spp] [spp 02934] Re: [PATCH] docs: fix typos of command example

[Hideyuki Yamashita]

Hello Ferruh-san,

I am planning to contribute on SPP.
I think it is better that the base line source code be 18.05.

Though I think you might be super busy,
I am waiting remained patches merged into master branch ASAP.

Thanks in advance.

BR,
Hideyuki Yamashita

> Hi Ferruh,
> 
> Many thnaks for your reviewing and maintaining for SPP. I am appreciate your cooperation because SPP has grown up and the number of contributors is increased gradually.
> 
> By the way, could you check remained patches for merging? If there are OK, I would like to fix to update for SPP 18.05. Here is a list of patches.
> 
> Thanks,
> Yasufumi
> 
> - [PATCH v3 0/3] docs:improvement of document under VF directory
>    docs: add how to install qemu 2.7
>    docs: correct incorrect SPP git URL
>    docs: delete unsupported SPP VF Secondary Command
> 
> - [PATCH 0/3] Introduce recipes as config
>    recipes: add recipes directory
>    recipes: update SPP usecases
>    recipes: update SPP_VF usecases
> 
> - [PATCH 0/2] Update doc for inappropriate link
>    docs: add label to index of command reference
>    docs: update link of command reference
> 
> - [PATCH v2 00/15] Fix mistakes of SPP container documentation
>    docs: add index of SPP container tool
>    docs: add overview of SPP container
>    docs: add overview image of SPP container
>    docs: add getting started guide of SPP container
>    docs: add image of example for gsg
>    docs: add install guide for SPP container
>    docs: add build image guide for SPP container
>    docs: add manual for app container launchers
>    docs: add use cases of SPP container
>    docs: add usecase image of testing vhost
>    docs: add usecase image of testing ring
>    docs: add usecase image of pktgen and l2fwd
>    docs: add usecase image of using less lcores
>    docs: add usecase image of load balancer
>    docs: add how to develop guide for SPP container
> 
> - [PATCH 00/15] Add SPP container tools
>    tools/sppc: add SPP container build tool
>    tools/sppc: add dockerfiles for DPDK
>    tools/sppc: add dockerfiles for pktgen
>    tools/sppc: add dockerfiles for SPP
>    tools/sppc: add spp-primary app continer
>    tools/sppc: add spp-nfv app continer
>    tools/sppc: add spp-vm app continer
>    tools/sppc: add l2fwd app continer
>    tools/sppc: add testpmd app continer
>    tools/sppc: add l3fwd app continer
>    tools/sppc: add pktgen app continer
>    tools/sppc: add load-balancer app continer
>    tools/sppc: add helloworld app continer
>    tools/sppc: add helper script for build
>    tools/sppc: add spp launcher script
> 
> - [PATCH 0/7] patches for DPDK v18.05
>    spp_nfv: fix deprecated use of rte_eth_dev_count
>    spp_primary: fix deprecated use of rte_eth_dev_count
>    spp_vm: fix deprecated use of rte_eth_dev_count
>    spp_vf: fix deprecated use of rte_eth_dev_count
>    spp_vm: fix changing spec of rte_mem_config
>    shared: fix for updating API of DPDK v18.05
>    spp_vm: add DALLOW_EXPERIMENTAL_API on CFLA
> 
> On 2018/06/27 20:00, Ferruh Yigit wrote:
> > On 6/12/2018 12:16 PM, ogawa.yasufumi@lab.ntt.co.jp wrote:
> >> From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
> >>
> >> Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
> >
> > Applied, thanks.
> >
> > 
> 
> -- Yasufumi Ogawa
> NTT Network Service Systems Labs
> 

Re: [spp] [spp 02934] Re: [PATCH] docs: fix typos of command example

[Ferruh Yigit]

On 7/9/2018 3:18 AM, Hideyuki Yamashita wrote:
> Hello Ferruh-san,
> 
> I am planning to contribute on SPP.
> I think it is better that the base line source code be 18.05.
> 
> Though I think you might be super busy,
> I am waiting remained patches merged into master branch ASAP.

Hi Yasufumi, Jim, Thomas,

I start to be a bottleneck, first of all sorry about that. What do you guys
would think about adding Yasufumi as maintainer to overcome this?

Thanks,
ferruh

Re: [spp] [spp 02934] Re: [PATCH] docs: fix typos of command example

[Thomas Monjalon]

15/08/2018 17:48, Ferruh Yigit:
> On 7/9/2018 3:18 AM, Hideyuki Yamashita wrote:
> > Hello Ferruh-san,
> > 
> > I am planning to contribute on SPP.
> > I think it is better that the base line source code be 18.05.
> > 
> > Though I think you might be super busy,
> > I am waiting remained patches merged into master branch ASAP.
> 
> Hi Yasufumi, Jim, Thomas,
> 
> I start to be a bottleneck, first of all sorry about that. What do you guys
> would think about adding Yasufumi as maintainer to overcome this?

I am OK

I still need to fix how the doc is updated on the website.

Re: [spp] [spp 02934] Re: [PATCH] docs: fix typos of command example

[Yasufumi Ogawa]

On 2018/08/16 17:01, Thomas Monjalon wrote:
> 15/08/2018 17:48, Ferruh Yigit:
>> On 7/9/2018 3:18 AM, Hideyuki Yamashita wrote:
>>> Hello Ferruh-san,
>>>
>>> I am planning to contribute on SPP.
>>> I think it is better that the base line source code be 18.05.
>>>
>>> Though I think you might be super busy,
>>> I am waiting remained patches merged into master branch ASAP.
>>
>> Hi Yasufumi, Jim, Thomas,
>>
>> I start to be a bottleneck, first of all sorry about that. What do you guys
>> would think about adding Yasufumi as maintainer to overcome this?
> 
> I am OK
> 
> I still need to fix how the doc is updated on the website.

Hi Thomas,

SPP's doc is hosted on readthedocs.org currently same as pktgen. I hope SPP doc is hosted on dpdk.org if it is possible.

Thanks,
Yasufumi

Re: [spp] [spp 02934] Re: [PATCH] docs: fix typos of command example

[Yasufumi Ogawa]

> On 7/9/2018 3:18 AM, Hideyuki Yamashita wrote:
>> Hello Ferruh-san,
>>
>> I am planning to contribute on SPP.
>> I think it is better that the base line source code be 18.05.
>>
>> Though I think you might be super busy,
>> I am waiting remained patches merged into master branch ASAP.
> 
> Hi Yasufumi, Jim, Thomas,
> 
> I start to be a bottleneck, first of all sorry about that. What do you guys
> would think about adding Yasufumi as maintainer to overcome this?
Hi Ferruh,

Thanks for your suggestion kindly!

Yasufumi
> 
> Thanks,
> ferruh
>