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 40FDE5F2D for ; Mon, 18 Feb 2019 12:50:49 +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 x1IBomB9029203; Mon, 18 Feb 2019 20:50:48 +0900 Received: from vc1.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 9E4AFEA8180; Mon, 18 Feb 2019 20:50:48 +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 8FC6AEA818F; Mon, 18 Feb 2019 20:50:48 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp Date: Mon, 18 Feb 2019 20:48:16 +0900 Message-Id: <1550490511-31683-6-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1550490511-31683-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> References: <1550490511-31683-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-TM-AS-MML: disable Subject: [spp] [PATCH 05/20] docs: move package installation to gsg 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, 18 Feb 2019 11:50:51 -0000 From: Yasufumi Ogawa This patch is to move instruction for packages installation from `SPP VF` to `Getting Started Guide`. Signed-off-by: Yasufumi Ogawa --- docs/guides/gsg/install.rst | 14 ++++++++++++-- docs/guides/spp_vf/gsg/setup.rst | 15 --------------- 2 files changed, 12 insertions(+), 17 deletions(-) diff --git a/docs/guides/gsg/install.rst b/docs/guides/gsg/install.rst index 3bf5246..b44cdaf 100644 --- a/docs/guides/gsg/install.rst +++ b/docs/guides/gsg/install.rst @@ -40,15 +40,25 @@ Python and pip are also required if not installed. # Python3 $ sudo apt install python3 python3-pip +Some of secondary processes depend on external libraries and you failed to +compile SPP without them. + SPP provides libpcap-based PMD for dumping packet to a file or retrieve it from the file. -To use PCAP PMD, install ``libpcap-dev`` and enable it. +``spp_nfv`` and ``spp_pcap`` use ``libpcap-dev`` for packet capture. +``spp_pcap`` uses ``liblz4-dev`` and ``liblz4-tool`` to compress PCAP file. + +.. code-block:: console + + $ sudo apt install libpcap-dev + $ sudo apt install liblz4-dev + $ sudo apt install liblz4-tool + ``text2pcap`` is also required for creating pcap file which is included in ``wireshark``. .. code-block:: console - $ sudo apt install libpcap-dev $ sudo apt install wireshark PCAP is disabled by default in DPDK configuration. diff --git a/docs/guides/spp_vf/gsg/setup.rst b/docs/guides/spp_vf/gsg/setup.rst index f0b8274..eebe591 100644 --- a/docs/guides/spp_vf/gsg/setup.rst +++ b/docs/guides/spp_vf/gsg/setup.rst @@ -84,18 +84,3 @@ Then, run make command to compile ``spp_mirror``. .. code-block:: console $ make - -Setup spp_pcap --------------- - -Setup of ``spp_pcap`` is almost the same as :ref:`SPP VF`. -``libpcap-dev`` is are used by ``spp_pcap`` when capturing and packet, -so you need to install ``libpcap-dev`` . -``liblz4-dev`` and ``liblz4-tool`` are used for compression and decompression -respectively, so you need to install ``liblz4-dev`` and ``liblz4-tool`` . - -.. code-block:: console - - $ sudo apt install libpcap-dev - $ sudo apt install liblz4-dev - $ sudo apt install liblz4-tool -- 2.7.4