]> www.infradead.org Git - users/jedix/linux-maple.git/commit
kref: Improve documentation
authorMatthew Wilcox (Oracle) <willy@infradead.org>
Mon, 9 Dec 2024 16:09:44 +0000 (16:09 +0000)
committerJonathan Corbet <corbet@lwn.net>
Fri, 13 Dec 2024 15:49:31 +0000 (08:49 -0700)
commitb76d32422c09bc9310f61a5a89671975db34bd2a
treeb67a8e4b7007b76cfc351c1487cf9497517be592
parent9fb89b97652837a1b73a32aa472d3d44dc7a5ae6
kref: Improve documentation

There is already kernel-doc written for many of the functions in kref.h
but it's not linked into the html docs anywhere.  Add it to kref.rst.

Improve the kref documentation by using the standard Return: section,
rewording some unclear verbiage and adding docs for some undocumented
functions.

Update Thomas' email address to his current one.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241209160953.757673-1-willy@infradead.org
Documentation/core-api/kref.rst
include/linux/kref.h