From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw0534.ocn.ad.jp (mogw0534.ocn.ad.jp [118.23.178.176]) by dpdk.org (Postfix) with ESMTP id D9C451B292 for ; Mon, 5 Feb 2018 03:39:04 +0100 (CET) Received: from mf-smf-ucb015.ocn.ad.jp (mf-smf-ucb015.ocn.ad.jp [153.149.231.2]) by mogw0534.ocn.ad.jp (Postfix) with ESMTP id 5525A348241; Mon, 5 Feb 2018 11:39:03 +0900 (JST) Received: from mf-smf-ucb015.ocn.ad.jp (mf-smf-ucb015 [153.149.231.2]) by mf-smf-ucb015.ocn.ad.jp (Postfix) with ESMTP id 398E81200EC; Mon, 5 Feb 2018 11:39:03 +0900 (JST) Received: from ntt.pod01.mv-mta-ucb030 (mv-mta-ucb030.ocn.ad.jp [153.149.230.164]) by mf-smf-ucb015.ocn.ad.jp (Switch-3.3.4/Switch-3.3.4) with ESMTP id w152cwgi037656; Mon, 5 Feb 2018 11:39:02 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.134]) by ntt.pod01.mv-mta-ucb030 with id 6qf21x0082ud8JZ01qf2HU; Mon, 05 Feb 2018 02:39:02 +0000 Received: from localhost.localdomain (sp49-97-109-142.msc.spmode.ne.jp [49.97.109.142]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Mon, 5 Feb 2018 11:39:02 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: ferruh.yigit@intel.com, spp@dpdk.org, nakamura.hiroyuki@po.ntt-tx.co.jp Cc: Yasufumi Ogawa Date: Mon, 5 Feb 2018 11:39:11 +0900 Message-Id: <20180205023921.7775-18-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.13.1 In-Reply-To: <20180205023921.7775-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20180205023921.7775-1-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 18/28] docs: add spp_vf primary command section 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: Mon, 05 Feb 2018 02:39:05 -0000 From: Yasufumi Ogawa Signed-off-by: Yasufumi Ogawa --- docs/guides/spp_vf/commands/primary.rst | 77 +++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 docs/guides/spp_vf/commands/primary.rst diff --git a/docs/guides/spp_vf/commands/primary.rst b/docs/guides/spp_vf/commands/primary.rst new file mode 100644 index 0000000..d4f13a8 --- /dev/null +++ b/docs/guides/spp_vf/commands/primary.rst @@ -0,0 +1,77 @@ +.. BSD LICENSE + Copyright(c) 2010-2014 Intel Corporation. All rights reserved. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Intel Corporation nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +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} -- 2.13.1