From: "André Almeida" <andrealmeid@igalia.com>
To: Hugh Dickins <hughd@google.com>,
Andrew Morton <akpm@linux-foundation.org>,
Alexander Viro <viro@zeniv.linux.org.uk>,
Christian Brauner <brauner@kernel.org>, Jan Kara <jack@suse.cz>,
krisman@kernel.org
Cc: linux-mm@kvack.org, linux-kernel@vger.kernel.org,
linux-fsdevel@vger.kernel.org, kernel-dev@igalia.com,
"Daniel Rosenberg" <drosen@google.com>,
smcv@collabora.com, "Christoph Hellwig" <hch@lst.de>,
"Theodore Ts'o" <tytso@mit.edu>,
"André Almeida" <andrealmeid@igalia.com>,
"Gabriel Krisman Bertazi" <krisman@suse.de>
Subject: [PATCH v5 10/10] docs: tmpfs: Add casefold options
Date: Wed, 2 Oct 2024 20:44:44 -0300 [thread overview]
Message-ID: <20241002234444.398367-11-andrealmeid@igalia.com> (raw)
In-Reply-To: <20241002234444.398367-1-andrealmeid@igalia.com>
Document mounting options for casefold support in tmpfs.
Signed-off-by: André Almeida <andrealmeid@igalia.com>
Reviewed-by: Gabriel Krisman Bertazi <krisman@suse.de>
---
Changes from v3:
- Rewrote note about "this doesn't enable casefold by default" (Krisman)
---
Documentation/filesystems/tmpfs.rst | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/Documentation/filesystems/tmpfs.rst b/Documentation/filesystems/tmpfs.rst
index 56a26c843dbe..0385310f2258 100644
--- a/Documentation/filesystems/tmpfs.rst
+++ b/Documentation/filesystems/tmpfs.rst
@@ -241,6 +241,28 @@ So 'mount -t tmpfs -o size=10G,nr_inodes=10k,mode=700 tmpfs /mytmpfs'
will give you tmpfs instance on /mytmpfs which can allocate 10GB
RAM/SWAP in 10240 inodes and it is only accessible by root.
+tmpfs has the following mounting options for case-insensitive lookup support:
+
+================= ==============================================================
+casefold Enable casefold support at this mount point using the given
+ argument as the encoding standard. Currently only UTF-8
+ encodings are supported. If no argument is used, it will load
+ the latest UTF-8 encoding available.
+strict_encoding Enable strict encoding at this mount point (disabled by
+ default). In this mode, the filesystem refuses to create file
+ and directory with names containing invalid UTF-8 characters.
+================= ==============================================================
+
+This option doesn't render the entire filesystem case-insensitive. One needs to
+still set the casefold flag per directory, by flipping +F attribute in an empty
+directory. Nevertheless, new directories will inherit the attribute. The
+mountpoint itself cannot be made case-insensitive.
+
+Example::
+
+ $ mount -t tmpfs -o casefold=utf8-12.1.0,strict_encoding fs_name /mytmpfs
+ $ mount -t tmpfs -o casefold fs_name /mytmpfs
+
:Author:
Christoph Rohland <cr@sap.com>, 1.12.01
@@ -250,3 +272,5 @@ RAM/SWAP in 10240 inodes and it is only accessible by root.
KOSAKI Motohiro, 16 Mar 2010
:Updated:
Chris Down, 13 July 2020
+:Updated:
+ André Almeida, 23 Aug 2024
--
2.46.0
prev parent reply other threads:[~2024-10-02 23:45 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-02 23:44 [PATCH v5 00/10] tmpfs: Add case-insensitive support for tmpfs André Almeida
2024-10-02 23:44 ` [PATCH v5 01/10] libfs: Create the helper function generic_ci_validate_strict_name() André Almeida
2024-10-02 23:44 ` [PATCH v5 02/10] ext4: Use generic_ci_validate_strict_name helper André Almeida
2024-10-02 23:44 ` [PATCH v5 03/10] unicode: Export latest available UTF-8 version number André Almeida
2024-10-02 23:44 ` [PATCH v5 04/10] unicode: Recreate utf8_parse_version() André Almeida
2024-10-02 23:44 ` [PATCH v5 05/10] libfs: Export generic_ci_ dentry functions André Almeida
2024-10-02 23:44 ` [PATCH v5 06/10] tmpfs: Always set simple_dentry_operations as dentry ops André Almeida
2024-10-02 23:44 ` [PATCH v5 07/10] tmpfs: Add casefold lookup support André Almeida
2024-10-05 22:47 ` kernel test robot
2024-10-06 5:10 ` kernel test robot
2024-10-02 23:44 ` [PATCH v5 08/10] tmpfs: Add flag FS_CASEFOLD_FL support for tmpfs dirs André Almeida
2024-10-02 23:44 ` [PATCH v5 09/10] tmpfs: Expose filesystem features via sysfs André Almeida
2024-10-02 23:44 ` André Almeida [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20241002234444.398367-11-andrealmeid@igalia.com \
--to=andrealmeid@igalia.com \
--cc=akpm@linux-foundation.org \
--cc=brauner@kernel.org \
--cc=drosen@google.com \
--cc=hch@lst.de \
--cc=hughd@google.com \
--cc=jack@suse.cz \
--cc=kernel-dev@igalia.com \
--cc=krisman@kernel.org \
--cc=krisman@suse.de \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=smcv@collabora.com \
--cc=tytso@mit.edu \
--cc=viro@zeniv.linux.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox