2020-05-01 15:43:08

by Mauro Carvalho Chehab

Subject: [PATCH 08/14] docs: move kobject and kref docs into the core-api book

Both documents are documenting Kernel core objects. So, add
them into the core-api book.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/core-api/index.rst | 1 +
Documentation/core-api/kobject.rst | 2 +-
Documentation/{kref.txt => core-api/kref.rst} | 0
3 files changed, 2 insertions(+), 1 deletion(-)
rename Documentation/{kref.txt => core-api/kref.rst} (100%)

diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index 49a885e83a55..eeac63ba17c3 100644
--- a/Documentation/core-api/index.rst
+++ b/Documentation/core-api/index.rst
@@ -31,6 +31,7 @@ Library functionality that is used throughout the kernel.
:maxdepth: 1

kobject
+ kref
assoc_array
xarray
idr
diff --git a/Documentation/core-api/kobject.rst b/Documentation/core-api/kobject.rst
index 1f62d4d7d966..44c02be65475 100644
--- a/Documentation/core-api/kobject.rst
+++ b/Documentation/core-api/kobject.rst
@@ -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
diff --git a/Documentation/kref.txt b/Documentation/core-api/kref.rst
similarity index 100%
rename from Documentation/kref.txt
rename to Documentation/core-api/kref.rst
--
2.25.4

2020-05-15 18:05:30

by Jonathan Corbet

Subject: Re: [PATCH 08/14] docs: move kobject and kref docs into the core-api book

On Fri, 1 May 2020 17:37:52 +0200
Mauro Carvalho Chehab <[email protected]> wrote:

> Both documents are documenting Kernel core objects. So, add
> them into the core-api book.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> Documentation/core-api/index.rst | 1 +
> Documentation/core-api/kobject.rst | 2 +-
> Documentation/{kref.txt => core-api/kref.rst} | 0
> 3 files changed, 2 insertions(+), 1 deletion(-)
> rename Documentation/{kref.txt => core-api/kref.rst} (100%)

Applied with a tweaked changelog, since it's not actually moving the
kobject doc.

jon