toctree fix for bcachefs docs
cover toctree fix for bcachefs docs
Hi Kent,
Building htmldocs for current Linus's tree triggers a new warning, and that is on your docs (missing toctree). Here's the fix + MAINTAINERS entry for bcachefs docs.
Thanks.
Bagas Sanjaya (2):
Documentation: filesystems: Add bcachefs toctree
MAINTAINERS: Add entry for bcachefs documentation
Documentation/filesystems/bcachefs/index.rst | 11 +++++++++++ Documentation/filesystems/index.rst | 1 + MAINTAINERS | 1 + 3 files changed, 13 insertions(+) create mode 100644 Documentation/filesystems/bcachefs/index.rst
base-commit: 09d4c2acbf4c864fef0f520bbcba256c9a19102e
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 1/2 Documentation: filesystems: Add bcachefs toctree
Commit eb386617be4bdf ("bcachefs: Errcode tracepoint, documentation") adds initial bcachefs documentation (private error codes) but without any table of contents tree for the filesystem docs, hence Sphinx warns:
Documentation/filesystems/bcachefs/errorcodes.rst: WARNING: document isn't included in any toctree
Add bcachefs toctree to fix above warning.
--- Documentation/filesystems/bcachefs/index.rst | 11 +++++++++++ Documentation/filesystems/index.rst | 1 + 2 files changed, 12 insertions(+) create mode 100644 Documentation/filesystems/bcachefs/index.rst
Documentation/filesystems/bcachefs/index.rst new file +11 -0
@@ -0,0 +1,11 @@ +.. SPDX-License-Identifier: GPL-2.0 + +====================== +bcachefs Documentation +====================== + +.. toctree:: + :maxdepth: 2 + :numbered: + + errorcodes
Documentation/filesystems/index.rst +1 -0
@@ -69,6 +69,7 @@ Documentation for filesystem implementations. afs autofs autofs-mount-control + bcachefs/index befs bfs btrfs
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 2/2 MAINTAINERS: Add entry for bcachefs documentation
In reply to Bagas SanjayaNow that bcachefs docs exist in Documentation/filesystems/bcachefs/, cover it in MAINTAINERS entry for the filesystem.
--- MAINTAINERS | 1 + 1 file changed, 1 insertion(+)
MAINTAINERS +1 -0
@@ -3573,6 +3573,7 @@ S: Supported C: irc://irc.oftc.net/bcache T: git https://evilpiepirate.org/git/bcachefs.git F: fs/bcachefs/ +F: Documentation/filesystems/bcachefs/ BDISP ST MEDIA DRIVER M: Fabien Dessenne <[email protected]>
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Kent Overstreet
AppliedQuoted 5 lines · Bagas Sanjaya
Hi Kent,
Building htmldocs for current Linus's tree triggers a new warning, and that is on your docs (missing toctree). Here's the fix +
MAINTAINERSentry for bcachefs docs.
Thanks! Applied.