From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from tama50.ecl.ntt.co.jp (tama50.ecl.ntt.co.jp [129.60.39.147]) by dpdk.org (Postfix) with ESMTP id C29621B43F for ; Thu, 31 Jan 2019 12:04:23 +0100 (CET) Received: from vc1.ecl.ntt.co.jp (vc1.ecl.ntt.co.jp [129.60.86.153]) by tama50.ecl.ntt.co.jp (8.13.8/8.13.8) with ESMTP id x0VB4MFu005250; Thu, 31 Jan 2019 20:04:22 +0900 Received: from vc1.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 9D85DEA8475; Thu, 31 Jan 2019 20:04:22 +0900 (JST) Received: from localhost.localdomain (lobster.nslab.ecl.ntt.co.jp [129.60.13.95]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 8C737EA8536; Thu, 31 Jan 2019 20:04:22 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: ferruh.yigit@intel.com, spp@dpdk.org, ogawa.yasufumi@lab.ntt.co.jp Date: Thu, 31 Jan 2019 20:02:12 +0900 Message-Id: <1548932534-20983-4-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1548932534-20983-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> References: <1548932534-20983-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-TM-AS-MML: disable Subject: [spp] [PATCH 3/5] docs: add launch command in primary X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 31 Jan 2019 11:04:24 -0000 From: Yasufumi Ogawa This update is to add launch sub command of primary to `Commands` section. Signed-off-by: Yasufumi Ogawa --- docs/guides/commands/primary.rst | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/guides/commands/primary.rst b/docs/guides/commands/primary.rst index 11e378c..5032b37 100644 --- a/docs/guides/commands/primary.rst +++ b/docs/guides/commands/primary.rst @@ -35,3 +35,39 @@ Clear statistics. .. code-block:: console spp > pri; clear + + +launch +------ + +Launch secondary process. + +Spp_primary is able to launch a secondary process with given type, secondary +ID and options of EAL and application itself. This is a list of supported type +of secondary processes. + + * nfv + * vf + * mirror + * pcap + +.. code-block:: console + + # spp_nfv with sec ID 1 + spp > pri; launch nfv 1 -l 1,2 -m 512 -- -n -s 192.168.1.100:6666 + + # spp_vf with sec ID 2 + spp > pri; launch vf 2 -l 1,3-5 -m 512 -- --client-id -s 192.168.1.100:6666 + +You notice that ``--proc-type secondary`` is not given for launching secondary +processes. ``launch`` command adds this option before requesting to launch +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. + +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 +with type of process and secondary ID. For instance, ``nfv 2``, the path of log +file is ``log/spp_nfv-2.log``. -- 2.7.4