[PATCH -next] freevxfs: Modify parameter description in kernel-doc comment

Yang Li posted 1 patch 3 years, 12 months ago
fs/freevxfs/vxfs_immed.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH -next] freevxfs: Modify parameter description in kernel-doc comment
Posted by Yang Li 3 years, 12 months ago
Modify parameter description @file->@fp in vxfs_immed_read_folio()
kernel-doc comment to remove warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.

fs/freevxfs/vxfs_immed.c:67: warning: Function parameter or member 'fp'
not described in 'vxfs_immed_read_folio'
fs/freevxfs/vxfs_immed.c:67: warning: Excess function parameter 'file'
description in 'vxfs_immed_read_folio'

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 fs/freevxfs/vxfs_immed.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/freevxfs/vxfs_immed.c b/fs/freevxfs/vxfs_immed.c
index a37431e443d3..34df0327f580 100644
--- a/fs/freevxfs/vxfs_immed.c
+++ b/fs/freevxfs/vxfs_immed.c
@@ -49,7 +49,7 @@ const struct address_space_operations vxfs_immed_aops = {
 
 /**
  * vxfs_immed_read_folio - read part of an immed inode into pagecache
- * @file:	file context (unused)
+ * @fp:	file context (unused)
  * @folio:	folio to fill in.
  *
  * Description:
-- 
2.20.1.7.g153144c
Re: [PATCH -next] freevxfs: Modify parameter description in kernel-doc comment
Posted by Christoph Hellwig 3 years, 11 months ago
Looks good:

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

I don't have a freevfs tree, so please send it to Al or Andrew, thanks!