* [PATCH -next] fs/kernel_read_file: Fix some kernel-doc comments
@ 2022-08-15 5:44 Yang Li
2022-08-16 22:47 ` Randy Dunlap
0 siblings, 1 reply; 2+ messages in thread
From: Yang Li @ 2022-08-15 5:44 UTC (permalink / raw)
To: viro; +Cc: linux-fsdevel, linux-kernel, Yang Li, Abaci Robot
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>
---
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
--
2.20.1.7.g153144c
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH -next] fs/kernel_read_file: Fix some kernel-doc comments
2022-08-15 5:44 [PATCH -next] fs/kernel_read_file: Fix some kernel-doc comments Yang Li
@ 2022-08-16 22:47 ` Randy Dunlap
0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2022-08-16 22:47 UTC (permalink / raw)
To: Yang Li, viro; +Cc: linux-fsdevel, linux-kernel, Abaci Robot
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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2022-08-16 22:47 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-08-15 5:44 [PATCH -next] fs/kernel_read_file: Fix some kernel-doc comments Yang Li
2022-08-16 22:47 ` Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).