man: document that some unit types do not support unit aliases via symlinks
authorLennart Poettering <lennart@poettering.net>
Fri, 29 Apr 2016 15:48:07 +0000 (17:48 +0200)
committerLennart Poettering <lennart@poettering.net>
Fri, 29 Apr 2016 16:06:12 +0000 (18:06 +0200)
man/systemd.automount.xml
man/systemd.mount.xml
man/systemd.slice.xml
man/systemd.swap.xml
man/systemd.unit.xml

index 93bae2a..a43dc98 100644 (file)
     [Install] sections. The automount specific configuration options
     are configured in the [Automount] section.</para>
 
-    <para>Automount units must be named after the automount
-    directories they control. Example: the automount point
-    <filename noindex='true'>/home/lennart</filename> must be
-    configured in a unit file
-    <filename>home-lennart.automount</filename>. For details about the
-    escaping logic used to convert a file system path to a unit name
-    see
-    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+    <para>Automount units must be named after the automount directories they control. Example: the automount point
+    <filename noindex='true'>/home/lennart</filename> must be configured in a unit file
+    <filename>home-lennart.automount</filename>. For details about the escaping logic used to convert a file system
+    path to a unit name see
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note that
+    automount units cannot be templated, nor is it possible to add multiple names to an automount unit by creating
+    additional symlinks to its unit file.</para>
 
     <para>For each automount unit file a matching mount unit file (see
     <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
index f116782..bf56a49 100644 (file)
     will refuse options that are not listed in
     <filename>/etc/fstab</filename> if it is not run as UID 0.</para>
 
-    <para>Mount units must be named after the mount point directories
-    they control. Example: the mount point
-    <filename noindex='true'>/home/lennart</filename> must be
-    configured in a unit file <filename>home-lennart.mount</filename>.
-    For details about the escaping logic used to convert a file system
-    path to a unit name, see
-    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
-    Note that mount units cannot be templated.</para>
+    <para>Mount units must be named after the mount point directories they control. Example: the mount point <filename
+    noindex='true'>/home/lennart</filename> must be configured in a unit file <filename>home-lennart.mount</filename>.
+    For details about the escaping logic used to convert a file system path to a unit name, see
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.  Note that mount
+    units cannot be templated, nor is possible to add multiple names to a mount unit by creating additional symlinks to
+    it.</para>
 
     <para>Optionally, a mount unit may be accompanied by an automount
     unit, to allow on-demand or parallelized mounting. See
index 1624762..eee98d9 100644 (file)
@@ -71,6 +71,9 @@
     the root slice <filename>-.slice</filename>.
     </para>
 
+    <para>Note that slice units cannot be templated, nor is possible to add multiple names to a slice unit by creating
+    additional symlinks to it.</para>
+
     <para>By default, service and scope units are placed in
     <filename>system.slice</filename>, virtual machines and containers
     registered with
index 6fc4c7b..cf4e1ba 100644 (file)
     which configure resource control settings for these processes of the
     unit.</para>
 
-    <para>Swap units must be named after the devices
-    or files they control. Example: the swap device
-    <filename noindex='true'>/dev/sda5</filename> must be configured in a
-    unit file <filename>dev-sda5.swap</filename>. For details about
-    the escaping logic used to convert a file system path to a unit
-    name, see
-    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+    <para>Swap units must be named after the devices or files they control. Example: the swap device <filename
+    noindex='true'>/dev/sda5</filename> must be configured in a unit file <filename>dev-sda5.swap</filename>. For
+    details about the escaping logic used to convert a file system path to a unit name, see
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note that swap
+    units cannot be templated, nor is possible to add multiple names to a swap unit by creating additional symlinks to
+    it.</para>
   </refsect1>
 
   <refsect1>
index 7993301..69f56e3 100644 (file)
       <varlistentry>
         <term><varname>Alias=</varname></term>
 
-        <listitem><para>A space-separated list of additional names
-        this unit shall be installed under. The names listed here must
-        have the same suffix (i.e. type) as the unit file name. This
-        option may be specified more than once, in which case all
-        listed names are used. At installation time,
-        <command>systemctl enable</command> will create symlinks from
-        these names to the unit filename.</para></listitem>
+        <listitem><para>A space-separated list of additional names this unit shall be installed under. The names listed
+        here must have the same suffix (i.e. type) as the unit file name. This option may be specified more than once,
+        in which case all listed names are used. At installation time, <command>systemctl enable</command> will create
+        symlinks from these names to the unit filename. Note that not all unit types support such alias names, and this
+        setting is not supported for them. Specifically, mount, slice, swap, and automount units do not support
+        aliasing.</para></listitem>
       </varlistentry>
 
       <varlistentry>