Re: [PATCH] nilfs2: cpfile: fix some kernel-doc warnings

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, Dec 20, 2023 at 3:59 PM Randy Dunlap wrote:
>
> Correct the function parameter names for nilfs_cpfile_get_info():
>
> cpfile.c:564: warning: Function parameter or member 'cnop' not described in 'nilfs_cpfile_get_cpinfo'
> cpfile.c:564: warning: Function parameter or member 'mode' not described in 'nilfs_cpfile_get_cpinfo'
> cpfile.c:564: warning: Function parameter or member 'buf' not described in 'nilfs_cpfile_get_cpinfo'
> cpfile.c:564: warning: Function parameter or member 'cisz' not described in 'nilfs_cpfile_get_cpinfo'
> cpfile.c:564: warning: Excess function parameter 'cno' description in 'nilfs_cpfile_get_cpinfo'
> cpfile.c:564: warning: Excess function parameter 'ci' description in 'nilfs_cpfile_get_cpinfo'
>
> This still leaves a few kernel-doc warnings.
> Also, the function parameters should have descriptions after them.
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Ryusuke Konishi <konishi.ryusuke@xxxxxxxxx>
> Cc: linux-nilfs@xxxxxxxxxxxxxxx
> ---
>  fs/nilfs2/cpfile.c |    6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff -- a/fs/nilfs2/cpfile.c b/fs/nilfs2/cpfile.c
> --- a/fs/nilfs2/cpfile.c
> +++ b/fs/nilfs2/cpfile.c
> @@ -554,8 +554,10 @@ static ssize_t nilfs_cpfile_do_get_ssinf
>  /**
>   * nilfs_cpfile_get_cpinfo -
>   * @cpfile:
> - * @cno:
> - * @ci:
> + * @cnop:
> + * @mode:
> + * @buf:
> + * @cisz:
>   * @nci:
>   */
>

Ah, thank you for pointing it out.

I would like to fill in the missing descriptions and send it upstream.

Thanks,
Ryusuke Konishi





[Index of Archives]     [Linux Filesystem Development]     [Linux BTRFS]     [Linux CIFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux SCSI]

  Powered by Linux