[v1] Improve buffer head documentation

[PATCH 0/5] Improve buffer head documentation

Matthew Wilcox (Oracle) posted 5 patches 1 year, 11 months ago

Diff against v2
Download series mbox

There is a newer version of this series

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

Expand all Fold all

[PATCH 0/5] Improve buffer head documentation

Posted by Matthew Wilcox (Oracle) 1 year, 11 months ago

Having started improving the kernel-doc for __folio_mark_dirty(), I
then started noticing other improvements that could be made, and this
is as far as I got before deciding I'd made enough for now.  Tested with
make htmldocs.

Matthew Wilcox (Oracle) (5):
  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() kernel-doc
  doc: Split buffer.rst out of api-summary.rst

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

-- 
2.43.0