From 78a529caa5f725af5547878442360cd4aa223af9 Mon Sep 17 00:00:00 2001
From: anphir <158041111+anphir@users.noreply.github.com>
Date: Fri, 3 May 2024 10:34:05 +0200
Subject: [PATCH] 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.
---
man/systemd.mount.xml | 6 +++---
man/systemd.slice.xml | 7 +++++--
man/systemd.socket.xml | 6 +++---
man/systemd.swap.xml | 6 +++---
4 files changed, 14 insertions(+), 11 deletions(-)
diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
index 307acc4ce9..1b70392813 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
- systemd.exec5
- and
- systemd.kill5.
+ systemd.exec5,
+ systemd.kill5 and
+ systemd.resource-control5.
The options specific to the [Mount] section of mount units are the
following:
diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml
index b6ee58d661..630b2024b8 100644
--- a/man/systemd.slice.xml
+++ b/man/systemd.slice.xml
@@ -102,8 +102,11 @@
Options
Slice unit files may include [Unit] and [Install] sections, which are described in
- systemd.unit5.
- No options specific to this file type are supported.
+ systemd.unit5.
+
+ 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
+ systemd.resource-control5.
diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index 8dc7641dde..a944efad3b 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
- systemd.exec5
- and
- systemd.kill5.
+ systemd.exec5,
+ systemd.kill5 and
+ systemd.resource-control5.
The options specific to the [Socket] section of socket units are
the following:
diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml
index 2b3305ccde..f5e3c0742b 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
- systemd.exec5
- and
- systemd.kill5.
+ systemd.exec5,
+ systemd.kill5 and
+ systemd.resource-control5.
The options specific to the [Swap] section of swap units are the
following: