lkml.org 
[lkml]   [2022]   [Aug]   [16]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH -next] fs/kernel_read_file: Fix some kernel-doc comments
From


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@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Acked-by: Randy Dunlap <rdunlap@infradead.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

\
 
 \ /
  Last update: 2022-09-17 16:27    [W:0.036 / U:0.488 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site