[spp] [PATCH 0/4] Add labels to commands in documentation

[spp] [PATCH 0/4] Add labels to commands in documentation

[ogawa.yasufumi]

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

This series of patches is to add labels for each of commands
to be referred.

Yasufumi Ogawa (4):
  docs: add labels for common commands
  docs: add labels for primary commands
  docs: add labels for nfv commands
  docs: add labels for experimental commands

 docs/guides/commands/common.rst            | 35 ++++++++++++++++++++++++++++++
 docs/guides/commands/experimental.rst      | 20 ++++++++++++++++-
 docs/guides/commands/primary.rst           | 14 +++++++++++-
 docs/guides/commands/secondary/spp_nfv.rst | 18 +++++++++++++++
 4 files changed, 85 insertions(+), 2 deletions(-)

-- 
2.7.4

[spp] [PATCH 1/4] docs: add labels for common commands

[ogawa.yasufumi]

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

To be linked, add labels for each of common commands.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/commands/common.rst | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/docs/guides/commands/common.rst b/docs/guides/commands/common.rst
index 6c72878..eb71859 100644
--- a/docs/guides/commands/common.rst
+++ b/docs/guides/commands/common.rst
@@ -2,9 +2,14 @@
     Copyright(c) 2010-2014 Intel Corporation
     Copyright(c) 2017-2019 Nippon Telegraph and Telephone Corporation
 
+
+.. _commands_common:
+
 Common Commands
 ===============
 
+.. _commands_common_status:
+
 status
 ------
 
@@ -23,6 +28,8 @@ Show the status of SPP processes.
         2: vf:3
 
 
+.. _commands_common_config:
+
 config
 ------
 
@@ -96,6 +103,8 @@ After updating the param, expanded options is also updated.
     spp > pri; launch nfv 2 -l 1,2 --socket-mem 512,0 -- -n 2 -s ...
 
 
+.. _commands_common_playback:
+
 playback
 --------
 
@@ -113,6 +122,8 @@ a recipe, although you can use any of extensions such as ``.txt`` or
     spp > playback /path/to/my.rcp
 
 
+.. _commands_common_record:
+
 record
 ------
 
@@ -133,6 +144,8 @@ command.
     next relase.
 
 
+.. _commands_common_history:
+
 history
 -------
 
@@ -147,6 +160,8 @@ meaning for history, ``bye``, ``exit``, ``history`` and ``redo``.
       2  cat file.txt
 
 
+.. _commands_common_redo:
+
 redo
 ----
 
@@ -157,6 +172,8 @@ Execute command of index of history.
     spp > redo 5  # exec 5th command in the history
 
 
+.. _commands_common_server:
+
 server
 ------
 
@@ -213,6 +230,8 @@ You cannot unregister node under the control, or switch to other one before.
     Cannot del server "1" in use!
 
 
+.. _commands_common_pwd:
+
 pwd
 ---
 
@@ -224,6 +243,8 @@ Show current path.
     /path/to/curdir
 
 
+.. _commands_common_cd:
+
 cd
 --
 
@@ -234,6 +255,8 @@ Change current directory.
     spp> cd /path/to/dir
 
 
+.. _commands_common_ls:
+
 ls
 --
 
@@ -244,6 +267,8 @@ Show a list of directory contents.
     spp> ls /path/to/dir
 
 
+.. _commands_common_mkdir:
+
 mkdir
 -----
 
@@ -254,6 +279,8 @@ Make a directory.
     spp> mkdir /path/to/dir
 
 
+.. _commands_common_cat:
+
 cat
 ---
 
@@ -264,6 +291,8 @@ Show contents of a file.
     spp> cat /path/to/file
 
 
+.. _commands_common_less:
+
 less
 ----
 
@@ -274,6 +303,8 @@ Show contents of a file.
     spp> less /path/to/file
 
 
+.. _commands_common_bye:
+
 bye
 ---
 
@@ -305,6 +336,8 @@ Second one is for all SPP processes other than controller.
     Exit primary
 
 
+.. _commands_common_exit:
+
 exit
 ----
 
@@ -317,6 +350,8 @@ not for other processes.
     Thank you for using Soft Patch Panel
 
 
+.. _commands_common_help:
+
 help
 ----
 
-- 
2.7.4

[spp] [PATCH 2/4] docs: add labels for primary commands

[ogawa.yasufumi]

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

To be linked, add labels for each of primary commands.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/commands/primary.rst | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/docs/guides/commands/primary.rst b/docs/guides/commands/primary.rst
index 687484d..58e22d4 100644
--- a/docs/guides/commands/primary.rst
+++ b/docs/guides/commands/primary.rst
@@ -1,5 +1,9 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation
+    Copyright(c) 2017-2019 Nippon Telegraph and Telephone Corporation
+
+
+.. _commands_primary:
 
 Primary Commands
 ================
