ubifs: Fix some kernel-doc comments
Subsystems (2)
PATCH 1/1 ubifs: Fix some kernel-doc comments
Remove warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'. fs/ubifs/journal.c:1221: warning: Function parameter or member 'old_inode' not described in 'ubifs_jnl_rename' fs/ubifs/journal.c:1221: warning: Function parameter or member 'old_nm' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Function parameter or member 'new_inode' not described in 'ubifs_jnl_rename' fs/ubifs/journal.c:1221: warning: Function parameter or member 'new_nm' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Function parameter or member 'whiteout' not described in 'ubifs_jnl_rename' fs/ubifs/journal.c:1221: warning: Excess function parameter 'old_dentry' description in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Excess function parameter 'new_dentry' description in 'ubifs_jnl_rename'
--- fs/ubifs/journal.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
fs/ubifs/journal.c +5 -2
@@ -1201,9 +1201,12 @@ int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir,* ubifs_jnl_rename - rename a directory entry. * @c: UBIFS file-system description object * @old_dir: parent inode of directory entry to rename -* @old_dentry: directory entry to rename +* @old_inode: parent inode to rename +* @old_nm: name of old inode to rename * @new_dir: parent inode of directory entry to rename -* @new_dentry: new directory entry (or directory entry to replace) +* @new_inode: new inode to rename +* @new_nm: name of new inode to rename +* @whiteout: whiteout inode * @sync: non-zero if the write-buffer has to be synchronized * * This function implements the re-name operation which may involve writing up
Signature · 1 line
2.20.1.7.g153144c
Zhihao Cheng
reviewerHi, maybe we should change them like this:
fs/ubifs/journal.c int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir, · line 1204
Quoted 10 lines
fs/ubifs/journal.c +1
-1@@ -1201,9 +1201,12 @@ int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir,* ubifs_jnl_rename - rename a directory entry. * @c: UBIFS file-system description object * @old_dir: parent inode of directory entry to rename -* @old_dentry: directory entry to rename +* @old_inode: parent inode to rename
old_inode: directory entry's inode to rename
fs/ubifs/journal.c int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir, · line 1205
Quoted 1 line
fs/ubifs/journal.c +1
-0+* @old_nm: name of old inode to rename
old_nm: name of the old directory entry to rename
fs/ubifs/journal.c int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir, · line 1207
Quoted 3 lines
fs/ubifs/journal.c +1
-1* @new_dir: parent inode of directory entry to rename -* @new_dentry: new directory entry (or directory entry to replace) +* @new_inode: new inode to rename
new_inode: new directory entry's inode (or directory entry's inode to replace)
fs/ubifs/journal.c int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir, · line 1208
Quoted 1 line
fs/ubifs/journal.c +1
-0+* @new_nm: name of new inode to rename
new_name: name of the new directory entry to rename
Quoted 5 lines
fs/ubifs/journal.c +1
-0+* @whiteout: whiteout inode * @sync: non-zero if the write-buffer has to be synchronized * * This function implements the re-name operation which may involve writing up
Quoted 33 lines · Yang Li
Remove warnings found by running
scripts/kernel-doc,
which is caused by using 'make W=1'.fs/ubifs/journal.c:1221: warning: Function parameter or member 'old_inode' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Function parameter or member 'old_nm' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Function parameter or member 'new_inode' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Function parameter or member 'new_nm' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Function parameter or member 'whiteout' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Excess function parameter 'old_dentry' description in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Excess function parameter 'new_dentry' description in 'ubifs_jnl_rename'Reported-by Abaci Robot <[email protected]>Signed-off-by Yang Li <[email protected]>--- fs/ubifs/journal.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)fs/ubifs/journal.c +0
-1@@ -1201,9 +1201,12 @@ int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir,* ubifs_jnl_rename - rename a directory entry. * @c: UBIFS file-system description object * @old_dir: parent inode of directory entry to rename -* @old_dentry: directory entry to rename
fs/ubifs/journal.c int ubifs_jnl_xrename(struct ubifs_info *c, const struct inode *fst_dir, · line 1212
Quoted 10 lines
fs/ubifs/journal.c +5
-1+* @old_inode: parent inode to rename +* @old_nm: name of old inode to rename * @new_dir: parent inode of directory entry to rename -* @new_dentry: new directory entry (or directory entry to replace) +* @new_inode: new inode to rename +* @new_nm: name of new inode to rename +* @whiteout: whiteout inode * @sync: non-zero if the write-buffer has to be synchronized * * This function implements the re-name operation which may involve writing up
Zhihao Cheng
reviewerQuoted 38 lines · Zhihao Cheng
Quoted 37 lines · Yang Li
Remove warnings found by running
scripts/kernel-doc,
which is caused by using 'make W=1'.fs/ubifs/journal.c:1221: warning: Function parameter or member 'old_inode' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Function parameter or member 'old_nm' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Function parameter or member 'new_inode' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Function parameter or member 'new_nm' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Function parameter or member 'whiteout' not described in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Excess function parameter 'old_dentry' description in 'ubifs_jnl_rename'fs/ubifs/journal.c:1221: warning: Excess function parameter 'new_dentry' description in 'ubifs_jnl_rename'Reported-by Abaci Robot <[email protected]>Signed-off-by Yang Li <[email protected]>---
fs/ubifs/journal.c| 7 +++++--1 file changed, 5 insertions(+), 2 deletions(-)fs/ubifs/journal.c +2
-2@@ -1201,9 +1201,12 @@ int ubifs_jnl_xrename(struct ubifs_info *c,const struct inode *fst_dir, * ubifs_jnl_rename - rename a directory entry. * @c: UBIFS file-system description object * @old_dir: parent inode of directory entry to rename - * @old_dentry: directory entry to rename + * @old_inode: parent inode to rename + * @old_nm: name of old inode to rename * @new_dir: parent inode of directory entry to rename - * @new_dentry: new directory entry (or directory entry to replace)
Quoted 8 lines
Quoted 7 lines
fs/ubifs/journal.c +3
-0+* @new_inode: new inode to rename +* @new_nm: name of new inode to rename +* @whiteout: whiteout inode * @sync: non-zero if the write-buffer has to be synchronized * * This function implements the re-name operation which may involve writing up
Reviewed-by Zhihao Cheng <[email protected]>
Please ignore this review tag, sorry for this mistaken reply, the review tag is for v2.
Quoted 5 lines
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/