Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752547AbcLFHws (ORCPT ); Tue, 6 Dec 2016 02:52:48 -0500 Received: from bombadil.infradead.org ([198.137.202.9]:60107 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751180AbcLFHwp (ORCPT ); Tue, 6 Dec 2016 02:52:45 -0500 Date: Tue, 6 Dec 2016 08:52:41 +0100 From: Peter Zijlstra To: LKML , Jonathan Corbet , linux-doc@vger.kernel.org, Christoph Hellwig , Jani Nikula , Mauro Carvalho Chehab , Daniel Vetter Subject: Re: [PATCH] doc: Explain light-handed markup preference a bit better Message-ID: <20161206075241.GU3092@twins.programming.kicks-ass.net> References: <20161129092314.351-1-daniel.vetter@ffwll.ch> <20161129131752.63443vbvoudxe6sy@phenom.ffwll.local> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20161129131752.63443vbvoudxe6sy@phenom.ffwll.local> User-Agent: Mutt/1.5.23.1 (2014-03-12) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1511 Lines: 34 On Tue, Nov 29, 2016 at 02:17:52PM +0100, Daniel Vetter wrote: > Hi Peter, > > On Tue, Nov 29, 2016 at 10:23:14AM +0100, Daniel Vetter wrote: > > 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 > > Since this was motivated by a discussion you've (re)started, does this > sufficiently address your concerns for conversion from plain text .txt to > plain text .rst of existing documents? Anything you'd want to see changed? Seems OK to me, but there's already a bunch of bike-shedding in this thread.