patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Dekel Peled <dekelp@mellanox.com>
To: yskoh@mellanox.com, shahafs@mellanox.com
Cc: dev@dpdk.org, stable@dpdk.org
Subject: [dpdk-stable] [PATCH v4 3/4] net/mlx5: fix description of function return value
Date: Wed,  8 May 2019 11:29:40 +0300	[thread overview]
Message-ID: <dec422f0804032c9ae227f81bf6d292d4dab8ef7.1557303531.git.dekelp@mellanox.com> (raw)
In-Reply-To: <cover.1557303531.git.dekelp@mellanox.com>

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 --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.
  */
 int
 mlx5_rxq_releasable(struct rte_eth_dev *dev, uint16_t idx)
-- 
1.8.3.1


      parent reply	other threads:[~2019-05-08  8:36 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <cover.1556534247.git.dekelp@mellanox.com>
2019-04-29 11:00 ` [dpdk-stable] [PATCH " Dekel Peled
     [not found] ` <cover.1556809050.git.dekelp@mellanox.com>
2019-05-02 15:01   ` [dpdk-stable] [PATCH v2 2/4] net/mlx5: fix missing validation of null pointer Dekel Peled
2019-05-02 18:12     ` Yongseok Koh
2019-05-02 15:01   ` [dpdk-stable] [PATCH v2 3/4] net/mlx5: fix description of function return value Dekel Peled
2019-05-02 18:13     ` Yongseok Koh
     [not found]   ` <cover.1557061532.git.dekelp@mellanox.com>
2019-05-05 13:09     ` [dpdk-stable] [PATCH v3 2/4] net/mlx5: fix missing validation of null pointer Dekel Peled
2019-05-05 13:09     ` [dpdk-stable] [PATCH v3 3/4] net/mlx5: fix description of function return value Dekel Peled
     [not found]     ` <cover.1557303531.git.dekelp@mellanox.com>
2019-05-08  8:29       ` [dpdk-stable] [PATCH v4 2/4] net/mlx5: fix missing validation of null pointer Dekel Peled
2019-05-08  8:29       ` Dekel Peled [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=dec422f0804032c9ae227f81bf6d292d4dab8ef7.1557303531.git.dekelp@mellanox.com \
    --to=dekelp@mellanox.com \
    --cc=dev@dpdk.org \
    --cc=shahafs@mellanox.com \
    --cc=stable@dpdk.org \
    --cc=yskoh@mellanox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).