linux-kernel - Re: [PATCH 08/22] devfreq: shut up kernel-doc warnings

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] [thread-next>] [day] [month] [year] [list]

Date:   Thu, 30 Jun 2022 04:31:50 +0900
From:   Chanwoo Choi <cwchoi00@...il.com>
To:     Mauro Carvalho Chehab <mchehab@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Jonathan Corbet <corbet@....net>,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Chanwoo Choi <cw00.choi@...sung.com>,
        Kyungmin Park <kyungmin.park@...sung.com>,
        MyungJoo Ham <myungjoo.ham@...sung.com>,
        linux-kernel@...r.kernel.org, linux-pm@...r.kernel.org
Subject: Re: [PATCH 08/22] devfreq: shut up kernel-doc warnings

On 22. 6. 28. 18:46, Mauro Carvalho Chehab wrote:
> There are 4 warnings there:
> 	drivers/devfreq/devfreq.c:707: warning: Function parameter or member 'val' not described in 'qos_min_notifier_call'
> 	drivers/devfreq/devfreq.c:707: warning: Function parameter or member 'ptr' not described in 'qos_min_notifier_call'
> 	drivers/devfreq/devfreq.c:717: warning: Function parameter or member 'val' not described in 'qos_max_notifier_call'
> 	drivers/devfreq/devfreq.c:717: warning: Function parameter or member 'ptr' not described in 'qos_max_notifier_call'
> 
> It turns that neither val nor ptr are actually used on those
> function, so document as such.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@...nel.org>
> ---
> 
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH 00/22] at: https://lore.kernel.org/all/cover.1656409369.git.mchehab@kernel.org/
> 
>  drivers/devfreq/devfreq.c | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
> index 01474daf4548..3020855d8400 100644
> --- a/drivers/devfreq/devfreq.c
> +++ b/drivers/devfreq/devfreq.c
> @@ -700,6 +700,8 @@ static int qos_notifier_call(struct devfreq *devfreq)
>  /**
>   * qos_min_notifier_call() - Callback for QoS min_freq changes.
>   * @nb:		Should be devfreq->nb_min
> + * @val:	not used
> + * @ptr:	not used
>   */
>  static int qos_min_notifier_call(struct notifier_block *nb,
>  					 unsigned long val, void *ptr)
> @@ -710,6 +712,8 @@ static int qos_min_notifier_call(struct notifier_block *nb,
>  /**
>   * qos_max_notifier_call() - Callback for QoS max_freq changes.
>   * @nb:		Should be devfreq->nb_max
> + * @val:	not used
> + * @ptr:	not used
>   */
>  static int qos_max_notifier_call(struct notifier_block *nb,
>  					 unsigned long val, void *ptr)

Applied it. Thanks.

-- 
Best Regards,
Samsung Electronics
Chanwoo Choi