From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id C5C3C432B0 for ; Mon, 6 Nov 2023 13:24:30 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BBD4840633; Mon, 6 Nov 2023 13:24:30 +0100 (CET) Received: from shelob.oktetlabs.ru (shelob.oktetlabs.ru [91.220.146.113]) by mails.dpdk.org (Postfix) with ESMTP id 931D1402AA; Mon, 6 Nov 2023 13:24:28 +0100 (CET) Received: from [192.168.1.38] (unknown [188.170.78.242]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by shelob.oktetlabs.ru (Postfix) with ESMTPSA id 996E05E; Mon, 6 Nov 2023 15:24:26 +0300 (MSK) DKIM-Filter: OpenDKIM Filter v2.11.0 shelob.oktetlabs.ru 996E05E DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=oktetlabs.ru; s=default; t=1699273467; bh=q+Fl3rXyOXhCo27Zmn+Y5jMkdjerIzN/6SAsv+8m9zw=; h=Date:Subject:To:Cc:References:From:In-Reply-To:From; b=aunaYb5bcWFJz/Ew+9aFwMs8teVMcuwXLu0O63KBdHrn31whnaCspc7PJOfxVJRly t77wrIh7qGM2m+ORMG9mqHI0HKfMRB432m2h0giZyPCjFDUNqEpXF5xOMGVgPHSWmN 7NE1/K9guVV7WKaXwgk5Ls1aD6JjKED8f9gbYBOQ= Message-ID: Date: Mon, 6 Nov 2023 15:24:24 +0300 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v2 1/2] mempool: fix internal function documentation Content-Language: en-US To: Ferruh Yigit , Thomas Monjalon Cc: dev@dpdk.org, stable@dpdk.org, Mahesh Adulla , =?UTF-8?Q?Morten_Br=C3=B8rup?= , Huisong Li References: <20231020144647.1682698-1-ferruh.yigit@amd.com> <20231023093844.4150572-1-ferruh.yigit@amd.com> From: Andrew Rybchenko In-Reply-To: <20231023093844.4150572-1-ferruh.yigit@amd.com> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org On 10/23/23 12:38, Ferruh Yigit wrote: > static function `rte_mempool_do_generic_get()` returns zero on success, > not >=0 as its function comment documents. > > Since this function called by public API, the comment causes confusion > on the public API return value. > > Fixing the internal function documentation for return value. > > Fixes: af75078fece3 ("first public release") > Cc: stable@dpdk.org > > Reported-by: Mahesh Adulla > Signed-off-by: Ferruh Yigit > Reviewed-by: Morten Brørup > Acked-by: Huisong Li > --- > .mailmap | 1 + > lib/mempool/rte_mempool.h | 2 +- > 2 files changed, 2 insertions(+), 1 deletion(-) > > diff --git a/.mailmap b/.mailmap > index 3f5bab26a81f..bfe451980f1c 100644 > --- a/.mailmap > +++ b/.mailmap > @@ -836,6 +836,7 @@ Maciej Rabeda > Maciej Szwed > Madhu Chittim > Madhuker Mythri > +Mahesh Adulla > Mahipal Challa > Mah Yock Gen > Mairtin o Loingsigh > diff --git a/lib/mempool/rte_mempool.h b/lib/mempool/rte_mempool.h > index f70bf36080fb..86598bc639e6 100644 > --- a/lib/mempool/rte_mempool.h > +++ b/lib/mempool/rte_mempool.h > @@ -1484,7 +1484,7 @@ rte_mempool_put(struct rte_mempool *mp, void *obj) > * @param cache > * A pointer to a mempool cache structure. May be NULL if not needed. > * @return > - * - >=0: Success; number of objects supplied. > + * - 0: Success; number of objects supplied. I think "number of objects supplied" does not make sense here any more. > * - <0: Error; code of driver dequeue function. > */ > static __rte_always_inline int