Better doc mount.cifs.

Original commit msg from Jeff:

This patch adds a section to the mount.cifs manpage to clarify how
mount.cifs treats delimiters and when it autoconverts them from one
type to another. It also has it state that the use of forward slash
as a delimiter is preferred and why.

Signed-off-by: Jeff Layton <jlayton@redhat.com>

diff --git a/docs/manpages-3/mount.cifs.8.xml b/docs/manpages-3/mount.cifs.8.xml
index 4c86c45ffac137063a1265ee96adee8eea201ffb..b62bd3c8923c695696d153eeaf0cd89c85e04cdd 100644 (file)
--- a/docs/manpages-3/mount.cifs.8.xml
+++ b/docs/manpages-3/mount.cifs.8.xml
@@ -498,6 +498,17 @@ port 445 is tried and if no response then port 139 is tried.
        </variablelist>
 </refsect1>
 
+<refsect1>
+       <title>SERVICE FORMATTING AND DELIMITERS</title>
+
+       <para>
+               It's generally preferred to use forward slashes (/) as a delimiter in service names. They are considered to be the "universal delimiter" since they are generally not allowed to be embedded within path components on Windows machines and the client can convert them to blackslashes (\) unconditionally. Conversely, backslash characters are allowed by POSIX to be part of a path component, and can't be automatically converted in the same way.
+       </para>
+       <para>
+               mount.cifs will attempt to convert backslashes to forward slashes where it's able to do so, but it cannot do so in any path component following the sharename.
+       </para>
+</refsect1>
+
 <refsect1>
        <title>ENVIRONMENT VARIABLES</title>