Skip to contentSkip to conversation

moduleparam: fix kerneldoc

PATCH Superseded Fabien Dessenne 2 participants 3 messages Nov 28, 2019 – Nov 29, 2019 Module support

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 moduleparam: fix kerneldoc

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

---
 include/linux/moduleparam.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
include/linux/moduleparam.h +4 -2
index e5c3e23..944c569 100644
@@ -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.
Signature · 1 line
2.7.4
#1 lore raw
Quoted 2 lines · Fabien Dessenne

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

I think that it's not a typo...

Wikipedia says for lvalue:
In computer science, a value that points to a storage location, potentially allowing new values to be assigned (so named because it appears on the left side of a variable assignment)

Quoted 44 lines
---
 include/linux/moduleparam.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
include/linux/moduleparam.h +4 -2
index e5c3e23..944c569 100644
@@ -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.
Signature · 2 lines
~Randy
Reported-by: Randy Dunlap <[email protected]>
#2 lore raw

Hi Randy

Quoted 7 lines · Randy Dunlap
Quoted 2 lines · Fabien Dessenne

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

I think that it's not a typo...

Wikipedia says for lvalue:
In computer science, a value that points to a storage location, potentially allowing new values to be assigned (so named because it appears on the left side of a variable assignment)

You are absolutely right! I am about to send a v2.

BR

Fabien

Quoted 46 lines
Quoted 45 lines
---
  include/linux/moduleparam.h | 6 ++++--
  1 file changed, 4 insertions(+), 2 deletions(-)
include/linux/moduleparam.h +4 -2
index e5c3e23..944c569 100644
@@ -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.