From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <reshmapa@ecsmtp.ir.intel.com>
Received: from mga11.intel.com (mga11.intel.com [192.55.52.93])
 by dpdk.org (Postfix) with ESMTP id 2AEAD8DA0
 for <dev@dpdk.org>; Wed,  6 Jul 2016 17:57:54 +0200 (CEST)
Received: from fmsmga003.fm.intel.com ([10.253.24.29])
 by fmsmga102.fm.intel.com with ESMTP; 06 Jul 2016 08:57:52 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.28,319,1464678000"; d="scan'208";a="730442260"
Received: from irvmail001.ir.intel.com ([163.33.26.43])
 by FMSMGA003.fm.intel.com with ESMTP; 06 Jul 2016 08:57:49 -0700
Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com
 [10.237.217.46])
 by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id
 u66Fvmu7002766; Wed, 6 Jul 2016 16:57:49 +0100
Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1])
 by sivswdev02.ir.intel.com with ESMTP id u66FvmMs003507;
 Wed, 6 Jul 2016 16:57:48 +0100
Received: (from reshmapa@localhost)
 by sivswdev02.ir.intel.com with  id u66FvmAj003503;
 Wed, 6 Jul 2016 16:57:48 +0100
From: Reshma Pattan <reshma.pattan@intel.com>
To: dev@dpdk.org
Cc: Reshma Pattan <reshma.pattan@intel.com>
Date: Wed,  6 Jul 2016 16:57:39 +0100
Message-Id: <1467820660-3418-2-git-send-email-reshma.pattan@intel.com>
X-Mailer: git-send-email 1.7.4.1
In-Reply-To: <1467820660-3418-1-git-send-email-reshma.pattan@intel.com>
References: <1467820660-3418-1-git-send-email-reshma.pattan@intel.com>
Subject: [dpdk-dev] [PATCH 1/2] doc: add pcap dependency note to pdump tool
	guide
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 06 Jul 2016 15:57:54 -0000

Added a missing note about dependencies on libpcap and
CONFIG_RTE_LIBRTE_PMD_PCAP flag that pdump tool has.

Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
---
 doc/guides/sample_app_ug/pdump.rst | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/doc/guides/sample_app_ug/pdump.rst b/doc/guides/sample_app_ug/pdump.rst
index 96c8709..32d4fbc 100644
--- a/doc/guides/sample_app_ug/pdump.rst
+++ b/doc/guides/sample_app_ug/pdump.rst
@@ -33,14 +33,21 @@
 dpdk_pdump Application
 ======================
 
-The ``dpdk_pdump`` application is a Data Plane Development Kit (DPDK) application that runs as a DPDK secondary process and
+The ``dpdk_pdump`` tool is a Data Plane Development Kit (DPDK) tool that runs as a DPDK secondary process and
 is capable of enabling packet capture on dpdk ports.
 
+   .. Note::
+
+      * The ``dpdk_pdump`` tool depends on libpcap based PMD which is disabled by default in the build configuration
+        files, owing to an external dependency on the libpcap development files which must be installed on the board.
+        Once the libpcap development files are installed, the libpcap based PMD can be enabled by setting
+        CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK.
+
 
 Running the Application
 -----------------------
 
-The application has a ``--pdump`` command line option with various sub arguments:
+The tool has a ``--pdump`` command line option with various sub arguments:
 
 .. code-block:: console
 
-- 
2.5.0