units: deemphesize Names= settings, and explain why nobody whould use them

This commit is contained in:
Lennart Poettering 2011-03-18 04:49:38 +01:00
parent b1c66c44ef
commit e2130f189a

View File

@ -219,21 +219,6 @@
dependent on the type of unit:</para>
<variablelist>
<varlistentry>
<term><varname>Names=</varname></term>
<listitem><para>Additional names for
this unit. 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. Note
that this option is different from the
<varname>Alias=</varname> option from
the [Install] section mentioned
below. See below for details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>Description=</varname></term>
@ -660,6 +645,35 @@
pipe symbol must be passed first, the
exclamation second.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>Names=</varname></term>
<listitem><para>Additional names for
this unit. 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. Note
that this option is different from the
<varname>Alias=</varname> option from
the [Install] section mentioned
below. See below for details. Note
that in almost all cases this option
is not what you want. A symlink alias
in the file system is generally
preferable since it can be used as
lookup key. If a unit with a symlinked
alias name is not loaded and needs to
be it is easily found via the
symlink. However, if a unit with an
alias name configured with this
setting is not loaded it will not be
discovered. This settings' only use is
in conjunction with service
instances.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Unit file may include a [Install] section, which