From: anphir <158041111+anphir@users.noreply.github.com>
Date: Fri, 3 May 2024 08:34:05 +0000 (+0200)
Subject: man: improve documentation about using resource-control options
X-Git-Tag: v256-rc2~109
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=78a529caa5f725af5547878442360cd4aa223af9;p=thirdparty%2Fsystemd.git

man: improve documentation about using resource-control options

According to the documentation in systemd.resource-control(5),
resource-control options may be used in mount, scope, service,
slice, socket and swap units.
While e.g. systemd.service(5) includes that information,
documentation for some other units does not.

The most problematic example is systemd.slice(5).
Its documentation states a slice unit may only contain [Install]
and [Unit] sections, while actually it may contain also a [Slice]
section with options from systemd.resource-control(5).
units/user/app.slice is an example of a slice unit having a [Slice]
section.
---

diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
index 307acc4ce9e..1b70392813b 100644
--- a/man/systemd.mount.xml
+++ b/man/systemd.mount.xml
@@ -506,9 +506,9 @@
     information about the file system mount points it supervises. A
     number of options that may be used in this section are shared with
     other unit types. These options are documented in
-    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-    and
-    <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry> and
+    <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
     The options specific to the [Mount] section of mount units are the
     following:</para>
 
diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml
index b6ee58d661a..630b2024b89 100644
--- a/man/systemd.slice.xml
+++ b/man/systemd.slice.xml
@@ -102,8 +102,11 @@
     <title>Options</title>
 
     <para>Slice unit files may include [Unit] and [Install] sections, which are described in
-    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
-    No options specific to this file type are supported.</para>
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+
+    <para>Slice files may include a [Slice] section. Options that may be used in this section are shared with other unit types.
+    These options are documented in
+    <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
   </refsect1>
 
   <refsect1>
diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index 8dc7641dde8..a944efad3bd 100644
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -167,9 +167,9 @@
     information about the socket or FIFO it supervises. A number of
     options that may be used in this section are shared with other
     unit types. These options are documented in
-    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-    and
-    <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry> and
+    <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
     The options specific to the [Socket] section of socket units are
     the following:</para>
 
diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml
index 2b3305ccdeb..f5e3c0742b3 100644
--- a/man/systemd.swap.xml
+++ b/man/systemd.swap.xml
@@ -181,9 +181,9 @@
     information about the swap device it supervises. A number of
     options that may be used in this section are shared with other
     unit types. These options are documented in
-    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-    and
-    <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry> and
+    <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
     The options specific to the [Swap] section of swap units are the
     following:</para>