* [PATCH] moduleparam: fix kerneldoc
@ 2019-11-28 16:58 Fabien Dessenne
2019-11-28 18:07 ` Randy Dunlap
0 siblings, 1 reply; 3+ messages in thread
From: Fabien Dessenne @ 2019-11-28 16:58 UTC (permalink / raw)
To: Jessica Yu, Alexey Gladkov, Zhenzhong Duan,
Gleb Fotengauer-Malinovskiy, linux-kernel
Cc: Fabien Dessenne
Document missing @args in xxx_param_cb().
Typo: use 'value' instead of 'lvalue'.
Signed-off-by: Fabien Dessenne <fabien.dessenne@st.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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] moduleparam: fix kerneldoc
2019-11-28 16:58 [PATCH] moduleparam: fix kerneldoc Fabien Dessenne
@ 2019-11-28 18:07 ` Randy Dunlap
2019-11-29 15:38 ` Fabien DESSENNE
0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2019-11-28 18:07 UTC (permalink / raw)
To: Fabien Dessenne, Jessica Yu, Alexey Gladkov, Zhenzhong Duan,
Gleb Fotengauer-Malinovskiy, linux-kernel
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 <fabien.dessenne@st.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.
>
--
~Randy
Reported-by: Randy Dunlap <rdunlap@infradead.org>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] moduleparam: fix kerneldoc
2019-11-28 18:07 ` Randy Dunlap
@ 2019-11-29 15:38 ` Fabien DESSENNE
0 siblings, 0 replies; 3+ messages in thread
From: Fabien DESSENNE @ 2019-11-29 15:38 UTC (permalink / raw)
To: Randy Dunlap, Jessica Yu, Alexey Gladkov, Zhenzhong Duan,
Gleb Fotengauer-Malinovskiy, linux-kernel
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 <fabien.dessenne@st.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.
>>
>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-11-29 15:39 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-11-28 16:58 [PATCH] moduleparam: fix kerneldoc Fabien Dessenne
2019-11-28 18:07 ` Randy Dunlap
2019-11-29 15:38 ` Fabien DESSENNE
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).