[spp] [PATCH 0/2] Revise docs

[spp] [PATCH 0/2] Revise docs

[ogawa.yasufumi]

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

This series of patches is to revise docs for typos or renames.

Yasufumi Ogawa (2):
  docs: change use_cases to usecases
  docs: fix typo of usecase of spp_mirror

 docs/guides/index.rst                         |  2 +-
 docs/guides/{use_cases => usecases}/index.rst |  0
 .../{use_cases => usecases}/multi_nodes.rst   |  0
 .../{use_cases => usecases}/spp_mirror.rst    | 22 +++++++++----------
 .../{use_cases => usecases}/spp_nfv.rst       |  0
 .../{use_cases => usecases}/spp_pcap.rst      |  0
 .../guides/{use_cases => usecases}/spp_vf.rst |  0
 7 files changed, 12 insertions(+), 12 deletions(-)
 rename docs/guides/{use_cases => usecases}/index.rst (100%)
 rename docs/guides/{use_cases => usecases}/multi_nodes.rst (100%)
 rename docs/guides/{use_cases => usecases}/spp_mirror.rst (95%)
 rename docs/guides/{use_cases => usecases}/spp_nfv.rst (100%)
 rename docs/guides/{use_cases => usecases}/spp_pcap.rst (100%)
 rename docs/guides/{use_cases => usecases}/spp_vf.rst (100%)

-- 
2.17.1

[spp] [PATCH 1/2] docs: change use_cases to usecases

[ogawa.yasufumi]

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

To remove ambiguity from naming of path, change to not use `use_case`
but `usecase`.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/index.rst                               | 2 +-
 docs/guides/{use_cases => usecases}/index.rst       | 0
 docs/guides/{use_cases => usecases}/multi_nodes.rst | 0
 docs/guides/{use_cases => usecases}/spp_mirror.rst  | 0
 docs/guides/{use_cases => usecases}/spp_nfv.rst     | 0
 docs/guides/{use_cases => usecases}/spp_pcap.rst    | 0
 docs/guides/{use_cases => usecases}/spp_vf.rst      | 0
 7 files changed, 1 insertion(+), 1 deletion(-)
 rename docs/guides/{use_cases => usecases}/index.rst (100%)
 rename docs/guides/{use_cases => usecases}/multi_nodes.rst (100%)
 rename docs/guides/{use_cases => usecases}/spp_mirror.rst (100%)
 rename docs/guides/{use_cases => usecases}/spp_nfv.rst (100%)
 rename docs/guides/{use_cases => usecases}/spp_pcap.rst (100%)
 rename docs/guides/{use_cases => usecases}/spp_vf.rst (100%)

diff --git a/docs/guides/index.rst b/docs/guides/index.rst
index 1f4a5fb..70ec4a6 100644
--- a/docs/guides/index.rst
+++ b/docs/guides/index.rst
@@ -11,7 +11,7 @@ SPP documentation
    overview
    design/index
    gsg/index
-   use_cases/index
+   usecases/index
    commands/index
    tools/index
    api_ref/index
diff --git a/docs/guides/use_cases/index.rst b/docs/guides/usecases/index.rst
similarity index 100%
rename from docs/guides/use_cases/index.rst
rename to docs/guides/usecases/index.rst
diff --git a/docs/guides/use_cases/multi_nodes.rst b/docs/guides/usecases/multi_nodes.rst
similarity index 100%
rename from docs/guides/use_cases/multi_nodes.rst
rename to docs/guides/usecases/multi_nodes.rst
diff --git a/docs/guides/use_cases/spp_mirror.rst b/docs/guides/usecases/spp_mirror.rst
similarity index 100%
rename from docs/guides/use_cases/spp_mirror.rst
rename to docs/guides/usecases/spp_mirror.rst
diff --git a/docs/guides/use_cases/spp_nfv.rst b/docs/guides/usecases/spp_nfv.rst
similarity index 100%
rename from docs/guides/use_cases/spp_nfv.rst
rename to docs/guides/usecases/spp_nfv.rst
diff --git a/docs/guides/use_cases/spp_pcap.rst b/docs/guides/usecases/spp_pcap.rst
similarity index 100%
rename from docs/guides/use_cases/spp_pcap.rst
rename to docs/guides/usecases/spp_pcap.rst
diff --git a/docs/guides/use_cases/spp_vf.rst b/docs/guides/usecases/spp_vf.rst
similarity index 100%
rename from docs/guides/use_cases/spp_vf.rst
rename to docs/guides/usecases/spp_vf.rst
-- 
2.17.1

[spp] [PATCH 2/2] docs: fix typo of usecase of spp_mirror

[ogawa.yasufumi]

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

Correct wrong `mir1` to `mir`, `minitor` to `monitor`.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/usecases/spp_mirror.rst | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/docs/guides/usecases/spp_mirror.rst b/docs/guides/usecases/spp_mirror.rst
index dcb8e4d..5846bd1 100644
--- a/docs/guides/usecases/spp_mirror.rst
+++ b/docs/guides/usecases/spp_mirror.rst
@@ -94,17 +94,17 @@ Start mirror component with core ID 2.
 .. code-block:: console
 
     # terminal 2
-    spp > mirror 1; component start mir1 2 mirror
+    spp > mirror 1; component start mir 2 mirror
 
 Add ``phy:0`` as rx port, and ``phy:1`` and ``phy:2`` as tx ports.
 
 .. code-block:: none
 
     # terminal 2
-    # add ports to mir1
-    spp > mirror 1; port add phy:0 rx mir1
-    spp > mirror 1; port add phy:1 tx mir1
-    spp > mirror 1; port add phy:2 tx mir1
+    # add ports to mir
+    spp > mirror 1; port add phy:0 rx mir
+    spp > mirror 1; port add phy:1 tx mir
+    spp > mirror 1; port add phy:2 tx mir
 
 
 Duplicate Packets
@@ -152,17 +152,17 @@ Delete ports for components.
 
 .. code-block:: none
 
-   # Delete port for mir1
-   spp > mirror 1; port del phy:0 rx mir1
-   spp > mirror 1; port del phy:1 tx mir1
-   spp > mirror 1; port del phy:2 tx mir1
+   # Delete port for mir
+   spp > mirror 1; port del phy:0 rx mir
+   spp > mirror 1; port del phy:1 tx mir
+   spp > mirror 1; port del phy:2 tx mir
 
 Next, stop components.
 
 .. code-block:: console
 
    # Stop mirror
-   spp > mirror 1; component stop mir1 2 mirror
+   spp > mirror 1; component stop mir 2 mirror
 
    spp > mirror 1; status
    Basic Information:
@@ -186,7 +186,7 @@ Monitoring Packets
 Duplicate classified packets for monitoring before going to a VM.
 In this usecase, we are only interested in packets going to ``VM1``.
 Although you might be able to run packet monitor app on host,
-run minitor on ``VM3`` considering more NFV like senario.
+run monitor on ``VM3`` considering more NFV like senario.
 You use ``spp_mirror`` for copying, and ``spp_vf`` classifying packets.
 
 .. _figure_usecase_monitor_overview:
-- 
2.17.1