patch 'mempool: clarify enqueue/dequeue ops documentation' has been queued to stable release 20.11.10

[luca.boccassi at gmail.com]

Hi,

FYI, your patch has been queued to stable release 20.11.10

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/01/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/bluca/dpdk-stable

This queued commit can be viewed at:
https://github.com/bluca/dpdk-stable/commit/a8853f9d34f297849fdbda5f3443844f0c6ce4ad

Thanks.

Luca Boccassi

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

[ upstream commit 37fc1db98c082d3f423c46bed7357a158abe53e9 ]

API documentations doesn't clarify expected return types for enqueue and
dequeue mempool_ops, clarifying it.

Fixes: 449c49b93a6b ("mempool: support handler operations")

Reported-by: Morten Brørup <mb at smartsharesystems.com>
Signed-off-by: Ferruh Yigit <ferruh.yigit at amd.com>
Reviewed-by: Morten Brørup <mb at smartsharesystems.com>
---
 lib/librte_mempool/rte_mempool.h | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/lib/librte_mempool/rte_mempool.h b/lib/librte_mempool/rte_mempool.h
index 10c023b93f..0f5cd4b072 100644
--- a/lib/librte_mempool/rte_mempool.h
+++ b/lib/librte_mempool/rte_mempool.h
@@ -404,13 +404,19 @@ typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
 
 /**
- * Enqueue an object into the external pool.
+ * Enqueue 'n' objects into the external pool.
+ * @return
+ *   - 0: Success
+ *   - <0: Error
  */
 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
 		void * const *obj_table, unsigned int n);
 
 /**
- * Dequeue an object from the external pool.
+ * Dequeue 'n' objects from the external pool.
+ * @return
+ *   - 0: Success
+ *   - <0: Error
  */
 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
 		void **obj_table, unsigned int n);
-- 
2.39.2

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2023-11-29 02:31:25.009384448 +0000
+++ 0005-mempool-clarify-enqueue-dequeue-ops-documentation.patch	2023-11-29 02:31:24.793770882 +0000
@@ -1 +1 @@
-From 37fc1db98c082d3f423c46bed7357a158abe53e9 Mon Sep 17 00:00:00 2001
+From a8853f9d34f297849fdbda5f3443844f0c6ce4ad Mon Sep 17 00:00:00 2001
@@ -8,0 +9,2 @@
+[ upstream commit 37fc1db98c082d3f423c46bed7357a158abe53e9 ]
+
@@ -13 +14,0 @@
-Cc: stable at dpdk.org
@@ -19 +20 @@
- lib/mempool/rte_mempool.h | 10 ++++++++--
+ lib/librte_mempool/rte_mempool.h | 10 ++++++++--
@@ -22,5 +23,5 @@
-diff --git a/lib/mempool/rte_mempool.h b/lib/mempool/rte_mempool.h
-index 1303eef494..95deade160 100644
---- a/lib/mempool/rte_mempool.h
-+++ b/lib/mempool/rte_mempool.h
-@@ -465,13 +465,19 @@ typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
+diff --git a/lib/librte_mempool/rte_mempool.h b/lib/librte_mempool/rte_mempool.h
+index 10c023b93f..0f5cd4b072 100644
+--- a/lib/librte_mempool/rte_mempool.h
++++ b/lib/librte_mempool/rte_mempool.h
+@@ -404,13 +404,19 @@ typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);