linux-kernel - Re: [PATCH -next] fs/kernel_read_file: Fix some kernel-doc comments

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] [day] [month] [year] [list]

Message-ID: <a063c19e-f6b9-a7ae-a199-1fc60de01c21@infradead.org>
Date:   Tue, 16 Aug 2022 15:47:45 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Yang Li <yang.lee@...ux.alibaba.com>, viro@...iv.linux.org.uk
Cc:     linux-fsdevel@...r.kernel.org, linux-kernel@...r.kernel.org,
        Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH -next] fs/kernel_read_file: Fix some kernel-doc comments



On 8/14/22 22:44, Yang Li wrote:
> Add a colon between the parameter name and description to meet the
> scripts/kernel-doc.
> 
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=1901
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>

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

Thanks.

> ---
>  fs/kernel_read_file.c | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/fs/kernel_read_file.c b/fs/kernel_read_file.c
> index 5d826274570c..c4fc84e6d099 100644
> --- a/fs/kernel_read_file.c
> +++ b/fs/kernel_read_file.c
> @@ -8,16 +8,16 @@
>  /**
>   * kernel_read_file() - read file contents into a kernel buffer
>   *
> - * @file	file to read from
> - * @offset	where to start reading from (see below).
> - * @buf		pointer to a "void *" buffer for reading into (if
> + * @file:	file to read from
> + * @offset:	where to start reading from (see below).
> + * @buf:	pointer to a "void *" buffer for reading into (if
>   *		*@buf is NULL, a buffer will be allocated, and
>   *		@buf_size will be ignored)
> - * @buf_size	size of buf, if already allocated. If @buf not
> + * @buf_size:	size of buf, if already allocated. If @buf not
>   *		allocated, this is the largest size to allocate.
> - * @file_size	if non-NULL, the full size of @file will be
> + * @file_size:	if non-NULL, the full size of @file will be
>   *		written here.
> - * @id		the kernel_read_file_id identifying the type of
> + * @id:	the kernel_read_file_id identifying the type of
>   *		file contents being read (for LSMs to examine)
>   *
>   * @offset must be 0 unless both @buf and @file_size are non-NULL

-- 
~Randy