patch 'mempool: fix get function documentation' has been queued to stable release 21.11.6

[Kevin Traynor]

Hi,

FYI, your patch has been queued to stable release 21.11.6

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 12/12/23. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable/commit/1699794ad5d64e9fecce4b6d022f2446209b58da

Thanks.

Kevin

---
>From 1699794ad5d64e9fecce4b6d022f2446209b58da Mon Sep 17 00:00:00 2001
From: Ferruh Yigit <ferruh.yigit at amd.com>
Date: Mon, 23 Oct 2023 10:38:42 +0100
Subject: [PATCH] mempool: fix get function documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

[ upstream commit 9b3233ab09ea331dcf5fb38d215d91818bef3b47 ]

static function `rte_mempool_do_generic_get()` returns zero on success,
not >=0 as its function comment documents.

Since this function called by public API, the comment causes confusion
on the public API return value.

Fixing the internal function documentation for return value.

Fixes: af75078fece3 ("first public release")

Reported-by: Mahesh Adulla <mahesh.adulla at amd.com>
Signed-off-by: Ferruh Yigit <ferruh.yigit at amd.com>
Reviewed-by: Morten Brørup <mb at smartsharesystems.com>
Acked-by: Huisong Li <lihuisong at huawei.com>
---
 .mailmap                  | 1 +
 lib/mempool/rte_mempool.h | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/.mailmap b/.mailmap
index 3b6d7a0069..fe94cbe1ff 100644
--- a/.mailmap
+++ b/.mailmap
@@ -808,4 +808,5 @@ Maciej Rabeda <maciej.rabeda at intel.com>
 Maciej Szwed <maciej.szwed at intel.com>
 Madhuker Mythri <madhuker.mythri at oracle.com>
+Mahesh Adulla <mahesh.adulla at amd.com>
 Mahipal Challa <mchalla at marvell.com>
 Mah Yock Gen <yock.gen.mah at intel.com>
diff --git a/lib/mempool/rte_mempool.h b/lib/mempool/rte_mempool.h
index 2b2a9dc20d..771a3a1e7f 100644
--- a/lib/mempool/rte_mempool.h
+++ b/lib/mempool/rte_mempool.h
@@ -1452,5 +1452,5 @@ rte_mempool_put(struct rte_mempool *mp, void *obj)
  *   A pointer to a mempool cache structure. May be NULL if not needed.
  * @return
- *   - >=0: Success; number of objects supplied.
+ *   - 0: Success.
  *   - <0: Error; code of ring dequeue function.
  */
-- 
2.43.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2023-12-07 11:18:59.987625216 +0000
+++ 0016-mempool-fix-get-function-documentation.patch	2023-12-07 11:18:59.636873958 +0000
@@ -1 +1 @@
-From 9b3233ab09ea331dcf5fb38d215d91818bef3b47 Mon Sep 17 00:00:00 2001
+From 1699794ad5d64e9fecce4b6d022f2446209b58da Mon Sep 17 00:00:00 2001
@@ -8,0 +9,2 @@
+[ upstream commit 9b3233ab09ea331dcf5fb38d215d91818bef3b47 ]
+
@@ -18 +19,0 @@
-Cc: stable at dpdk.org
@@ -30 +31 @@
-index 49d3616c4c..3630e72f41 100644
+index 3b6d7a0069..fe94cbe1ff 100644
@@ -33,2 +34,2 @@
-@@ -840,4 +840,5 @@ Maciej Szwed <maciej.szwed at intel.com>
- Madhu Chittim <madhu.chittim at intel.com>
+@@ -808,4 +808,5 @@ Maciej Rabeda <maciej.rabeda at intel.com>
+ Maciej Szwed <maciej.szwed at intel.com>
@@ -40 +41 @@
-index df87cd231e..1303eef494 100644
+index 2b2a9dc20d..771a3a1e7f 100644
@@ -43 +44 @@
-@@ -1485,5 +1485,5 @@ rte_mempool_put(struct rte_mempool *mp, void *obj)
+@@ -1452,5 +1452,5 @@ rte_mempool_put(struct rte_mempool *mp, void *obj)
@@ -48 +49 @@
-  *   - <0: Error; code of driver dequeue function.
+  *   - <0: Error; code of ring dequeue function.