From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jonathan Corbet Subject: Re: [PATCH 0/8] Prepare files under Documentation/*.txt to build with Sphinx Date: Fri, 12 Apr 2019 09:39:47 -0600 Message-ID: <20190412093947.62913186@lwn.net> References: <94c47f05-0412-b938-908d-1ef8a91243ed@darmarit.de> <18261.1555064496@warthog.procyon.org.uk> <27303.1555071586@warthog.procyon.org.uk> Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Return-path: In-Reply-To: Sender: linux-kernel-owner@vger.kernel.org To: Markus Heiser Cc: David Howells , Mauro Carvalho Chehab , Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Andrea Parri , Nicholas Piggin , linux-arch@vger.kernel.org, Peter Zijlstra , Boqun Feng , Luc Maranget , Alan Stern , Akira Yokosawa , Will Deacon , "Paul E. McKenney" , Daniel Lustig , Jade Alglave List-Id: linux-arch.vger.kernel.org On Fri, 12 Apr 2019 14:34:25 +0200 Markus Heiser wrote: > Am 12.04.19 um 14:19 schrieb David Howells: > > Markus Heiser 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 From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ms.lwn.net ([45.79.88.28]:45164 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726711AbfDLPjz (ORCPT ); Fri, 12 Apr 2019 11:39:55 -0400 Date: Fri, 12 Apr 2019 09:39:47 -0600 From: Jonathan Corbet Subject: Re: [PATCH 0/8] Prepare files under Documentation/*.txt to build with Sphinx Message-ID: <20190412093947.62913186@lwn.net> In-Reply-To: References: <94c47f05-0412-b938-908d-1ef8a91243ed@darmarit.de> <18261.1555064496@warthog.procyon.org.uk> <27303.1555071586@warthog.procyon.org.uk> MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-arch-owner@vger.kernel.org List-ID: To: Markus Heiser Cc: David Howells , Mauro Carvalho Chehab , Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Andrea Parri , Nicholas Piggin , linux-arch@vger.kernel.org, Peter Zijlstra , Boqun Feng , Luc Maranget , Alan Stern , Akira Yokosawa , Will Deacon , "Paul E. McKenney" , Daniel Lustig , Jade Alglave Message-ID: <20190412153947.vOowt4R-JYkALKiGnDCctruYQAzScdXcnGyRyLrIV1U@z> On Fri, 12 Apr 2019 14:34:25 +0200 Markus Heiser wrote: > Am 12.04.19 um 14:19 schrieb David Howells: > > Markus Heiser 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