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

[PATCH v3 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'},

Fixes e7d85a934182d5bde1eea865169fbf2e0637a3ed ("cpupower: Add cpupower-idle-info manpage")

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 v3 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'},

Fixes 8382dce5e4835c045f33b8958a5f559d212cdd11 ("cpupower: Add "perf" option to print AMD P-State information")

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 v3 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'},

Fixes 7fe2f6399a84760a9af8896ac152728250f82adb ("cpupowerutils - cpufrequtils extended with quite some features")
Fixes 5f567afc283fc9e7c6a34d013c4fc6c5e8d6afae ("cpupower: Add support for showing energy performance preference")

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..1dc7536e13ab 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 v3 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.

Fixes 7fe2f6399a84760a9af8896ac152728250f82adb ("cpupowerutils - cpufrequtils extended with quite some features")

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..a8d5aee4381c 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 v3 1/4] cpupower-idle-info.1: fix short option names

[Shuah Khan]

On 3/12/26 04:20, Roberto Ricci wrote:
> 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'},
> 
> Fixes e7d85a934182d5bde1eea865169fbf2e0637a3ed ("cpupower: Add cpupower-idle-info manpage")

There is no need t for Fixes tag in any of these patches.
Fixes tag is used when you fix a bug in code. Using Fixes
for every single patch adds lot of churn for stable releases.

Remove Fixes tag from all these 4 patches and run checkpatch
before sending patches to me adding version information.

Incorrect fixes style in all of these 4 patches. Running checkpatch
helps you catch these error before I see them.

ERROR: Please use git commit description style 'commit <12+ chars of sha1> ("<title line>")' - ie: 'commit e7d85a934182 ("cpupower: Add cpupower-idle-info manpage")'
#86:


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

Adding changes in since patch v1 makes reviewers job easier.
We can easily our comments are addressed or not.


>   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

thanks,
-- Shuah

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

[Shuah Khan]

On 3/12/26 04:20, 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'},
> 
> Fixes 8382dce5e4835c045f33b8958a5f559d212cdd11 ("cpupower: Add "perf" option to print AMD P-State information")

Remove Fixes tag from all these 4 patches and run checkpatch
before sending patches to me adding version information.

thanks,
-- Shuah

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

[Shuah Khan]

On 3/12/26 04:20, Roberto Ricci wrote:
> 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.
> 
> Fixes 7fe2f6399a84760a9af8896ac152728250f82adb ("cpupowerutils - cpufrequtils extended with quite some features")
> 
> Signed-off-by: Roberto Ricci <io@r-ricci.it>

Remove Fixes tag from all these 4 patches and run checkpatch
before sending patches to me adding version information.

+ add a cover letter is helpful and makes it easier to comment
on things common across all patches such as these.

thanks,
-- Shuah

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

[Shuah Khan]

On 3/12/26 04:20, Roberto Ricci wrote:
> `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'},
> 
> Fixes 7fe2f6399a84760a9af8896ac152728250f82adb ("cpupowerutils - cpufrequtils extended with quite some features")
> Fixes 5f567afc283fc9e7c6a34d013c4fc6c5e8d6afae ("cpupower: Add support for showing energy performance preference")
> 

Remove Fixes tag from all these 4 patches and run checkpatch
before sending patches to me adding version information.

+ add a cover letter is helpful and makes it easier to comment
on things common across all patches such as these.

thanks,
-- Shuah