Sphinx reports htmldocs warnings on dentry/dcache section:
Documentation/filesystems/bcachefs/casefolding.rst:75: WARNING: Title underline
too short.
dentry/dcache considerations
--------- [docutils]
Documentation/filesystems/bcachefs/casefolding.rst:84: WARNING: Definition list
ends without a blank line; unexpected unindent. [docutils]
Fix the section by:
* Extending the section underline to match the section title length;
* Separating problem list from surrounding paragraphs.
Fixes: bc5cc09246c5 ("bcachefs: bcachefs_metadata_version_casefolding")
Reported-by: Stephen Rothwell <[email protected]>
Closes:
https://lore.kernel.org/linux-next/[email protected]/
Closes:
https://lore.kernel.org/linux-next/[email protected]/
Signed-off-by: Bagas Sanjaya <[email protected]>
---
Documentation/filesystems/bcachefs/casefolding.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/filesystems/bcachefs/casefolding.rst
b/Documentation/filesystems/bcachefs/casefolding.rst
index 1c385b6d21a0a8..d5861b44463576 100644
--- a/Documentation/filesystems/bcachefs/casefolding.rst
+++ b/Documentation/filesystems/bcachefs/casefolding.rst
@@ -73,15 +73,17 @@ any encodings than a single UTF-8 version. When future
encodings are desirable,
they will be added trivially using the opts mechanism.
dentry/dcache considerations
----------
+----------------------------
Currently, in casefolded directories, bcachefs (like other filesystems) will
not cache
negative dentry's.
This is because currently doing so presents a problem in the following
scenario:
+
- Lookup file "blAH" in a casefolded directory
- Creation of file "BLAH" in a casefolded directory
- Lookup file "blAH" in a casefolded directory
+
This would fail if negative dentry's were cached.
This is slightly suboptimal, but could be fixed in future with some vfs work.
--
An old man doll... just what I always wanted! - Clara
