2022-04-22 19:43:23

by Yang Li

[permalink] [raw]
Subject: [PATCH -next] freevxfs: Fix vxfs_lookup() kernel-doc comment

Add the description of @ctx and delete obsolete content in vxfs_lookup()
kernel-doc comment to remove warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.

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

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
fs/freevxfs/vxfs_lookup.c | 7 +------
1 file changed, 1 insertion(+), 6 deletions(-)

diff --git a/fs/freevxfs/vxfs_lookup.c b/fs/freevxfs/vxfs_lookup.c
index a51425634f65..7a0d2b8ef0fa 100644
--- a/fs/freevxfs/vxfs_lookup.c
+++ b/fs/freevxfs/vxfs_lookup.c
@@ -201,12 +201,7 @@ 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
- *
- * Description:
- * vxfs_readdir fills @retp with directory entries from @fp
- * using the VFS supplied callback @filler.
+ * @ctx: actor we feed the entries to
*
* Returns:
* Zero.
--
2.20.1.7.g153144c