[PATCH] cpufreq: schedutil: Fix self-contradictory comment in sugov_iowait_apply()

[PATCH] cpufreq: schedutil: Fix self-contradictory comment in sugov_iowait_apply()

[Zhongqiu Han]

The kerneldoc of sugov_iowait_apply() says the IO boost value is increased
in sugov_iowait_apply() and, in the same sentence, that it is decreased by
the same function. That is self-contradictory, and the first part is wrong:
sugov_iowait_apply() only decreases the boost.

The boost is actually increased in sugov_iowait_boost(). Fix the comment to
name sugov_iowait_boost() as the place where the boost is increased, so it
matches the code.

No functional change.

Fixes: fd7d5287fd65 ("cpufreq: schedutil: Cleanup and document iowait boost")
Signed-off-by: Zhongqiu Han <zhongqiu.han@oss.qualcomm.com>
---
 kernel/sched/cpufreq_schedutil.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/sched/cpufreq_schedutil.c b/kernel/sched/cpufreq_schedutil.c
index a4e689eefdfb..f7aa26d62700 100644
--- a/kernel/sched/cpufreq_schedutil.c
+++ b/kernel/sched/cpufreq_schedutil.c
@@ -314,7 +314,7 @@ static void sugov_iowait_boost(struct sugov_cpu *sg_cpu, u64 time,
  * A CPU running a task which woken up after an IO operation can have its
  * utilization boosted to speed up the completion of those IO operations.
  * The IO boost value is increased each time a task wakes up from IO, in
- * sugov_iowait_apply(), and it's instead decreased by this function,
+ * sugov_iowait_boost(), and it's instead decreased by this function,
  * each time an increase has not been requested (!iowait_boost_pending).
  *
  * A CPU which also appears to have been idle for at least one tick has also
-- 
2.43.0

Re: [PATCH] cpufreq: schedutil: Fix self-contradictory comment in sugov_iowait_apply()

[Christian Loehle]

On 7/3/26 10:24, Zhongqiu Han wrote:
> The kerneldoc of sugov_iowait_apply() says the IO boost value is increased
> in sugov_iowait_apply() and, in the same sentence, that it is decreased by
> the same function. That is self-contradictory, and the first part is wrong:
> sugov_iowait_apply() only decreases the boost.
> 
> The boost is actually increased in sugov_iowait_boost(). Fix the comment to
> name sugov_iowait_boost() as the place where the boost is increased, so it
> matches the code.
> 
> No functional change.
> 
> Fixes: fd7d5287fd65 ("cpufreq: schedutil: Cleanup and document iowait boost")
> Signed-off-by: Zhongqiu Han <zhongqiu.han@oss.qualcomm.com>

Reviewed-by: Christian Loehle <christian.loehle@arm.com>

> ---
>  kernel/sched/cpufreq_schedutil.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/kernel/sched/cpufreq_schedutil.c b/kernel/sched/cpufreq_schedutil.c
> index a4e689eefdfb..f7aa26d62700 100644
> --- a/kernel/sched/cpufreq_schedutil.c
> +++ b/kernel/sched/cpufreq_schedutil.c
> @@ -314,7 +314,7 @@ static void sugov_iowait_boost(struct sugov_cpu *sg_cpu, u64 time,
>   * A CPU running a task which woken up after an IO operation can have its
>   * utilization boosted to speed up the completion of those IO operations.
>   * The IO boost value is increased each time a task wakes up from IO, in
> - * sugov_iowait_apply(), and it's instead decreased by this function,
> + * sugov_iowait_boost(), and it's instead decreased by this function,
>   * each time an increase has not been requested (!iowait_boost_pending).
>   *
>   * A CPU which also appears to have been idle for at least one tick has also