[PATCH v5 0/4] cpupower: fix various man pages issues

[PATCH v5 0/4] cpupower: fix various man pages issues

[Roberto Ricci]

This patch series fixes a few issues with the cpupower manual pages,
such as missing or incorrect options and trailing whitespace.

Signed-off-by: Roberto Ricci <io@r-ricci.it>

---
Changes in v5:
- Drop whitespace removal patches
  Link to v4: https://lore.kernel.org/linux-pm/20260324013543.4776-1-io@r-ricci.it/

Changes in v4:
- Remove Fixes tags from commit messages
- Fix issues reported by scripts/checkpatch.pl
- Add patches to trim whitespace from some files
- Add cover letter
  Link to v3: https://lore.kernel.org/linux-pm/20260312102029.14980-1-io@r-ricci.it/

Changes in v3:
- Resend because v2 patches have been incorrectly sent as replies to
  individual v1 messages.
  Links to v2:
  - https://lore.kernel.org/linux-pm/abH7pF9p8KxAsHIE@desktop0a/
  - https://lore.kernel.org/linux-pm/abH9KsKbvyi-iceb@desktop0a/
  - https://lore.kernel.org/linux-pm/abH9rMVuy8wmzgkG@desktop0a/
  - https://lore.kernel.org/linux-pm/abH9_Jk-ckkJvsGb@desktop0a/

Changes in v2:
- More descriptive commit messages
  Links to v1:
  - https://lore.kernel.org/linux-pm/abHAZj9xwfDf5JVZ@desktop0a/
  - https://lore.kernel.org/linux-pm/abHAdH-ggaxUugCy@desktop0a/
  - https://lore.kernel.org/linux-pm/abHAhAg-6gaK0Qn7@desktop0a/
  - https://lore.kernel.org/linux-pm/abHAkgiPg8VDpDoV@desktop0a/
---

Roberto Ricci (4):
  cpupower-idle-info.1: fix short option names
  cpupower-frequency-info.1: use the proper name of the --perf option
  cpupower-frequency-info.1: document --boost and --epp options
  cpupower-info.1: describe the --perf-bias option

 tools/power/cpupower/man/cpupower-frequency-info.1 | 8 +++++++-
 tools/power/cpupower/man/cpupower-idle-info.1      | 4 ++--
 tools/power/cpupower/man/cpupower-info.1           | 9 ++++++++-
 3 files changed, 17 insertions(+), 4 deletions(-)

-- 
2.53.0

[PATCH v5 1/4] cpupower-idle-info.1: fix short option names

[Roberto Ricci]

The cpupower-idle-info(1) man page describes '-f' as the short form of the
'--silent' option and '-e' as the short form of the '--proc' option.
But they are not correct:

$ cpupower idle-info -f
idle-info: invalid option -- 'f'
invalid or unknown argument
$ cpupower idle-info -e
idle-info: invalid option -- 'e'
invalid or unknown argument

The short form of '--silent' is actually '-s' and the short form of
'--proc' is actually '-o':

cpuidle-info.c:
	{"silent", no_argument, NULL, 's'},
	{"proc", no_argument, NULL, 'o'},

Signed-off-by: Roberto Ricci <io@r-ricci.it>
---
 tools/power/cpupower/man/cpupower-idle-info.1 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/tools/power/cpupower/man/cpupower-idle-info.1 b/tools/power/cpupower/man/cpupower-idle-info.1
index 20b6345c53ad..b2f92aba5f5b 100644
--- a/tools/power/cpupower/man/cpupower-idle-info.1
+++ b/tools/power/cpupower/man/cpupower-idle-info.1
@@ -11,10 +11,10 @@ A tool which prints out per cpu idle information helpful to developers and inter
 .SH "OPTIONS"
 .LP
 .TP
-\fB\-f\fR \fB\-\-silent\fR
+\fB\-s\fR \fB\-\-silent\fR
 Only print a summary of all available C-states in the system.
 .TP
