Hi, David, Konstantin and Honnappa
> -----邮件原件-----
> 发件人: David Marchand <david.march...@redhat.com>
> 发送时间: 2020年7月30日 0:00
> 收件人: Feifei Wang <feifei.wa...@arm.com>; Ananyev, Konstantin
> <konstantin.anan...@intel.com>; Honnappa Nagarahalli
> <honnappa.nagaraha...@arm.com>; Olivier Matz <olivier.m...@6wind.com>
> 抄送: dev <dev@dpdk.org>; nd <n...@arm.com>; dpdk stable
> <sta...@dpdk.org>; tho...@monjalon.net
> 主题: Re: [dpdk-dev] [PATCH v1 1/2] ring: fix the misdescription of the param
>
> On Wed, Jul 29, 2020 at 8:31 AM Feifei Wang <feifei.wa...@arm.com>
> wrote:
> >
> > When enqueue one element to the ring, the param "obj" should be the
> > object to be added into the ring. The object is of type void*.
>
> I understand void * as a pointer to an object you don't know the type of.
> I would keep the current description.
>
Sorry for my commit message cannot express my view clearly.
Following is my supplementary explanation of this:
First, the APIs to be changed are:
1. rte_ring_mp_enqueue
2. rte_ring_sp_enqueue
3. rte_ring_enqueue
Second, Let's use an example to explain this:
1. We call API in form: rte_ring_enqueue(r, obj).
2. Current function header indicates that we will have ring[idx] = *obj.
3. However, this is not the case, what we eventually have is: ring[idx] = obj.
So I think the current function header is misleading or
maybe the implementation of above three functions need to be changed.
> Honnappa, Konstantin, Olivier ?
>
> >
> > Fixes: af75078fece3 ("first public release")
> > Cc: sta...@dpdk.org
> >
> > Signed-off-by: Feifei Wang <feifei.wa...@arm.com>
> > Reviewed-by: Ruifeng Wang <ruifeng.w...@arm.com>
> > ---
> > lib/librte_ring/rte_ring.h | 6 +++---
> > 1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/lib/librte_ring/rte_ring.h b/lib/librte_ring/rte_ring.h
> > index da17ed6d7..418536b61 100644
> > --- a/lib/librte_ring/rte_ring.h
> > +++ b/lib/librte_ring/rte_ring.h
> > @@ -276,7 +276,7 @@ rte_ring_enqueue_bulk(struct rte_ring *r, void *
> const *obj_table,
> > * @param r
> > * A pointer to the ring structure.
> > * @param obj
> > - * A pointer to the object to be added.
> > + * A pointer (object) to be added.
>
>
> --
> David Marchand
