From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Linux bcachefs <linux-bcachefs@vger.kernel.org>
Cc: Kent Overstreet <kent.overstreet@linux.dev>,
Jonathan Corbet <corbet@lwn.net>,
Joshua Ashton <joshua@froggi.es>,
Bagas Sanjaya <bagasdotme@gmail.com>,
Stephen Rothwell <sfr@canb.auug.org.au>
Subject: [PATCH 1/4] Documentation: bcachefs: casefolding: Do not italicize NUL
Date: Sat, 22 Feb 2025 16:18:50 +0700 [thread overview]
Message-ID: <20250222091853.16487-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20250222091853.16487-1-bagasdotme@gmail.com>
Sphinx reports htmldocs warning:
Documentation/filesystems/bcachefs/casefolding.rst:36: WARNING: Inline interpreted text or phrase reference start-string without end-string. [docutils]
That's because NUL word is italicized but it is written in plural form
instead (`NUL`s). Sphinx, however, doesn't tip over when the italicized
word in this fashion is followed by punctuation instead.
Do not italicize the word to keep Sphinx happy.
Fixes: bc5cc09246c5 ("bcachefs: bcachefs_metadata_version_casefolding")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20250221162135.79be0147@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/filesystems/bcachefs/casefolding.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/filesystems/bcachefs/casefolding.rst b/Documentation/filesystems/bcachefs/casefolding.rst
index 6546aa4f7a8684..1c385b6d21a0a8 100644
--- a/Documentation/filesystems/bcachefs/casefolding.rst
+++ b/Documentation/filesystems/bcachefs/casefolding.rst
@@ -33,8 +33,9 @@ The structure looks like this:
Regular: [dirent data][regular name][nul][nul]...
Casefolded: [dirent data][reg len][cf len][regular name][casefolded name][nul][nul]...
-(Do note, the number of `NUL`s here is merely for illustration, they count can vary
- per-key, and they may not even be present if the key is aligned to `sizeof(u64)`.)
+(Do note, the number of NULs here is merely for illustration; their count can
+vary per-key, and they may not even be present if the key is aligned to
+`sizeof(u64)`.)
This is efficient as it means that for all file lookups that require casefolding,
it has identical performance to a regular lookup:
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2025-02-22 9:19 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-02-22 9:18 [PATCH 0/4] bcachefs: casefolding.rst fixes Bagas Sanjaya
2025-02-22 9:18 ` Bagas Sanjaya [this message]
2025-02-22 9:18 ` [PATCH 2/4] Documentation: bcachefs: casefolding: Fix dentry/dcache considerations section Bagas Sanjaya
2025-02-22 9:18 ` [PATCH 3/4] Documentation: bcachefs: casefolding: Use bullet list for dirent structure Bagas Sanjaya
2025-02-22 9:18 ` [PATCH 4/4] Documentation: bcachefs: Add casefolding toctree entry Bagas Sanjaya
2025-02-22 14:07 ` [PATCH 0/4] bcachefs: casefolding.rst fixes Kent Overstreet
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=20250222091853.16487-2-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=joshua@froggi.es \
--cc=kent.overstreet@linux.dev \
--cc=linux-bcachefs@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=sfr@canb.auug.org.au \
/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