]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
docs: move the kref doc into the core-api book
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Fri, 1 May 2020 15:37:52 +0000 (17:37 +0200)
committerJonathan Corbet <corbet@lwn.net>
Fri, 15 May 2020 18:02:19 +0000 (12:02 -0600)
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>
Documentation/core-api/index.rst
Documentation/core-api/kobject.rst
Documentation/core-api/kref.rst [moved from Documentation/kref.txt with 100% similarity]

index 0caaed576225f17a2e1681620f7c79b270283564..15ab8611262720da67254faf431a4b8ce1b3366a 100644 (file)
@@ -31,6 +31,7 @@ Library functionality that is used throughout the kernel.
    :maxdepth: 1
 
    kobject
+   kref
    assoc_array
    xarray
    idr
index c3ac2963283bfa2c69ad5bf94f47610952f540d5..e93dc8cf52dd4b1a0d5fd890d54ced8c1cd73f72 100644 (file)
@@ -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