From: Yu Watanabe <watanabe.yu+github@gmail.com>
Date: Wed, 23 Jun 2021 07:58:20 +0000 (+0900)
Subject: man: update description of "string_escape=" udev option
X-Git-Tag: v249-rc2~11^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=91c27ac686261fcca913ac6e3fe1520f38440dcb;p=thirdparty%2Fsystemd.git

man: update description of "string_escape=" udev option
---

diff --git a/man/udev.xml b/man/udev.xml
index 8782bb15c54..f6ea2abc121 100644
--- a/man/udev.xml
+++ b/man/udev.xml
@@ -117,7 +117,7 @@
           <varlistentry>
             <term><literal>:=</literal></term>
             <listitem>
-              <para>Assign  a  value  to  a key finally; disallow any later changes.</para>
+              <para>Assign a value to a key finally; disallow any later changes.</para>
             </listitem>
           </varlistentry>
         </variablelist>
@@ -607,9 +607,12 @@
                 <varlistentry>
                   <term><option>string_escape=<replaceable>none|replace</replaceable></option></term>
                   <listitem>
-                    <para>Usually, control and other possibly unsafe characters are replaced
-                    in strings used for device naming. The mode of replacement can be specified
-                    with this option.</para>
+                    <para>When <literal>replace</literal>, possibly unsafe characters in strings
+                    assigned to <varname>NAME</varname>, <varname>SYMLINK</varname>, and
+                    <varname>ENV{<replaceable>key</replaceable>}</varname> are replaced. When
+                    <literal>none</literal>, no replacement is performed. When unset, the replacement
+                    is performed for <varname>NAME</varname>, <varname>SYMLINK</varname>, but not for
+                    <varname>ENV{<replaceable>key</replaceable>}</varname>. Defaults to unset.</para>
                   </listitem>
                 </varlistentry>
                 <varlistentry>