From 1ac00669c35e02c3ce3a5f7c02e65ac6edca6595 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Fri, 1 May 2020 17:37:52 +0200 Subject: [PATCH] docs: move the kref doc into the core-api book This document covers core kernel objects. So, add it into the core-api book. Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/f385af13b4a6d3ff8c89beedd4506900e79ca72e.1588345503.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet --- 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 0caaed576225..15ab86112627 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 c3ac2963283b..e93dc8cf52dd 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