From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752521AbcHII2n (ORCPT ); Tue, 9 Aug 2016 04:28:43 -0400 Received: from mail-it0-f68.google.com ([209.85.214.68]:33788 "EHLO mail-it0-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752214AbcHII2k (ORCPT ); Tue, 9 Aug 2016 04:28:40 -0400 MIME-Version: 1.0 X-Originating-IP: [2a02:168:56b5:0:ac27:b86c:7764:9429] In-Reply-To: <20160809082209.GA7553@infradead.org> References: <20160808233502.16950-1-corbet@lwn.net> <20160808233502.16950-4-corbet@lwn.net> <20160809080736.GA15461@infradead.org> <87lh06xsk9.fsf@intel.com> <20160809082209.GA7553@infradead.org> From: Daniel Vetter Date: Tue, 9 Aug 2016 10:28:38 +0200 Message-ID: Subject: Re: [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools To: Christoph Hellwig Cc: Jani Nikula , Jonathan Corbet , linux-doc@vger.kernel.org, Linux Kernel Mailing List Content-Type: text/plain; charset=UTF-8 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Tue, Aug 9, 2016 at 10:22 AM, Christoph Hellwig wrote: > On Tue, Aug 09, 2016 at 11:19:50AM +0300, Jani Nikula wrote: >> On Tue, 09 Aug 2016, Christoph Hellwig wrote: >> > The ugly format is a major regression over a proper simple text >> > file. What's the point? >> >> Major regression? Please be reasonable. >> >> I think the changes are rather small, and it's a fair compromise between >> a simple text file and one that can be used to generate pretty >> documentation [1]. > > It's a lot less pretty to read - it look like a cat threw up to be > specific. The point of the Document is to read it quickly in the kernel > tree. If you want fancy websites write a separate document. > >> [1] http://static.lwn.net/kerneldoc/dev-tools/sparse.html > > And I wouldn't exactly call that pretty. There is no value add > over a simple text file here, and it requires a browser to not look > ugly instead of a text editor, which is a giant usablity regression. The point is to make the docs more discoverable by being able to cross-link them. Old hats like us don't need that, but it definitely has value in bringing new folks on board. And yes I want that, at least for everything that's at least half-relevant to drm/gpu/i915 topics. And given that we just started on a large-scale effort to roll out rcu in our driver (besides all the other bits we're using) that's pretty much everything. -Daniel -- Daniel Vetter Software Engineer, Intel Corporation +41 (0) 79 365 57 48 - http://blog.ffwll.ch