Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754595AbcK1KVh (ORCPT ); Mon, 28 Nov 2016 05:21:37 -0500 Received: from merlin.infradead.org ([205.233.59.134]:34174 "EHLO merlin.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754268AbcK1KUf (ORCPT ); Mon, 28 Nov 2016 05:20:35 -0500 Date: Mon, 28 Nov 2016 11:20:09 +0100 From: Peter Zijlstra To: Jonathan Corbet , Silvio Fricke , linux-doc@vger.kernel.org, Ming Lei , "Luis R . Rodriguez" , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jani Nikula Subject: Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup Message-ID: <20161128102009.GV3092@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> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20161128084442.uqfcar5qx2b7u34v@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: 1236 Lines: 30 On Mon, Nov 28, 2016 at 09:44:42AM +0100, Daniel Vetter wrote: > > > > Why change them? What was wrong with txt to begin with? > > In my opinion good docs matter, and one of the key things is to be able to > cross reference stuff. Well, good docs begin with useful content; and many docs lack that. Fixing that would be a much more useful thing to do. In any case, I've never had any problems with typing things like: "go read: Documentation/file.txt for more information.". Also, what text editor supports cross references at all then? With the filename I can use 'gf' in vim to open it up in a new buffer and go read that. > Another concern some core kernel folks raised is that the .rst markup was > too heavy-handed, and makes the text much harder to read. Christoph called > it "cat spew". That can be fixed with a much lighter-handed conversion > (and 2nd patch iteration was acceptable for Christoph). 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. Basically, if a file isn't usable from within a 'normal' text editor, it doesn't exist.