Re: [PATCH -next] ubifs: Fix some kernel-doc comments

Zhihao Cheng
2022-07-08T09:17:54Z

在 2022/6/2 13:52, 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 <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
> fs/ubifs/journal.c | 7 +++++--
> 1 file changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/fs/ubifs/journal.c b/fs/ubifs/journal.c
> index 75dab0ae3939..16857d4e9aa8 100644
> --- a/fs/ubifs/journal.c
> +++ b/fs/ubifs/journal.c
> @@ -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
>
Reviewed-by: Zhihao Cheng <chengzhihao1@huawei.com>