include/linux/moduleparam.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)
Add missing kernel-doc comments to prevent kernel-doc warnings:
Warning: include/linux/moduleparam.h:364 function parameter 'arg' not
described in '__core_param_cb'
Warning: include/linux/moduleparam.h:395 No description found for return
value of 'parameq'
Warning: include/linux/moduleparam.h:405 No description found for return
value of 'parameqn'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Luis Chamberlain <mcgrof@kernel.org>
Cc: Petr Pavlu <petr.pavlu@suse.com>
Cc: Daniel Gomez <da.gomez@kernel.org>
Cc: linux-modules@vger.kernel.org
---
include/linux/moduleparam.h | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
--- linux-next-20251203.orig/include/linux/moduleparam.h
+++ linux-next-20251203/include/linux/moduleparam.h
@@ -355,8 +355,8 @@ static inline void kernel_param_unlock(s
/**
* __core_param_cb - similar like core_param, with a set/get ops instead of type.
* @name: the name of the cmdline and sysfs parameter (often the same as var)
- * @var: the variable
* @ops: the set & get operations for this parameter.
+ * @arg: the variable
* @perm: visibility in sysfs
*
* Ideally this should be called 'core_param_cb', but the name has been
@@ -390,7 +390,7 @@ static inline void kernel_param_unlock(s
* @name1: parameter name 1
* @name2: parameter name 2
*
- * Returns true if the two parameter names are equal.
+ * Returns: true if the two parameter names are equal.
* Dashes (-) are considered equal to underscores (_).
*/
extern bool parameq(const char *name1, const char *name2);
@@ -402,6 +402,10 @@ extern bool parameq(const char *name1, c
* @n: the length to compare
*
* Similar to parameq(), except it compares @n characters.
+ *
+ * Returns: true if the first @n characters of the two parameter names
+ * are equal.
+ * Dashes (-) are considered equal to underscores (_).
*/
extern bool parameqn(const char *name1, const char *name2, size_t n);
On 12/14/25 9:23 PM, Randy Dunlap wrote: > Add missing kernel-doc comments to prevent kernel-doc warnings: > > Warning: include/linux/moduleparam.h:364 function parameter 'arg' not > described in '__core_param_cb' > Warning: include/linux/moduleparam.h:395 No description found for return > value of 'parameq' > Warning: include/linux/moduleparam.h:405 No description found for return > value of 'parameqn' > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Nit: The description is somewhat misleading as it mentions adding kernel-doc comments, but the patch actually involves fixing the existing comments. I guess this can be adjusted by a maintainer who picks up the patch and there is no need to resend it. Looks ok to me otherwise. Reviewed-by: Petr Pavlu <petr.pavlu@suse.com> -- Thanks, Petr
© 2016 - 2025 Red Hat, Inc.