From: Ferruh Yigit <ferruh.yigit@amd.com>
To: Thomas Monjalon <thomas@monjalon.net>,
Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Cc: dev@dpdk.org, stable@dpdk.org,
"Mahesh Adulla" <mahesh.adulla@amd.com>,
"Morten Brørup" <mb@smartsharesystems.com>,
"Huisong Li" <lihuisong@huawei.com>
Subject: [PATCH v2 1/2] mempool: fix internal function documentation
Date: Mon, 23 Oct 2023 10:38:42 +0100 [thread overview]
Message-ID: <20231023093844.4150572-1-ferruh.yigit@amd.com> (raw)
In-Reply-To: <20231020144647.1682698-1-ferruh.yigit@amd.com>
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 <mahesh.adulla@amd.com>
Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
Reviewed-by: Morten Brørup <mb@smartsharesystems.com>
Acked-by: Huisong Li <lihuisong@huawei.com>
---
.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.rabeda@intel.com>
Maciej Szwed <maciej.szwed@intel.com>
Madhu Chittim <madhu.chittim@intel.com>
Madhuker Mythri <madhuker.mythri@oracle.com>
+Mahesh Adulla <mahesh.adulla@amd.com>
Mahipal Challa <mchalla@marvell.com>
Mah Yock Gen <yock.gen.mah@intel.com>
Mairtin o Loingsigh <mairtin.oloingsigh@intel.com>
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.
* - <0: Error; code of driver dequeue function.
*/
static __rte_always_inline int
--
2.34.1
next prev parent reply other threads:[~2023-10-23 9:39 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-20 14:46 [PATCH] " Ferruh Yigit
2023-10-20 16:08 ` Morten Brørup
2023-10-23 9:07 ` Ferruh Yigit
2023-10-21 3:09 ` lihuisong (C)
2023-10-23 9:38 ` Ferruh Yigit [this message]
2023-10-23 9:38 ` [PATCH v2 2/2] mempool: clarify enqueue and dequeue ops return type Ferruh Yigit
2023-10-23 9:43 ` Morten Brørup
2023-11-27 15:27 ` Thomas Monjalon
2023-11-06 12:24 ` [PATCH v2 1/2] mempool: fix internal function documentation Andrew Rybchenko
2023-11-27 14:41 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231023093844.4150572-1-ferruh.yigit@amd.com \
--to=ferruh.yigit@amd.com \
--cc=andrew.rybchenko@oktetlabs.ru \
--cc=dev@dpdk.org \
--cc=lihuisong@huawei.com \
--cc=mahesh.adulla@amd.com \
--cc=mb@smartsharesystems.com \
--cc=stable@dpdk.org \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).