From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 49EC5A0352 for ; Mon, 23 Dec 2019 02:57:07 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 01E0A1252; Mon, 23 Dec 2019 02:57:07 +0100 (CET) Received: from mail-pl1-f195.google.com (mail-pl1-f195.google.com [209.85.214.195]) by dpdk.org (Postfix) with ESMTP id 4F3981252 for ; Mon, 23 Dec 2019 02:57:05 +0100 (CET) Received: by mail-pl1-f195.google.com with SMTP id c13so6583109pls.0 for ; Sun, 22 Dec 2019 17:57:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id; bh=+QHzGeBIVi0V0EuMm3C94W722EFgWDgUZqzyrEZQ2hg=; b=gQ+q5u3IPF9AZmdNqteC+riuE7Pgm2AdexniwZ1FjPKJhz62BEmcV3qyKpEQXOFdLM BVUWrX325VMpGMZtHrOs/VXtQO4r6dRs8wqa473QRB9mDeKIAijd+i9QjhzlSlkTh9Op WOwmRmkyCbnHcZTz8kIsGIzIWE9jLt+/Tn+8mKyYUixygQLgcwXawE4tvipHfFvnUMBi 2x64a/k+FNR+WHxLG4D2LRX5QCETKzFS8jJ1qzRhYAFanwCY1J6LzctbCekOszYNOdve eEGM5ycWrgvP8aU2Bw5w6Bni0qFSK34ysE+e6Cg/HHwc/bUIK5pv8ek6SGErMwE5514S JoeA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id; bh=+QHzGeBIVi0V0EuMm3C94W722EFgWDgUZqzyrEZQ2hg=; b=MHYaMd5lVqmhSH84Q/HPfW98DvZ1eYl6LfmPqM7oT2ttSDgBNmxfWroUezhfDZJRji IkDUgP8SmaU31l8cwlCHhj5oQP9YoHxR4uT8YG/qHsG2aSwRexJj0h9+1i+9VNJTF+zU V2Y4Gsl3tk6zgEyjDqQVgYFsjqdzbLPs+zWcMr9d+89NyjXWQj3hZ8r+IxNCF4oxLj6K tzjOqh/AN/aBKJTnSxyedq8QjjhP10UHlmDZlhtmqbWLKF0BiPZ87zzfwyTX3qJH8Ip5 66LtI51/dlt0To32Oqadcl4JV71ugICleLviURHmW+O+cvbwmX/r+xEKCEbNC4q9dKhe fzOw== X-Gm-Message-State: APjAAAULu6vTAZJ+wZSCvvlhklib2FWSYO5kg6evxJIK7RQPM6voT1C7 WkQipvRxQI+iihwOEqPVph92Csnv X-Google-Smtp-Source: APXvYqxFzl0yreOZtFEgbelmh/LfbWHZYpWjXszQb7R+jLUaN+qlv6cZ/d7u1TCbUplTURj05QH4TQ== X-Received: by 2002:a17:902:9a8d:: with SMTP id w13mr7475485plp.40.1577066224116; Sun, 22 Dec 2019 17:57:04 -0800 (PST) Received: from localhost.localdomain ([2400:4050:c8c2:de00:a8e9:fba3:b6bc:6f5]) by smtp.gmail.com with ESMTPSA id l66sm19592315pga.30.2019.12.22.17.57.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 22 Dec 2019 17:57:03 -0800 (PST) From: Yasufumi Ogawa To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com Date: Mon, 23 Dec 2019 10:56:58 +0900 Message-Id: <20191223015658.3474-1-yasufum.o@gmail.com> X-Mailer: git-send-email 2.17.1 Subject: [spp] [PATCH] docs: update howto_use for startup scripts 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: , Errors-To: spp-bounces@dpdk.org Sender: "spp" As memif is supported in the SPP startup scripts, add explanation how to configure params of vdev options and an example. This update also revise quick start guide. Signed-off-by: Yasufumi Ogawa --- docs/guides/gsg/howto_use.rst | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/docs/guides/gsg/howto_use.rst b/docs/guides/gsg/howto_use.rst index 8520de5..f4f1f08 100644 --- a/docs/guides/gsg/howto_use.rst +++ b/docs/guides/gsg/howto_use.rst @@ -36,11 +36,33 @@ DPDK applications in actual usecases. Quick Start ----------- -Run ``bin/start.sh`` with configuration file ``bin/config.sh``. -First time you run the script, it does not lanch processes but create a -template configuration file and asks you to edit this file. -After that, you can run the startup script for launching processes. All of -options for the processes are defined in the configuration. +Run ``bin/start.sh`` with configuration file ``bin/config.sh``. However, +at the first time you run the script, it is failed because this configration +file does not exist. It create the config from template +``bin/sample/config.sh`` and asks you to edit this file. +All of options for launching the processes are defined in the configuration +file. + +Edit the config file before run ``bin/start.sh`` again. It is expected you +have two physical ports on your server, but it is configurable. +You can use virtual ports instead of physical. +The number of ports is defined as ``PRI_PORTMASK=0x03`` as default. +If you do not have physical ports and use two memif ports instead of physical, +uncomment ``PRI_MEMIF_VDEVS=(0 1)``. +You can also use several types of port at once. + +.. code-block:: none + + # spp_primary options + ... + PRI_PORTMASK=0x03 # total num of ports of spp_primary. + + # Vdevs of spp_primary + #PRI_MEMIF_VDEVS=(0 1) # IDs of `net_memif` + #PRI_VHOST_VDEVS=(11 12) # IDs of `eth_vhost` + ... + +After that, you can run the startup script again for launching processes. .. code-block:: console @@ -48,7 +70,7 @@ options for the processes are defined in the configuration. $ bin/start.sh Start spp-ctl Start spp_primary - Waiting for spp-ctl is ready ... + Waiting for spp_primary is ready .................... OK! (8.5[sec]) Welcome to the SPP CLI. Type `help` or `?` to list commands. spp > -- 2.17.1