From: David Marchand <david.marchand@redhat.com>
To: Thomas Monjalon <thomas@monjalon.net>,
Aaron Conole <aconole@redhat.com>,
Michael Santana <msantana@redhat.com>
Cc: dev <dev@dpdk.org>, Neil Horman <nhorman@tuxdriver.com>,
Adrien Mazarguil <adrien.mazarguil@6wind.com>,
Stephen Hemminger <stephen@networkplumber.org>
Subject: Re: [dpdk-dev] [PATCH v2 10/10] enforce __rte_experimental at the start of symbol declarations
Date: Sat, 29 Jun 2019 18:39:32 +0200 [thread overview]
Message-ID: <CAJFAV8xwXWr6vL7Sb26-=_rqkxJVR+p1e0WsBSQxCQN0rH_9qA@mail.gmail.com> (raw)
In-Reply-To: <3633624.cieMKMvx7x@xps>
On Sat, Jun 29, 2019 at 6:14 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> 29/06/2019 13:58, David Marchand:
> > Special mention for rte_mbuf_data_addr_default():
> >
> > There is either a bug or a (not yet understood) issue with gcc.
> > gcc won't drop this inline when unused and rte_mbuf_data_addr_default()
> > calls rte_mbuf_buf_addr() which itself is experimental.
> > This results in a build warning when not accepting experimental apis
> > from sources just including rte_mbuf.h.
> >
> > For this specific case, we hide the call to rte_mbuf_buf_addr() under
> > the ALLOW_EXPERIMENTAL_API flag.
> [...]
> > -static inline char * __rte_experimental
> > -rte_mbuf_data_addr_default(struct rte_mbuf *mb)
> > +__rte_experimental
> > +static inline char *
> > +rte_mbuf_data_addr_default(struct rte_mbuf *mb __rte_unused)
> > {
> > + /* gcc complains about calling this experimental function even
> > + * when not using it. Hide it with ALLOW_EXPERIMENTAL_API.
> > + */
> > +#ifdef ALLOW_EXPERIMENTAL_API
> > return rte_mbuf_buf_addr(mb, mb->pool) + RTE_PKTMBUF_HEADROOM;
> > +#else
> > + return NULL;
> > +#endif
> > }
>
> Doxygen is confused by having __rte_unused at the end:
>
> lib/librte_mbuf/rte_mbuf.h:876: warning:
> argument 'mb' of command @param is not found in the argument list
> of
> rte_mbuf_data_addr_default(struct rte_mbuf *mb __rte_unused)
> lib/librte_mbuf/rte_mbuf.h:889: warning:
> The following parameters of
> rte_mbuf_data_addr_default(struct rte_mbuf *mb __rte_unused)
> are not documented:
> parameter '__rte_unused'
>
> I move __rte_unused at the beginning while merging.
>
Indeed.
Thanks for catching and fixing.
Consequently, could we have the documentation (html only?) generated in the
CI if it is not too time consuming.
WDYT Aaron, Michael?
--
David Marchand
next prev parent reply other threads:[~2019-06-29 16:39 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-27 11:33 [dpdk-dev] [PATCH 0/9] experimental tags fixes David Marchand
2019-06-27 11:33 ` [dpdk-dev] [PATCH 1/9] eal: hide internal hotplug symbol David Marchand
2019-06-28 16:25 ` Stephen Hemminger
2019-06-27 11:33 ` [dpdk-dev] [PATCH 2/9] devargs: remove incorrect experimental tags David Marchand
2019-06-28 16:23 ` Stephen Hemminger
2019-06-27 11:33 ` [dpdk-dev] [PATCH 3/9] vfio: remove incorrect experimental tag David Marchand
2019-06-28 16:24 ` Stephen Hemminger
2019-06-27 11:33 ` [dpdk-dev] [PATCH 4/9] raw/dpaa2_qdma: " David Marchand
2019-06-27 11:33 ` [dpdk-dev] [PATCH 5/9] buildtools: detect discrepancies for experimental symbols David Marchand
2019-06-27 11:33 ` [dpdk-dev] [PATCH 6/9] net/atlantic: add missing experimental api tags David Marchand
2019-06-27 11:33 ` [dpdk-dev] [PATCH 7/9] mem: remove incorrect experimental tag on static symbol David Marchand
2019-06-27 11:33 ` [dpdk-dev] [PATCH 8/9] remove experimental tags from all symbol definitions David Marchand
2019-06-28 15:56 ` Thomas Monjalon
2019-06-28 19:20 ` David Marchand
2019-06-29 5:57 ` David Marchand
2019-06-29 6:19 ` David Marchand
2019-07-01 9:57 ` Laatz, Kevin
2019-06-27 11:33 ` [dpdk-dev] [PATCH 9/9] enforce __rte_experimental at the start of symbol declarations David Marchand
2019-06-27 12:23 ` Adrien Mazarguil
2019-06-27 12:38 ` Gaëtan Rivet
2019-06-28 13:38 ` Thomas Monjalon
2019-06-28 19:58 ` [dpdk-dev] [PATCH 0/9] experimental tags fixes Neil Horman
2019-06-29 11:58 ` [dpdk-dev] [PATCH v2 00/10] " David Marchand
2019-06-29 11:58 ` [dpdk-dev] [PATCH v2 01/10] eal: hide internal hotplug symbol David Marchand
2019-06-29 11:58 ` [dpdk-dev] [PATCH v2 02/10] devargs: remove incorrect experimental tags David Marchand
2019-06-29 11:58 ` [dpdk-dev] [PATCH v2 03/10] vfio: remove incorrect experimental tag David Marchand
2019-06-29 11:58 ` [dpdk-dev] [PATCH v2 04/10] raw/dpaa2_qdma: " David Marchand
2019-06-29 11:58 ` [dpdk-dev] [PATCH v2 05/10] buildtools: detect discrepancies for experimental symbols David Marchand
2019-06-29 11:58 ` [dpdk-dev] [PATCH v2 06/10] net/atlantic: add missing experimental api tags David Marchand
2019-06-29 11:58 ` [dpdk-dev] [PATCH v2 07/10] mem: remove incorrect experimental tag on static symbol David Marchand
2019-06-29 11:58 ` [dpdk-dev] [PATCH v2 08/10] telemetry: add missing header include David Marchand
2019-06-29 11:58 ` [dpdk-dev] [PATCH v2 09/10] remove experimental tags from all symbol definitions David Marchand
2019-06-29 11:58 ` [dpdk-dev] [PATCH v2 10/10] enforce __rte_experimental at the start of symbol declarations David Marchand
2019-06-29 16:13 ` Thomas Monjalon
2019-06-29 16:39 ` David Marchand [this message]
2019-07-01 12:05 ` Aaron Conole
2019-07-01 12:08 ` David Marchand
2019-06-29 17:06 ` [dpdk-dev] [PATCH v2 00/10] experimental tags fixes Thomas Monjalon
2019-07-01 14:15 ` Ferruh Yigit
2019-07-01 14:36 ` David Marchand
2019-07-01 15:30 ` Ferruh Yigit
2019-07-01 19:27 ` David Marchand
2019-07-01 21:12 ` Ferruh Yigit
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='CAJFAV8xwXWr6vL7Sb26-=_rqkxJVR+p1e0WsBSQxCQN0rH_9qA@mail.gmail.com' \
--to=david.marchand@redhat.com \
--cc=aconole@redhat.com \
--cc=adrien.mazarguil@6wind.com \
--cc=dev@dpdk.org \
--cc=msantana@redhat.com \
--cc=nhorman@tuxdriver.com \
--cc=stephen@networkplumber.org \
--cc=thomas@monjalon.net \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).