Re: [PATCH] fs: namei: fix two excess parameter description warnings

From: Randy Dunlap
Date: Thu Nov 24 2022 - 21:52:19 EST




On 11/17/22 04:28, Kushagra Verma wrote:
> While building the kernel documentation, two excess parameter description
> warnings appear:
> ./fs/namei.c:3589: warning: Excess function parameter 'dentry'
> description in 'vfs_tmpfile'
> ./fs/namei.c:3589: warning: Excess function parameter 'open_flag'
> description in 'vfs_tmpfile'
>
> Fix these warnings by changing 'dentry' to 'parentpath' in the parameter
> description and 'open_flag' to 'file' and change 'file' parameter's
> description accordingly.
>
> Signed-off-by: Kushagra Verma <kushagra765@xxxxxxxxxxx>

Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.

> ---
> fs/namei.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/fs/namei.c b/fs/namei.c
> index 578c2110df02..8e77e194fed5 100644
> --- a/fs/namei.c
> +++ b/fs/namei.c
> @@ -3571,9 +3571,9 @@ static int do_open(struct nameidata *nd,
> /**
> * vfs_tmpfile - create tmpfile
> * @mnt_userns: user namespace of the mount the inode was found from
> - * @dentry: pointer to dentry of the base directory
> + * @parentpath: pointer to dentry of the base directory
> * @mode: mode of the new tmpfile
> - * @open_flag: flags
> + * @file: file information
> *
> * Create a temporary file.
> *

--
~Randy