[PATCH] PM / devfreq: Reword the kernel-doc comment for devfreq_monitor_start() API

[PATCH] PM / devfreq: Reword the kernel-doc comment for devfreq_monitor_start() API

[Manivannan Sadhasivam]

Current kernel-doc comment doesn't specify the default timer used for the
load monitoring. Also, it uses the term "default delayed work" which could
be misunderstood as "default delayer timer". So reword the comment to
clearly specify the default timer and also reword the last sentence to make
it more understandable.

Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
---
 drivers/devfreq/devfreq.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
index 7686993d639f..e2939c1b7d1f 100644
--- a/drivers/devfreq/devfreq.c
+++ b/drivers/devfreq/devfreq.c
@@ -472,10 +472,11 @@ static void devfreq_monitor(struct work_struct *work)
  * devfreq_monitor_start() - Start load monitoring of devfreq instance
  * @devfreq:	the devfreq instance.
  *
- * Helper function for starting devfreq device load monitoring. By
- * default delayed work based monitoring is supported. Function
- * to be called from governor in response to DEVFREQ_GOV_START
- * event when device is added to devfreq framework.
+ * Helper function for starting devfreq device load monitoring. By default,
+ * deferrable timer is used for load monitoring. But the users can change this
+ * behavior using the "timer" type in devfreq_dev_profile. This function will be
+ * called by devfreq governor in response to the DEVFREQ_GOV_START event
+ * generated while adding a device to the devfreq framework.
  */
 void devfreq_monitor_start(struct devfreq *devfreq)
 {
-- 
2.25.1

Re: [PATCH] PM / devfreq: Reword the kernel-doc comment for devfreq_monitor_start() API

[Chanwoo Choi]

On 23. 7. 20. 17:48, Manivannan Sadhasivam wrote:
> Current kernel-doc comment doesn't specify the default timer used for the
> load monitoring. Also, it uses the term "default delayed work" which could
> be misunderstood as "default delayer timer". So reword the comment to
> clearly specify the default timer and also reword the last sentence to make
> it more understandable.
> 
> Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
> ---
>  drivers/devfreq/devfreq.c | 9 +++++----
>  1 file changed, 5 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
> index 7686993d639f..e2939c1b7d1f 100644
> --- a/drivers/devfreq/devfreq.c
> +++ b/drivers/devfreq/devfreq.c
> @@ -472,10 +472,11 @@ static void devfreq_monitor(struct work_struct *work)
>   * devfreq_monitor_start() - Start load monitoring of devfreq instance
>   * @devfreq:	the devfreq instance.
>   *
> - * Helper function for starting devfreq device load monitoring. By
> - * default delayed work based monitoring is supported. Function
> - * to be called from governor in response to DEVFREQ_GOV_START
> - * event when device is added to devfreq framework.
> + * Helper function for starting devfreq device load monitoring. By default,
> + * deferrable timer is used for load monitoring. But the users can change this
> + * behavior using the "timer" type in devfreq_dev_profile. This function will be
> + * called by devfreq governor in response to the DEVFREQ_GOV_START event
> + * generated while adding a device to the devfreq framework.
>   */
>  void devfreq_monitor_start(struct devfreq *devfreq)
>  {

Applied it. Thanks.

-- 
Best Regards,
Samsung Electronics
Chanwoo Choi