From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas.monjalon@6wind.com>
Subject: Re: [PATCH v9 5/8] pdump: add new library for packet
	capturing support
Date: Tue, 14 Jun 2016 22:28:29 +0200
Message-ID: <3000552.2jYBPTLpa9@xps13>
References: <1465575534-23605-1-git-send-email-reshma.pattan@intel.com>
 <1465897108-26548-1-git-send-email-reshma.pattan@intel.com>
 <1465897108-26548-6-git-send-email-reshma.pattan@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org
To: Reshma Pattan <reshma.pattan@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mail-wm0-f47.google.com (mail-wm0-f47.google.com [74.125.82.47])
 by dpdk.org (Postfix) with ESMTP id 217479AE4
 for <dev@dpdk.org>; Tue, 14 Jun 2016 22:28:34 +0200 (CEST)
Received: by mail-wm0-f47.google.com with SMTP id v199so136786851wmv.0
 for <dev@dpdk.org>; Tue, 14 Jun 2016 13:28:34 -0700 (PDT)
In-Reply-To: <1465897108-26548-6-git-send-email-reshma.pattan@intel.com>
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>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

2016-06-14 10:38, Reshma Pattan:
> The new librte_pdump library is added for packet capturing
> support.
> 
> Added public api rte_pdump_init, applications should call
> this as part of their application setup to have packet
> capturing framework ready.
> 
> Added public api rte_pdump_uninit to uninitialize the packet
> capturing framework.
> 
> Added public apis rte_pdump_enable and rte_pdump_disable to
> enable and disable packet capturing on specific port and queue.
> 
> Added public apis rte_pdump_enable_by_deviceid and
> rte_pdump_disable_by_deviceid to enable and disable packet
> capturing on a specific device (pci address or name) and queue.
> 
> Added public api rte_pdump_set_socket_dir to set the
> server and client socket paths.

Reshma, it is not the right info to put in a commit log.
The description of each function is in the doxygen comments.
We need to have the overview, what is the design architecture
(rings, mempool, etc) and why you do that?

>  MAINTAINERS                            |   4 +
>  config/common_base                     |   5 +
>  lib/Makefile                           |   1 +
>  lib/librte_pdump/Makefile              |  55 ++
>  lib/librte_pdump/rte_pdump.c           | 913 +++++++++++++++++++++++++++++++++
>  lib/librte_pdump/rte_pdump.h           | 216 ++++++++
>  lib/librte_pdump/rte_pdump_version.map |  13 +
>  mk/rte.app.mk                          |   1 +

And more importantly, we need a doc in the prog guide.