Skip to contentSkip to conversation

fs/kernel_read_file: Fix some kernel-doc comments

PATCH In review Yang Li 2 participants 2 messages Aug 15, 2022 – Aug 16, 2022 VFS

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 fs/kernel_read_file: Fix some kernel-doc comments

Add a colon between the parameter name and description to meet the scripts/kernel-doc.

---
 fs/kernel_read_file.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
fs/kernel_read_file.c +6 -6
index 5d826274570c..c4fc84e6d099 100644
@@ -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
Signature · 1 line
2.20.1.7.g153144c
Acked-by on v1 1/1
#1 lore raw
Quoted 6 lines · Yang Li

Add a colon between the parameter name and description to meet the scripts/kernel-doc.

Thanks.

Quoted 31 lines
---
 fs/kernel_read_file.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
fs/kernel_read_file.c +6 -6
index 5d826274570c..c4fc84e6d099 100644
@@ -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
Signature · 1 line
~Randy