2022-05-13 17:18:47

by Yang Li

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

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 <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
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

2022-05-18 01:52:58

by Christoph Hellwig

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

Looks good:

Reviewed-by: Christoph Hellwig <[email protected]>

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