From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dekelp@mellanox.com>
Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129])
 by dpdk.org (Postfix) with ESMTP id 3F18132A5
 for <dev@dpdk.org>; Sun,  5 May 2019 15:12:08 +0200 (CEST)
Received: from Internal Mail-Server by MTLPINE2 (envelope-from
 dekelp@mellanox.com)
 with ESMTPS (AES256-SHA encrypted); 5 May 2019 16:12:05 +0300
Received: from mtl-vdi-280.wap.labs.mlnx. (mtl-vdi-280.wap.labs.mlnx
 [10.128.130.87])
 by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id x45DC2s3011781;
 Sun, 5 May 2019 16:12:04 +0300
From: Dekel Peled <dekelp@mellanox.com>
To: yskoh@mellanox.com, shahafs@mellanox.com
Cc: dev@dpdk.org, stable@dpdk.org
Date: Sun,  5 May 2019 16:09:17 +0300
Message-Id: <218fbdf7656dec5f3d4b82de2f922113fc4b0eb4.1557061532.git.dekelp@mellanox.com>
X-Mailer: git-send-email 1.7.1
In-Reply-To: <cover.1557061532.git.dekelp@mellanox.com>
References: <cover.1556809050.git.dekelp@mellanox.com>
 <cover.1557061532.git.dekelp@mellanox.com>
Subject: [dpdk-dev] [PATCH v3 3/4] net/mlx5: fix description of function
	return value
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Sun, 05 May 2019 13:12:08 -0000

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 0054096..a22ed91 100644
--- a/drivers/net/mlx5/mlx5_rxq.c
+++ b/drivers/net/mlx5/mlx5_rxq.c
@@ -1526,8 +1526,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

From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
	by dpdk.space (Postfix) with ESMTP id 1A609A0096
	for <public@inbox.dpdk.org>; Sun,  5 May 2019 15:12:30 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
	by dpdk.org (Postfix) with ESMTP id 7B4D63977;
	Sun,  5 May 2019 15:12:14 +0200 (CEST)
Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129])
 by dpdk.org (Postfix) with ESMTP id 3F18132A5
 for <dev@dpdk.org>; Sun,  5 May 2019 15:12:08 +0200 (CEST)
Received: from Internal Mail-Server by MTLPINE2 (envelope-from
 dekelp@mellanox.com)
 with ESMTPS (AES256-SHA encrypted); 5 May 2019 16:12:05 +0300
Received: from mtl-vdi-280.wap.labs.mlnx. (mtl-vdi-280.wap.labs.mlnx
 [10.128.130.87])
 by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id x45DC2s3011781;
 Sun, 5 May 2019 16:12:04 +0300
From: Dekel Peled <dekelp@mellanox.com>
To: yskoh@mellanox.com, shahafs@mellanox.com
Cc: dev@dpdk.org, stable@dpdk.org
Date: Sun,  5 May 2019 16:09:17 +0300
Message-Id:
 <218fbdf7656dec5f3d4b82de2f922113fc4b0eb4.1557061532.git.dekelp@mellanox.com>
X-Mailer: git-send-email 1.7.1
In-Reply-To: <cover.1557061532.git.dekelp@mellanox.com>
References: <cover.1556809050.git.dekelp@mellanox.com>
 <cover.1557061532.git.dekelp@mellanox.com>
Subject: [dpdk-dev] [PATCH v3 3/4] net/mlx5: fix description of function
	return value
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>
Content-Type: text/plain; charset="UTF-8"
Message-ID: <20190505130917.yobjGkL3ptfAgHuTcUbfvANr75vUaTNEMCLjfE82q50@z>

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 0054096..a22ed91 100644
--- a/drivers/net/mlx5/mlx5_rxq.c
+++ b/drivers/net/mlx5/mlx5_rxq.c
@@ -1526,8 +1526,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