[PATCH] tools/power/cpupower: Add documentation for some recently introduced options

[PATCH] tools/power/cpupower: Add documentation for some recently introduced options

[Tor Vic]

The 'cpupower-set' tool has learned new options with commits:

  f2ab5557119a "cpupower: Add EPP value change support"
  df8776b03689 "cpupower: Add support for amd_pstate mode change"
  eb426fc6bdd6 "cpupower: Add turbo-boost support in cpupower"

However, the corresponding manpage was never updated.

Add a basic description of these new options to the existing manpage.

Signed-off-by: Tor Vic <torvic9@mailbox.org>
---
 tools/power/cpupower/man/cpupower-set.1 | 38 +++++++++++++++++++++++--
 1 file changed, 36 insertions(+), 2 deletions(-)

diff --git a/tools/power/cpupower/man/cpupower-set.1 b/tools/power/cpupower/man/cpupower-set.1
index 2bcc696f4496..500653ef98c7 100644
--- a/tools/power/cpupower/man/cpupower-set.1
+++ b/tools/power/cpupower/man/cpupower-set.1
@@ -3,7 +3,7 @@
 cpupower\-set \- Set processor power related kernel or hardware configurations
 .SH SYNOPSIS
 .ft B
-.B cpupower set [ \-b VAL ]
+.B cpupower set [ \-b VAL | \-e POLICY | \-m MODE | \-t BOOL ]
 
 
 .SH DESCRIPTION
@@ -19,7 +19,7 @@ described in the Options sections.
 Use \fBcpupower info \fP to read out current settings and whether they are
 supported on the system at all.
 
-.SH Options
+.SH OPTIONS
 .PP
 \-\-perf-bias, \-b
 .RS 4
@@ -56,6 +56,40 @@ Use \fBcpupower -c all info -b\fP to verify.
 This options needs the msr kernel driver (CONFIG_X86_MSR) loaded.
 .RE
 
+.PP
+\-\-epp, \-e
+.RS 4
+Sets the energy performance policy preference on supported Intel or AMD
+processors which use the Intel or AMD P-State cpufreq driver respectively.
+
+Available policies can be found with
+\fBcat /sys/devices/system/cpu/cpufreq/policy0/energy_performance_available_preferences\fP :
+.RS 4
+default performance balance_performance balance_power power
+.RE
+
+.RE
+
+.PP
+\-\-amd\-pstate\-mode, \-m
+.RS 4
+Sets the AMD P-State mode for supported AMD processors.
+Available modes are "active", "guided" or "passive".
+
+Refer to the AMD P-State kernel documentation for further information.
+
+.RE
+
+.PP
+\-\-turbo\-boost, \-t
+.RS 4
+This option is used to enable or disable the turbo boost feature on
+supported Intel and AMD processors.
+
+This option takes as parameter either \fB1\fP to enable, or \fB0\fP to disable the feature.
+
+.RE
+
 .SH "SEE ALSO"
 cpupower-info(1), cpupower-monitor(1), powertop(1)
 .PP
-- 
2.46.1

Re: [PATCH] tools/power/cpupower: Add documentation for some recently introduced options

[Shuah Khan]

On 9/24/24 08:17, Tor Vic wrote:
> The 'cpupower-set' tool has learned new options with commits:
> 
>    f2ab5557119a "cpupower: Add EPP value change support"
>    df8776b03689 "cpupower: Add support for amd_pstate mode change"
>    eb426fc6bdd6 "cpupower: Add turbo-boost support in cpupower"


Thank you for finding and fixing this.

Checkpatch complains about commit description format. I fixed them
for now.

This patch will be applied once the merge window closes.

> 
> However, the corresponding manpage was never updated.

Thank you for finding and fixing this.

This patch will be applied once the merge window closes.
> 
> Add a basic description of these new options to the existing manpage.
> 
> Signed-off-by: Tor Vic <torvic9@mailbox.org>
> ---

thanks,
-- Shuah

Re: [PATCH] tools/power/cpupower: Add documentation for some recently introduced options

[Shuah Khan]

On 9/24/24 12:36, Shuah Khan wrote:
> On 9/24/24 08:17, Tor Vic wrote:
>> The 'cpupower-set' tool has learned new options with commits:
>>
>>    f2ab5557119a "cpupower: Add EPP value change support"
>>    df8776b03689 "cpupower: Add support for amd_pstate mode change"
>>    eb426fc6bdd6 "cpupower: Add turbo-boost support in cpupower"
> 
> 
> Thank you for finding and fixing this.
> 
> Checkpatch complains about commit description format. I fixed them
> for now.
> 
> This patch will be applied once the merge window closes.
> 
>>
>> However, the corresponding manpage was never updated.
> 
> Thank you for finding and fixing this.
> 
> This patch will be applied once the merge window closes.
>>
>> Add a basic description of these new options to the existing manpage.
>>
>> Signed-off-by: Tor Vic <torvic9@mailbox.org>
>> ---
> 

Thank you. Applied to
https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux.git/log/?h=cpupower

It will be included in my next pull request to PM maintainer.

thanks,
-- Shuah