mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH v2] cpufreq: Documentation: fix freq_step description
@ 2026-06-03  5:56 Pengjie Zhang
  2026-06-03 13:31 ` Zhongqiu Han
  0 siblings, 1 reply; 3+ messages in thread
From: Pengjie Zhang @ 2026-06-03  5:56 UTC (permalink / raw)
  To: rafael, viresh.kumar, corbet, skhan
  Cc: linux-pm, linux-doc, linux-kernel, linuxarm, zhanjie9,
	prime.zeng, wanghuiqiang, xuwei5, lihuisong, zhenglifeng1,
	yubowen8, zhangpengjie2, wangzhi12, zhongqiu.han

The conservative governor documentation incorrectly states that setting
freq_step to 0 will use the default 5% frequency step. In reality, since
at least commit 8e677ce83bf4 ("[CPUFREQ] conservative: fixup governor to
function more like ondemand logic"), freq_step=0 has always caused the
governor to skip frequency updates entirely.

Correct the documentation to reflect the actual behavior: freq_step=0
disables frequency changes by the governor entirely.

Fixes: 2a0e49279850 ("cpufreq: User/admin documentation update and consolidation")
Signed-off-by: Pengjie Zhang <zhangpengjie2@huawei.com>
---
Changes in v2:
- Update commit message to reference the correct historical commit
  8e677ce83bf4 instead of b9170836d1aa, as the original implementation
  had asymmetric behavior for freq_step=0 (suggested by Zhongqiu Han).
- Link to v1:https://lore.kernel.org/all/20260529111122.3321645-1-zhangpengjie2@huawei.com/
---
 Documentation/admin-guide/pm/cpufreq.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/admin-guide/pm/cpufreq.rst b/Documentation/admin-guide/pm/cpufreq.rst
index dbe6d23a5d67..98c724d49047 100644
--- a/Documentation/admin-guide/pm/cpufreq.rst
+++ b/Documentation/admin-guide/pm/cpufreq.rst
@@ -586,8 +586,8 @@ This governor exposes the following tunables:
 	100 (5 by default).
 
 	This is how much the frequency is allowed to change in one go.  Setting
-	it to 0 will cause the default frequency step (5 percent) to be used
-	and setting it to 100 effectively causes the governor to periodically
+	it to 0 disables frequency changes by the governor entirely and setting
+	it to 100 effectively causes the governor to periodically
 	switch the frequency between the ``scaling_min_freq`` and
 	``scaling_max_freq`` policy limits.
 
-- 
2.33.0


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH v2] cpufreq: Documentation: fix freq_step description
  2026-06-03  5:56 [PATCH v2] cpufreq: Documentation: fix freq_step description Pengjie Zhang
@ 2026-06-03 13:31 ` Zhongqiu Han
  2026-06-08 13:34   ` Rafael J. Wysocki
  0 siblings, 1 reply; 3+ messages in thread
From: Zhongqiu Han @ 2026-06-03 13:31 UTC (permalink / raw)
  To: Pengjie Zhang, rafael, viresh.kumar, corbet, skhan
  Cc: linux-pm, linux-doc, linux-kernel, linuxarm, zhanjie9,
	prime.zeng, wanghuiqiang, xuwei5, lihuisong, zhenglifeng1,
	yubowen8, wangzhi12, zhongqiu.han

On 6/3/2026 1:56 PM, Pengjie Zhang wrote:
> The conservative governor documentation incorrectly states that setting
> freq_step to 0 will use the default 5% frequency step. In reality, since
> at least commit 8e677ce83bf4 ("[CPUFREQ] conservative: fixup governor to
> function more like ondemand logic"), freq_step=0 has always caused the
> governor to skip frequency updates entirely.
> 
> Correct the documentation to reflect the actual behavior: freq_step=0
> disables frequency changes by the governor entirely.
> 
> Fixes: 2a0e49279850 ("cpufreq: User/admin documentation update and consolidation")
> Signed-off-by: Pengjie Zhang <zhangpengjie2@huawei.com>
> ---
> Changes in v2:
> - Update commit message to reference the correct historical commit
>    8e677ce83bf4 instead of b9170836d1aa, as the original implementation
>    had asymmetric behavior for freq_step=0 (suggested by Zhongqiu Han).
> - Link to v1:https://lore.kernel.org/all/20260529111122.3321645-1-zhangpengjie2@huawei.com/


Looks good to me.

Reviewed-by: Zhongqiu Han <zhongqiu.han@oss.qualcomm.com>


> ---
>   Documentation/admin-guide/pm/cpufreq.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/admin-guide/pm/cpufreq.rst b/Documentation/admin-guide/pm/cpufreq.rst
> index dbe6d23a5d67..98c724d49047 100644
> --- a/Documentation/admin-guide/pm/cpufreq.rst
> +++ b/Documentation/admin-guide/pm/cpufreq.rst
> @@ -586,8 +586,8 @@ This governor exposes the following tunables:
>   	100 (5 by default).
>   
>   	This is how much the frequency is allowed to change in one go.  Setting
> -	it to 0 will cause the default frequency step (5 percent) to be used
> -	and setting it to 100 effectively causes the governor to periodically
> +	it to 0 disables frequency changes by the governor entirely and setting
> +	it to 100 effectively causes the governor to periodically
>   	switch the frequency between the ``scaling_min_freq`` and
>   	``scaling_max_freq`` policy limits.
>   


-- 
Thx and BRs,
Zhongqiu Han

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH v2] cpufreq: Documentation: fix freq_step description
  2026-06-03 13:31 ` Zhongqiu Han
@ 2026-06-08 13:34   ` Rafael J. Wysocki
  0 siblings, 0 replies; 3+ messages in thread
From: Rafael J. Wysocki @ 2026-06-08 13:34 UTC (permalink / raw)
  To: Zhongqiu Han, Pengjie Zhang
  Cc: viresh.kumar, corbet, skhan, linux-pm, linux-doc, linux-kernel,
	linuxarm, zhanjie9, prime.zeng, wanghuiqiang, xuwei5, lihuisong,
	zhenglifeng1, yubowen8, wangzhi12

On Wed, Jun 3, 2026 at 3:32 PM Zhongqiu Han
<zhongqiu.han@oss.qualcomm.com> wrote:
>
> On 6/3/2026 1:56 PM, Pengjie Zhang wrote:
> > The conservative governor documentation incorrectly states that setting
> > freq_step to 0 will use the default 5% frequency step. In reality, since
> > at least commit 8e677ce83bf4 ("[CPUFREQ] conservative: fixup governor to
> > function more like ondemand logic"), freq_step=0 has always caused the
> > governor to skip frequency updates entirely.
> >
> > Correct the documentation to reflect the actual behavior: freq_step=0
> > disables frequency changes by the governor entirely.
> >
> > Fixes: 2a0e49279850 ("cpufreq: User/admin documentation update and consolidation")
> > Signed-off-by: Pengjie Zhang <zhangpengjie2@huawei.com>
> > ---
> > Changes in v2:
> > - Update commit message to reference the correct historical commit
> >    8e677ce83bf4 instead of b9170836d1aa, as the original implementation
> >    had asymmetric behavior for freq_step=0 (suggested by Zhongqiu Han).
> > - Link to v1:https://lore.kernel.org/all/20260529111122.3321645-1-zhangpengjie2@huawei.com/
>
>
> Looks good to me.
>
> Reviewed-by: Zhongqiu Han <zhongqiu.han@oss.qualcomm.com>

Applied as 7.2 material, thanks!

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-06-08 13:34 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-06-03  5:56 [PATCH v2] cpufreq: Documentation: fix freq_step description Pengjie Zhang
2026-06-03 13:31 ` Zhongqiu Han
2026-06-08 13:34   ` Rafael J. Wysocki

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®