* [dpdk-dev] [PATCH] ethdev: fix link speed helper documentation
@ 2020-09-29 12:12 David Marchand
2020-09-29 12:17 ` Andrew Rybchenko
0 siblings, 1 reply; 5+ messages in thread
From: David Marchand @ 2020-09-29 12:12 UTC (permalink / raw)
To: dev
Cc: Thomas Monjalon, Ferruh Yigit, Andrew Rybchenko,
Morten Brørup, Ivan Dyukov
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>
---
lib/librte_ethdev/rte_ethdev.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index 645a18664d..9759f13303 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -2452,7 +2452,7 @@ int rte_eth_link_get_nowait(uint16_t port_id, struct rte_eth_link *link);
* No free is required.
*/
__rte_experimental
-const char *rte_eth_link_speed_to_str(uint32_t speed_link);
+const char *rte_eth_link_speed_to_str(uint32_t link_speed);
/**
* @warning
--
2.23.0
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [dpdk-dev] [PATCH] ethdev: fix link speed helper documentation
2020-09-29 12:12 [dpdk-dev] [PATCH] ethdev: fix link speed helper documentation David Marchand
@ 2020-09-29 12:17 ` Andrew Rybchenko
2020-09-29 12:52 ` Thomas Monjalon
2020-09-29 16:08 ` Ferruh Yigit
0 siblings, 2 replies; 5+ messages in thread
From: Andrew Rybchenko @ 2020-09-29 12:17 UTC (permalink / raw)
To: David Marchand, dev
Cc: Thomas Monjalon, Ferruh Yigit, Morten Brørup, Ivan Dyukov
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>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [dpdk-dev] [PATCH] ethdev: fix link speed helper documentation
2020-09-29 12:17 ` Andrew Rybchenko
@ 2020-09-29 12:52 ` Thomas Monjalon
2020-09-29 15:45 ` Bruce Richardson
2020-09-29 16:08 ` Ferruh Yigit
1 sibling, 1 reply; 5+ messages in thread
From: Thomas Monjalon @ 2020-09-29 12:52 UTC (permalink / raw)
To: David Marchand, Andrew Rybchenko
Cc: dev, Ferruh Yigit, Morten Brørup, Ivan Dyukov, bruce.richardson
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.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [dpdk-dev] [PATCH] ethdev: fix link speed helper documentation
2020-09-29 12:52 ` Thomas Monjalon
@ 2020-09-29 15:45 ` Bruce Richardson
0 siblings, 0 replies; 5+ messages in thread
From: Bruce Richardson @ 2020-09-29 15:45 UTC (permalink / raw)
To: Thomas Monjalon
Cc: David Marchand, Andrew Rybchenko, dev, Ferruh Yigit,
Morten Brørup, Ivan Dyukov
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
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [dpdk-dev] [PATCH] ethdev: fix link speed helper documentation
2020-09-29 12:17 ` Andrew Rybchenko
2020-09-29 12:52 ` Thomas Monjalon
@ 2020-09-29 16:08 ` Ferruh Yigit
1 sibling, 0 replies; 5+ messages in thread
From: Ferruh Yigit @ 2020-09-29 16:08 UTC (permalink / raw)
To: Andrew Rybchenko, David Marchand, dev
Cc: Thomas Monjalon, Morten Brørup, Ivan Dyukov
On 9/29/2020 1:17 PM, Andrew Rybchenko wrote:
> 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>
>
Thanks for catching this.
Applied to dpdk-next-net/main, thanks.
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2020-09-29 16:08 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-09-29 12:12 [dpdk-dev] [PATCH] ethdev: fix link speed helper documentation David Marchand
2020-09-29 12:17 ` Andrew Rybchenko
2020-09-29 12:52 ` Thomas Monjalon
2020-09-29 15:45 ` Bruce Richardson
2020-09-29 16:08 ` Ferruh Yigit
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).