Skip to content

Commit d9704c0

Browse files
committed
doc: update documentation for normalization and case sensitivity
Signed-off-by: Xavi Hernandez <[email protected]>
1 parent b8a7764 commit d9704c0

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

doc/cephfs/fs-volumes.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ Use a command of the following form to create a subvolume:
287287

288288
.. prompt:: bash #
289289

290-
ceph fs subvolume create <vol_name> <subvol_name> [--size <size_in_bytes>] [--group_name <subvol_group_name>] [--pool_layout <data_pool_name>] [--uid <uid>] [--gid <gid>] [--mode <octal_mode>] [--namespace-isolated] [--earmark <earmark>]
290+
ceph fs subvolume create <vol_name> <subvol_name> [--size <size_in_bytes>] [--group_name <subvol_group_name>] [--pool_layout <data_pool_name>] [--uid <uid>] [--gid <gid>] [--mode <octal_mode>] [--namespace-isolated] [--earmark <earmark>] [--normalization <form>] [--case-insensitive]
291291

292292

293293
The command succeeds even if the subvolume already exists.
@@ -327,6 +327,29 @@ Valid Earmarks
327327
be aware that user permissions and ACLs associated with the previous scope might still apply. Ensure that
328328
any necessary permissions are updated as needed to maintain proper access control.
329329

330+
When creating a subvolume you can also specify an unicode normalization form by
331+
using the ``--normalization`` option. This will be used to internally mangle
332+
file names so that unicode characters that can be represented by different
333+
unicode code point sequences are all mapped to the representation, which means
334+
that they will all access the same file. However, users will continue to see
335+
the same name that they used when the file was created.
336+
337+
The valid values for the unicode normalization form are:
338+
339+
- nfd: canonical decomposition (default)
340+
- nfc: canonical decomposition, followed by canonical composition
341+
- nfkd: compatibility decomposition
342+
- nfkc: compatibility decomposition, followed by canonical composition
343+
344+
To learn more about unicode normalization forms see https://unicode.org/reports/tr15
345+
346+
It's also possible to configure a subvolume for case insensitive access when
347+
the ``--case-insensitive`` option is used. When this option is added, file
348+
names that only differ in the case of its characters will be mapped to the same
349+
file. The case of the file name used when the file was created is preserved.
350+
351+
.. note:: Setting ``--case-insensitive`` option implicitly enables
352+
unicode normalization on the subvolume.
330353

331354
Removing a subvolume
332355
~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)