man: explicit say for priority/weight values whether more is more or less

Fixes: #17523
This commit is contained in:
Lennart Poettering 2021-05-26 11:23:06 +02:00 committed by Luca Boccassi
parent bb635f3706
commit 7dbc38db50
2 changed files with 34 additions and 26 deletions

View file

@ -1036,8 +1036,10 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
<varlistentry> <varlistentry>
<term><varname>Nice=</varname></term> <term><varname>Nice=</varname></term>
<listitem><para>Sets the default nice level (scheduling priority) for executed processes. Takes an integer <listitem><para>Sets the default nice level (scheduling priority) for executed processes. Takes an
between -20 (highest priority) and 19 (lowest priority). See integer between -20 (highest priority) and 19 (lowest priority). In case of resource contention,
smaller values mean more resources will be made available to the unit's processes, larger values mean
less resources will be made available. See
<citerefentry><refentrytitle>setpriority</refentrytitle><manvolnum>2</manvolnum></citerefentry> for <citerefentry><refentrytitle>setpriority</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
details.</para></listitem> details.</para></listitem>
</varlistentry> </varlistentry>
@ -1054,11 +1056,13 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
<varlistentry> <varlistentry>
<term><varname>CPUSchedulingPriority=</varname></term> <term><varname>CPUSchedulingPriority=</varname></term>
<listitem><para>Sets the CPU scheduling priority for executed processes. The available priority range depends <listitem><para>Sets the CPU scheduling priority for executed processes. The available priority range
on the selected CPU scheduling policy (see above). For real-time scheduling policies an integer between 1 depends on the selected CPU scheduling policy (see above). For real-time scheduling policies an
(lowest priority) and 99 (highest priority) can be used. See integer between 1 (lowest priority) and 99 (highest priority) can be used. In case of CPU resource
<citerefentry project='man-pages'><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry> for contention, smaller values mean less CPU time is made available to the service, larger values mean
details. </para></listitem> more. See <citerefentry
project='man-pages'><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
for details. </para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1122,11 +1126,13 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
<varlistentry> <varlistentry>
<term><varname>IOSchedulingPriority=</varname></term> <term><varname>IOSchedulingPriority=</varname></term>
<listitem><para>Sets the I/O scheduling priority for executed processes. Takes an integer between 0 (highest <listitem><para>Sets the I/O scheduling priority for executed processes. Takes an integer between 0
priority) and 7 (lowest priority). The available priorities depend on the selected I/O scheduling class (see (highest priority) and 7 (lowest priority). In case of I/O contention, smaller values mean more I/O
above). If the empty string is assigned to this option, all prior assignments to both bandwidth is made available to the unit's processes, larger values mean less bandwidth. The available
<varname>IOSchedulingClass=</varname> and <varname>IOSchedulingPriority=</varname> have no effect. priorities depend on the selected I/O scheduling class (see above). If the empty string is assigned
See <citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry> for to this option, all prior assignments to both <varname>IOSchedulingClass=</varname> and
<varname>IOSchedulingPriority=</varname> have no effect. See
<citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
details.</para></listitem> details.</para></listitem>
</varlistentry> </varlistentry>

View file

@ -180,13 +180,14 @@
<term><varname>StartupCPUWeight=<replaceable>weight</replaceable></varname></term> <term><varname>StartupCPUWeight=<replaceable>weight</replaceable></varname></term>
<listitem> <listitem>
<para>Assign the specified CPU time weight to the processes executed, if the unified control group hierarchy <para>Assign the specified CPU time weight to the processes executed, if the unified control group
is used on the system. These options take an integer value and control the <literal>cpu.weight</literal> hierarchy is used on the system. These options take an integer value and control the
control group attribute. The allowed range is 1 to 10000. Defaults to 100. For details about this control <literal>cpu.weight</literal> control group attribute. The allowed range is 1 to 10000. Defaults to
group attribute, see <ulink 100. For details about this control group attribute, see <ulink
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html">Control Groups v2</ulink> and <ulink url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html">Control Groups v2</ulink>
url="https://www.kernel.org/doc/html/latest/scheduler/sched-design-CFS.html">CFS Scheduler</ulink>. and <ulink url="https://www.kernel.org/doc/html/latest/scheduler/sched-design-CFS.html">CFS
The available CPU time is split up among all units within one slice relative to their CPU time weight.</para> Scheduler</ulink>. The available CPU time is split up among all units within one slice relative to
their CPU time weight. A higher weight means more CPU time, a lower weight means less.</para>
<para>While <varname>StartupCPUWeight=</varname> only applies to the startup phase of the system, <para>While <varname>StartupCPUWeight=</varname> only applies to the startup phase of the system,
<varname>CPUWeight=</varname> applies to normal runtime of the system, and if the former is not set also to <varname>CPUWeight=</varname> applies to normal runtime of the system, and if the former is not set also to
@ -435,13 +436,14 @@
<term><varname>StartupIOWeight=<replaceable>weight</replaceable></varname></term> <term><varname>StartupIOWeight=<replaceable>weight</replaceable></varname></term>
<listitem> <listitem>
<para>Set the default overall block I/O weight for the executed processes, if the unified control group <para>Set the default overall block I/O weight for the executed processes, if the unified control
hierarchy is used on the system. Takes a single weight value (between 1 and 10000) to set the default block group hierarchy is used on the system. Takes a single weight value (between 1 and 10000) to set the
I/O weight. This controls the <literal>io.weight</literal> control group attribute, which defaults to default block I/O weight. This controls the <literal>io.weight</literal> control group attribute,
100. For details about this control group attribute, see <ulink which defaults to 100. For details about this control group attribute, see <ulink
url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#io-interface-files">IO Interface Files</ulink>. url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#io-interface-files">IO
The available I/O bandwidth is split up among all units within one slice relative to their block Interface Files</ulink>. The available I/O bandwidth is split up among all units within one slice
I/O weight.</para> relative to their block I/O weight. A higher weight means more I/O bandwidth, a lower weight means
less.</para>
<para>While <varname>StartupIOWeight=</varname> only applies <para>While <varname>StartupIOWeight=</varname> only applies
to the startup phase of the system, to the startup phase of the system,