linux-kernel - [PATCH -next] freevxfs: 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 for Android: free password hash cracker in your pocket

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

Date:   Wed, 24 May 2023 13:37:53 +0800
From:   Yang Li <yang.lee@...ux.alibaba.com>
To:     hch@...radead.org
Cc:     linux-kernel@...r.kernel.org, Yang Li <yang.lee@...ux.alibaba.com>,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: [PATCH -next] freevxfs: Fix some kernel-doc comments

Remove the description of @retp and @filler, and add the description
of @ctx, to silence the warnings:

fs/freevxfs/vxfs_lookup.c:192: warning: Function parameter or member 'ctx' not described in 'vxfs_readdir'
fs/freevxfs/vxfs_lookup.c:192: warning: Excess function parameter 'retp' description in 'vxfs_readdir'
fs/freevxfs/vxfs_lookup.c:192: warning: Excess function parameter 'filler' description in 'vxfs_readdir'

Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5301
Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
---
 fs/freevxfs/vxfs_lookup.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/fs/freevxfs/vxfs_lookup.c b/fs/freevxfs/vxfs_lookup.c
index f04ba2ed1e1a..8dfcd5f1013a 100644
--- a/fs/freevxfs/vxfs_lookup.c
+++ b/fs/freevxfs/vxfs_lookup.c
@@ -176,9 +176,8 @@ vxfs_lookup(struct inode *dip, struct dentry *dp, unsigned int flags)
 
 /**
  * vxfs_readdir - read a directory
- * @fp:		the directory to read
- * @retp:	return buffer
- * @filler:	filldir callback
+ * @fp:    the directory to read
+ * @ctx:   actor to feed the entries to
  *
  * Description:
  *   vxfs_readdir fills @retp with directory entries from @fp
-- 
2.20.1.7.g153144c