Return value of function mlx5_rxq_releasable() was not described
correctly in function description.
This patch updates the description to correctly describe the optional
return values.
Fixes: a6d83b6a9209 ("net/mlx5: standardize on negative errno values")
cc: sta...@dpdk.org
Signed-off-by: Dekel Peled <dek...@mellanox.com>
---
drivers/net/mlx5/mlx5_rxq.c | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/drivers/net/mlx5/mlx5_rxq.c b/drivers/net/mlx5/mlx5_rxq.c
index d4b94b5..ffca777 100644
--- a/drivers/net/mlx5/mlx5_rxq.c
+++ b/drivers/net/mlx5/mlx5_rxq.c
@@ -1531,8 +1531,9 @@ struct mlx5_rxq_ctrl *
* RX queue index.
*
* @return
- * 1 if the queue can be released, negative errno otherwise and rte_errno is
- * set.
+ * 1 if the queue can be released
+ * 0 if the queue can not be released, there are references to it.
+ * Negative errno and rte_errno is set if queue doesn't exist.
*/
int
mlx5_rxq_releasable(struct rte_eth_dev *dev, uint16_t idx)
--
1.8.3.1
