From: Jonathan Corbet <corbet@lwn.net>
To: Markus Heiser <markus.heiser@darmarit.de>
Cc: David Howells <dhowells@redhat.com>,
Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org,
Andrea Parri <andrea.parri@amarulasolutions.com>,
Nicholas Piggin <npiggin@gmail.com>,
linux-arch@vger.kernel.org, Peter Zijlstra <peterz@infradead.org>,
Boqun Feng <boqun.feng@gmail.com>,
Luc Maranget <luc.maranget@inria.fr>,
Alan Stern <stern@rowland.harvard.edu>,
Akira Yokosawa <akiyks@gmail.com>,
Will Deacon <will.deacon@arm.com>,
"Paul E. McKenney" <paulmck@linux.ibm.com>,
Daniel Lustig <dlustig@nvidia.com>,
Jade Alglave <j.alglave@ucl.ac.uk>
Subject: Re: [PATCH 0/8] Prepare files under Documentation/*.txt to build with Sphinx
Date: Fri, 12 Apr 2019 09:39:47 -0600 [thread overview]
Message-ID: <20190412093947.62913186@lwn.net> (raw)
In-Reply-To: <df609cad-fa5b-ac15-314f-ac8759771d90@darmarit.de>
On Fri, 12 Apr 2019 14:34:25 +0200
Markus Heiser <markus.heiser@darmarit.de> wrote:
> Am 12.04.19 um 14:19 schrieb David Howells:
> > Markus Heiser <markus.heiser@darmarit.de> wrote:
> >
> >> Which is already named in our 'How to write kernel documentation' introduction
> >>
> >> - https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html#writing-documentation
> >
> > This should really be in Documentation/ directory.
> >
>
> I agree with you, it is a kind of information hiding. If you know proper
> places, please send a patch to Jon.
As Jani pointed out, it's in Documentation/doc-guide.
If you're saying it should be in the top level, I kind of disagree.
Documentation/ is an exercise in hiding information by placing it in the
middle of 200 other, unrelated files. We've made some progress on that,
and I would like to continue to do so.
Thanks,
jon
next prev parent reply other threads:[~2019-04-12 15:39 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-10 9:56 [PATCH 0/8] Prepare files under Documentation/*.txt to build with Sphinx Mauro Carvalho Chehab
2019-04-10 9:56 ` [PATCH 1/8] docs: DMA-API-HOWTO: add a missing "=" Mauro Carvalho Chehab
2019-04-10 9:56 ` [PATCH 2/8] docs: atomic_bitops.txt: add a title for this document Mauro Carvalho Chehab
2019-04-10 9:56 ` [PATCH 3/8] docs: clearing-warn-once.txt: " Mauro Carvalho Chehab
2019-04-10 9:56 ` [PATCH 4/8] docs: ntb.txt: use Sphinx notation for the two ascii figures Mauro Carvalho Chehab
2019-04-10 9:56 ` [PATCH 5/8] docs: unaligned-memory-access.txt: use a lowercase title Mauro Carvalho Chehab
2019-04-10 9:56 ` [PATCH 6/8] docs: video-output.txt: convert it to ReST format Mauro Carvalho Chehab
2019-04-10 9:56 ` [PATCH 7/8] docs: ntb.txt: add blank lines to clean up some Sphinx warnings Mauro Carvalho Chehab
2019-04-10 9:56 ` [PATCH 8/8] docs: speculation.txt: mark example blocks as such Mauro Carvalho Chehab
2019-04-11 18:37 ` [PATCH 0/8] Prepare files under Documentation/*.txt to build with Sphinx Jonathan Corbet
2019-04-12 10:21 ` David Howells
2019-04-12 10:31 ` Markus Heiser
2019-04-12 12:19 ` David Howells
2019-04-12 12:34 ` Markus Heiser
2019-04-12 15:39 ` Jonathan Corbet [this message]
2019-04-12 16:45 ` Markus Heiser
2019-04-12 14:13 ` Jani Nikula
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=20190412093947.62913186@lwn.net \
--to=corbet@lwn.net \
--cc=akiyks@gmail.com \
--cc=andrea.parri@amarulasolutions.com \
--cc=boqun.feng@gmail.com \
--cc=dhowells@redhat.com \
--cc=dlustig@nvidia.com \
--cc=j.alglave@ucl.ac.uk \
--cc=linux-arch@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=luc.maranget@inria.fr \
--cc=markus.heiser@darmarit.de \
--cc=mchehab+samsung@kernel.org \
--cc=mchehab@infradead.org \
--cc=npiggin@gmail.com \
--cc=paulmck@linux.ibm.com \
--cc=peterz@infradead.org \
--cc=stern@rowland.harvard.edu \
--cc=will.deacon@arm.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).