[PATCH] cifs-utils: Fix documentation for character remappings.

[PATCH] cifs-utils: Fix documentation for character remappings.

[Eduard Bachmakov]

Current documentation swapped the relevant specs. Additionally,
elaborate on SFM a bit.

Supported by fs/cifs/cifs_unicode.c:{convert_to_sfu_char,
convert_to_sfm_char}.

Previously raised in:

  https://lore.kernel.org/linux-cifs/CADCRUiMn_2Vk3HZzU0WKu3xPgo1P-1aqDy+NjEzOz03W-HFChw@mail.gmail.com/

Signed-off-by: Eduard Bachmakov <e.bachmakov@gmail.com>
---
 mount.cifs.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/mount.cifs.rst b/mount.cifs.rst
index d489070..9eee7d5 100644
--- a/mount.cifs.rst
+++ b/mount.cifs.rst
@@ -307,10 +307,10 @@ rwpidforward
 
 mapchars
   Translate six of the seven reserved characters (not backslash, but
-  including the colon, question mark, pipe, asterik, greater than and
+  including the colon, question mark, pipe, asterisk, greater than and
   less than characters) to the remap range (above 0xF000), which also
   allows the CIFS client to recognize files created with such characters
-  by Windows's Services for Mac. This can also be useful when mounting to
+  by Windows's Services for Unix. This can also be useful when mounting to
   most versions of Samba (which also forbids creating and opening files
   whose names contain any of these seven characters). This has no effect
   if the server does not support Unicode on the wire. Please note that
@@ -322,7 +322,8 @@ nomapchars
 
 mapposix
   Translate reserved characters similarly to ``mapchars`` but use the
-  mapping from Microsoft "Services For Unix".
+  mapping from Microsoft "Services For Mac". This additionally remaps the
+  double quote and a trailing period or space.
 
 intr
   currently unimplemented.
-- 
2.50.1

Re: [PATCH] cifs-utils: Fix documentation for character remappings.

[Steve French]

good catch.

merged into cifs-utils for-next

There also are some undocumented ones that would be great if someone
would add (and probably some that could be made clearer as well, or
rearranged so less important ones are less distracting) - looking
through fs/smb/client/fs_context.c and comparing to mount.cifs.8 could
find a few mount parms missing descriptions.

On Thu, Aug 14, 2025 at 4:26 PM Eduard Bachmakov <e.bachmakov@gmail.com> wrote:
>
> Current documentation swapped the relevant specs. Additionally,
> elaborate on SFM a bit.
>
> Supported by fs/cifs/cifs_unicode.c:{convert_to_sfu_char,
> convert_to_sfm_char}.
>
> Previously raised in:
>
>   https://lore.kernel.org/linux-cifs/CADCRUiMn_2Vk3HZzU0WKu3xPgo1P-1aqDy+NjEzOz03W-HFChw@mail.gmail.com/
>
> Signed-off-by: Eduard Bachmakov <e.bachmakov@gmail.com>
> ---
>  mount.cifs.rst | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/mount.cifs.rst b/mount.cifs.rst
> index d489070..9eee7d5 100644
> --- a/mount.cifs.rst
> +++ b/mount.cifs.rst
> @@ -307,10 +307,10 @@ rwpidforward
>
>  mapchars
>    Translate six of the seven reserved characters (not backslash, but
> -  including the colon, question mark, pipe, asterik, greater than and
> +  including the colon, question mark, pipe, asterisk, greater than and
>    less than characters) to the remap range (above 0xF000), which also
>    allows the CIFS client to recognize files created with such characters
> -  by Windows's Services for Mac. This can also be useful when mounting to
> +  by Windows's Services for Unix. This can also be useful when mounting to
>    most versions of Samba (which also forbids creating and opening files
>    whose names contain any of these seven characters). This has no effect
>    if the server does not support Unicode on the wire. Please note that
> @@ -322,7 +322,8 @@ nomapchars
>
>  mapposix
>    Translate reserved characters similarly to ``mapchars`` but use the
> -  mapping from Microsoft "Services For Unix".
> +  mapping from Microsoft "Services For Mac". This additionally remaps the
> +  double quote and a trailing period or space.
>
>  intr
>    currently unimplemented.
> --
> 2.50.1
>
>


-- 
Thanks,

Steve