@@ -35,6 +39,8 @@ All of Sub commands are referred with ``help`` command.
             spp > pri; launch vf 2 -l 1,4-7 -m 512 -- --client-id 2 -s ...
 
 
+.. _commands_primary_status:
+
 status
 ------
 
@@ -56,6 +62,8 @@ Show status fo spp_primary and forwarding statistics of each of ports.
          ...
 
 
+.. _commands_primary_clear:
+
 clear
 -----
 
@@ -67,6 +75,8 @@ Clear statistics.
     Clear port statistics.
 
 
+.. _commands_primary_launch:
+
 launch
 ------
 
@@ -95,7 +105,9 @@ the process so that you do not need to input this option by yourself.
 
 ``launch`` command supports TAB completion for type, secondary ID and the rest
 of options. Some of EAL and application options are just a template, so you
-should update them before launching.
+should edit them before launching. Some of default params of options,
+for instance, the number of lcores or the amount of memory, are changed from
+``config`` command of :ref:`Common Commands<commands_common_config>`.
 
 In terms of log, each of secondary processes are output its log messages to
 files under ``log`` directory of project root. The name of log file is defined
-- 
2.7.4

[spp] [PATCH 3/4] docs: add labels for nfv commands

[ogawa.yasufumi]

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

To be linked, add labels for each of nfv commands.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/commands/secondary/spp_nfv.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/docs/guides/commands/secondary/spp_nfv.rst b/docs/guides/commands/secondary/spp_nfv.rst
index 4057c25..d6db76e 100644
--- a/docs/guides/commands/secondary/spp_nfv.rst
+++ b/docs/guides/commands/secondary/spp_nfv.rst
@@ -1,6 +1,9 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation
 
+
+.. _commands_spp_nfv:
+
 spp_nfv
 =======
 
@@ -38,6 +41,9 @@ All of Sub commands are referred with ``help`` command.
         spp > nfv 1;  # press TAB
         add     del     exit    forward patch   status  stop
 
+
+.. _commands_spp_nfv_status:
+
 status
 ------
 
@@ -55,6 +61,8 @@ source if it is not patched.
       - phy:1
 
 
+.. _commands_spp_nfv_add:
+
 add
 ---
 
@@ -75,6 +83,8 @@ Or adding ``vhost:0`` by
     Add vhost:0.
 
 
+.. _commands_spp_nfv_patch:
+
 patch
 ------
 
@@ -87,6 +97,8 @@ This command just creates a path and does not start forwarding.
     Patch ports (phy:0 -> ring:0).
 
 
+.. _commands_spp_nfv_forward:
+
 forward
 -------
 
@@ -109,6 +121,8 @@ executing it.
       - phy:1
 
 
+.. _commands_spp_nfv_stop:
+
 stop
 ----
 
@@ -131,6 +145,8 @@ executing it.
       - phy:1
 
 
+.. _commands_spp_nfv_del:
+
 del
 ---
 
@@ -142,6 +158,8 @@ Delete a port from the secondary.
     Delete ring:0.
 
 
+.. _commands_spp_nfv_exit:
+
 exit
 ----
 
-- 
2.7.4

[spp] [PATCH 4/4] docs: add labels for experimental commands

[ogawa.yasufumi]

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

To be linked, add labels for each of experimental commands.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/commands/experimental.rst | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/docs/guides/commands/experimental.rst b/docs/guides/commands/experimental.rst
index 6a98ef2..e649a05 100644
--- a/docs/guides/commands/experimental.rst
+++ b/docs/guides/commands/experimental.rst
@@ -1,5 +1,8 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
-    Copyright(c) 2017 Nippon Telegraph and Telephone Corporation
+    Copyright(c) 2017-2019 Nippon Telegraph and Telephone Corporation
+
+
+.. _commands_experimental:
 
 Experimental Commands
 =====================
@@ -8,6 +11,9 @@ There are experimental commands in SPP controller.
 It might not work for some cases properly because it is not well tested
 currently.
 
+
+.. _commands_experimental_topo:
+
 topo
 ----
 
@@ -143,6 +149,8 @@ To generate a jpg image, run ``topo`` with the name ``network.jpg``.
     ...  network.jpg  ...
 
 
+.. _commands_experimental_topo_subgraph:
+
 topo_subgraph
 -------------
 
@@ -214,9 +222,17 @@ delete subgraph ``guest_vm``.
     spp > topo_subgraph del guest_vm
 
 
+.. _commands_experimental_topo_resize:
+
 topo_resize
 -----------
 
+.. note::
+
+    This command will be removed because the size of image is configurable
+    with :ref:`config<commands_common_config>` command. You can resize images by changing the value of
+    ``topo_size``.
+
 ``topo_resize`` is a supplemental command for changing the size of
 images displayed on the terminal with ``topo``.
 
@@ -250,6 +266,8 @@ or ratio.
     80%
 
 
+.. _commands_experimental_load_cmd:
+
 load_cmd
 --------
 
-- 
2.7.4