Re: [PATCH 0/8] Prepare files under Documentation/*.txt to build with Sphinx

From: Jonathan Corbet
Date: Fri Apr 12 2019 - 11:39:56 EST


On Fri, 12 Apr 2019 14:34:25 +0200
Markus Heiser <markus.heiser@xxxxxxxxxxx> wrote:

> Am 12.04.19 um 14:19 schrieb David Howells:
> > Markus Heiser <markus.heiser@xxxxxxxxxxx> 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