From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 2863CA052B;
	Wed, 29 Jul 2020 17:59:47 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
	by dpdk.org (Postfix) with ESMTP id 04BC14C98;
	Wed, 29 Jul 2020 17:59:47 +0200 (CEST)
Received: from us-smtp-delivery-1.mimecast.com (us-smtp-1.mimecast.com
 [205.139.110.61]) by dpdk.org (Postfix) with ESMTP id 1FD993B5
 for <dev@dpdk.org>; Wed, 29 Jul 2020 17:59:45 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;
 s=mimecast20190719; t=1596038384;
 h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
 to:to:cc:cc:mime-version:mime-version:content-type:content-type:
 in-reply-to:in-reply-to:references:references;
 bh=/AqU+vxPlKwxcjXjrStKn1Jx+uPVtMR9G+VnFGTAE2M=;
 b=i48gs5nNfYWAgZJa2VpwGdDpxLl/bkfwwFS40K94VtToTUIRUNVeWLIiCypSPFFtmph5RO
 T5HnJcTj4ODbrkveIMiDY7+bLmLymLKF4aIsbWtUHzkXsVw/8VPZ/aMBF3Mp2eCOa8dt4H
 d1Bk3B4E9l61AjfDapHiG12YwTwu/6c=
Received: from mail-ua1-f72.google.com (mail-ua1-f72.google.com
 [209.85.222.72]) (Using TLS) by relay.mimecast.com with ESMTP id
 us-mta-326-JCWIt0OfO3u08aW10K8uFg-1; Wed, 29 Jul 2020 11:59:42 -0400
X-MC-Unique: JCWIt0OfO3u08aW10K8uFg-1
Received: by mail-ua1-f72.google.com with SMTP id c13so7316835uae.0
 for <dev@dpdk.org>; Wed, 29 Jul 2020 08:59:42 -0700 (PDT)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20161025;
 h=x-gm-message-state:mime-version:references:in-reply-to:from:date
 :message-id:subject:to:cc;
 bh=/AqU+vxPlKwxcjXjrStKn1Jx+uPVtMR9G+VnFGTAE2M=;
 b=FKNyCHL3OCeqc8MTpngHc70PZ8N3BNwqeZnrtkl4hfCZSqYv8Bxxv5+3HusskzKE52
 52jUmuudCWLFMMva+lbRWkscWFMyfUZAzDG+rADDLoqFJIhW5D0l2evB2fcU8MxgipiA
 u78IrsTlPA+L8MQ+mJRB52mZ71iPYE0OhQYlCAN7cMc9Gempy7oNAgiGpbMZBdZWGdtv
 yGjBM1USJEKV5G9i8d82137xyX3vRGDn8VYOGLd5H48ziTyYl6XSll4/KKr3HOjrxvTl
 oLn+5j9NhFfyJjDw/xt/5ju9k5Fkt4Z0pEd4nojQwvM5Td3jzdsGEmqzvKNa1dap5aZD
 fYlw==
X-Gm-Message-State: AOAM531ARz4q/DAyrta0Q/+w4tvR6xGaFcXtBz94FFCUYbdGs2U6QFGU
 VHL3tgFLsOJwXrl0rWM2JA/UOboTDcMyqTEN0GzhZyocd/RfayA7AfhCqZcR/x17BMr+HJvWN7l
 SGS0nGECIk4qI02/f2Sg=
X-Received: by 2002:a67:cb9c:: with SMTP id h28mr24202339vsl.39.1596038381705; 
 Wed, 29 Jul 2020 08:59:41 -0700 (PDT)
X-Google-Smtp-Source: ABdhPJyI0TfxlSNn8oD7x9kP9ASVbZ1n4vgKl/88wxar3uGpIWiT9nSl1Mo/pp6RFvMTevgn1IAqWXBColr3gFJqHmA=
X-Received: by 2002:a67:cb9c:: with SMTP id h28mr24202316vsl.39.1596038381395; 
 Wed, 29 Jul 2020 08:59:41 -0700 (PDT)
MIME-Version: 1.0
References: <20200729063105.11299-1-feifei.wang2@arm.com>
 <20200729063105.11299-2-feifei.wang2@arm.com>
In-Reply-To: <20200729063105.11299-2-feifei.wang2@arm.com>
From: David Marchand <david.marchand@redhat.com>
Date: Wed, 29 Jul 2020 17:59:30 +0200
Message-ID: <CAJFAV8yMzOZ536bbsw4fLu_af_m3hJy5RkPhdMuibH0WZcaktg@mail.gmail.com>
To: Feifei Wang <feifei.wang2@arm.com>, 
 "Ananyev, Konstantin" <konstantin.ananyev@intel.com>, 
 Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>,
 Olivier Matz <olivier.matz@6wind.com>
Cc: dev <dev@dpdk.org>, nd <nd@arm.com>, dpdk stable <stable@dpdk.org>, 
 Thomas Monjalon <thomas@monjalon.net>
X-Mimecast-Spam-Score: 0
X-Mimecast-Originator: redhat.com
Content-Type: text/plain; charset="UTF-8"
Subject: Re: [dpdk-dev] [PATCH v1 1/2] ring: fix the misdescription of the
	param
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

On Wed, Jul 29, 2020 at 8:31 AM Feifei Wang <feifei.wang2@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.

Honnappa, Konstantin, Olivier ?

>
> Fixes: af75078fece3 ("first public release")
> Cc: stable@dpdk.org
>
> Signed-off-by: Feifei Wang <feifei.wang2@arm.com>
> Reviewed-by: Ruifeng Wang <ruifeng.wang@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