From 41d8e791625544d98ea9465f2767f91e0a561f39 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Lyson=C4=9Bk?= Date: Mon, 11 Sep 2017 16:05:53 +0200 Subject: [PATCH 1/3] Update man pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Ondřej Lysoněk --- man/tuned-adm.8 | 35 ++++++++++++++++++++++------------- man/tuned-profiles-compat.7 | 7 +++---- man/tuned-profiles.7 | 9 ++++----- man/tuned.8 | 3 --- man/tuned.conf.5 | 16 ++++++++-------- 5 files changed, 37 insertions(+), 33 deletions(-) diff --git a/man/tuned-adm.8 b/man/tuned-adm.8 index 933ad75..ec99f4f 100644 --- a/man/tuned-adm.8 +++ b/man/tuned-adm.8 @@ -21,7 +21,7 @@ .\" .TH TUNED_ADM "8" "30 Mar 2017" "Fedora Power Management SIG" "tuned" .SH NAME -tuned\-adm - commandline tool for switching between different tuning profiles +tuned\-adm - command line tool for switching between different tuning profiles .SH SYNOPSIS .B tuned\-adm .RB [ list " | " active " | " "profile \fI[profile]\fP" " | " off " | " verify " | " recommend ] @@ -32,8 +32,8 @@ profiles. Several predefined profiles are already included. You can even create your own profile, either based on one of the existing ones by copying it or make a completely new one. The distribution provided profiles are stored in subdirectories below \fI/usr/lib/tuned\fP and the user defined profiles in -subdirectories below \fI/etc/tuned\fP. If there are same profiles on both places, -user defined profiles have precedence. +subdirectories below \fI/etc/tuned\fP. If there are profiles with the same name +in both places, user defined profiles have precedence. .SH "OPTIONS" @@ -47,26 +47,35 @@ List all available profiles. Show current active profile. .TP -.BI "profile " [PROFILE] -Switches to the given profilename. If none is given then all available profiles +.BI "profile " [PROFILE_NAME] +Switches to the given profile. If none is given then all available profiles are listed. If the profile given is not valid the command gracefully exits without performing any operation. .TP .B verify Verifies current profile against system settings. Outputs information whether -system settings matches current profile or not (e.g. somebody modified -sysfs/sysctl value by hand). Detailed information what is checked, what +system settings match current profile or not (e.g. somebody modified +a sysfs/sysctl value by hand). Detailed information about what is checked, what value is set and what value is expected can be found in the log. .TP .B recommend -Recommend profile suitable for your system. Currently only static detection is -implemented - it decides according to data in /etc/system\-release\-cpe and -virt\-what output. The rules for autodetection are defined in recommend.conf in -profile directory. They can be overridden by user by putting the recommend.conf -into /etc/tuned. The default rules recommend profiles targeted to the best -performance or balanced profile if unsure. +Recommend a profile suitable for your system. Currently only static detection is +implemented - it decides according to data in \fI/etc/system\-release\-cpe\fP +and virt\-what output. The rules for autodetection are defined in the file +\fI/usr/lib/tuned/recommend.d/50-tuned.conf\fP. The default rules recommend profiles +targeted to the best performance, or the balanced profile if unsure. + +The default rules can be overridden by the user by putting a file named +\fIrecommend.conf\fP into /etc/tuned, or by creating a file in the +\fI/etc/tuned/recommend.d\fP directory. The file \fI/etc/tuned/recommend.conf\fP +is evaluated first. If no match is found, the files in the +\fI/etc/tuned/recommend.d\fP directory are merged with the files in the +\fI/usr/lib/tuned/recommend.d\fP directory (if there is a file with the same +name in both directories, the one from \fI/etc/tuned/recommend.d\fP is used) +and the files are evaluated in alphabetical order. The first matching +entry is used. .TP .B off diff --git a/man/tuned-profiles-compat.7 b/man/tuned-profiles-compat.7 index e5190b3..54f6aa7 100644 --- a/man/tuned-profiles-compat.7 +++ b/man/tuned-profiles-compat.7 @@ -65,14 +65,13 @@ an alias to powersave profile. Strong power saving profile directed at machines with classic HDDs. It enables aggressive disk spin-down. Disk writeback values are increased and disk swappiness is lowered. Log syncing is disabled. All partitions are remounted -with 'noatime' option. All tuned plugins are disabled. +with 'noatime' option. .TP .BI "enterprise\-storage" Server profile for high disk throughput performance tuning. Disables power -saving mechanisms and enables deadline IO scheduler. Enables hugepages and -disables disk barriers. Disk readahead values are increased. CPU governor is -set to performance. +saving mechanisms and enables hugepages. Disk readahead values are increased. +CPU governor is set to performance. .SH "FILES" .nf diff --git a/man/tuned-profiles.7 b/man/tuned-profiles.7 index a159044..59d4890 100644 --- a/man/tuned-profiles.7 +++ b/man/tuned-profiles.7 @@ -49,7 +49,7 @@ At the moment we're providing the following pre\-defined profiles: .BI "balanced" It is the default profile. It provides balanced power saving and performance. At the moment it enables CPU and disk plugins of tuned and it makes sure the -ondemand governor is active (if supported by the current cpufreq driver). +conservative governor is active (if supported by the current cpufreq driver). It enables ALPM power saving for SATA host adapters and sets the link power management policy to medium_power. It also sets the CPU energy performance bias to normal. It also enables AC97 audio power saving or (it depends on @@ -62,9 +62,8 @@ configures it to automatic power saving. Maximal power saving, at the moment it enables USB autosuspend (in case environment variable USB_AUTOSUSPEND is set to 1), enables ALPM power saving for SATA host adapters and sets the link power management policy to min_power. -It also enables WiFi power saving, enables multi core power savings scheduler -for low wakeup systems and makes sure the ondemand governor is active (if -supported by the current cpufreq driver). It sets the CPU energy performance +It also enables WiFi power saving and makes sure the ondemand governor is active +(if supported by the current cpufreq driver). It sets the CPU energy performance bias to powersave. It also enables AC97 audio power saving or (it depends on your system) HDA\-Intel power savings (with 10 seconds timeout). In case your system contains supported Radeon graphics card (with enabled KMS) it @@ -81,7 +80,7 @@ performance bias is set to performance. Disk readahead values are increased. .TP .BI "latency\-performance" Profile for low latency performance tuning. Disables power saving mechanisms. -CPU governor is set to performance andlocked to the low C states (by PM QoS). +CPU governor is set to performance and locked to the low C states (by PM QoS). CPU energy performance bias to performance. .TP diff --git a/man/tuned.8 b/man/tuned.8 index 4636206..06c6061 100644 --- a/man/tuned.8 +++ b/man/tuned.8 @@ -31,9 +31,6 @@ usage. .SH OPTIONS .TP 12 -.BI \-c " CONFFILE" "\fR, \fP" \fB\-\-conffile= \fICONFFILE\fP -Specify the name and path of the configuration file. By default the \fB/etc/tuned.conf\fP is used. -.TP 12 .BI \-d "\fR, \fP" \-\-daemon This options starts \fBtuned\fP as a daemon as opposed to in the foreground without forking at startup. diff --git a/man/tuned.conf.5 b/man/tuned.conf.5 index 1660f34..4871dae 100644 --- a/man/tuned.conf.5 +++ b/man/tuned.conf.5 @@ -2,8 +2,8 @@ .SH NAME tuned.conf - Tuned profile definition .SH DESCRIPTION -This man page documents format of Tuned 2.0 profile definition files. Profile is -stored in /etc/tuned//tuned.conf or in +This man page documents format of Tuned 2.0 profile definition files. +The profile definition is stored in /etc/tuned//tuned.conf or in /usr/lib/tuned//tuned.conf file where the /etc/tuned/ directory has higher priority. @@ -14,9 +14,9 @@ The main section is called "[main]" and can contain following options: .TP include= -Includes config file defined as value. Config file can be defined as full path -or by the profile name to which it belongs. -If this parameter is present, the histogram will be shown at the end of the measurement. +Includes a profile with the given name. This allows you to base a new profile +on an already existing profile. In case there are conflicting parameters in the +new profile and the base profile, the parameters from the new profile are used. .SH PLUGINS Every other section defines one plugin. The name of the section is used as name @@ -30,9 +30,9 @@ Every plugin section can contain following sections: .TP type= Plugin type. Currently there are following upstream plugins: audio, bootloader, cpu, disk, -eeepc_she, mounts, net script, selinux, scheduler, sysctl, sysfs, usb, video, vm. This -list may be incomplete. If you installed tuned through RPM you can list upstream plugins by -the following command: +eeepc_she, modules, mounts, net, script, scsi_host, selinux, scheduler, sysctl, +sysfs, systemd, usb, video, vm. This list may be incomplete. If you installed +tuned through RPM you can list upstream plugins by the following command: .B rpm -ql tuned | grep 'plugins/plugin_.*.py$' Check the plugins directory returned by this command to see all plugins (e.g. plugins provided by 3rd party packages). From 297a154440b39b36278ecdafda643fdca6285d38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Lyson=C4=9Bk?= Date: Tue, 12 Sep 2017 13:16:01 +0200 Subject: [PATCH 2/3] Update README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Ondřej Lysoněk --- README | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README b/README index 860ece9..46ee620 100644 --- a/README +++ b/README @@ -37,21 +37,20 @@ To switch to a different profile, run: # tuned-adm profile -And to disable all tunings, run: +Your profile choice is also written into /etc/tuned/active_profile and this +choice is used when the daemon is restarted (e.g. with the machine reboot). + +To disable all tunings, run: +# tuned-adm off # tuned-adm recommend Recommend profile suitable for your system. Currently only static detection is implemented - it decides according to data in /etc/system-release-cpe and -virt-what output. The rules for autodetection are defined in recommend.conf -in profile directory. They can be overridden by user by putting the -recommend.conf into /etc/tuned. The default rules recommends profiles targeted -to the best performance or balanced profile if unsure. - -# tuned-adm off - -Your profile choice is also written into /etc/tuned/active_profile and this -choice is used when the daemon is restarted (e.g. with the machine reboot). - +virt-what output. The rules for autodetection are defined in the file +/usr/lib/tuned/recommend.d/50-tuned.conf. They can be overridden by the user by +putting a file to /etc/tuned/recommend.d or a file named recommend.conf into +/etc/tuned (see tuned-adm(8) for more details). The default rules recommend +profiles targeted to the best performance or the balanced profile if unsure. Available tunings ----------------- From fed000fd6430f4aad2180f10d7e93547314093cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Lyson=C4=9Bk?= Date: Tue, 12 Sep 2017 13:16:30 +0200 Subject: [PATCH 3/3] Fix typos in TIPS.txt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Ondřej Lysoněk --- doc/TIPS.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/TIPS.txt b/doc/TIPS.txt index 6c5680a..36b4071 100644 --- a/doc/TIPS.txt +++ b/doc/TIPS.txt @@ -2,12 +2,12 @@ * Use a properly dimensioned system for the job (no need for overpowered systems for simple Desktop use e.g.). * For servers consolidate services on fewer systems to maximize efficiency of each system. * For a server farm consolidating all physical machines on one bigger server and then using Virtualization. -* Enforce turning of machines that are not used (e.g. company policy). +* Enforce turning off machines that are not used (e.g. company policy). * Try to establish a company culture that is Green "aware", including but not limited to the above point. -* Unplug and/or turn of peripherals that aren't used (e.g. external USB devices, monitors, printers, scanners). -* Turn of unused hardware already in BIOS. +* Unplug and/or turn off peripherals that aren't used (e.g. external USB devices, monitors, printers, scanners). +* Turn off unused hardware already in BIOS. * Disable power hungry features. -* Enable CPU scaling if supported for ondemand CPU governor. DONT use powersave governor, typically uses more power than ondemand +* Enable CPU scaling if supported for ondemand CPU governor. DO NOT use powersave governor, typically uses more power than ondemand (race to idle). * Put network card to 100 mbit/10 mbit: ** 10 mbit: ethtool -s eth0 advertise 0x002 @@ -25,7 +25,7 @@ ** mount -o remount,relatime / * Enable USB autosuspend by adding the following to the kernel boot commandline: ** usbcore.autosuspend=5 -* Screensaver needs to dpms off the screen, not just make colors black. To turn of monitor after 120s when X is running: +* Screensaver needs to dpms off the screen, not just make colors black. To turn off monitor after 120s when X is running: ** xset dpms 0 0 120 === Simple programmer tips for improving power usage ===