public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH -next] lib: objpool: Fix some kernel-doc comments
@ 2022-11-09  3:57 Yang Li
  0 siblings, 0 replies; only message in thread
From: Yang Li @ 2022-11-09  3:57 UTC (permalink / raw)
  To: akpm; +Cc: linux-kernel, Yang Li, Abaci Robot

Make the description of @oh to @head in objpool_pop()
to clear the below warnings:

lib/objpool.c:425: warning: Excess function parameter 'oh' description in 'objpool_pop'
lib/objpool.c:425: warning: Function parameter or member 'head' not described in 'objpool_pop'

Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=2821
Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 lib/objpool.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/objpool.c b/lib/objpool.c
index ecffa0795f3d..96cd43eb53e1 100644
--- a/lib/objpool.c
+++ b/lib/objpool.c
@@ -414,7 +414,7 @@ static inline void *__objpool_try_get_slot(struct objpool_slot *os)
  * objpool_pop: allocate an object from objects pool
  *
  * args:
- * @oh:  object pool
+ * @head:  object pool used to allocate an object
  *
  * return:
  *   object: NULL if failed (object pool is empty)
-- 
2.20.1.7.g153144c


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2022-11-09  3:57 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-11-09  3:57 [PATCH -next] lib: objpool: Fix some kernel-doc comments Yang Li

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox