From mboxrd@z Thu Jan  1 00:00:00 1970
From: Olivier Matz <olivier.matz@6wind.com>
Subject: Re: [dpdk-stable] [PATCH 2/2] ethdev: clarify xstats Api
 documentation
Date: Fri, 16 Dec 2016 15:36:10 +0100
Message-ID: <20161216153610.546941f7@platinum>
References: <1481881454-17382-1-git-send-email-olivier.matz@6wind.com>
 <1481881454-17382-2-git-send-email-olivier.matz@6wind.com>
 <B27915DBBA3421428155699D51E4CFE202686E3E@IRSMSX103.ger.corp.intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Cc: "dev@dpdk.org" <dev@dpdk.org>, "thomas.monjalon@6wind.com"
 <thomas.monjalon@6wind.com>, "Horton, Remy" <remy.horton@intel.com>,
 "stable@dpdk.org" <stable@dpdk.org>
To: "Mcnamara, John" <john.mcnamara@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mail-wj0-f174.google.com (mail-wj0-f174.google.com
 [209.85.210.174]) by dpdk.org (Postfix) with ESMTP id 231D34B79
 for <dev@dpdk.org>; Fri, 16 Dec 2016 15:36:13 +0100 (CET)
Received: by mail-wj0-f174.google.com with SMTP id v7so94961617wjy.2
 for <dev@dpdk.org>; Fri, 16 Dec 2016 06:36:13 -0800 (PST)
In-Reply-To: <B27915DBBA3421428155699D51E4CFE202686E3E@IRSMSX103.ger.corp.intel.com>
List-Id: DPDK patches and discussions <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>

Hi John,

On Fri, 16 Dec 2016 14:28:21 +0000, "Mcnamara, John"
<john.mcnamara@intel.com> wrote:
> > -----Original Message-----
> > From: stable [mailto:stable-bounces@dpdk.org] On Behalf Of Olivier
> > Matz Sent: Friday, December 16, 2016 9:44 AM
> > To: dev@dpdk.org; thomas.monjalon@6wind.com
> > Cc: Horton, Remy <remy.horton@intel.com>; stable@dpdk.org
> > Subject: [dpdk-stable] [PATCH 2/2] ethdev: clarify xstats Api
> > documentation
> > 
> > Reword the Api documentation of xstats ethdev.
> > 
> > CC: stable@dpdk.org
> > Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
> > ---
> >  lib/librte_ether/rte_ethdev.h | 45
> > ++++++++++++++++++++++++-------------- -----
> >  ...
> >  int rte_eth_xstats_get_names(uint8_t port_id,
> >  		struct rte_eth_xstat_name *xstats_names, @@
> > -2296,19 +2300,20 @@ int rte_eth_xstats_get_names(uint8_t port_id,
> >   *   The port identifier of the Ethernet device.
> >   * @param xstats
> >   *   A pointer to a table of structure of type *rte_eth_xstat*
> > - *   to be filled with device statistics ids and values.
> > + *   to be filled with device statistics ids and values: id is the
> > + *   index of the name string in xstats_names (@see
> > rte_eth_xstats_get_names),  
> 
> The @see directive starts a new "See also" section and
> breaks/interrupts the parameter description. Probably what you want
> is:
> 
>     index of the name string in xstats_names (see
> rte_eth_xstats_get_names()), 
> 
> Otherwise it is a good update.
> 
> John

Thank you for the review. I'll send a new version of the patch
addressing this.


Regards,
Olivier