]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: correct/tweak text about unit name syntax
authorLennart Poettering <lennart@poettering.net>
Tue, 28 Mar 2023 21:25:52 +0000 (23:25 +0200)
committerLuca Boccassi <luca.boccassi@gmail.com>
Tue, 28 Mar 2023 22:07:11 +0000 (23:07 +0100)
Unit names can be 255 characters long, not 256.

We first say "name prefix" and then continue with "unit prefix".
Confusing. Couldn't figure out which term is better hence settled on
"unit name prefix".

man/systemd.unit.xml

index 556fcad3a44c801a511e0d045e3769ea3321b06d..9411ea2e0387153de85c5ded0198c4d8fbc7ed0b 100644 (file)
     <para>Unit files are loaded from a set of paths determined during compilation, described in the next
     section.</para>
 
-    <para>Valid unit names consist of a "name prefix" and a dot and a suffix specifying the unit type. The
-    "unit prefix" must consist of one or more valid characters (ASCII letters, digits, <literal>:</literal>,
-    <literal>-</literal>, <literal>_</literal>, <literal>.</literal>, and <literal>\</literal>). The total
-    length of the unit name including the suffix must not exceed 256 characters. The type suffix must be one
-    of <literal>.service</literal>, <literal>.socket</literal>, <literal>.device</literal>,
-    <literal>.mount</literal>, <literal>.automount</literal>, <literal>.swap</literal>,
-    <literal>.target</literal>, <literal>.path</literal>, <literal>.timer</literal>,
-    <literal>.slice</literal>, or <literal>.scope</literal>.</para>
-
-    <para>Units names can be parameterized by a single argument called the "instance name". The unit is then
+    <para>Valid unit names consist of a "unit name prefix", and a suffix specifying the unit type which
+    begins with a dot. The "unit name prefix" must consist of one or more valid characters (ASCII letters,
+    digits, <literal>:</literal>, <literal>-</literal>, <literal>_</literal>, <literal>.</literal>, and
+    <literal>\</literal>). The total length of the unit name including the suffix must not exceed 255
+    characters. The unit type suffix must be one of <literal>.service</literal>, <literal>.socket</literal>,
+    <literal>.device</literal>, <literal>.mount</literal>, <literal>.automount</literal>,
+    <literal>.swap</literal>, <literal>.target</literal>, <literal>.path</literal>,
+    <literal>.timer</literal>, <literal>.slice</literal>, or <literal>.scope</literal>.</para>
+
+    <para>Unit names can be parameterized by a single argument called the "instance name". The unit is then
     constructed based on a "template file" which serves as the definition of multiple services or other
-    units. A template unit must have a single <literal>@</literal> at the end of the name (right before the
-    type suffix). The name of the full unit is formed by inserting the instance name between
+    units. A template unit must have a single <literal>@</literal> at the end of the unit name prefix (right
+    before the type suffix). The name of the full unit is formed by inserting the instance name between
     <literal>@</literal> and the unit type suffix. In the unit file itself, the instance parameter may be
     referred to using <literal>%i</literal> and other specifiers, see below.</para>