[spp] [PATCH 1/2] docs: move spp_vf command reference

[ogawa.yasufumi at lab.ntt.co.jp]

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

Remove command reference from 'SPP VF' section because 'spp_vf.py' is
obsoleted. 'spp.py' is changed to accept commands for spp_vf instead of
'spp_vf.py', command reference of spp_vf is moved to 'SPP Commands'.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi at lab.ntt.co.jp>
---
 docs/guides/commands/index.rst                     |   1 +
 .../commands/secondary.rst => commands/spp_vf.rst} |   6 +-
 docs/guides/spp_vf/commands/common.rst             | 104 ---------------------
 docs/guides/spp_vf/commands/index.rst              |  15 ---
 docs/guides/spp_vf/commands/primary.rst            |  49 ----------
 docs/guides/spp_vf/index.rst                       |   1 -
 6 files changed, 4 insertions(+), 172 deletions(-)
 rename docs/guides/{spp_vf/commands/secondary.rst => commands/spp_vf.rst} (98%)
 delete mode 100644 docs/guides/spp_vf/commands/common.rst
 delete mode 100644 docs/guides/spp_vf/commands/index.rst
 delete mode 100644 docs/guides/spp_vf/commands/primary.rst

diff --git a/docs/guides/commands/index.rst b/docs/guides/commands/index.rst
index 2d65a72..5a615c0 100644
--- a/docs/guides/commands/index.rst
+++ b/docs/guides/commands/index.rst
@@ -13,5 +13,6 @@ controller.
 
    primary
    secondary
+   spp_vf
    common
    experimental
diff --git a/docs/guides/spp_vf/commands/secondary.rst b/docs/guides/commands/spp_vf.rst
similarity index 98%
rename from docs/guides/spp_vf/commands/secondary.rst
rename to docs/guides/commands/spp_vf.rst
index ab89698..8e4a72a 100644
--- a/docs/guides/spp_vf/commands/secondary.rst
+++ b/docs/guides/commands/spp_vf.rst
@@ -1,10 +1,10 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation
 
-.. _spp_vf_commands_spp_vf_secondary:
+.. _commands_spp_vf:
 
-Secondary Commands
-======================
+SPP VF Commands
+===============
 
 Each of secondary processes is managed with ``sec`` command.
 It is for sending sub commands to secondary with specific ID called
diff --git a/docs/guides/spp_vf/commands/common.rst b/docs/guides/spp_vf/commands/common.rst
deleted file mode 100644
index b270f49..0000000
--- a/docs/guides/spp_vf/commands/common.rst
+++ /dev/null
@@ -1,104 +0,0 @@
-..  SPDX-License-Identifier: BSD-3-Clause
-    Copyright(c) 2010-2014 Intel Corporation
-
-.. _spp_vf_commands_spp_vf_common:
-
-Common Commands
-====================
-
-status
-------
-
-Show the number of connected primary and secondary processes.
-It also show a list of secondary IDs
-
-.. code-block:: console
-
-    spp > status
-    Soft Patch Panel Status :
-    primary: 1
-    secondary count: 4
-    Connected secondary id: 1
-    Connected secondary id: 2
-
-
-record
-------
-
-Start recording user's input and create a history file for ``playback``
-commnad.
-Recording is stopped by executing ``exit`` or ``playback`` command.
-
-.. code-block:: console
-
-    spp > record 2nfv_uni.config
-
-.. note::
-
-    It is not supported to stop recording without ``exit`` or ``playback``
-    command.
-    It is planned to support ``stop`` command for stopping record in
-    next relase.
-
-
-playback
---------
-
-Restore configuration from a config file.
-Content of config file is just a series of SPP commnad.
-You prepare a config file by using ``record`` command or editing a text
-file by hand.
-
-It is recommended to use extension ``.config`` to be self-sxplanatory
-as a config, although you can use any of extensions such as ``.txt`` or
-``.log``.
-
-.. code-block:: console
-
-    spp> playback 2nfv_uni.config
-
-
-bye
----
-
-``bye`` command is for terminating SPP processes.
-It supports two types of termination as sub commands.
-
-  - sec
-  - all
-
-First one is for terminating only secondary processes at once.
-
-.. code-block:: console
-
-    spp > bye sec
-    closing:<socket._socketobject object at 0x105750910>
-    closing:<socket._socketobject object at 0x105750a60>
-
-Second one is for all SPP processes other than controller.
-
-.. code-block:: console
-
-    spp > bye all
-    closing:<socket._socketobject object at 0x10bd95910>
-    closing:<socket._socketobject object at 0x10bd95a60>
-    closing:('127.0.0.1', 53620)
-
-
-help
-----
-
-Show help message for SPP commands.
-
-.. code-block:: console
-
-    spp > help
-
-    Documented commands (type help <topic>):
-    ========================================
-    bye  help  playback  pri  record  sec  status
-
-    spp > help status
-    Display Soft Patch Panel Status
-    spp > help sec
-    Send command to secondary process
diff --git a/docs/guides/spp_vf/commands/index.rst b/docs/guides/spp_vf/commands/index.rst
deleted file mode 100644
index ecd4b73..0000000
--- a/docs/guides/spp_vf/commands/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-..  SPDX-License-Identifier: BSD-3-Clause
-    Copyright(c) 2010-2014 Intel Corporation
-
-SPP VF Commands
-===============
-
-SPP VF provides commands for managing primary, secondary processes and
-SPP controller.
-
-.. toctree::
-   :maxdepth: 2
-
-   primary
-   secondary
-   common
diff --git a/docs/guides/spp_vf/commands/primary.rst b/docs/guides/spp_vf/commands/primary.rst
deleted file mode 100644
index b34b77b..0000000
--- a/docs/guides/spp_vf/commands/primary.rst
+++ /dev/null
@@ -1,49 +0,0 @@
-..  SPDX-License-Identifier: BSD-3-Clause
-    Copyright(c) 2010-2014 Intel Corporation
-
-Primary Commands
-====================
-
-Primary process is managed with ``pri`` command.
-
-
-status
-------
-
-Show status of primary.
-
-.. code-block:: console
-
-    spp > pri status
-    recv:('127.0.0.1', 50524):{Server Running}
-
-
-exit
-----
-
-Terminate primary.
-
-.. code-block:: console
-
-    spp > pri exit
-    closing:('127.0.0.1', 50524)
-
-.. note::
-
-    You should not use this command because terminating primary before
-    secondaries may cause an error.
-    You shold use ``bye`` command instead of ``pri exit``.
-
-clear
------
-
-Clear statistics.
-
-.. note::
-
-    This command is not supported currently.
-
-.. code-block:: console
-
-    spp > pri clear
-    recv:('127.0.0.1', 50524):{clear stats}
diff --git a/docs/guides/spp_vf/index.rst b/docs/guides/spp_vf/index.rst
index 576c108..c0ce125 100644
--- a/docs/guides/spp_vf/index.rst
+++ b/docs/guides/spp_vf/index.rst
@@ -12,5 +12,4 @@ SPP VF
    design
    gsg/index
    use_cases/index
-   commands/index
    explain/index
-- 
2.13.1