Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1757110AbcK2K2p convert rfc822-to-8bit (ORCPT ); Tue, 29 Nov 2016 05:28:45 -0500 Received: from smtp3.goneo.de ([85.220.129.37]:36290 "EHLO smtp3.goneo.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1757173AbcK2K2b (ORCPT ); Tue, 29 Nov 2016 05:28:31 -0500 X-Spam-Flag: NO X-Spam-Score: -2.726 Content-Type: text/plain; charset=us-ascii Mime-Version: 1.0 (Mac OS X Mail 6.6 \(1510\)) Subject: Re: [PATCH] doc: Explain light-handed markup preference a bit better From: Markus Heiser In-Reply-To: <20161129092314.351-1-daniel.vetter@ffwll.ch> Date: Tue, 29 Nov 2016 11:28:12 +0100 Cc: LKML , Jonathan Corbet , linux-doc@vger.kernel.org, Christoph Hellwig , Peter Zijlstra , Jani Nikula , Mauro Carvalho Chehab , Daniel Vetter Content-Transfer-Encoding: 8BIT Message-Id: <8EA6D751-36E7-4CEB-8817-1B186A685B96@darmarit.de> References: <20161129092314.351-1-daniel.vetter@ffwll.ch> To: Daniel Vetter X-Mailer: Apple Mail (2.1510) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1849 Lines: 49 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. -- Markus --