nilfs2: Fix some kernel-doc warnings for nilfs2
PATCH 1/1 nilfs2: Fix some kernel-doc warnings for nilfs2
Fixes the following W=1 kernel build warning(s):
fs/nilfs2/bmap.c:378: warning: Excess function parameter 'bhp' description in 'nilfs_bmap_assign' fs/nilfs2/cpfile.c:907: warning: Excess function parameter 'status' description in 'nilfs_cpfile_change_cpmode' fs/nilfs2/cpfile.c:946: warning: Excess function parameter 'stat' description in 'nilfs_cpfile_get_stat' fs/nilfs2/page.c:76: warning: Excess function parameter 'inode' description in 'nilfs_forget_buffer' fs/nilfs2/sufile.c:563: warning: Excess function parameter 'stat' description in 'nilfs_sufile_get_stat'
--- fs/nilfs2/bmap.c | 2 +- fs/nilfs2/cpfile.c | 6 +++--- fs/nilfs2/page.c | 1 - fs/nilfs2/sufile.c | 4 ++-- 4 files changed, 6 insertions(+), 7 deletions(-)
fs/nilfs2/bmap.c +1 -1
@@ -355,7 +355,7 @@ void nilfs_bmap_lookup_dirty_buffers(struct nilfs_bmap *bmap,/** * nilfs_bmap_assign - assign a new block number to a block * @bmap: bmap -* @bhp: pointer to buffer head +* @bh: pointer to buffer head * @blocknr: block number * @binfo: block information *
fs/nilfs2/cpfile.c +3 -3
@@ -889,7 +889,7 @@ int nilfs_cpfile_is_snapshot(struct inode *cpfile, __u64 cno)* nilfs_cpfile_change_cpmode - change checkpoint mode * @cpfile: inode of checkpoint file * @cno: checkpoint number -* @status: mode of checkpoint +* @mode: mode of checkpoint * * Description: nilfs_change_cpmode() changes the mode of the checkpoint * specified by @cno. The mode @mode is NILFS_CHECKPOINT or NILFS_SNAPSHOT.
@@ -930,12 +930,12 @@ int nilfs_cpfile_change_cpmode(struct inode *cpfile, __u64 cno, int mode)/** * nilfs_cpfile_get_stat - get checkpoint statistics * @cpfile: inode of checkpoint file -* @stat: pointer to a structure of checkpoint statistics +* @cpstat: pointer to a structure of checkpoint statistics * * Description: nilfs_cpfile_get_stat() returns information about checkpoints. * * Return Value: On success, 0 is returned, and checkpoints information is -* stored in the place pointed by @stat. On error, one of the following +* stored in the place pointed by @cpstat. On error, one of the following * negative error codes is returned. * * %-EIO - I/O error.
fs/nilfs2/page.c +0 -1
@@ -69,7 +69,6 @@ struct buffer_head *nilfs_grab_buffer(struct inode *inode,/** * nilfs_forget_buffer - discard dirty state -* @inode: owner inode of the buffer * @bh: buffer head of the buffer to be discarded */ void nilfs_forget_buffer (struct buffer_head *bh)
fs/nilfs2/sufile.c +2 -2
@@ -546,13 +546,13 @@ int nilfs_sufile_set_segment_usage(struct inode *sufile, __u64 segnum,/** * nilfs_sufile_get_stat - get segment usage statistics * @sufile: inode of segment usage file -* @stat: pointer to a structure of segment usage statistics +* @sustat: pointer to a structure of segment usage statistics * * Description: nilfs_sufile_get_stat() returns information about segment * usage. * * Return Value: On success, 0 is returned, and segment usage information is -* stored in the place pointed by @stat. On error, one of the following +* stored in the place pointed by @sustat. On error, one of the following * negative error codes is returned. * * %-EIO - I/O error.
Signature · 1 line
2.17.1
Ryusuke Konishi
maintainerHi Wang,
The patch looks correct. Will apply, thank you.
Ryusuke Konishi
Quoted 93 lines · Wang Hai
Fixes the following W=1 kernel build warning(s):
fs/nilfs2/bmap.c:378: warning: Excess function parameter 'bhp' description in 'nilfs_bmap_assign'fs/nilfs2/cpfile.c:907: warning: Excess function parameter 'status' description in 'nilfs_cpfile_change_cpmode'fs/nilfs2/cpfile.c:946: warning: Excess function parameter 'stat' description in 'nilfs_cpfile_get_stat'fs/nilfs2/page.c:76: warning: Excess function parameter 'inode' description in 'nilfs_forget_buffer'fs/nilfs2/sufile.c:563: warning: Excess function parameter 'stat' description in 'nilfs_sufile_get_stat'Signed-off-by Wang Hai <[email protected]>--- fs/nilfs2/bmap.c | 2 +- fs/nilfs2/cpfile.c | 6 +++--- fs/nilfs2/page.c | 1 - fs/nilfs2/sufile.c | 4 ++-- 4 files changed, 6 insertions(+), 7 deletions(-)fs/nilfs2/bmap.c +1
-1@@ -355,7 +355,7 @@ void nilfs_bmap_lookup_dirty_buffers(struct nilfs_bmap *bmap,/** * nilfs_bmap_assign - assign a new block number to a block * @bmap: bmap -* @bhp: pointer to buffer head +* @bh: pointer to buffer head * @blocknr: block number * @binfo: block information * fs/nilfs2/cpfile.c +3
-3@@ -889,7 +889,7 @@ int nilfs_cpfile_is_snapshot(struct inode *cpfile, __u64 cno)* nilfs_cpfile_change_cpmode - change checkpoint mode * @cpfile: inode of checkpoint file * @cno: checkpoint number -* @status: mode of checkpoint +* @mode: mode of checkpoint * * Description: nilfs_change_cpmode() changes the mode of the checkpoint * specified by @cno. The mode @mode is NILFS_CHECKPOINT or NILFS_SNAPSHOT. @@ -930,12 +930,12 @@ int nilfs_cpfile_change_cpmode(struct inode *cpfile, __u64 cno, int mode)/** * nilfs_cpfile_get_stat - get checkpoint statistics * @cpfile: inode of checkpoint file -* @stat: pointer to a structure of checkpoint statistics +* @cpstat: pointer to a structure of checkpoint statistics * * Description: nilfs_cpfile_get_stat() returns information about checkpoints. * * Return Value: On success, 0 is returned, and checkpoints information is -* stored in the place pointed by @stat. On error, one of the following +* stored in the place pointed by @cpstat. On error, one of the following * negative error codes is returned. * * %-EIO - I/O error. fs/nilfs2/page.c +0
-1@@ -69,7 +69,6 @@ struct buffer_head *nilfs_grab_buffer(struct inode *inode,/** * nilfs_forget_buffer - discard dirty state -* @inode: owner inode of the buffer * @bh: buffer head of the buffer to be discarded */ void nilfs_forget_buffer (struct buffer_head *bh)fs/nilfs2/sufile.c +2
-3@@ -546,13 +546,13 @@ int nilfs_sufile_set_segment_usage(struct inode *sufile, __u64 segnum,/** * nilfs_sufile_get_stat - get segment usage statistics * @sufile: inode of segment usage file -* @stat: pointer to a structure of segment usage statistics +* @sustat: pointer to a structure of segment usage statistics * * Description: nilfs_sufile_get_stat() returns information about segment * usage. * * Return Value: On success, 0 is returned, and segment usage information is -* stored in the place pointed by @stat. On error, one of the following +* stored in the place pointed by @sustat. On error, one of the following * negative error codes is returned. * * %-EIO - I/O error. -- 2.17.1