lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
Open Source and information security mailing list archives
| ||
|
Message-ID: <06b2aeb4-825a-28d6-fa7d-f1f5900e53d8@darmarit.de> Date: Fri, 12 Apr 2019 18:45:42 +0200 From: Markus Heiser <markus.heiser@...marit.de> To: Jonathan Corbet <corbet@....net> Cc: David Howells <dhowells@...hat.com>, Mauro Carvalho Chehab <mchehab+samsung@...nel.org>, Linux Doc Mailing List <linux-doc@...r.kernel.org>, Mauro Carvalho Chehab <mchehab@...radead.org>, linux-kernel@...r.kernel.org, Andrea Parri <andrea.parri@...rulasolutions.com>, Nicholas Piggin <npiggin@...il.com>, linux-arch@...r.kernel.org, Peter Zijlstra <peterz@...radead.org>, Boqun Feng <boqun.feng@...il.com>, Luc Maranget <luc.maranget@...ia.fr>, Alan Stern <stern@...land.harvard.edu>, Akira Yokosawa <akiyks@...il.com>, Will Deacon <will.deacon@....com>, "Paul E. McKenney" <paulmck@...ux.ibm.com>, Daniel Lustig <dlustig@...dia.com>, Jade Alglave <j.alglave@....ac.uk> Subject: Re: [PATCH 0/8] Prepare files under Documentation/*.txt to build with Sphinx Am 12.04.19 um 17:39 schrieb Jonathan Corbet: > On Fri, 12 Apr 2019 14:34:25 +0200 > Markus Heiser <markus.heiser@...marit.de> wrote: > >> Am 12.04.19 um 14:19 schrieb David Howells: >>> Markus Heiser <markus.heiser@...marit.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. 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 --
Powered by blists - more mailing lists