diff options
| author | Matthew Wilcox (Oracle) <willy@infradead.org> | 2024-12-09 19:09:44 +0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2024-12-13 18:49:31 +0300 |
| commit | b76d32422c09bc9310f61a5a89671975db34bd2a (patch) | |
| tree | b67a8e4b7007b76cfc351c1487cf9497517be592 /Documentation/core-api | |
| parent | 9fb89b97652837a1b73a32aa472d3d44dc7a5ae6 (diff) | |
| download | linux-b76d32422c09bc9310f61a5a89671975db34bd2a.tar.xz | |
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
Diffstat (limited to 'Documentation/core-api')
| -rw-r--r-- | Documentation/core-api/kref.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Documentation/core-api/kref.rst b/Documentation/core-api/kref.rst index c61eea6f1bf2..8db9ff03d952 100644 --- a/Documentation/core-api/kref.rst +++ b/Documentation/core-api/kref.rst @@ -3,7 +3,7 @@ Adding reference counters (krefs) to kernel objects =================================================== :Author: Corey Minyard <minyard@acm.org> -:Author: Thomas Hellstrom <thellstrom@vmware.com> +:Author: Thomas Hellström <thomas.hellstrom@linux.intel.com> A lot of this was lifted from Greg Kroah-Hartman's 2004 OLS paper and presentation on krefs, which can be found at: @@ -321,3 +321,8 @@ rcu grace period after release_entry_rcu was called. That can be accomplished by using kfree_rcu(entry, rhead) as done above, or by calling synchronize_rcu() before using kfree, but note that synchronize_rcu() may sleep for a substantial amount of time. + +Functions and structures +======================== + +.. kernel-doc:: include/linux/kref.h |