linux-kernel - [PATCH] modules: moduleparam.h: add 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 for Android: free password hash cracker in your pocket

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20251214202357.2208303-1-rdunlap@infradead.org>
Date: Sun, 14 Dec 2025 12:23:57 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Luis Chamberlain <mcgrof@...nel.org>,
	Petr Pavlu <petr.pavlu@...e.com>,
	Daniel Gomez <da.gomez@...nel.org>,
	linux-modules@...r.kernel.org
Subject: [PATCH] modules: moduleparam.h: add kernel-doc comments

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@...radead.org>
---
Cc: Luis Chamberlain <mcgrof@...nel.org>
Cc: Petr Pavlu <petr.pavlu@...e.com>
Cc: Daniel Gomez <da.gomez@...nel.org>
Cc: linux-modules@...r.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);