From f4bf8d2f45b02c26234219d07bfd3a41290cc84e Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 29 Apr 2016 17:48:07 +0200 Subject: [PATCH] man: document that some unit types do not support unit aliases via symlinks --- man/systemd.automount.xml | 15 +++++++-------- man/systemd.mount.xml | 14 ++++++-------- man/systemd.slice.xml | 3 +++ man/systemd.swap.xml | 13 ++++++------- man/systemd.unit.xml | 13 ++++++------- 5 files changed, 28 insertions(+), 30 deletions(-) diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index 93bae2a6dc..a43dc981bd 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -66,14 +66,13 @@ [Install] sections. The automount specific configuration options are configured in the [Automount] section. - Automount units must be named after the automount - directories they control. Example: the automount point - /home/lennart must be - configured in a unit file - home-lennart.automount. For details about the - escaping logic used to convert a file system path to a unit name - see - systemd.unit5. + Automount units must be named after the automount directories they control. Example: the automount point + /home/lennart must be configured in a unit file + home-lennart.automount. For details about the escaping logic used to convert a file system + path to a unit name see + systemd.unit5. 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. For each automount unit file a matching mount unit file (see systemd.mount5 diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index f116782b40..bf56a49e58 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -82,14 +82,12 @@ will refuse options that are not listed in /etc/fstab if it is not run as UID 0. - Mount units must be named after the mount point directories - they control. Example: the mount point - /home/lennart must be - configured in a unit file home-lennart.mount. - For details about the escaping logic used to convert a file system - path to a unit name, see - systemd.unit5. - Note that mount units cannot be templated. + Mount units must be named after the mount point directories they control. Example: the mount point /home/lennart must be configured in a unit file home-lennart.mount. + For details about the escaping logic used to convert a file system path to a unit name, see + systemd.unit5. Note that mount + units cannot be templated, nor is possible to add multiple names to a mount unit by creating additional symlinks to + it. Optionally, a mount unit may be accompanied by an automount unit, to allow on-demand or parallelized mounting. See diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml index 16247628af..eee98d99ee 100644 --- a/man/systemd.slice.xml +++ b/man/systemd.slice.xml @@ -71,6 +71,9 @@ the root slice -.slice. + Note that slice units cannot be templated, nor is possible to add multiple names to a slice unit by creating + additional symlinks to it. + By default, service and scope units are placed in system.slice, virtual machines and containers registered with diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 6fc4c7bf13..cf4e1ba839 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -78,13 +78,12 @@ which configure resource control settings for these processes of the unit. - Swap units must be named after the devices - or files they control. Example: the swap device - /dev/sda5 must be configured in a - unit file dev-sda5.swap. For details about - the escaping logic used to convert a file system path to a unit - name, see - systemd.unit5. + Swap units must be named after the devices or files they control. Example: the swap device /dev/sda5 must be configured in a unit file dev-sda5.swap. For + details about the escaping logic used to convert a file system path to a unit name, see + systemd.unit5. Note that swap + units cannot be templated, nor is possible to add multiple names to a swap unit by creating additional symlinks to + it. diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 7993301167..69f56e3f0a 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -1102,13 +1102,12 @@ Alias= - 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, - systemctl enable will create symlinks from - these names to the unit filename. + 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, systemctl enable 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.