]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: fix list of escaped characters in unit names
authorLennart Poettering <lennart@poettering.net>
Wed, 26 May 2021 11:55:37 +0000 (13:55 +0200)
committerLennart Poettering <lennart@poettering.net>
Wed, 26 May 2021 15:27:24 +0000 (17:27 +0200)
The code works differently than the docs, and the code is right here.
Fix the doc hence.

See VALID_CHARS in unit-name.c for details about allowed chars in unit
names, but keep in mind that "-" and "\" are special, since generated by
the escaping logic: they are OK to show up in unit names, but need to be
escaped when converting foreign strings to unit names to make sure
things remain reversible.

Fixes: #19623
man/systemd.unit.xml

index 0b5e86932193fcfc77eb31d20d6cd8d50c610d1d..552ede51f5fbe5b7c9d9033dbaa75bd3ee32a928 100644 (file)
     objects in the file system hierarchy. Example: a device unit <filename>dev-sda.device</filename> refers to a device
     with the device node <filename index="false">/dev/sda</filename> in the file system.</para>
 
-    <para>The escaping algorithm operates as follows: given a string, any <literal>/</literal> character is replaced by
-    <literal>-</literal>, and all other characters which are not ASCII alphanumerics or <literal>_</literal> are
-    replaced by C-style <literal>\x2d</literal> escapes. In addition, <literal>.</literal> is replaced with such a
-    C-style escape when it would appear as the first character in the escaped string.</para>
+    <para>The escaping algorithm operates as follows: given a string, any <literal>/</literal> character is
+    replaced by <literal>-</literal>, and all other characters which are not ASCII alphanumerics,
+    <literal>:</literal>, <literal>_</literal> or <literal>.</literal> are replaced by C-style
+    <literal>\x2d</literal> escapes. In addition, <literal>.</literal> is replaced with such a C-style escape
+    when it would appear as the first character in the escaped string.</para>
 
     <para>When the input qualifies as absolute file system path, this algorithm is extended slightly: the path to the
     root directory <literal>/</literal> is encoded as single dash <literal>-</literal>. In addition, any leading,