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

[Kevin Traynor]

Hi,

FYI, your patch has been queued to stable release 25.11.3

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

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

Thanks.

Kevin

---
>From 58e65cbda0702988396de52ed960435d2c26e53e 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 5533a5b8a1..974e93d4f3 100644
--- a/.mailmap
+++ b/.mailmap
@@ -1932,4 +1932,5 @@ 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>
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
@@ -236,5 +236,5 @@ rte_ring_enqueue_zc_bulk_start(struct rte_ring *r, unsigned int n,
  *   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
@@ -266,5 +266,5 @@ rte_ring_enqueue_zc_burst_elem_start(struct rte_ring *r, unsigned int esize,
  *   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
@@ -443,5 +443,5 @@ rte_ring_dequeue_zc_bulk_start(struct rte_ring *r, unsigned int n,
  *   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
@@ -472,5 +472,5 @@ rte_ring_dequeue_zc_burst_elem_start(struct rte_ring *r, unsigned int esize,
  *   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
-- 
2.55.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2026-07-23 17:58:00.699340032 +0100
+++ 0071-ring-fix-zero-copy-burst-API-documentation.patch	2026-07-23 17:57:58.688218406 +0100
@@ -1 +1 @@
-From 800fe583fc1df534f8a0b46510a8a5af134102fe Mon Sep 17 00:00:00 2001
+From 58e65cbda0702988396de52ed960435d2c26e53e 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 5533a5b8a1..974e93d4f3 100644
@@ -26 +27 @@
-@@ -1947,4 +1947,5 @@ Zhigang Hu <zhigang.hu at intel.com>
+@@ -1932,4 +1932,5 @@ Zhigang Hu <zhigang.hu at intel.com>