]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: improve documentation about using resource-control options
authoranphir <158041111+anphir@users.noreply.github.com>
Fri, 3 May 2024 08:34:05 +0000 (10:34 +0200)
committerLuca Boccassi <luca.boccassi@gmail.com>
Fri, 3 May 2024 09:36:56 +0000 (11:36 +0200)
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.

man/systemd.mount.xml
man/systemd.slice.xml
man/systemd.socket.xml
man/systemd.swap.xml

index 307acc4ce9e7936db450ce4feffd3071aee8306d..1b70392813bac21d94cbc57f23ce2c0d188fde72 100644 (file)
     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>
 
index b6ee58d661adfb9361ab76cf2c140d8ae323ee81..630b2024b892740f0db99ecf6ba0af2eb39b085f 100644 (file)
     <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>
index 8dc7641dde8e9cd72ce239efe7aeb848812f5eb1..a944efad3bd71d9d4af90fc5a866fe6ba942ca7c 100644 (file)
     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>
 
index 2b3305ccdeb4af322034c487cfa25ae7d8e0deaa..f5e3c0742b3640337c3f865a438d57614be400f3 100644 (file)
     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>