> These are burst APIs 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: jinzhiguang <[email protected]>
> ---
> Cc: [email protected]
> Cc: [email protected]
> ---
> .mailmap | 1 +
> lib/ring/rte_ring_peek_zc.h | 8 ++++----
> 2 files changed, 5 insertions(+), 4 deletions(-)
>
> diff --git a/.mailmap b/.mailmap
> index 4d26d9c286..a4f91f2131 100644
> --- a/.mailmap
> +++ b/.mailmap
> @@ -756,6 +756,7 @@ Jing Chen <[email protected]>
> Jingguo Fu <[email protected]>
> Jingjing Wu <[email protected]>
> Jingzhao Ni <[email protected]>
> +jinzhiguang <[email protected]>
> Jiri Slaby <[email protected]>
> Job Abraham <[email protected]>
> Jochen Behrens <[email protected]> <[email protected]>
> diff --git a/lib/ring/rte_ring_peek_zc.h b/lib/ring/rte_ring_peek_zc.h
> index 3254fe0481..fa566e8e0d 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
> + * Actual number of objects enqueued.
Here and in other places, probably better:
The actual number of objects that can be enqueued.
Acked-by: Konstantin Ananyev <[email protected]>
> */
> 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.
> + * Actual number of objects 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.
> + * Actual number of objects 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.
> + * Actual number of objects dequeued.
> */
> static __rte_always_inline unsigned int
> rte_ring_dequeue_zc_burst_start(struct rte_ring *r, unsigned int n,
> --
> 2.53.0
