2019-11-28 17:02:52

by Fabien DESSENNE

[permalink] [raw]
Subject: [PATCH] moduleparam: fix kerneldoc

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

Signed-off-by: Fabien Dessenne <[email protected]>
---
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


2019-11-28 18:10:17

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] moduleparam: fix kerneldoc

On 11/28/19 8:58 AM, Fabien Dessenne wrote:
> 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)


> Signed-off-by: Fabien Dessenne <[email protected]>
> ---
> 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.
>


--
~Randy
Reported-by: Randy Dunlap <[email protected]>

2019-11-29 15:40:49

by Fabien DESSENNE

[permalink] [raw]
Subject: Re: [PATCH] moduleparam: fix kerneldoc

Hi Randy


On 28/11/2019 7:07 PM, Randy Dunlap wrote:
> On 11/28/19 8:58 AM, Fabien Dessenne wrote:
>> 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


>
>> Signed-off-by: Fabien Dessenne <[email protected]>
>> ---
>> 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.
>>
>