qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v4 04/18] tests/qapi/doc-good.json: Clean up markup


From: Peter Maydell
Subject: Re: [PATCH v4 04/18] tests/qapi/doc-good.json: Clean up markup
Date: Thu, 6 Aug 2020 16:33:01 +0100

On Thu, 6 Aug 2020 at 15:46, Markus Armbruster <armbru@redhat.com> wrote:
> Remind me, how is messed up doc comment indentation reported in the
> brave new Sphinx world?

For insufficient indentatation, like this:

  GEN     qapi-gen
In file included from
/home/petmay01/linaro/qemu-from-laptop/qemu/qapi/qapi-schema.json:91:
/home/petmay01/linaro/qemu-from-laptop/qemu/qapi/machine.json:194:1:
unexpected de-indent

(where the quoted line number in the .json file is the line
that was insufficiently indented).

If you over-indent, then the QAPI parser assumes you intended
to use some rST syntax which needed the extra indent, and passes
it to Sphinx, which will either interpret it as per the rST
spec or complain.

thanks
-- PMM



reply via email to

[Prev in Thread] Current Thread [Next in Thread]