[dpdk-dev] [PATCH] ethdev: fix link speed helper documentation

[Bruce Richardson]

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 at redhat.com>
> > 
> > Acked-by: Andrew Rybchenko <arybchenko at 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