Re: [PATCH 00/29] Convert QAPI doc comments to generate rST instead of texinfo

[Peter Maydell]

On Thu, 6 Feb 2020 at 17:30, Peter Maydell <address@hidden> wrote:
> This series switches all our QAPI doc comments over from
> texinfo format to rST.

Oops, this fails 'make check' because I forgot to run it (not thinking
of docs changes as being stuff that affects test) and there are
a couple of golden-master files that need updating. I have some
minor changes that I'll put in v2 which correct that:

 * a new patch "tests/qapi/doc-good.json: Clean up markup"
   which removes some oddities of the old markup that we don't
   want to support, tightening up the tested doc comments:
     * in a single list the bullet types must all match
     * lists must have leading and following blank lines
     * indentation is important
     * the '|' example syntax is going to go away entirely,
       so stop testing it
 * patches "scripts/qapi: Move doc-comment whitespace stripping to doc.py"
   and "scripts/qapi/parser.py: improve doc comment indent handling"
   both make minor whitespace changes that require updates to the
   tests/qapi-schema/doc-good.out reference
 * "scripts/qapi: Remove texinfo generation support" now
   removes the no-longer-used tests/qapi-schema/doc-good.texi

I won't send v2 until this has had some review, though. If you
want a git branch with the pending-for-v2 fixups it's at:
https://git.linaro.org/people/peter.maydell/qemu-arm.git sphinx-conversions

thanks
-- PMM