mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Fabien DESSENNE <fabien.dessenne@st.com>
To: Randy Dunlap <rdunlap@infradead.org>,
	Jessica Yu <jeyu@kernel.org>,
	"Alexey Gladkov" <gladkov.alexey@gmail.com>,
	Zhenzhong Duan <zhenzhong.duan@oracle.com>,
	Gleb Fotengauer-Malinovskiy <glebfm@altlinux.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] moduleparam: fix kerneldoc
Date: Fri, 29 Nov 2019 15:38:47 +0000	[thread overview]
Message-ID: <f9b0d788-deb4-9114-f074-2e11d44be147@st.com> (raw)
In-Reply-To: <bc38fbde-fa80-43f2-abf2-6629c346d8e3@infradead.org>

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.
>>
>

      reply	other threads:[~2019-11-29 15:39 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-28 16:58 Fabien Dessenne
2019-11-28 18:07 ` Randy Dunlap
2019-11-29 15:38   ` Fabien DESSENNE [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=f9b0d788-deb4-9114-f074-2e11d44be147@st.com \
    --to=fabien.dessenne@st.com \
    --cc=gladkov.alexey@gmail.com \
    --cc=glebfm@altlinux.org \
    --cc=jeyu@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=zhenzhong.duan@oracle.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®