linux-kernel - [PATCH -next] lib: objpool: Fix some kernel-doc comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20221109035704.88975-1-yang.lee@linux.alibaba.com>
Date:   Wed,  9 Nov 2022 11:57:04 +0800
From:   Yang Li <yang.lee@...ux.alibaba.com>
To:     akpm@...ux-foundation.org
Cc:     linux-kernel@...r.kernel.org, Yang Li <yang.lee@...ux.alibaba.com>,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: [PATCH -next] 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'

Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=2821
Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@...ux.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