Commit 516edb45 authored May 12, 2022 by Yang Li Committed by Matthew Wilcox (Oracle) May 12, 2022

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>

parent 08104fb0

fs/nilfs2/inode.c

+7 −6

Original line number	Diff line number	Diff line
		@@ -63,10 +63,10 @@ void nilfs_inode_sub_blocks(struct inode *inode, int n)

		/**
		* nilfs_get_block() - get a file block on the filesystem (callback function)
		* @inode - inode struct of the target file
		* @blkoff - file block number
		* @bh_result - buffer head to be mapped on
		* @create - indicate whether allocating the block or not when it has not
		* @inode: inode struct of the target file
		* @blkoff: file block number
		* @bh_result: buffer head to be mapped on
		* @create: indicate whether allocating the block or not when it has not
		* been allocated yet.
		*
		* 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,
		/**
		* nilfs_read_folio() - implement read_folio() method of nilfs_aops {}
		* address_space_operations.
		* @file - file struct of the file to be read
		* @folio - the folio to be read
		* @file: file struct of the file to be read
		* @folio: the folio to be read
		*/
		static int nilfs_read_folio(struct file file, struct folio folio)
		{
		@@ -1086,6 +1086,7 @@ int __nilfs_mark_inode_dirty(struct inode *inode, int flags)
		/**
		* nilfs_dirty_inode - reflect changes on given inode to an inode block.
		* @inode: inode of the file to be registered.
		* @flags: flags to determine the dirty state of the inode
		*
		* nilfs_dirty_inode() loads a inode block containing the specified
		* @inode and copies data from a nilfs_inode to a corresponding inode