From: Bagas Sanjaya Date: Sat, 22 Feb 2025 09:18:50 +0000 (+0700) Subject: Documentation: bcachefs: casefolding: Do not italicize NUL X-Git-Tag: v6.15-rc1~146^2~87 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=82b5666912e643ce806460130c1fd05fe6354193;p=thirdparty%2Fkernel%2Flinux.git Documentation: bcachefs: casefolding: Do not italicize NUL 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 Closes: https://lore.kernel.org/linux-next/20250221162135.79be0147@canb.auug.org.au/ Signed-off-by: Bagas Sanjaya Signed-off-by: Kent Overstreet --- diff --git a/Documentation/filesystems/bcachefs/casefolding.rst b/Documentation/filesystems/bcachefs/casefolding.rst index 6546aa4f7a868..1c385b6d21a0a 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: