Re: [dpdk-dev] [PATCH v2 3/4] net/mlx5: fix description of function return value

[Yongseok Koh <yskoh@mellanox.com>]

> On May 2, 2019, at 8:01 AM, Dekel Peled <dekelp@mellanox.com> wrote:
> 
> 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: Yongseok Koh <yskoh@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 c9c2a14..a547f2a 100644
> --- a/drivers/net/mlx5/mlx5_rxq.c
> +++ b/drivers/net/mlx5/mlx5_rxq.c
> @@ -1546,8 +1546,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
>