diff mbox series

PM / devfreq: Fix two malformed kerneldoc comments

Message ID 20200122105716.2868f272@lwn.net (mailing list archive)
State Rejected
Delegated to: Chanwoo Choi
Headers show
Series PM / devfreq: Fix two malformed kerneldoc comments | expand

Commit Message

Jonathan Corbet Jan. 22, 2020, 5:57 p.m. UTC
Two kerneldoc comments in devfreq.c fail to adhere to the required format,
resulting in these doc-build warnings:

  ./drivers/devfreq/devfreq.c:1818: warning: bad line:
  	- Resource-managed devfreq_register_notifier()
  ./drivers/devfreq/devfreq.c:1854: warning: bad line:
	- Resource-managed devfreq_unregister_notifier()

Add a couple of missing asterisks and make kerneldoc a little happier.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 drivers/devfreq/devfreq.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Chanwoo Choi Jan. 22, 2020, 11:05 p.m. UTC | #1
Hi Jonathan,

The same patch[1] was already merged to linux-pm.git
via devfreq git. Thanks for your patch.

[1] https://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm.git/commit/?h=linux-next&id=54cb5740526a2f30d57f146d8a17364c59287187

Regards,
Chanwoo Choi

On 1/23/20 2:57 AM, Jonathan Corbet wrote:
> Two kerneldoc comments in devfreq.c fail to adhere to the required format,
> resulting in these doc-build warnings:
> 
>   ./drivers/devfreq/devfreq.c:1818: warning: bad line:
>   	- Resource-managed devfreq_register_notifier()
>   ./drivers/devfreq/devfreq.c:1854: warning: bad line:
> 	- Resource-managed devfreq_unregister_notifier()
> 
> Add a couple of missing asterisks and make kerneldoc a little happier.
> 
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
>  drivers/devfreq/devfreq.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
> index 57f6944d65a6..00c9b80b3d33 100644
> --- a/drivers/devfreq/devfreq.c
> +++ b/drivers/devfreq/devfreq.c
> @@ -1814,7 +1814,7 @@ static void devm_devfreq_notifier_release(struct device *dev, void *res)
>  
>  /**
>   * devm_devfreq_register_notifier()
> -	- Resource-managed devfreq_register_notifier()
> + *	- Resource-managed devfreq_register_notifier()
>   * @dev:	The devfreq user device. (parent of devfreq)
>   * @devfreq:	The devfreq object.
>   * @nb:		The notifier block to be unregistered.
> @@ -1850,7 +1850,7 @@ EXPORT_SYMBOL(devm_devfreq_register_notifier);
>  
>  /**
>   * devm_devfreq_unregister_notifier()
> -	- Resource-managed devfreq_unregister_notifier()
> + *	- Resource-managed devfreq_unregister_notifier()
>   * @dev:	The devfreq user device. (parent of devfreq)
>   * @devfreq:	The devfreq object.
>   * @nb:		The notifier block to be unregistered.
>
diff mbox series

Patch

diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
index 57f6944d65a6..00c9b80b3d33 100644
--- a/drivers/devfreq/devfreq.c
+++ b/drivers/devfreq/devfreq.c
@@ -1814,7 +1814,7 @@  static void devm_devfreq_notifier_release(struct device *dev, void *res)
 
 /**
  * devm_devfreq_register_notifier()
-	- Resource-managed devfreq_register_notifier()
+ *	- Resource-managed devfreq_register_notifier()
  * @dev:	The devfreq user device. (parent of devfreq)
  * @devfreq:	The devfreq object.
  * @nb:		The notifier block to be unregistered.
@@ -1850,7 +1850,7 @@  EXPORT_SYMBOL(devm_devfreq_register_notifier);
 
 /**
  * devm_devfreq_unregister_notifier()
-	- Resource-managed devfreq_unregister_notifier()
+ *	- Resource-managed devfreq_unregister_notifier()
  * @dev:	The devfreq user device. (parent of devfreq)
  * @devfreq:	The devfreq object.
  * @nb:		The notifier block to be unregistered.