summaryrefslogtreecommitdiff
path: root/man/systemd.resource-control.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2022-04-26 22:04:31 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2022-04-28 15:46:44 +0200
commit6f83ea60e90b18e44cc979834aae2947afa66834 (patch)
tree3737967c9eda6e1961ae4d0dbd66727d1227a17d /man/systemd.resource-control.xml
parentc0a96b1b1d19a06a3828885b10a275c423a5e6f2 (diff)
downloadsystemd-6f83ea60e90b18e44cc979834aae2947afa66834.tar.gz
man: beef up the description of systemd-oomd.service
The gist of the description is moved from systemd.resource-control to systemd-oomd man page. Cross-references to OOMPolicy, memory.oom.group, oomctl, ManagedOOMSwap and ManagedOOMMemoryPressure are added in all places. The descriptions are also more down-to-earth: instead of talking about "taking action" let's just say "kill". We *might* add configuration for different actions in the future, but we're not there yet, so let's just describe what we do now.
Diffstat (limited to 'man/systemd.resource-control.xml')
-rw-r--r--man/systemd.resource-control.xml30
1 files changed, 15 insertions, 15 deletions
diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml
index d9edb6ab74..ce03a2f1a6 100644
--- a/man/systemd.resource-control.xml
+++ b/man/systemd.resource-control.xml
@@ -1108,24 +1108,24 @@ DeviceAllow=/dev/loop-control
<citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
will act on this unit's cgroups. Defaults to <option>auto</option>.</para>
- <para>When set to <option>kill</option>, <command>systemd-oomd</command> will actively monitor this unit's
- cgroup metrics to decide whether it needs to act. If the cgroup passes the limits set by
- <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> or its
- overrides, <command>systemd-oomd</command> will send a <constant>SIGKILL</constant> to all of the processes
- under the chosen candidate cgroup. Note that only descendant cgroups can be eligible candidates for killing;
- the unit that set its property to <option>kill</option> is not a candidate (unless one of its ancestors set
- their property to <option>kill</option>). You can find more details on candidates and kill behavior at
+ <para>When set to <option>kill</option>, the unit becomes a candidate for monitoring by
+ <command>systemd-oomd</command>. If the cgroup passes the limits set by
+ <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> or
+ the unit configuration, <command>systemd-oomd</command> will select a descendant cgroup and send
+ <constant>SIGKILL</constant> to all of the processes under it. You can find more details on
+ candidates and kill behavior at
<citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
- and <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Setting
- either of these properties to <option>kill</option> will also automatically acquire
+ and
+ <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+
+ <para>Setting either of these properties to <option>kill</option> will also result in
<varname>After=</varname> and <varname>Wants=</varname> dependencies on
- <filename>systemd-oomd.service</filename> unless <varname>DefaultDependencies=no</varname>.
- </para>
+ <filename>systemd-oomd.service</filename> unless <varname>DefaultDependencies=no</varname>.</para>
- <para>When set to <option>auto</option>, <command>systemd-oomd</command> will not actively use this cgroup's
- data for monitoring and detection. However, if an ancestor cgroup has one of these properties set to
- <option>kill</option>, a unit with <option>auto</option> can still be an eligible candidate for
- <command>systemd-oomd</command> to act on.</para>
+ <para>When set to <option>auto</option>, <command>systemd-oomd</command> will not actively use this
+ cgroup's data for monitoring and detection. However, if an ancestor cgroup has one of these
+ properties set to <option>kill</option>, a unit with <option>auto</option> can still be a candidate
+ for <command>systemd-oomd</command> to terminate.</para>
</listitem>
</varlistentry>