Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754431AbcK1L4v (ORCPT ); Mon, 28 Nov 2016 06:56:51 -0500 Received: from merlin.infradead.org ([205.233.59.134]:34492 "EHLO merlin.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750878AbcK1L4p (ORCPT ); Mon, 28 Nov 2016 06:56:45 -0500 Date: Mon, 28 Nov 2016 12:56:41 +0100 From: Peter Zijlstra To: Jani Nikula Cc: Jonathan Corbet , Silvio Fricke , linux-doc@vger.kernel.org, Ming Lei , "Luis R . Rodriguez" , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org Subject: Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup Message-ID: <20161128115641.GX3092@twins.programming.kicks-ass.net> References: <20161125215814.GA3061@worktop.programming.kicks-ass.net> <20161127165914.5b84cc65@lwn.net> <20161128072626.GT3092@twins.programming.kicks-ass.net> <20161128084442.uqfcar5qx2b7u34v@phenom.ffwll.local> <20161128102009.GV3092@twins.programming.kicks-ass.net> <87fumb26si.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <87fumb26si.fsf@intel.com> 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: 1265 Lines: 27 On Mon, Nov 28, 2016 at 01:16:45PM +0200, Jani Nikula wrote: > Using rst we can produce decent HTML pages, and make them available at > [1], in context. You don't have to read that, but it will be a lot more > discoverable for other people, another important quality of good > documentation. And perhaps you don't have to tell people to go read it > so much. > > [1] https://www.kernel.org/doc/html/latest/ *sigh*, basically if I have to touch a browser its broken. > > Very much agreed, once a file is no longer readable with less or the > > text editor of your choice, it as good doesn't exist at all. So I very > > much worry about RST even supporting such heavy markup that the end > > result is unreadable. > > The goal is to have the best of both worlds, keeping it pretty much > plain text, but adding just enough consistency in formatting that you > can generate other formats out of it. We don't have to and we shouldn't > go overboard with the markup. > > Arguably you could call rst a "coding style" for plain text. We have > pretty uniform C code, I don't think it's unreasonable to have a little > bit of consistency in the plain text. And really, it's not much we're > asking. With some decidedly daft conventions though; see my email to Mauro.