From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
linux-kernel@vger.kernel.org,
Thomas Gleixner <tglx@linutronix.de>,
Ingo Molnar <mingo@redhat.com>,
Peter Zijlstra <peterz@infradead.org>,
Darren Hart <dvhart@infradead.org>, Will Deacon <will@kernel.org>,
Ohad Ben-Cohen <ohad@wizery.com>,
Bjorn Andersson <bjorn.andersson@linaro.org>,
Baolin Wang <baolin.wang7@gmail.com>,
Rob Herring <robh@kernel.org>,
"David S. Miller" <davem@davemloft.net>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
linux-remoteproc@vger.kernel.org
Subject: Re: [PATCH 10/14] docs: move locking-specific documenta to locking/ directory
Date: Fri, 22 May 2020 06:39:58 +0200 [thread overview]
Message-ID: <20200522063958.7e961a98@coco.lan> (raw)
In-Reply-To: <20200515120607.73ee1278@lwn.net>
Em Fri, 15 May 2020 12:06:07 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:
> On Fri, 1 May 2020 17:37:54 +0200
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
>
> > Several files under Documentation/*.txt describe some type of
> > locking API. Move them to locking/ subdir and add to the
> > locking/index.rst index file.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
>
> I've applied this, but it really seems like this belongs in the core-api
> manual someday.
Makes sense.
Well, right now, it is at the same level as core-api, just below it:
Kernel API documentation
------------------------
These books get into the details of how specific kernel subsystems work
from the point of view of a kernel developer. Much of the information here
is taken directly from the kernel source, with supplemental material added
as needed (or at least as we managed to add it — probably *not* all that is
needed).
.. toctree::
:maxdepth: 2
driver-api/index
core-api/index
locking/index
Not too bad.
Btw, there are other doc sets that could also fit into the core-api, like:
...
accounting/index
...
security/index
...
bpf/index
...
scheduler/index
while most of the rest should likely be inside driver-api.
Some care should be taken when moving stuff, though: there is a
reason why they weren't moved to driver-api in the first place:
they may contain stuff for the admin guide mixed there.
Thanks,
Mauro
next prev parent reply other threads:[~2020-05-22 4:40 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 ` [PATCH 08/14] docs: move kobject and kref docs into " Mauro Carvalho Chehab
2020-05-15 18:03 ` 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 [this message]
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=20200522063958.7e961a98@coco.lan \
--to=mchehab+huawei@kernel.org \
--cc=baolin.wang7@gmail.com \
--cc=bjorn.andersson@linaro.org \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=dvhart@infradead.org \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-remoteproc@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=ohad@wizery.com \
--cc=peterz@infradead.org \
--cc=robh@kernel.org \
--cc=tglx@linutronix.de \
--cc=will@kernel.org \
/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).