[PATCH v2 0/8] Improve buffer head documentation

From: Matthew Wilcox (Oracle)
Date: Tue Jan 09 2024 - 09:36:53 EST


Turn buffer head documentation into its own document, and make many
general improvements to the docs. Obviously there is much more that
could be done. Tested with make htmldocs.

v2:
- Incorporate feedback from Randy & Pankaj
- Add docs for brelse() and bforget()
- Improve bdev_getblk() docs

Matthew Wilcox (Oracle) (8):
doc: Improve the description of __folio_mark_dirty
buffer: Add kernel-doc for block_dirty_folio()
buffer: Add kernel-doc for try_to_free_buffers()
buffer: Fix __bread and __bread_gfp kernel-doc
buffer: Add kernel-doc for brelse() and __brelse()
buffer: Add kernel-doc for bforget() and __bforget()
buffer: Improve bdev_getblk documentation
doc: Split buffer.rst out of api-summary.rst

Documentation/filesystems/api-summary.rst | 3 -
Documentation/filesystems/index.rst | 1 +
fs/buffer.c | 165 +++++++++++++---------
include/linux/buffer_head.h | 48 +++++--
mm/page-writeback.c | 14 +-
5 files changed, 145 insertions(+), 86 deletions(-)

--
2.43.0