diff mbox series

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

Message ID 6a15081e17d78e914526c315d5bb53ea575edf90.1656409369.git.mchehab@kernel.org
State New
Headers show
Series None | expand

Commit Message

Mauro Carvalho Chehab June 28, 2022, 9:46 a.m. UTC
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@kernel.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(+)

Comments

Chanwoo Choi June 29, 2022, 7:31 p.m. UTC | #1
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@kernel.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.
diff mbox series

Patch

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)