From: Lennart Poettering <lennart@poettering.net>
Date: Wed, 26 May 2021 09:23:06 +0000 (+0200)
Subject: man: explicit say for priority/weight values whether more is more or less
X-Git-Tag: v249-rc1~147
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7dbc38db509f153256d3a3bfe6cbb26e2731c741;p=thirdparty%2Fsystemd.git

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

Fixes: #17523
---

diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index b2fbb3b6441..893b56d93ad 100644
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -1036,8 +1036,10 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
       <varlistentry>
         <term><varname>Nice=</varname></term>
 
-        <listitem><para>Sets the default nice level (scheduling priority) for executed processes. Takes an integer
-        between -20 (highest priority) and 19 (lowest priority). See
+        <listitem><para>Sets the default nice level (scheduling priority) for executed processes. Takes an
+        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
         details.</para></listitem>
       </varlistentry>
@@ -1054,11 +1056,13 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
       <varlistentry>
         <term><varname>CPUSchedulingPriority=</varname></term>
 
-        <listitem><para>Sets the CPU scheduling priority for executed processes. The available priority range depends
-        on the selected CPU scheduling policy (see above). For real-time scheduling policies an integer between 1
-        (lowest priority) and 99 (highest priority) can be used. See
-        <citerefentry project='man-pages'><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
-        details. </para></listitem>
+        <listitem><para>Sets the CPU scheduling priority for executed processes. The available priority range
+        depends on the selected CPU scheduling policy (see above). For real-time scheduling policies an
+        integer between 1 (lowest priority) and 99 (highest priority) can be used. In case of CPU resource
+        contention, smaller values mean less CPU time is made available to the service, larger values mean
+        more. See <citerefentry
+        project='man-pages'><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+        for details. </para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -1122,11 +1126,13 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
       <varlistentry>
         <term><varname>IOSchedulingPriority=</varname></term>
 
-        <listitem><para>Sets the I/O scheduling priority for executed processes. Takes an integer between 0 (highest
-        priority) and 7 (lowest priority). The available priorities depend on the selected I/O scheduling class (see
-        above). If the empty string is assigned 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
+        <listitem><para>Sets the I/O scheduling priority for executed processes. Takes an integer between 0
+        (highest priority) and 7 (lowest priority). In case of I/O contention, smaller values mean more I/O
+        bandwidth is made available to the unit's processes, larger values mean less bandwidth. The available
+        priorities depend on the selected I/O scheduling class (see above). If the empty string is assigned
+        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>
       </varlistentry>
 
diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml
index 827f343a50a..a1856f06dd6 100644
--- a/man/systemd.resource-control.xml
+++ b/man/systemd.resource-control.xml
@@ -180,13 +180,14 @@
         <term><varname>StartupCPUWeight=<replaceable>weight</replaceable></varname></term>
 
         <listitem>
-          <para>Assign the specified CPU time weight to the processes executed, if the unified control group hierarchy
-          is used on the system. These options take an integer value and control the <literal>cpu.weight</literal>
-          control group attribute. The allowed range is 1 to 10000. 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">Control Groups v2</ulink> and <ulink
-          url="https://www.kernel.org/doc/html/latest/scheduler/sched-design-CFS.html">CFS Scheduler</ulink>.
-          The available CPU time is split up among all units within one slice relative to their CPU time weight.</para>
+          <para>Assign the specified CPU time weight to the processes executed, if the unified control group
+          hierarchy is used on the system. These options take an integer value and control the
+          <literal>cpu.weight</literal> control group attribute. The allowed range is 1 to 10000. 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">Control Groups v2</ulink>
+          and <ulink url="https://www.kernel.org/doc/html/latest/scheduler/sched-design-CFS.html">CFS
+          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,
           <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>
 
         <listitem>
-          <para>Set the default overall block I/O weight for the executed processes, if the unified control group
-          hierarchy is used on the system. Takes a single weight value (between 1 and 10000) to set the default block
-          I/O weight. This controls the <literal>io.weight</literal> control group attribute, 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>.
-          The available I/O bandwidth is split up among all units within one slice relative to their block
-          I/O weight.</para>
+          <para>Set the default overall block I/O weight for the executed processes, if the unified control
+          group hierarchy is used on the system. Takes a single weight value (between 1 and 10000) to set the
+          default block I/O weight. This controls the <literal>io.weight</literal> control group attribute,
+          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>.  The available I/O bandwidth is split up among all units within one slice
+          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
           to the startup phase of the system,