Skip to content

Commit 5ec5aab

Browse files
Matthew Wilcox (Oracle)akpm00
authored andcommitted
doc: split buffer.rst out of api-summary.rst
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. [[email protected]: fix kerneldoc warning] Link: https://lkml.kernel.org/r/[email protected] [[email protected]: remove newline at EOF] Link: https://lkml.kernel.org/r/[email protected] Signed-off-by: Matthew Wilcox (Oracle) <[email protected]> Tested-by: Randy Dunlap <[email protected]> Cc: Pankaj Raghav <[email protected]> Signed-off-by: Andrew Morton <[email protected]>
1 parent 0b116ff commit 5ec5aab

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

Documentation/filesystems/api-summary.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,6 @@ Other Functions
5656
.. kernel-doc:: fs/namei.c
5757
:export:
5858

59-
.. kernel-doc:: fs/buffer.c
60-
:export:
61-
6259
.. kernel-doc:: block/bio.c
6360
:export:
6461

Documentation/filesystems/buffer.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Buffer Heads
2+
============
3+
4+
Linux uses buffer heads to maintain state about individual filesystem blocks.
5+
Buffer heads are deprecated and new filesystems should use iomap instead.
6+
7+
Functions
8+
---------
9+
10+
.. kernel-doc:: include/linux/buffer_head.h
11+
.. kernel-doc:: fs/buffer.c
12+
:export:

Documentation/filesystems/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ filesystem implementations.
5050
.. toctree::
5151
:maxdepth: 2
5252

53+
buffer
5354
journalling
5455
fscrypt
5556
fsverity

0 commit comments

Comments
 (0)