From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
"Rafael J. Wysocki" <rafael@kernel.org>,
Masahiro Yamada <yamada.masahiro@socionext.com>,
Mike Rapoport <rppt@linux.ibm.com>,
Daniel Jordan <daniel.m.jordan@oracle.com>,
Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Subject: [PATCH 08/14] docs: move kobject and kref docs into the core-api book
Date: Fri, 1 May 2020 17:37:52 +0200 [thread overview]
Message-ID: <f385af13b4a6d3ff8c89beedd4506900e79ca72e.1588345503.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1588345503.git.mchehab+huawei@kernel.org>
Both documents are documenting Kernel core objects. So, add
them into the core-api book.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
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
next prev parent reply other threads:[~2020-05-01 15:38 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1588345503.git.mchehab+huawei@kernel.org>
2020-05-01 15:37 ` [PATCH 01/14] docs: move DMA kAPI to Documentation/core-api Mauro Carvalho Chehab
2020-05-15 17:52 ` Jonathan Corbet
2020-05-01 15:37 ` [PATCH 02/14] docs: add bus-virt-phys-mapping.txt to core-api Mauro Carvalho Chehab
2020-05-15 17:53 ` Jonathan Corbet
2020-05-22 4:22 ` Mauro Carvalho Chehab
2020-05-01 15:37 ` [PATCH 04/14] docs: move IPMI.txt to the driver API book Mauro Carvalho Chehab
2020-05-01 16:16 ` Corey Minyard
2020-05-15 17:56 ` Jonathan Corbet
2020-05-01 15:37 ` [PATCH 05/14] docs: fix references for ipmi.rst file Mauro Carvalho Chehab
2020-05-01 15:37 ` [PATCH 06/14] docs: debugging-via-ohci1394.txt: add it to the core-api book Mauro Carvalho Chehab
2020-05-15 18:00 ` Jonathan Corbet
2020-05-22 4:26 ` Mauro Carvalho Chehab
2020-05-01 15:37 ` [PATCH 07/14] docs: add IRQ documentation at " Mauro Carvalho Chehab
2020-05-02 7:41 ` Mike Rapoport
2020-05-02 10:16 ` Mauro Carvalho Chehab
2020-05-02 11:21 ` Mike Rapoport
2020-05-15 18:01 ` Jonathan Corbet
2020-05-01 15:37 ` Mauro Carvalho Chehab [this message]
2020-05-15 18:03 ` [PATCH 08/14] docs: move kobject and kref docs into " Jonathan Corbet
2020-05-01 15:37 ` [PATCH 09/14] docs: move digsig docs to the security book Mauro Carvalho Chehab
2020-05-15 18:04 ` Jonathan Corbet
2020-05-01 15:37 ` [PATCH 10/14] docs: move locking-specific documenta to locking/ directory Mauro Carvalho Chehab
2020-05-15 18:06 ` Jonathan Corbet
2020-05-22 4:39 ` Mauro Carvalho Chehab
2020-05-01 15:37 ` [PATCH 11/14] docs: move other kAPI documents to core-api Mauro Carvalho Chehab
2020-05-02 7:43 ` Mike Rapoport
2020-05-15 18:10 ` Jonathan Corbet
2020-05-01 15:37 ` [PATCH 12/14] docs: move remaining stuff under Documentation/*.txt to Documentation/staging Mauro Carvalho Chehab
2020-05-03 23:54 ` Masami Hiramatsu
2020-05-04 0:47 ` Joe Perches
2020-05-04 9:51 ` Naveen N. Rao
2020-05-01 15:37 ` [PATCH 13/14] docs: staging: don't use literalinclude Mauro Carvalho Chehab
2020-05-01 15:37 ` [PATCH 14/14] docs: staging: use small font for literal includes Mauro Carvalho Chehab
2020-05-02 0:10 ` Joe Perches
2020-05-02 10:27 ` Mauro Carvalho Chehab
2020-05-04 9:25 ` [PATCH 00/14] Move the ReST files from Documentation/*.txt Akira Yokosawa
2020-05-04 9:50 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=f385af13b4a6d3ff8c89beedd4506900e79ca72e.1588345503.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=daniel.m.jordan@oracle.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=manivannan.sadhasivam@linaro.org \
--cc=rafael@kernel.org \
--cc=rppt@linux.ibm.com \
--cc=yamada.masahiro@socionext.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).