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

From: Jonathan Corbet
Date: Tue Aug 09 2016 - 18:53:53 EST


On Tue, 9 Aug 2016 01:31:06 -0700
Christoph Hellwig <hch@xxxxxxxxxxxxx> wrote:

> On Tue, Aug 09, 2016 at 10:28:38AM +0200, Daniel Vetter wrote:
> > 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.
>
> But do that in a way that keeps the old hats happy. The crazy use of
> punctuation and the weird quotes is an absolute no-go.

As others have noted, the long-term goal is to turn our disorganized
documentation hairball into something more approachable, maintainable, and
integrated; this is a step in that direction.

I take it you object to the ``literal quotes`` which render in a monospace
font? That's the bulk of the changes there. I can certainly take them
out if you really think "__bitwise" looks better than ``__bitwise``; it
will adversely affect the resulting pages, but so be it.

jon