ethdev: fix link speed helper documentation
PATCH 1/1 ethdev: fix link speed helper documentation
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.
--- lib/librte_ethdev/rte_ethdev.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
lib/librte_ethdev/rte_ethdev.h +1 -1
@@ -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
Signature · 1 line
2.23.0
Quoted 9 lines · David Marchand
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 ofrte_eth_link_speed_to_str(uint32_t speed_link).../dpdk/lib/librte_ethdev/rte_ethdev.h:2455: warning: The following
parameters ofrte_eth_link_speed_to_str(uint32_t speed_link)are not
documented: parameter 'speed_link'
Quoted 5 lines
Align the function prototype to its doxygen description.
Fixes fbf931c9c392 ("ethdev: format link status text")Signed-off-by David Marchand <[email protected]>
29/09/2020 14:17, Andrew Rybchenko:
Quoted 10 lines · David Marchand
Quoted 9 lines
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 ofrte_eth_link_speed_to_str(uint32_t speed_link).../dpdk/lib/librte_ethdev/rte_ethdev.h:2455: warning: The following
parameters ofrte_eth_link_speed_to_str(uint32_t speed_link)are not
documented: parameter 'speed_link'
Quoted 7 lines
Quoted 5 lines
Align the function prototype to its doxygen description.
Fixes fbf931c9c392 ("ethdev: format link status text")Signed-off-by David Marchand <[email protected]>Acked-by Andrew Rybchenko <[email protected]>
More errors of the same kind will happen because doxygen warnings are sent to stdout by meson, so are hard to catch.
Quoted 13 lines · Thomas Monjalon
29/09/2020 14:17, Andrew Rybchenko:
Quoted 12 lines · David Marchand
Quoted 11 lines
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 ofrte_eth_link_speed_to_str(uint32_t speed_link).../dpdk/lib/librte_ethdev/rte_ethdev.h:2455: warning: The following
parameters ofrte_eth_link_speed_to_str(uint32_t speed_link)are not
documented: parameter 'speed_link'Align the function prototype to its doxygen description.
Quoted 9 lines
Quoted 5 lines
Quoted 3 lines
Fixes fbf931c9c392 ("ethdev: format link status text")Signed-off-by David Marchand <[email protected]>Acked-by Andrew Rybchenko <[email protected]>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
AppliedQuoted 10 lines · Andrew Rybchenko
Quoted 9 lines · David Marchand
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 ofrte_eth_link_speed_to_str(uint32_t speed_link).../dpdk/lib/librte_ethdev/rte_ethdev.h:2455: warning: The following
parameters ofrte_eth_link_speed_to_str(uint32_t speed_link)are not
documented: parameter 'speed_link'
Quoted 8 lines
Quoted 5 lines
Align the function prototype to its doxygen description.
Fixes fbf931c9c392 ("ethdev: format link status text")Signed-off-by David Marchand <[email protected]>Acked-by Andrew Rybchenko <[email protected]>
Thanks for catching this.
Applied to dpdk-next-net/main, thanks.