From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S965676AbcIPUx2 (ORCPT ); Fri, 16 Sep 2016 16:53:28 -0400 Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:47902 "EHLO s-opensource.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S965467AbcIPUxU (ORCPT ); Fri, 16 Sep 2016 16:53:20 -0400 Date: Fri, 16 Sep 2016 17:53:11 -0300 From: Mauro Carvalho Chehab To: Jonathan Corbet Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , Markus Heiser , Jani Nikula , LKML Subject: Re: [PATCH v3 13/21] Documentation/SecurityBugs: convert it to ReST markup Message-ID: <20160916175311.620e480c@vento.lan> In-Reply-To: <20160916111733.6c7e0f5a@lwn.net> References: <20160916111733.6c7e0f5a@lwn.net> Organization: Samsung X-Mailer: Claws Mail 3.13.2 (GTK+ 2.24.30; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Em Fri, 16 Sep 2016 11:17:33 -0600 Jonathan Corbet escreveu: > On Wed, 14 Sep 2016 08:06:42 -0300 > Mauro Carvalho Chehab wrote: > > > Add a name for the document and convert the sections to > > ReST markups. > > No objection to the changes (modulo the discussion on section numbers), > but I do wonder whether this one belongs with the process documentation. > This is here for users as much as anybody. We haven't really begun to > organize user-level docs, but, when we do, I think this maybe belongs > there. Agreed. I moved it to the dev-process just because it was mentioned at the HOWTO, but yeah, it would fit more on a doc/user book, together with README, kernel-parameters.txt, etc. We can certainly move it to there, and enable intersphinx extension, to avoid warnings when just one book is compiled. I guess the big problem with a user book is what should we do with the top README file. It is the main user book, but it is also something that a Kernel developer needs. If you want, I can find some time to work on an user book, but, before that, I guess we need to define what should we do with the README file. My suggestion would be to move its contents to the doc/user/intro.rst file, and, on its place, add a simple README file that would just point to the main books inside Documentation, like: Linux kernel release 4.x For the main Kernel user documentation, please see: Documentation/user For development documentation, please see: Documentation/process For the several API documentation files, please see: Documentation/media Documentation/kernel-drivers Documentation/gpu ... If you want, I can prepare such patches, but I prefer if we can merge those two series before that, in order to avoid dependencies between each patch series. > > Just a thought... > > jon Thanks, Mauro