104 lines
5.1 KiB
Diff
104 lines
5.1 KiB
Diff
|
From d918804408801bf46a49018e374ebdfbeae08805 Mon Sep 17 00:00:00 2001
|
||
|
|
From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= <zbyszek@in.waw.pl>
|
||
|
|
Date: Wed, 5 Jun 2024 11:28:21 +0200
|
||
|
|
Subject: [PATCH] man/systemd: reorder content a bit
|
||
|
|
|
||
|
|
Section "Description" didn't actually say what systemd does. And we had a giant
|
||
|
|
"Concepts" section that actually described units types and other details about
|
||
|
|
them. So let's move the basic description of functionality to "Description" and
|
||
|
|
rename the following section to "Units".
|
||
|
|
|
||
|
|
The link to the Original Design Document is moved to "See Also", it is of
|
||
|
|
historical interest mostly at this point.
|
||
|
|
|
||
|
|
The only actual change is that when talking about API filesystems, /dev is also
|
||
|
|
mentioned. (I think /sys+/proc+/dev are the canonical set and should be always
|
||
|
|
listed on one breath.)
|
||
|
|
|
||
|
|
(cherry picked from commit f11aaf7dfb295de429b1567282b19caaba036bba)
|
||
|
|
---
|
||
|
|
man/systemd.xml | 49 ++++++++++++++++++++++++-------------------------
|
||
|
|
1 file changed, 24 insertions(+), 25 deletions(-)
|
||
|
|
|
||
|
|
diff --git a/man/systemd.xml b/man/systemd.xml
|
||
|
|
index 66db5bbf25..f4aa7e06ca 100644
|
||
|
|
--- a/man/systemd.xml
|
||
|
|
+++ b/man/systemd.xml
|
||
|
|
@@ -62,10 +62,29 @@
|
||
|
|
<filename>user.conf.d</filename> directories. See
|
||
|
|
<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
||
|
|
for more information.</para>
|
||
|
|
+
|
||
|
|
+ <para><command>systemd</command> contains native implementations of various tasks that need to be
|
||
|
|
+ executed as part of the boot process. For example, it sets the hostname or configures the loopback
|
||
|
|
+ network device. It also sets up and mounts various API file systems, such as <filename>/sys/</filename>,
|
||
|
|
+ <filename>/proc/</filename>, and <filename>/dev/</filename>.</para>
|
||
|
|
+
|
||
|
|
+ <para>Note that some but not all interfaces provided by systemd are covered by the
|
||
|
|
+ <ulink url="https://systemd.io/PORTABILITY_AND_STABILITY/">Interface Portability and Stability Promise</ulink>.</para>
|
||
|
|
+
|
||
|
|
+ <para>The D-Bus API of <command>systemd</command> is described in
|
||
|
|
+ <citerefentry><refentrytitle>org.freedesktop.systemd1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
||
|
|
+ and
|
||
|
|
+ <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
|
||
|
|
+ </para>
|
||
|
|
+
|
||
|
|
+ <para>Systems which invoke systemd in a container or initrd environment should implement the <ulink
|
||
|
|
+ url="https://systemd.io/CONTAINER_INTERFACE">Container Interface</ulink> or
|
||
|
|
+ <ulink url="https://systemd.io/INITRD_INTERFACE/">initrd Interface</ulink>
|
||
|
|
+ specifications, respectively.</para>
|
||
|
|
</refsect1>
|
||
|
|
|
||
|
|
<refsect1>
|
||
|
|
- <title>Concepts</title>
|
||
|
|
+ <title>Units</title>
|
||
|
|
|
||
|
|
<para>systemd provides a dependency system between various
|
||
|
|
entities called "units" of 11 different types. Units encapsulate
|
||
|
|
@@ -261,34 +280,10 @@
|
||
|
|
example, start jobs for any of those inactive units getting queued as
|
||
|
|
well.</para>
|
||
|
|
|
||
|
|
- <para>systemd contains native implementations of various tasks
|
||
|
|
- that need to be executed as part of the boot process. For example,
|
||
|
|
- it sets the hostname or configures the loopback network device. It
|
||
|
|
- also sets up and mounts various API file systems, such as
|
||
|
|
- <filename>/sys/</filename> or <filename>/proc/</filename>.</para>
|
||
|
|
-
|
||
|
|
- <para>For more information about the concepts and
|
||
|
|
- ideas behind systemd, please refer to the
|
||
|
|
- <ulink url="https://0pointer.de/blog/projects/systemd.html">Original Design Document</ulink>.</para>
|
||
|
|
-
|
||
|
|
- <para>Note that some but not all interfaces provided by systemd are covered by the
|
||
|
|
- <ulink url="https://systemd.io/PORTABILITY_AND_STABILITY/">Interface Portability and Stability Promise</ulink>.</para>
|
||
|
|
-
|
||
|
|
<para>Units may be generated dynamically at boot and system
|
||
|
|
manager reload time, for example based on other configuration
|
||
|
|
files or parameters passed on the kernel command line. For details, see
|
||
|
|
<citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
|
||
|
|
-
|
||
|
|
- <para>The D-Bus API of <command>systemd</command> is described in
|
||
|
|
- <citerefentry><refentrytitle>org.freedesktop.systemd1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
||
|
|
- and
|
||
|
|
- <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
|
||
|
|
- </para>
|
||
|
|
-
|
||
|
|
- <para>Systems which invoke systemd in a container or initrd environment should implement the <ulink
|
||
|
|
- url="https://systemd.io/CONTAINER_INTERFACE">Container Interface</ulink> or
|
||
|
|
- <ulink url="https://systemd.io/INITRD_INTERFACE/">initrd Interface</ulink>
|
||
|
|
- specifications, respectively.</para>
|
||
|
|
</refsect1>
|
||
|
|
|
||
|
|
<refsect1>
|
||
|
|
@@ -1558,6 +1553,10 @@
|
||
|
|
<member><citerefentry project='man-pages'><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
|
||
|
|
<member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
|
||
|
|
</simplelist></para>
|
||
|
|
+
|
||
|
|
+ <para>For more information about the concepts and
|
||
|
|
+ ideas behind systemd, please refer to the
|
||
|
|
+ <ulink url="https://0pointer.de/blog/projects/systemd.html">Original Design Document</ulink>.</para>
|
||
|
|
</refsect1>
|
||
|
|
|
||
|
|
</refentry>
|