-\fB\-e\fR \fB\-\-proc\fR
+\fB\-o\fR \fB\-\-proc\fR
 deprecated.
 Prints out idle information in old /proc/acpi/processor/*/power format. This
 interface has been removed from the kernel for quite some time, do not let
-- 
2.53.0

[PATCH v5 2/4] cpupower-frequency-info.1: use the proper name of the --perf option

[Roberto Ricci]

The cpupower-frequency-info(1) man page describes a '--perf' option.
Even though this form is accepted by the program, its proper name is
'--performance'.

cpufreq-info.c:
	{"performance", no_argument,	 NULL,	 'c'},

Signed-off-by: Roberto Ricci <io@r-ricci.it>
---
 tools/power/cpupower/man/cpupower-frequency-info.1 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/power/cpupower/man/cpupower-frequency-info.1 b/tools/power/cpupower/man/cpupower-frequency-info.1
index 47fdd7218748..1173d4f31e69 100644
--- a/tools/power/cpupower/man/cpupower-frequency-info.1
+++ b/tools/power/cpupower/man/cpupower-frequency-info.1
@@ -53,7 +53,7 @@ human\-readable output for the \-f, \-w, \-s and \-y parameters.
 \fB\-n\fR \fB\-\-no-rounding\fR
 Output frequencies and latencies without rounding off values.
 .TP  
-\fB\-c\fR \fB\-\-perf\fR
+\fB\-c\fR \fB\-\-performance\fR
 Get performances and frequencies capabilities of CPPC, by reading it from hardware (only available on the hardware with CPPC).
 .TP
 .SH "REMARKS"
-- 
2.53.0

[PATCH v5 3/4] cpupower-frequency-info.1: document --boost and --epp options

[Roberto Ricci]

`cpupower frequency-info` supports the '--boost' option since the program
was first added with commit 7fe2f6399a84 ("cpupowerutils - cpufrequtils
extended with quite some features"), but the man page lacks it.

'--epp' has been added with commit 5f567afc283f ("cpupower: Add support for
showing energy performance preference") but it has never been added to the
man page.

cpufreq-info.c:
	{"boost",	 no_argument,		 NULL,	 'b'},
	...
	{"epp",		 no_argument,		 NULL,	 'z'},

Signed-off-by: Roberto Ricci <io@r-ricci.it>
---
 tools/power/cpupower/man/cpupower-frequency-info.1 | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/tools/power/cpupower/man/cpupower-frequency-info.1 b/tools/power/cpupower/man/cpupower-frequency-info.1
index 1173d4f31e69..b0d69c9adcbd 100644
--- a/tools/power/cpupower/man/cpupower-frequency-info.1
+++ b/tools/power/cpupower/man/cpupower-frequency-info.1
@@ -32,6 +32,12 @@ Gets the currently used cpufreq policy.
 \fB\-g\fR \fB\-\-governors\fR
 Determines available cpufreq governors.
 .TP  
+\fB\-b\fR \fB\-\-boost\fR
+Gets the current boost state support.
+.TP
+\fB\-z\fR \fB\-\-epp\fR
+Gets the current EPP (energy performance preference).
+.TP
 \fB\-r\fR \fB\-\-related\-cpus\fR
 Determines which CPUs run at the same hardware frequency.
 .TP  
-- 
2.53.0

[PATCH v5 4/4] cpupower-info.1: describe the --perf-bias option

[Roberto Ricci]

The cpupower-info(1) man page only mentions the short form of the
'--perf-bias' option in the synopsys, but the long form is not documented
and its effect is not explained.

cpupower-info.c:
     {"perf-bias", optional_argument, NULL, 'b'},

Signed-off-by: Roberto Ricci <io@r-ricci.it>
---
 tools/power/cpupower/man/cpupower-info.1 | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/tools/power/cpupower/man/cpupower-info.1 b/tools/power/cpupower/man/cpupower-info.1
index 340bcd0be7de..1f42d8c388a0 100644
--- a/tools/power/cpupower/man/cpupower-info.1
+++ b/tools/power/cpupower/man/cpupower-info.1
@@ -3,7 +3,7 @@
 cpupower\-info \- Shows processor power related kernel or hardware configurations
 .SH SYNOPSIS
 .ft B
-.B cpupower info [ \-b ]
+.B cpupower info [\fIoptions\fP]
 
 .SH DESCRIPTION
 \fBcpupower info \fP shows kernel configurations or processor hardware
@@ -13,6 +13,13 @@ Some options are platform wide, some affect single cores. By default values
 of core zero are displayed only. cpupower --cpu all cpuinfo will show the
 settings of all cores, see cpupower(1) how to choose specific cores.
 
+.SH "OPTIONS"
+.LP
+.TP
+\fB\-b\fR \fB\-\-perf-bias\fR
+Gets the current performance bias value.
+.TP
+
 .SH "SEE ALSO"
 Options are described in detail in:
 
-- 
2.53.0

Re: [PATCH v5 2/4] cpupower-frequency-info.1: use the proper name of the --perf option

[Shuah Khan]

On 3/24/26 16:39, Roberto Ricci wrote:
> The cpupower-frequency-info(1) man page describes a '--perf' option.
> Even though this form is accepted by the program, its proper name is
> '--performance'.
> 
> cpufreq-info.c:
> 	{"performance", no_argument,	 NULL,	 'c'},
> 
> Signed-off-by: Roberto Ricci <io@r-ricci.it>
> ---
>   tools/power/cpupower/man/cpupower-frequency-info.1 | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/tools/power/cpupower/man/cpupower-frequency-info.1 b/tools/power/cpupower/man/cpupower-frequency-info.1
> index 47fdd7218748..1173d4f31e69 100644
> --- a/tools/power/cpupower/man/cpupower-frequency-info.1
> +++ b/tools/power/cpupower/man/cpupower-frequency-info.1
> @@ -53,7 +53,7 @@ human\-readable output for the \-f, \-w, \-s and \-y parameters.
>   \fB\-n\fR \fB\-\-no-rounding\fR
>   Output frequencies and latencies without rounding off values.
>   .TP
> -\fB\-c\fR \fB\-\-perf\fR
> +\fB\-c\fR \fB\-\-performance\fR

I would keep perf and also add performance since --perf and --performance
work - it is lot easier to type --perf

>   Get performances and frequencies capabilities of CPPC, by reading it from hardware (only available on the hardware with CPPC).
>   .TP
>   .SH "REMARKS"

thanks,
-- Shuah

Re: [PATCH v5 2/4] cpupower-frequency-info.1: use the proper name of the --perf option

[Shuah Khan]

On 3/24/26 17:06, Shuah Khan wrote:
> On 3/24/26 16:39, Roberto Ricci wrote:
>> The cpupower-frequency-info(1) man page describes a '--perf' option.
>> Even though this form is accepted by the program, its proper name is
>> '--performance'.
>>
>> cpufreq-info.c:
>>     {"performance", no_argument,     NULL,     'c'},
>>
>> Signed-off-by: Roberto Ricci <io@r-ricci.it>
>> ---
>>   tools/power/cpupower/man/cpupower-frequency-info.1 | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/tools/power/cpupower/man/cpupower-frequency-info.1 b/tools/power/cpupower/man/cpupower-frequency-info.1
>> index 47fdd7218748..1173d4f31e69 100644
>> --- a/tools/power/cpupower/man/cpupower-frequency-info.1
>> +++ b/tools/power/cpupower/man/cpupower-frequency-info.1
>> @@ -53,7 +53,7 @@ human\-readable output for the \-f, \-w, \-s and \-y parameters.
>>   \fB\-n\fR \fB\-\-no-rounding\fR
>>   Output frequencies and latencies without rounding off values.
>>   .TP
>> -\fB\-c\fR \fB\-\-perf\fR
>> +\fB\-c\fR \fB\-\-performance\fR
> 
> I would keep perf and also add performance since --perf and --performance
> work - it is lot easier to type --perf

You can send just this one patch unless there are dependencies with
others.

thanks,
-- Shuah

Re: [PATCH v5 2/4] cpupower-frequency-info.1: use the proper name of the --perf option

[Roberto Ricci]

On 2026-03-24 17:06 -0600, Shuah Khan wrote:
> On 3/24/26 16:39, Roberto Ricci wrote:
> > The cpupower-frequency-info(1) man page describes a '--perf' option.
> > Even though this form is accepted by the program, its proper name is
> > '--performance'.
> > 
> > cpufreq-info.c:
> > 	{"performance", no_argument,	 NULL,	 'c'},
> > [...]
> > --- a/tools/power/cpupower/man/cpupower-frequency-info.1
> > +++ b/tools/power/cpupower/man/cpupower-frequency-info.1
> > @@ -53,7 +53,7 @@ human\-readable output for the \-f, \-w, \-s and \-y parameters.
> >   \fB\-n\fR \fB\-\-no-rounding\fR
> >   Output frequencies and latencies without rounding off values.
> >   .TP
> > -\fB\-c\fR \fB\-\-perf\fR
> > +\fB\-c\fR \fB\-\-performance\fR
> 
> I would keep perf and also add performance since --perf and --performance
> work - it is lot easier to type --perf

--perf would still be accepted by the program, whether or not the man
page mentions it. getopt_long() accepts any abbreviation which is not
ambiguous. While I agree that it would be nice to remind users about
abbreviations, why should the man page suggest an arbitrary one out of
the many accepted? And what about the other options (such as
--governors)? Suggesting an abbreviated long form only for --performance
would be inconsistent. The general convention is to list the one-letter
form and the complete long form. Also, if you want to save typing during
interactive use, you can use -c.

Re: [PATCH v5 0/4] cpupower: fix various man pages issues

[Shuah Khan]

On 3/24/26 16:39, Roberto Ricci wrote:
> This patch series fixes a few issues with the cpupower manual pages,
> such as missing or incorrect options and trailing whitespace.
> 
> Signed-off-by: Roberto Ricci <io@r-ricci.it>
> 
> ---
> Changes in v5:
> - Drop whitespace removal patches
>    Link to v4: https://lore.kernel.org/linux-pm/20260324013543.4776-1-io@r-ricci.it/
> 

Applied to my cpupower branch - I will send this my next pr to
PM maintainer.

https://web.git.kernel.org/pub/scm/linux/kernel/git/shuah/linux.git/log/?h=cpupower

thanks,
-- Shuah