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 529B5A2EFC for ; Tue, 17 Sep 2019 14:23:29 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 4BD9F1BF2C; Tue, 17 Sep 2019 14:23:29 +0200 (CEST) Received: from mail-pg1-f196.google.com (mail-pg1-f196.google.com [209.85.215.196]) by dpdk.org (Postfix) with ESMTP id 6AB8C1BF62 for ; Tue, 17 Sep 2019 14:23:28 +0200 (CEST) Received: by mail-pg1-f196.google.com with SMTP id w10so1939749pgj.7 for ; Tue, 17 Sep 2019 05:23:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id:in-reply-to:references; bh=zAF7BSk9lqSLfoy3cAaTWQ+NREXIEg4MwtJCagB8R9Y=; b=I3WQOmxSnnMrVhW3lB44XaVsf4WA1BBInyDIJk43v9Zd30I1Rnfoy1Adm4fSFX0Xz4 9Mzhn9PvTfSOv6i9IYfmtzRJIhuphkC1ZYeuko4Ebg4CZUlFieFyNIu+kj5aBnAQ21NY aq01lqPdtspb053vg3y/YDPp+ylPY2G7ao+v9PEyDZN8BPVgvjeRlk1QxTxnbMk3BIaH 1bW0dYYSkyl8o1dA6OB7o49/R15ARZ5Ac4cqpZ+iTZnGDtn4rSOxvQ4BCelWVXnTxHmV EHDLUUwX7hWn/XnqHbGLVTTfaD9sHphHiN80AeYO8YnPFd6+2S33b70WsNWVxYWzgoxN 7AVA== 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:in-reply-to :references; bh=zAF7BSk9lqSLfoy3cAaTWQ+NREXIEg4MwtJCagB8R9Y=; b=e8LowjhFIYOHvFw57rqRp5nI7l+6X+h9qTMYd5KKE3ICkp7iK9A9c4CFhbkn0AXHZF SuKWuGjeJRNDVdT4EOuGCVpCAHuurbUMfo495lje/LsARfVyMzlllTlsaxwtwPkr4Vz/ L/9YBTZ3N1QupE7+RNqSlnStqGhFQaF6Tdw/nVusEvXA6UqhUT1bdqD6qQKxukc9I1jx yfy5X9i1czUFSSfvNBx3ZeExlF00Ww7Dunl8s2SZEbV+kVnX2RObRdrVazSJdFngm7NL GC1se1f9GC8GkcYIBpTH3JOf3yWNOr7w623S98cUgYQvZsT4sh83+p1ZZ5LXlx1s9n5U LUMg== X-Gm-Message-State: APjAAAW7pSgbBezeBPSNNpyjXedBROQ3UNTYZieqta4EBOpSjJs2ZEAT H6ZLCL+aCtWhU5ogxprY4W28sUyb X-Google-Smtp-Source: APXvYqyBKEsXGgzlraVHjqOLWAyv3ncUAn2NhaWaR4AzFDECzxIwnegAckjNIKhivAeifmrq+Tb1rw== X-Received: by 2002:aa7:8118:: with SMTP id b24mr3951777pfi.148.1568723007557; Tue, 17 Sep 2019 05:23:27 -0700 (PDT) Received: from localhost.localdomain ([192.47.164.146]) by smtp.gmail.com with ESMTPSA id n66sm4742726pfn.90.2019.09.17.05.23.26 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 17 Sep 2019 05:23:27 -0700 (PDT) From: yasufum.o@gmail.com To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com Date: Tue, 17 Sep 2019 21:23:19 +0900 Message-Id: <20190917122319.16129-3-yasufum.o@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190917122319.16129-1-yasufum.o@gmail.com> References: <20190917122319.16129-1-yasufum.o@gmail.com> Subject: [spp] [PATCH 2/2] docs: update install 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: , Errors-To: spp-bounces@dpdk.org Sender: "spp" From: Yasufumi Ogawa This update is to revise how to install Python packages with `requirements.txt` to be more clear meaning. Signed-off-by: Yasufumi Ogawa --- docs/guides/gsg/install.rst | 38 ++++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 17 deletions(-) diff --git a/docs/guides/gsg/install.rst b/docs/guides/gsg/install.rst index c2763ad..335a151 100644 --- a/docs/guides/gsg/install.rst +++ b/docs/guides/gsg/install.rst @@ -7,13 +7,14 @@ Install DPDK and SPP ==================== -Before using SPP, you need to install DPDK. +Before setting up SPP, you need to install DPDK. In this document, briefly described how to install and setup DPDK. Refer to `DPDK documentation `_ for more details. For Linux, see `Getting Started Guide for Linux `_ . + .. _setup_install_packages: Required Packages @@ -22,10 +23,11 @@ Required Packages Installing packages for DPDK and SPP is almost the on Ubunu and CentOS, but names are different for some packages. + Ubuntu ~~~~~~ -To compile DPDK, required to install following packages. +To compile DPDK, it is required to install following packages. .. code-block:: console @@ -39,8 +41,8 @@ You also need to install linux-headers of your kernel version. $ sudo apt install linux-headers-$(uname -r) -Some of secondary processes depend on external libraries and you failed to -compile SPP without them. +Some of SPP secondary processes depend on other libraries and you fail to +compile SPP without installing them. SPP provides libpcap-based PMD for dumping packet to a file or retrieve it from the file. @@ -82,9 +84,7 @@ To compile DPDK, required to install following packages. kernel-headers \ kernel-devel -Some of secondary processes depend on external libraries and you failed to -compile SPP without them. - +As same as Ubuntu, you should install additional packages because SPP provides libpcap-based PMD for dumping packet to a file or retrieve it from the file. ``spp_nfv`` and ``spp_pcap`` use ``libpcap-dev`` for packet capture. @@ -115,8 +115,8 @@ Clone repository and compile DPDK in any directory. $ cd /path/to/any $ git clone http://dpdk.org/git/dpdk -Installing on Ubuntu and CentOS are almost the same, but packages are -different. +Installing on Ubuntu and CentOS are almost the same, but required packages +are just bit different. PCAP is disabled by default in DPDK configuration. ``CONFIG_RTE_LIBRTE_PMD_PCAP`` and ``CONFIG_RTE_PORT_PCAP`` defined in @@ -139,7 +139,8 @@ Compile DPDK with target environment. $ make install T=$RTE_TARGET -PCAP is disabled by default in DPDK configuration. +PCAP is disabled by default in DPDK configuration, so should be changed +if you use this feature. ``CONFIG_RTE_LIBRTE_PMD_PCAP`` and ``CONFIG_RTE_PORT_PCAP`` defined in config file ``common_base`` should be changed to ``y`` to enable PCAP. @@ -150,7 +151,7 @@ config file ``common_base`` should be changed to ``y`` to enable PCAP. ... CONFIG_RTE_PORT_PCAP=y -Compile DPDK with target environment. +Compile DPDK with options for target environment. .. code-block:: console @@ -163,7 +164,8 @@ Compile DPDK with target environment. Pyhton ------ -Python3 and pip3 are also required if not installed. +Python3 and pip3 are also required because SPP controller is implemented +in Pyhton3. Required packages can be installed from ``requirements.txt``. .. code-block:: console @@ -206,8 +208,10 @@ Clone SPP repository and compile it in any directory. $ cd spp $ make # Confirm that $RTE_SDK and $RTE_TARGET are set -If you use ``spp_mirror`` in deep copy mode, you should comment out -the definition of copy mode in Makefile of ``spp_mirror`` before. +If you use ``spp_mirror`` in deep copy mode, +which is used for cloning whole of packet data for modification, +you should change configuration of copy mode in Makefile of ``spp_mirror`` +before. It is for copying full payload into a new mbuf. Default mode is shallow copy. @@ -324,9 +328,9 @@ cannot find it by using ``ifconfig`` or ``ip``. Confirm DPDK is setup properly ------------------------------ -You can confirm if you are ready to use DPDK by running DPDK's sample -application. ``l2fwd`` is good choice to confirm it before SPP because -it is very similar to SPP's worker process for forwarding. +For testing, you can confirm if you are ready to use DPDK by running +DPDK's sample application. ``l2fwd`` is good example to confirm it +before SPP because it is very similar to SPP's worker process for forwarding. .. code-block:: console -- 2.17.1