]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: describe "symlink" and "systemctl link" explicitly in UNIT FILE LOAD PATH
authorHATAYAMA Daisuke <d.hatayama@fujitsu.com>
Wed, 18 Dec 2019 03:01:42 +0000 (22:01 -0500)
committerLennart Poettering <lennart@poettering.net>
Thu, 9 Jan 2020 17:52:13 +0000 (18:52 +0100)
There are sometimes users who put unit files in a location that is inaccessible
when systemd starts although they are not found and thus not started because
the corresponding mount units have not activated yet.

There is already a warning for such issue in man 8 systemctl:

     link PATH...
         ...<snip>...
         The file system where
         the linked unit files are located must be accessible
         when systemd is started (e.g. anything underneath /home
         or /var is not allowed, unless those directories are
         located on the root file system).

However, it looks that it's difficult to find the warning because introductory
users typically doesn't know systemctl link.

Although there is a description in UNIT FILE LOAD PATH pointing to systemctl
link, symlink is now not explicitly mentioned there and thus users doesn't
easily get aware of they should read it.

To deal with this, let's describe "symlink" and "systemctl link" more
explicitly in UNIT FILE LOAD PATH.

man/systemd.unit.xml

index 93c4a28d22505d46b972e80b601d736851c56c62..8e2765c86001d22fe0251c04ffc68657c698abef 100644 (file)
     <programlisting>systemd-analyze --user unit-paths</programlisting>
     </para>
 
-    <para>Moreover, additional units might be loaded into systemd ("linked") from
-    directories not on the unit load path. See the <command>link</command> command
-    for
-    <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
+    <para>Moreover, additional units might be loaded into systemd from
+    directories not on the unit load path by creating a symlink pointing to a
+    unit file in the directories. You can use <command>systemctl link</command>
+    for this operation. See
+    <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    for its usage and precaution.
     </para>
   </refsect1>