From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id 30E564CC5; Fri, 16 Dec 2016 15:28:25 +0100 (CET) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga105.fm.intel.com with ESMTP; 16 Dec 2016 06:28:24 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.33,357,1477983600"; d="scan'208";a="798724293" Received: from irsmsx153.ger.corp.intel.com ([163.33.192.75]) by FMSMGA003.fm.intel.com with ESMTP; 16 Dec 2016 06:28:23 -0800 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.124]) by IRSMSX153.ger.corp.intel.com ([169.254.9.24]) with mapi id 14.03.0248.002; Fri, 16 Dec 2016 14:28:22 +0000 From: "Mcnamara, John" To: Olivier Matz , "dev@dpdk.org" , "thomas.monjalon@6wind.com" CC: "Horton, Remy" , "stable@dpdk.org" Thread-Topic: [dpdk-stable] [PATCH 2/2] ethdev: clarify xstats Api documentation Thread-Index: AQHSV4EZXfeSbV0Bl0a9vrBStpuhZ6EKnZWQ Date: Fri, 16 Dec 2016 14:28:21 +0000 Message-ID: References: <1481881454-17382-1-git-send-email-olivier.matz@6wind.com> <1481881454-17382-2-git-send-email-olivier.matz@6wind.com> In-Reply-To: <1481881454-17382-2-git-send-email-olivier.matz@6wind.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_PUBLIC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiMzU5NGVkMzMtNWE5NC00NGI4LWJmZmMtNTJlNjA0OGMzZGJkIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX1BVQkxJQyJ9XX1dfSwiU3ViamVjdExhYmVscyI6W10sIlRNQ1ZlcnNpb24iOiIxNS45LjYuNiIsIlRydXN0ZWRMYWJlbEhhc2giOiJrN2RZeHJZQ2VIMHBySlZSVFJlS3hnZXBpNUhMODdVNVwvdERXZjNOaE1xTT0ifQ== x-originating-ip: [163.33.239.181] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 16 Dec 2016 14:28:25 -0000 > -----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 ; stable@dpdk.org > Subject: [dpdk-stable] [PATCH 2/2] ethdev: clarify xstats Api > documentation >=20 > Reword the Api documentation of xstats ethdev. >=20 > CC: stable@dpdk.org > Signed-off-by: Olivier Matz > --- > 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_n= ames), The @see directive starts a new "See also" section and breaks/interrupts th= e=20 parameter description. Probably what you want is: index of the name string in xstats_names (see rte_eth_xstats_get_names(= )),=20 Otherwise it is a good update. John