Skip to contentSkip to conversation

lib: objpool: Fix some kernel-doc comments

PATCH New Yang Li 1 participant 1 message Nov 9, 2022

Subsystems (2)
lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 lib: objpool: Fix some kernel-doc comments

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'

---
 lib/objpool.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
lib/objpool.c +1 -1
index ecffa0795f3d..96cd43eb53e1 100644
@@ -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)
Signature · 1 line
2.20.1.7.g153144c