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>
Subject: Re: [dpdk-stable] [PATCH 2/2] ethdev: clarify xstats Api documentation
Date: Fri, 16 Dec 2016 15:36:10 +0100 [thread overview]
Message-ID: <20161216153610.546941f7@platinum> (raw)
In-Reply-To: <B27915DBBA3421428155699D51E4CFE202686E3E@IRSMSX103.ger.corp.intel.com>
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
next prev parent reply other threads:[~2016-12-16 14:36 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-16 9:44 [PATCH 1/2] ethdev: fix name index in xstats Api Olivier Matz
2016-12-16 9:44 ` [PATCH 2/2] ethdev: clarify xstats Api documentation Olivier Matz
2016-12-16 14:28 ` [dpdk-stable] " Mcnamara, John
2016-12-16 14:36 ` Olivier Matz [this message]
2016-12-23 20:35 ` [PATCH v2 " Olivier Matz
2017-01-03 10:03 ` Remy Horton
2017-01-04 18:10 ` Thomas Monjalon
2017-01-03 10:03 ` [PATCH 1/2] ethdev: fix name index in xstats Api Remy Horton
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20161216153610.546941f7@platinum \
--to=olivier.matz@6wind.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=remy.horton@intel.com \
--cc=stable@dpdk.org \
--cc=thomas.monjalon@6wind.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.