Re: [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools

From: Christoph Hellwig
Date: Tue Aug 09 2016 - 04:22:17 EST


On Tue, Aug 09, 2016 at 11:19:50AM +0300, Jani Nikula wrote:
> On Tue, 09 Aug 2016, Christoph Hellwig <hch@xxxxxxxxxxxxx> 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.