Am 12.04.19 um 17:39 schrieb Jonathan Corbet:
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.
For those who are new and are willing to document, it migth be a good idea
to have a simple Documentation/README.txt with a link to doc-guide?
Just a few words, I find with my editor, this is what I find often helpful
when I'am new to a project.
-- Markus --