Skip to content

Commit 516edb4

Browse files
Yang LiMatthew Wilcox (Oracle)
authored andcommitted
nilfs2: Fix some kernel-doc comments
The description of @flags in nilfs_dirty_inode() kernel-doc comment is missing, and some functions had kernel-doc that used a hash instead of a colon to separate the parameter name from the one line description. Fix them to remove some warnings found by running scripts/kernel-doc, which is caused by using 'make W=1'. fs/nilfs2/inode.c:73: warning: Function parameter or member 'inode' not described in 'nilfs_get_block' fs/nilfs2/inode.c:73: warning: Function parameter or member 'blkoff' not described in 'nilfs_get_block' fs/nilfs2/inode.c:73: warning: Function parameter or member 'bh_result' not described in 'nilfs_get_block' fs/nilfs2/inode.c:73: warning: Function parameter or member 'create' not described in 'nilfs_get_block' fs/nilfs2/inode.c:145: warning: Function parameter or member 'file' not described in 'nilfs_readpage' fs/nilfs2/inode.c:145: warning: Function parameter or member 'page' not described in 'nilfs_readpage' fs/nilfs2/inode.c:968: warning: Function parameter or member 'flags' not described in 'nilfs_dirty_inode' Link: https://lkml.kernel.org/r/20220324024215.63479-1-yang.lee@linux.alibaba.com Link: https://lkml.kernel.org/r/1652276316-7791-1-git-send-email-konishi.ryusuke@gmail.com Reported-by: Abaci Robot <abaci@linux.alibaba.com> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com> Signed-off-by: Ryusuke Konishi <konishi.ryusuke@gmail.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
1 parent 08104fb commit 516edb4

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

fs/nilfs2/inode.c

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ void nilfs_inode_sub_blocks(struct inode *inode, int n)
6363

6464
/**
6565
* nilfs_get_block() - get a file block on the filesystem (callback function)
66-
* @inode - inode struct of the target file
67-
* @blkoff - file block number
68-
* @bh_result - buffer head to be mapped on
69-
* @create - indicate whether allocating the block or not when it has not
66+
* @inode: inode struct of the target file
67+
* @blkoff: file block number
68+
* @bh_result: buffer head to be mapped on
69+
* @create: indicate whether allocating the block or not when it has not
7070
* been allocated yet.
7171
*
7272
* This function does not issue actual read request of the specified data
@@ -142,8 +142,8 @@ int nilfs_get_block(struct inode *inode, sector_t blkoff,
142142
/**
143143
* nilfs_read_folio() - implement read_folio() method of nilfs_aops {}
144144
* address_space_operations.
145-
* @file - file struct of the file to be read
146-
* @folio - the folio to be read
145+
* @file: file struct of the file to be read
146+
* @folio: the folio to be read
147147
*/
148148
static int nilfs_read_folio(struct file *file, struct folio *folio)
149149
{
@@ -1086,6 +1086,7 @@ int __nilfs_mark_inode_dirty(struct inode *inode, int flags)
10861086
/**
10871087
* nilfs_dirty_inode - reflect changes on given inode to an inode block.
10881088
* @inode: inode of the file to be registered.
1089+
* @flags: flags to determine the dirty state of the inode
10891090
*
10901091
* nilfs_dirty_inode() loads a inode block containing the specified
10911092
* @inode and copies data from a nilfs_inode to a corresponding inode

0 commit comments

Comments
 (0)