[v4,3/4] net/mlx5: fix description of function return value
diff mbox series

Message ID dec422f0804032c9ae227f81bf6d292d4dab8ef7.1557303531.git.dekelp@mellanox.com
State Accepted, archived
Delegated to: Shahaf Shuler
Headers show
  • net/mlx5: code cleanup in rx and tx files
Related show


Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Dekel Peled May 8, 2019, 8:29 a.m. UTC
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: stable@dpdk.org

Signed-off-by: Dekel Peled <dekelp@mellanox.com>
Acked-by: Shahaf Shuler <shahafs@mellanox.com>
Acked-by: Yongseok Koh <yskoh@mellanox.com>
 drivers/net/mlx5/mlx5_rxq.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff mbox series

diff --git a/drivers/net/mlx5/mlx5_rxq.c b/drivers/net/mlx5/mlx5_rxq.c
index f595e7a..f10e896 100644
--- a/drivers/net/mlx5/mlx5_rxq.c
+++ b/drivers/net/mlx5/mlx5_rxq.c
@@ -1527,8 +1527,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.
 mlx5_rxq_releasable(struct rte_eth_dev *dev, uint16_t idx)