From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1758522AbcJRIiH (ORCPT ); Tue, 18 Oct 2016 04:38:07 -0400 Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:39816 "EHLO s-opensource.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752206AbcJRIiE (ORCPT ); Tue, 18 Oct 2016 04:38:04 -0400 Date: Tue, 18 Oct 2016 06:37:54 -0200 From: Mauro Carvalho Chehab To: Jonathan Corbet Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , LKML Subject: Re: [PATCH 00/32] Create an User's manual and improve development-process book Message-ID: <20161018063754.7a2820b3@vento.lan> In-Reply-To: <20161017164342.28d4f0c3@lwn.net> References: <20161017164342.28d4f0c3@lwn.net> Organization: Samsung X-Mailer: Claws Mail 3.14.0 (GTK+ 2.24.31; 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 Mon, 17 Oct 2016 16:43:42 -0600 Jonathan Corbet escreveu: > I've only been able to take a quick look at these - I'm buried fairly deep > at the moment. A few superficial thoughts. > > On Mon, 17 Oct 2016 14:55:37 -0200 > Mauro Carvalho Chehab wrote: > > > In my opinion, it would be better to move the converted files to be inside > > a Sphinx build directory, but Jon seems reluctant to that, so, this series > > use symlinks, as it is easy to move the files in the future with a very simple > > patch, if we decide to do so. > > So I raised this topic in talks at both Kernel Recipes and LinuxCon > Europe, and nobody threw things at me. I have come to suspect that I'm > worrying a little too much about it; maybe we should go ahead and move > the documents and see who screams. The work could go into docs-next soon, > and there would be an opportunity to fix things up if all hell breaks > loose at the kernel summit. > > Can I make some silly requests? > > - Can we move development-process to something shorter, like just > "process"? We'll be typing it a lot, and tab completion doesn't work in > most email clients :) OK! > - I think we should leave pointers behind in the form of one-line "this > file has moved" messages. Probably only SubmittingPatches and > CodingStyle need that treatment, I think. Ok. Following such logic, I guess we should also add a similar notice to the main README file too, that will be at the "user/admin-guide". I would actually be a little more verbose there, providing pointers to the main documentation books (e. g. the non-subsystem specific ones) there, like: The content of this file was moved to Documentation/admin-guide/README.rst For Kernel's build and admin documentation, please see Documentation/admin-guide; For guides about the Kernel development process, please see Documentation/process; ... > - The "user manual" is certainly something that has been on my mind as > well. We have documentation for completely separate audiences all mixed > together now, and definitely need to fix that. But rather than "user", > can we paint that shed "admin-guide" or something like that? Ok! "admin-guide" sounds a good name. > Thanks for doing all of this, Anytime! Thanks, Mauro