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>,
Brian Foster <bfoster@redhat.com>,
Jonathan Corbet <corbet@lwn.net>,
"Darrick J. Wong" <djwong@kernel.org>,
Bagas Sanjaya <bagasdotme@gmail.com>,
Chandan Babu R <chandanbabu@kernel.org>,
Namjae Jeon <linkinjeon@kernel.org>,
Steve French <stfrench@microsoft.com>,
Randy Dunlap <rdunlap@infradead.org>
Subject: [PATCH 1/2] Documentation: filesystems: Add bcachefs toctree
Date: Fri, 5 Apr 2024 14:23:18 +0700 [thread overview]
Message-ID: <20240405072320.23416-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20240405072320.23416-1-bagasdotme@gmail.com>
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 <bagasdotme@gmail.com>
---
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
next prev parent reply other threads:[~2024-04-05 7:23 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-05 7:23 [PATCH 0/2] toctree fix for bcachefs docs Bagas Sanjaya
2024-04-05 7:23 ` Bagas Sanjaya [this message]
2024-04-05 7:23 ` [PATCH 2/2] MAINTAINERS: Add entry for bcachefs documentation Bagas Sanjaya
2024-04-06 5:25 ` [PATCH 0/2] toctree fix for bcachefs docs 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=20240405072320.23416-2-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=bfoster@redhat.com \
--cc=chandanbabu@kernel.org \
--cc=corbet@lwn.net \
--cc=djwong@kernel.org \
--cc=kent.overstreet@linux.dev \
--cc=linkinjeon@kernel.org \
--cc=linux-bcachefs@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
--cc=stfrench@microsoft.com \
/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