Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

From: Jonathan Corbet
Date: Sun Nov 27 2016 - 18:59:29 EST


On Fri, 25 Nov 2016 22:58:14 +0100
Peter Zijlstra <peterz@xxxxxxxxxxxxx> wrote:

> Not a fan of this. The atomic_ops.txt file needs a lot of love, and I
> wouldn't want to edit a .rst file.
>
> Then again, I probably won't actually get around to fixing this document
> any time soon either.
>
> But if and when I would get around to it, I'll have to change it back to
> a regular .txt file.

Peter, could you please describe what the trouble with RST is? Most of
the files in Documentation/ are already almost in RST format; should we
change them to something else? :)

Silvio, one thing that might help would be to redo the patch with a
minimum of changes and, in particular, a minimum of unnecessary markup.
Yes, it's better to put literal strings in monospace, but we don't have
to, and getting rid of a lot of ``funny quotes`` makes the changes a lot
less intrusive.

jon