Skip to content

Commit

Permalink
docs: move the kref doc into the core-api book
Browse files Browse the repository at this point in the history
This document covers core kernel objects. So, add it into the core-api
book.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/f385af13b4a6d3ff8c89beedd4506900e79ca72e.1588345503.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Mauro Carvalho Chehab authored and Jonathan Corbet committed May 15, 2020
1 parent e00b0ab commit 1ac0066
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions Documentation/core-api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Library functionality that is used throughout the kernel.
:maxdepth: 1

kobject
kref
assoc_array
xarray
idr
Expand Down
2 changes: 1 addition & 1 deletion Documentation/core-api/kobject.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ statically and will warn the developer of this improper usage.
If all that you want to use a kobject for is to provide a reference counter
for your structure, please use the struct kref instead; a kobject would be
overkill. For more information on how to use struct kref, please see the
file Documentation/kref.txt in the Linux kernel source tree.
file Documentation/core-api/kref.rst in the Linux kernel source tree.


Creating "simple" kobjects
Expand Down
File renamed without changes.

0 comments on commit 1ac0066

Please sign in to comment.