From dc3cdcd69dd66e2e9328fc5bbc6e187c71b4f6a8 Mon Sep 17 00:00:00 2001 From: David Marchand Date: Tue, 29 Sep 2020 14:12:22 +0200 Subject: [PATCH] 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. Fixes: fbf931c9c392 ("ethdev: format link status text") Signed-off-by: David Marchand Acked-by: Andrew Rybchenko --- 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.20.1