Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932237AbcK1MdL (ORCPT ); Mon, 28 Nov 2016 07:33:11 -0500 Received: from mga06.intel.com ([134.134.136.31]:59541 "EHLO mga06.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932094AbcK1MdD (ORCPT ); Mon, 28 Nov 2016 07:33:03 -0500 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.31,563,1473145200"; d="scan'208";a="791636414" From: Jani Nikula To: Peter Zijlstra 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 In-Reply-To: <20161128115641.GX3092@twins.programming.kicks-ass.net> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo 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> <20161128115641.GX3092@twins.programming.kicks-ass.net> Date: Mon, 28 Nov 2016 14:32:42 +0200 Message-ID: <877f7n239x.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1463 Lines: 33 On Mon, 28 Nov 2016, Peter Zijlstra wrote: > 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. Hey, I specifically said *you* don't have to... >> > 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. -- Jani Nikula, Intel Open Source Technology Center