Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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.

[willy@infradead.org: fix kerneldoc warning]
Link: https://lkml.kernel.org/r/20240417015933.453505-1-willy@infradead.org
[akpm@linux-foundation.org: remove newline at EOF]
Link: https://lkml.kernel.org/r/20240416031754.4076917-9-willy@infradead.org
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Pankaj Raghav <p.raghav@samsung.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

authored by

Matthew Wilcox (Oracle) and committed by
Andrew Morton
5ec5aab7 0b116ff4

+13 -3
-3
Documentation/filesystems/api-summary.rst
··· 56 56 .. kernel-doc:: fs/namei.c 57 57 :export: 58 58 59 - .. kernel-doc:: fs/buffer.c 60 - :export: 61 - 62 59 .. kernel-doc:: block/bio.c 63 60 :export: 64 61
+12
Documentation/filesystems/buffer.rst
··· 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:
+1
Documentation/filesystems/index.rst
··· 50 50 .. toctree:: 51 51 :maxdepth: 2 52 52 53 + buffer 53 54 journalling 54 55 fscrypt 55 56 fsverity