linux-kernel - Re: [PATCH v2] 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-prev] [day] [month] [year] [list]

Message-ID: <4b6a1030-d84d-b2d6-13ac-e7fa102d039d@infradead.org>
Date:   Fri, 29 Nov 2019 13:40:37 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Fabien Dessenne <fabien.dessenne@...com>,
        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
Subject: Re: [PATCH v2] moduleparam: fix kerneldoc

On 11/29/19 7:39 AM, Fabien Dessenne wrote:
> Document missing @args in xxx_param_cb().
> 
> Signed-off-by: Fabien Dessenne <fabien.dessenne@...com>
> ---
> Changes since v1: do not replace 'lvalue' with 'value'
> ---
>  include/linux/moduleparam.h | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/include/linux/moduleparam.h b/include/linux/moduleparam.h
> index e5c3e23..5215198 100644
> --- a/include/linux/moduleparam.h
> +++ b/include/linux/moduleparam.h
> @@ -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

should be @arg:

>   * @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

should be @arg:

>   * @perm: visibility in sysfs.
>   *
>   * The ops can have NULL set or get functions.
> 

and @level needs to be documented here also.

I tested this patch with
$ ./scripts/kernel-doc -none -function module_param_cb include/linux/moduleparam.h

scripts/kernel-doc does not like this line:
 * <level>_param_cb - general callback for a module/cmdline parameter

It needs to match the macro name __level_param_cb.

-- 
~Randy