linux-kernel - Re: [PATCH -next] fs: Fix one kernel-doc comment

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <a238c84e-3ddb-ef0b-66e4-b90d142fcd48@infradead.org>
Date:   Thu, 10 Aug 2023 22:03:37 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Yang Li <yang.lee@...ux.alibaba.com>, viro@...iv.linux.org.uk,
        brauner@...nel.org
Cc:     linux-fsdevel@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH -next] fs: Fix one kernel-doc comment



On 8/10/23 18:43, Yang Li wrote:
> Fix one kernel-doc comment to silence the warning:
> 
> fs/read_write.c:88: warning: Function parameter or member 'maxsize' not described in 'generic_file_llseek_size'
> 
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
Thanks.

> ---
>  fs/read_write.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/fs/read_write.c b/fs/read_write.c
> index b07de77ef126..4771701c896b 100644
> --- a/fs/read_write.c
> +++ b/fs/read_write.c
> @@ -71,7 +71,7 @@ EXPORT_SYMBOL(vfs_setpos);
>   * @file:	file structure to seek on
>   * @offset:	file offset to seek to
>   * @whence:	type of seek
> - * @size:	max size of this file in file system
> + * @maxsize:	max size of this file in file system
>   * @eof:	offset used for SEEK_END position
>   *
>   * This is a variant of generic_file_llseek that allows passing in a custom

-- 
~Randy