diff mbox series

ethdev: fix link speed helper documentation

Message ID 20200929121222.12954-1-david.marchand@redhat.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series ethdev: fix link speed helper documentation |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-intel-Performance success Performance Testing PASS
ci/travis-robot success Travis build: passed
ci/iol-mellanox-Performance success Performance Testing PASS

Commit Message

David Marchand Sept. 29, 2020, 12:12 p.m. UTC 
  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(-)

Comments

Andrew Rybchenko Sept. 29, 2020, 12:17 p.m. UTC | #1 
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>
Thomas Monjalon Sept. 29, 2020, 12:52 p.m. UTC | #2 
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.
Bruce Richardson Sept. 29, 2020, 3:45 p.m. UTC | #3 
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
Ferruh Yigit Sept. 29, 2020, 4:08 p.m. UTC | #4 
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.
diff mbox series

Patch

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