From: Bruce Richardson <bruce.richardson@intel.com>
To: Thomas Monjalon <thomas@monjalon.net>
Cc: "David Marchand" <david.marchand@redhat.com>,
"Andrew Rybchenko" <arybchenko@solarflare.com>,
dev@dpdk.org, "Ferruh Yigit" <ferruh.yigit@intel.com>,
"Morten Brørup" <mb@smartsharesystems.com>,
"Ivan Dyukov" <i.dyukov@samsung.com>
Subject: Re: [dpdk-dev] [PATCH] ethdev: fix link speed helper documentation
Date: Tue, 29 Sep 2020 16:45:27 +0100 [thread overview]
Message-ID: <20200929154527.GA966@bricha3-MOBL.ger.corp.intel.com> (raw)
In-Reply-To: <3091094.eTDPxqWGOJ@thomas>
On Tue, Sep 29, 2020 at 02:52:34PM +0200, Thomas Monjalon wrote:
> 29/09/2020 14:17, Andrew Rybchenko:
> > On 9/29/20 3:12 PM, David Marchand wrote:
> > > When generating the documentation, a new warning can be seen:
> > >
> > > .../dpdk/lib/librte_ethdev/rte_ethdev.h:2441:
> > > warning: argument 'link_speed' of command @param is not found in the
> > > argument list of rte_eth_link_speed_to_str(uint32_t speed_link)
> > > .../dpdk/lib/librte_ethdev/rte_ethdev.h:2455: warning: The following
> > > parameters of rte_eth_link_speed_to_str(uint32_t speed_link) are not
> > > documented: parameter 'speed_link'
> > >
> > > Align the function prototype to its doxygen description.
> > >
> > > Fixes: fbf931c9c392 ("ethdev: format link status text")
> > >
> > > Signed-off-by: David Marchand <david.marchand@redhat.com>
> >
> > Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
>
> More errors of the same kind will happen because doxygen warnings
> are sent to stdout by meson, so are hard to catch.
>
Technically that's "ninja" behaviour by default rather than meson - just to
ensure we blame the right tool! :-)
I've sent patchset http://patches.dpdk.org/project/dpdk/list/?series=12595
to try and improve this situation.
Regards,
/Bruce
next prev parent reply other threads:[~2020-09-29 15:45 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-29 12:12 David Marchand
2020-09-29 12:17 ` Andrew Rybchenko
2020-09-29 12:52 ` Thomas Monjalon
2020-09-29 15:45 ` Bruce Richardson [this message]
2020-09-29 16:08 ` 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=20200929154527.GA966@bricha3-MOBL.ger.corp.intel.com \
--to=bruce.richardson@intel.com \
--cc=arybchenko@solarflare.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=i.dyukov@samsung.com \
--cc=mb@smartsharesystems.com \
--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).