linux-kernel - [PATCH] moduleparam: fix kerneldoc

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <1574960280-28770-1-git-send-email-fabien.dessenne@st.com>
Date:   Thu, 28 Nov 2019 17:58:00 +0100
From:   Fabien Dessenne <fabien.dessenne@...com>
To:     Jessica Yu <jeyu@...nel.org>,
        Alexey Gladkov <gladkov.alexey@...il.com>,
        Zhenzhong Duan <zhenzhong.duan@...cle.com>,
        Gleb Fotengauer-Malinovskiy <glebfm@...linux.org>,
        <linux-kernel@...r.kernel.org>
CC:     Fabien Dessenne <fabien.dessenne@...com>
Subject: [PATCH] moduleparam: fix kerneldoc

Document missing @args in xxx_param_cb().
Typo: use 'value' instead of 'lvalue'.

Signed-off-by: Fabien Dessenne <fabien.dessenne@...com>
---
 include/linux/moduleparam.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/linux/moduleparam.h b/include/linux/moduleparam.h
index e5c3e23..944c569 100644
--- a/include/linux/moduleparam.h
+++ b/include/linux/moduleparam.h
@@ -135,7 +135,7 @@ struct kparam_array
 /**
  * module_param_named - typesafe helper for a renamed module/cmdline parameter
  * @name: a valid C identifier which is the parameter name.
- * @value: the actual lvalue to alter.
+ * @value: the actual value to alter.
  * @type: the type of the parameter
  * @perm: visibility in sysfs.
  *
@@ -160,6 +160,7 @@ struct kparam_array
  * module_param_cb - general callback for a module/cmdline parameter
  * @name: a valid C identifier which is the parameter name.
  * @ops: the set & get operations for this parameter.
+ * @args: args for @ops
  * @perm: visibility in sysfs.
  *
  * The ops can have NULL set or get functions.
@@ -176,6 +177,7 @@ struct kparam_array
  *                    to be evaluated before certain initcall level
  * @name: a valid C identifier which is the parameter name.
  * @ops: the set & get operations for this parameter.
+ * @args: args for @ops
  * @perm: visibility in sysfs.
  *
  * The ops can have NULL set or get functions.
@@ -457,7 +459,7 @@ enum hwparam_type {
 /**
  * module_param_hw_named - A parameter representing a hw parameters
  * @name: a valid C identifier which is the parameter name.
- * @value: the actual lvalue to alter.
+ * @value: the actual value to alter.
  * @type: the type of the parameter
  * @hwtype: what the value represents (enum hwparam_type)
  * @perm: visibility in sysfs.
-- 
2.7.4