2024-04-05 07:24:23

by Bagas Sanjaya

Subject: [PATCH 0/2] 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
--
An old man doll... just what I always wanted! - Clara

2024-04-05 07:24:28

by Bagas Sanjaya

Subject: [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.

Fixes: eb386617be4b ("bcachefs: Errcode tracepoint, documentation")
Signed-off-by: Bagas Sanjaya <[email protected]>
---
Documentation/filesystems/bcachefs/index.rst | 11 +++++++++++
Documentation/filesystems/index.rst | 1 +
2 files changed, 12 insertions(+)
create mode 100644 Documentation/filesystems/bcachefs/index.rst

diff --git a/Documentation/filesystems/bcachefs/index.rst b/Documentation/filesystems/bcachefs/index.rst
new file mode 100644
index 00000000000000..e2bd61ccd96fff
--- /dev/null
+++ b/Documentation/filesystems/bcachefs/index.rst
@@ -0,0 +1,11 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+======================
+bcachefs Documentation
+======================
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+ errorcodes
diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index 0ea1e44fa02823..1f9b4c905a6a7c 100644
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -69,6 +69,7 @@ Documentation for filesystem implementations.
afs
autofs
autofs-mount-control
+ bcachefs/index
befs
bfs
btrfs
--
An old man doll... just what I always wanted! - Clara

2024-04-05 07:24:41

by Bagas Sanjaya

Subject: [PATCH 2/2] MAINTAINERS: Add entry for bcachefs documentation

Now that bcachefs docs exist in Documentation/filesystems/bcachefs/,
cover it in MAINTAINERS entry for the filesystem.

Signed-off-by: Bagas Sanjaya <[email protected]>
---
MAINTAINERS | 1 +
1 file changed, 1 insertion(+)

diff --git a/MAINTAINERS b/MAINTAINERS
index 7c121493f43d01..c0091a206fd206 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -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]>
--
An old man doll... just what I always wanted! - Clara

2024-04-06 05:25:39

by Kent Overstreet

Subject: Re: [PATCH 0/2] toctree fix for bcachefs docs

On Fri, Apr 05, 2024 at 02:23:17PM +0700, Bagas Sanjaya wrote:
> 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! Applied.