patch 'ring: fix zero-copy burst API documentation' has been queued to stable release 24.11.7

[luca.boccassi at gmail.com]

Hi,

FYI, your patch has been queued to stable release 24.11.7

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 06/13/26. 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/73afe47fb42b8b6d226fef269dde24e10acd1d81

Thanks.

Luca Boccassi

---
>From 73afe47fb42b8b6d226fef269dde24e10acd1d81 Mon Sep 17 00:00:00 2001
From: Zhiguang Jin <jinzhiguang at kylinos.cn>
Date: Thu, 21 May 2026 11:00:09 +0800
Subject: [PATCH] ring: fix zero-copy burst API documentation

[ upstream commit 800fe583fc1df534f8a0b46510a8a5af134102fe ]

These are burst API functions relying on RTE_RING_QUEUE_VARIABLE
behavior, they operate on a best-effort basis
and return the actual number of objects processed (between 0 and n).

Update description to match implementation.

Fixes: 47bec9a5ca9f ("ring: add zero copy API")

Signed-off-by: Zhiguang Jin <jinzhiguang at kylinos.cn>
Acked-by: Konstantin Ananyev <konstantin.ananyev at huawei.com>
---
 .mailmap                    | 1 +
 lib/ring/rte_ring_peek_zc.h | 8 ++++----
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/.mailmap b/.mailmap
index b78feeb110..9824d79d20 100644
--- a/.mailmap
+++ b/.mailmap
@@ -1862,6 +1862,7 @@ Zhichao Zeng <zhichaox.zeng at intel.com>
 Zhigang Hu <zhigang.hu at intel.com>
 Zhigang Lu <zlu at ezchip.com>
 Zhiguang He <hezhiguang3 at huawei.com>
+Zhiguang Jin <jinzhiguang at kylinos.cn>
 Zhihong Peng <zhihongx.peng at intel.com>
 Zhihong Wang <wangzhihong.wzh at bytedance.com> <zhihong.wang at intel.com>
 Zhike Wang <wangzhike at jd.com> <wangzk320 at 163.com>
diff --git a/lib/ring/rte_ring_peek_zc.h b/lib/ring/rte_ring_peek_zc.h
index 3254fe0481..43d6a53075 100644
--- a/lib/ring/rte_ring_peek_zc.h
+++ b/lib/ring/rte_ring_peek_zc.h
@@ -235,7 +235,7 @@ rte_ring_enqueue_zc_bulk_start(struct rte_ring *r, unsigned int n,
  *   If non-NULL, returns the amount of space in the ring after the
  *   reservation operation has finished.
  * @return
- *   The number of objects that can be enqueued, either 0 or n
+ *   The actual number of objects that can be enqueued.
  */
 static __rte_always_inline unsigned int
 rte_ring_enqueue_zc_burst_elem_start(struct rte_ring *r, unsigned int esize,
@@ -265,7 +265,7 @@ rte_ring_enqueue_zc_burst_elem_start(struct rte_ring *r, unsigned int esize,
  *   If non-NULL, returns the amount of space in the ring after the
  *   reservation operation has finished.
  * @return
- *   The number of objects that can be enqueued, either 0 or n.
+ *   The actual number of objects that can be enqueued.
  */
 static __rte_always_inline unsigned int
 rte_ring_enqueue_zc_burst_start(struct rte_ring *r, unsigned int n,
@@ -442,7 +442,7 @@ rte_ring_dequeue_zc_bulk_start(struct rte_ring *r, unsigned int n,
  *   If non-NULL, returns the number of remaining ring entries after the
  *   dequeue has finished.
  * @return
- *   The number of objects that can be dequeued, either 0 or n.
+ *   The actual number of objects that can be dequeued.
  */
 static __rte_always_inline unsigned int
 rte_ring_dequeue_zc_burst_elem_start(struct rte_ring *r, unsigned int esize,
@@ -471,7 +471,7 @@ rte_ring_dequeue_zc_burst_elem_start(struct rte_ring *r, unsigned int esize,
  *   If non-NULL, returns the number of remaining ring entries after the
  *   dequeue has finished.
  * @return
- *   The number of objects that can be dequeued, either 0 or n.
+ *   The actual number of objects that can be dequeued.
  */
 static __rte_always_inline unsigned int
 rte_ring_dequeue_zc_burst_start(struct rte_ring *r, unsigned int n,
-- 
2.47.3

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2026-06-11 14:20:03.902604248 +0100
+++ 0065-ring-fix-zero-copy-burst-API-documentation.patch	2026-06-11 14:20:01.278747537 +0100
@@ -1 +1 @@
-From 800fe583fc1df534f8a0b46510a8a5af134102fe Mon Sep 17 00:00:00 2001
+From 73afe47fb42b8b6d226fef269dde24e10acd1d81 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 800fe583fc1df534f8a0b46510a8a5af134102fe ]
+
@@ -13 +14,0 @@
-Cc: stable at dpdk.org
@@ -23 +24 @@
-index 43febb9030..d25925bad5 100644
+index b78feeb110..9824d79d20 100644
@@ -26 +27 @@
-@@ -1946,6 +1946,7 @@ Zhichao Zeng <zhichaox.zeng at intel.com>
+@@ -1862,6 +1862,7 @@ Zhichao Zeng <zhichaox.zeng at intel.com>