From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1757330AbcK2LyT convert rfc822-to-8bit (ORCPT ); Tue, 29 Nov 2016 06:54:19 -0500 Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:45091 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1751494AbcK2LyK (ORCPT ); Tue, 29 Nov 2016 06:54:10 -0500 Date: Tue, 29 Nov 2016 09:54:00 -0200 From: Mauro Carvalho Chehab To: Markus Heiser Cc: Daniel Vetter , LKML , Jonathan Corbet , linux-doc@vger.kernel.org, Christoph Hellwig , Peter Zijlstra , Jani Nikula , Daniel Vetter Subject: Re: [PATCH] doc: Explain light-handed markup preference a bit better Message-ID: <20161129095400.0e698ff6@vento.lan> In-Reply-To: <8EA6D751-36E7-4CEB-8817-1B186A685B96@darmarit.de> References: <20161129092314.351-1-daniel.vetter@ffwll.ch> <8EA6D751-36E7-4CEB-8817-1B186A685B96@darmarit.de> 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: 8BIT Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Em Tue, 29 Nov 2016 11:28:12 +0100 Markus Heiser escreveu: > Am 29.11.2016 um 10:23 schrieb Daniel Vetter : > > > We already had a super-short blurb, but worth extending it I think: > > We're still pretty far away from anything like a consensus, but > > there's clearly a lot of people who prefer an as-light as possible > > approach to converting existing .txt files to .rst. Make sure this is > > properly taken into account and clear. > > > > Motivated by discussions with Peter and Christoph and others. > > > > v2: > > - Mention that existing headings should be kept when converting > > existing .txt files (Mauro). > > - Explain that we prefer :: for quoting code, it's easier on the > > eyes (Mauro). > > - Explain that blindly converting outdated docs is harmful. Motived > > by comments Peter did in our discussion. > > > > Cc: Jonathan Corbet > > Cc: linux-doc@vger.kernel.org > > Cc: Christoph Hellwig > > Cc: Peter Zijlstra > > Cc: Jani Nikula > > Cc: Mauro Carvalho Chehab > > Signed-off-by: Daniel Vetter > > --- > > Documentation/kernel-documentation.rst | 44 ++++++++++++++++++++++++++++++++-- > > 1 file changed, 42 insertions(+), 2 deletions(-) > > Sorry for my dump remarks ... > > * shouldn't it on top of Jon's docs-next? > * should we lose a few words about tabs/indentation? > > IMO indentation for reST markup should be 2 spaces, not > tabs (8 spaces). I know about CodeStyling but I think this doc > (markup) and not source-code. Code-examples should be indent > by tabs as usual. BTW here is what CodingStyle says: > > Outside of comments, documentation and except in Kconfig, > spaces are never used for indentation, and the above example > is deliberately broken. > Get a decent editor and don't leave whitespace at the end of > lines. > > ... encourages me to prefer spaces. I agree that we should define the preferred spaces style. Yet, I very much prefer that patches converting existing documents to not touch whitespaces/tabs except when really needed. >>From my side, the editors I use to write documents are set to automatically convert 8 column alignments to tabs. I also have a script that I run when needed, when I receive a patch with whitespaces at the end of lines. It also converts spaces to tabs where needed. So, whatever definition we use, IMO we should define that a tab has 8 spaces, and that tabs should be used if the alignment requires more than 8 columns. With regards of using indentation with 2 spaces, I don't have any strong opinion. >>From what I remember, the scripts you used to convert the media documents made a 4 spaces alignment for the media documentation on several places, but I may be wrong. Thanks, Mauro