]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
tmpfiles: document that the "argument" field doesn't do quotes
authorLennart Poettering <lennart@poettering.net>
Tue, 12 Jan 2021 20:34:50 +0000 (21:34 +0100)
committerLennart Poettering <lennart@poettering.net>
Tue, 12 Jan 2021 21:00:35 +0000 (22:00 +0100)
This adjust the documentation to match the code, addressing #17740.

I actually think that not making the "argument" field accept quotes was
a mistake, but I also understand why this choice was made. Given that we
shipped this forever like this though I don't think it's worth changing
the behaviour now. Supporting quotes for this is not that important I
guess. Hence document the current behaviour.

Fixes: #17740
man/tmpfiles.d.xml

index 49ce8375a40b84459dad1179ab86b37520d2d8fe..4adbf6bb0a611703c8cb5c2ac3246c7e22ab1be7 100644 (file)
@@ -145,14 +145,17 @@ A+    /path-or-glob/to/append/acls/recursively -    -    -     -           POSIX
   <refsect1>
     <title>Configuration File Format</title>
 
-    <para>The configuration format is one line per path containing
-    type, path, mode, ownership, age, and argument fields:</para>
+    <para>The configuration format is one line per path, containing type, path, mode, ownership, age, and
+    argument fields. The lines are separated by newlines, the fields by whitespace:</para>
 
-    <programlisting>#Type Path        Mode User Group Age Argument
+    <programlisting>#Type Path        Mode User Group Age Argument
 d     /run/user   0755 root root  10d -
 L     /tmp/foobar -    -    -     -   /dev/null</programlisting>
 
-    <para>Fields may be enclosed within quotes and contain C-style escapes.</para>
+    <para>Fields may contain C-style escapes. With the exception of the seventh field (the "argument") all
+    fields may be enclosed in quotes. Note that any whitespace found in the line after the beginning of the
+    argument field will be considered part of the argument field. To begin the argument field with a
+    whitespace character, use C-style escapes (e.g. <literal>\x20</literal>).</para>
 
     <refsect2>
       <title>Type</title>