From: "Matthew Wilcox (Oracle)" <willy@infradead.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: "Matthew Wilcox (Oracle)" <willy@infradead.org>,
linux-doc@vger.kernel.org, linux-fsdevel@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH v2 8/8] doc: Split buffer.rst out of api-summary.rst
Date: Tue, 9 Jan 2024 14:33:57 +0000 [thread overview]
Message-ID: <20240109143357.2375046-9-willy@infradead.org> (raw)
In-Reply-To: <20240109143357.2375046-1-willy@infradead.org>
Buffer heads are no longer a generic filesystem API but an optional
filesystem support library. Make the documentation structure reflect
that, and include the fine documentation kept in buffer_head.h.
We could give a better overview of what buffer heads are all about,
but my enthusiasm for documenting it is limited.
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
---
Documentation/filesystems/api-summary.rst | 3 ---
Documentation/filesystems/index.rst | 1 +
2 files changed, 1 insertion(+), 3 deletions(-)
diff --git a/Documentation/filesystems/api-summary.rst b/Documentation/filesystems/api-summary.rst
index 98db2ea5fa12..cc5cc7f3fbd8 100644
--- a/Documentation/filesystems/api-summary.rst
+++ b/Documentation/filesystems/api-summary.rst
@@ -56,9 +56,6 @@ Other Functions
.. kernel-doc:: fs/namei.c
:export:
-.. kernel-doc:: fs/buffer.c
- :export:
-
.. kernel-doc:: block/bio.c
:export:
diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index e18bc5ae3b35..5fc9b19b8d8e 100644
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -50,6 +50,7 @@ filesystem implementations.
.. toctree::
:maxdepth: 2
+ buffer
journalling
fscrypt
fsverity
--
2.43.0
prev parent reply other threads:[~2024-01-09 14:34 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-09 14:33 [PATCH v2 0/8] Improve buffer head documentation Matthew Wilcox (Oracle)
2024-01-09 14:33 ` [PATCH v2 1/8] doc: Improve the description of __folio_mark_dirty Matthew Wilcox (Oracle)
2024-01-09 14:33 ` [PATCH v2 2/8] buffer: Add kernel-doc for block_dirty_folio() Matthew Wilcox (Oracle)
2024-01-10 14:12 ` Pankaj Raghav (Samsung)
2024-01-09 14:33 ` [PATCH v2 3/8] buffer: Add kernel-doc for try_to_free_buffers() Matthew Wilcox (Oracle)
2024-01-10 14:21 ` Pankaj Raghav (Samsung)
2024-01-11 3:22 ` Randy Dunlap
2024-01-09 14:33 ` [PATCH v2 4/8] buffer: Fix __bread and __bread_gfp kernel-doc Matthew Wilcox (Oracle)
2024-01-09 14:33 ` [PATCH v2 5/8] buffer: Add kernel-doc for brelse() and __brelse() Matthew Wilcox (Oracle)
2024-01-10 14:30 ` Pankaj Raghav (Samsung)
2024-01-10 17:26 ` Matthew Wilcox
2024-01-10 20:10 ` Pankaj Raghav (Samsung)
2024-01-09 14:33 ` [PATCH v2 6/8] buffer: Add kernel-doc for bforget() and __bforget() Matthew Wilcox (Oracle)
2024-01-09 14:33 ` [PATCH v2 7/8] buffer: Improve bdev_getblk documentation Matthew Wilcox (Oracle)
2024-01-09 14:33 ` Matthew Wilcox (Oracle) [this message]
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=20240109143357.2375046-9-willy@infradead.org \
--to=willy@infradead.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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;
as well as URLs for NNTP newsgroup(s).