From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <olivier.matz@6wind.com>
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)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=6wind-com.20150623.gappssmtp.com; s=20150623;
 h=date:from:to:cc:subject:message-id:in-reply-to:references
 :mime-version:content-transfer-encoding;
 bh=cxdc2gqVEnjcBmq9D3cc2ddgtk98B0Q0/8VG0yb7L+s=;
 b=Tbo9DJBTeb/O4EVLoJM621P1eKczdD5miTJnX5+pRUbCy8Ko0yz1EdFD2e2n/Bxl43
 +07yhZ3cwWEumSh0KAErtRUTMOHltff73GNIbO5M2ZOHi740icHX/G8gozvKzAbHK3UU
 HGHKsJDPdzkx5HQO9ZEJ3bVZnLEn4zAK8/DpF9O+Wc64FQNYQuYc8K/n50ZGYtdVkqwz
 0AYjXWppCFcrCiqV1E1oe4fReS1Uu8otUdPEhygVDyvV543WqF9YwgJXAodo6HsVGx5W
 5fJWjMw+gTU/C9XkHDlu6BwmENovH1uX1TzoS9rLF+DHgWnbPsI1FJ/CzRG5bKnML8pO
 Zm+w==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20161025;
 h=x-gm-message-state:date:from:to:cc:subject:message-id:in-reply-to
 :references:mime-version:content-transfer-encoding;
 bh=cxdc2gqVEnjcBmq9D3cc2ddgtk98B0Q0/8VG0yb7L+s=;
 b=BGGrGuDLmfqZofhyGSuElqzPyoP2+bK2TJkpkmXCJOTMSEbJL9jEFLUvQBdJ7tC2Wv
 XO9CT4YpnwIEDGHLdGCS3if5DXLwckI6FWVfrs72CNjB5D87W+nFfGLecnJvGQj6bhaC
 ohlg7ea+9FVt/wItlRG1D4NLtPHh0Ke/0tdebO7Vwq8mvtor1ic6s1u2KBRmDlI03fTn
 ANKcMLTLneW82VQYZ9goFcMhCHcmZk+Gr3eW51ZvJfAhmQNXE1X8EiM5rsk1L1y+QZOb
 V0bOKTet9mpbt0Z+7/MQqAL6XD8PteMx46zalQnHh6ZiBZmpOCChsS2M+KqJWBOY3JF9
 TaFA==
X-Gm-Message-State: AIkVDXI0dblD5QslMh3hNmbdp8in/QFoRrQulhXxlZOzUYwAEs8MU2RM3H/MvWd32PZ0jnIg
X-Received: by 10.194.222.169 with SMTP id qn9mr3064025wjc.62.1481898972886;
 Fri, 16 Dec 2016 06:36:12 -0800 (PST)
Received: from platinum (2a01cb0c03c651000226b0fffeed02fc.ipv6.abo.wanadoo.fr.
 [2a01:cb0c:3c6:5100:226:b0ff:feed:2fc])
 by smtp.gmail.com with ESMTPSA id d184sm3649785wmd.8.2016.12.16.06.36.12
 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256);
 Fri, 16 Dec 2016 06:36:12 -0800 (PST)
Date: Fri, 16 Dec 2016 15:36:10 +0100
From: Olivier Matz <olivier.matz@6wind.com>
To: "Mcnamara, John" <john.mcnamara@intel.com>
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>
Message-ID: <20161216153610.546941f7@platinum>
In-Reply-To: <B27915DBBA3421428155699D51E4CFE202686E3E@IRSMSX103.ger.corp.intel.com>
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>
X-Mailer: Claws Mail 3.14.1 (GTK+ 2.24.31; x86_64-pc-linux-gnu)
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Subject: Re: [dpdk-dev] [dpdk-stable] [PATCH 2/2] ethdev: clarify xstats Api
 documentation
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
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>
X-List-Received-Date: Fri, 16 Dec 2016 14:36:14 -0000

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