[PATCH -next] freevxfs: Fix some kernel-doc comments

Yang Li posted 1 patch 2 years, 8 months ago
fs/freevxfs/vxfs_lookup.c | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
[PATCH -next] freevxfs: Fix some kernel-doc comments
Posted by Yang Li 2 years, 8 months ago
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@linux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5301
Signed-off-by: Yang Li <yang.lee@linux.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
Re: [PATCH -next] freevxfs: Fix some kernel-doc comments
Posted by Christoph Hellwig 2 years, 8 months ago
Looks good:

Reviewed-by: Christoph Hellwig <hch@lst.de>