diff mbox series

[v3,10/12] mke2fs.8: Document fname_encoding options

Message ID 20181126221949.12172-11-krisman@collabora.com
State Accepted, archived
Headers show
Series Support encoding awareness and casefold | expand

Commit Message

Gabriel Krisman Bertazi Nov. 26, 2018, 10:19 p.m. UTC
Signed-off-by: Gabriel Krisman Bertazi <krisman@collabora.com>
---
 misc/mke2fs.8.in | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

Comments

Theodore Ts'o Nov. 30, 2018, 3:59 p.m. UTC | #1
In general, it's better to fold the man page updates with the patch
that adds the support.  So ideally patches 10 and 11 should be folded
into patch 2, and patch 12 should be folded into patch 3.

Thanks,

					- Ted
diff mbox series

Patch

diff --git a/misc/mke2fs.8.in b/misc/mke2fs.8.in
index 603e37e54a78..4a2aa8fd9672 100644
--- a/misc/mke2fs.8.in
+++ b/misc/mke2fs.8.in
@@ -280,6 +280,31 @@  option is still accepted for backwards compatibility, but is deprecated.
 The following extended options are supported:
 .RS 1.2i
 .TP
+.BI fname_encoding= encoding-name
+Enable the
+.I fname_encoding
+feature in the super block and set
+.I encoding-name
+as the encoding to be used.  If
+.I encoding-name
+is not specified, the encoding defined in
+.BR mke2fs.conf (5)
+is used.
+.TP
+.BI fname_encoding_flags= encoding-flags
+Define parameters for file name character encoding operations.  If a
+flag is not changed using this parameter, its default value is used.
+.I encoding-flags
+should be a comma-separated lists of flags to be enabled.  To disable a
+flag, add it to the list with the prefix "no".
+
+The only flag that can be set right now is
+.I strict
+which means that invalid strings should be rejected by the file system.
+In the default configuration, the
+.I strict
+flag is disabled.
+.TP
 .BI mmp_update_interval= interval
 Adjust the initial MMP update interval to
 .I interval