From: Peter Maydell <peter.maydell@linaro.org>
To: Markus Armbruster <armbru@redhat.com>
Cc: "Daniel P. Berrangé" <berrange@redhat.com>,
"John Snow" <jsnow@redhat.com>,
"QEMU Developers" <qemu-devel@nongnu.org>,
"Stefan Hajnoczi" <stefanha@redhat.com>,
"Michael Roth" <mdroth@linux.vnet.ibm.com>
Subject: Re: [PATCH v4 04/18] tests/qapi/doc-good.json: Clean up markup
Date: Thu, 6 Aug 2020 16:33:01 +0100 [thread overview]
Message-ID: <CAFEAcA-NX7mDthCwNKE+zQxfrmJ6D61jknMMubWf6Ym7HEncDA@mail.gmail.com> (raw)
In-Reply-To: <87364z6de4.fsf@dusky.pond.sub.org>
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
next prev parent reply other threads:[~2020-08-06 15:34 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-09 15:43 [PATCH v4 00/18] Convert QAPI doc comments to generate rST instead of texinfo Peter Maydell
2020-03-09 15:43 ` [PATCH v4 01/18] qapi/migration.json: Fix indentation Peter Maydell
2020-03-11 6:06 ` Richard Henderson
2020-03-11 15:12 ` Markus Armbruster
2020-03-09 15:43 ` [PATCH v4 02/18] qapi/qapi-schema.json: Put headers in their own doc-comment blocks Peter Maydell
2020-03-11 6:06 ` Richard Henderson
2020-03-20 9:54 ` Markus Armbruster
2020-03-09 15:43 ` [PATCH v4 03/18] qapi/machine.json: Escape a literal '*' in doc comment Peter Maydell
2020-03-11 6:06 ` Richard Henderson
2020-03-09 15:43 ` [PATCH v4 04/18] tests/qapi/doc-good.json: Clean up markup Peter Maydell
2020-03-11 6:07 ` Richard Henderson
2020-08-05 13:03 ` Markus Armbruster
2020-08-05 13:41 ` Peter Maydell
2020-08-06 14:46 ` Markus Armbruster
2020-08-06 15:33 ` Peter Maydell [this message]
2020-03-09 15:43 ` [PATCH v4 05/18] scripts/qapi: Move doc-comment whitespace stripping to doc.py Peter Maydell
2020-03-11 6:07 ` Richard Henderson
2020-08-06 15:06 ` Markus Armbruster
2020-03-09 15:43 ` [PATCH v4 06/18] scripts/qapi/parser.py: improve doc comment indent handling Peter Maydell
2020-03-11 6:08 ` Richard Henderson
2020-03-09 15:43 ` [PATCH v4 07/18] docs/sphinx: Add new qapi-doc Sphinx extension Peter Maydell
2020-03-09 15:43 ` [PATCH v4 08/18] docs/interop: Convert qemu-ga-ref to rST Peter Maydell
2020-03-11 6:10 ` Richard Henderson
2020-03-09 15:43 ` [PATCH v4 09/18] docs/interop: Convert qemu-qmp-ref " Peter Maydell
2020-03-11 6:11 ` Richard Henderson
2020-03-09 15:43 ` [PATCH v4 10/18] qapi: Use rST markup for literal blocks Peter Maydell
2020-03-11 6:22 ` Richard Henderson
2020-03-09 15:43 ` [PATCH v4 11/18] qga/qapi-schema.json: Add some headings Peter Maydell
2020-03-11 6:22 ` Richard Henderson
2020-03-09 15:43 ` [PATCH v4 12/18] scripts/qapi: Remove texinfo generation support Peter Maydell
2020-03-11 6:23 ` Richard Henderson
2020-03-09 15:44 ` [PATCH v4 13/18] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions Peter Maydell
2020-03-11 6:25 ` Richard Henderson
2020-03-09 15:44 ` [PATCH v4 14/18] Makefile: Remove redundant Texinfo related rules Peter Maydell
2020-03-11 6:27 ` Richard Henderson
2020-03-09 15:44 ` [PATCH v4 15/18] scripts/texi2pod: Delete unused script Peter Maydell
2020-03-11 6:29 ` Richard Henderson
2020-03-09 15:44 ` [PATCH v4 16/18] Remove Texinfo related files from .gitignore and git.orderfile Peter Maydell
2020-03-11 6:30 ` Richard Henderson
2020-03-09 15:44 ` [PATCH v4 17/18] configure: Drop texinfo requirement Peter Maydell
2020-03-11 6:31 ` Richard Henderson
2020-03-09 15:44 ` [PATCH v4 18/18] Remove texinfo dependency from docker and CI configs Peter Maydell
2020-03-11 6:32 ` Richard Henderson
2020-08-05 13:01 ` [PATCH v4 00/18] Convert QAPI doc comments to generate rST instead of texinfo Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAFEAcA-NX7mDthCwNKE+zQxfrmJ6D61jknMMubWf6Ym7HEncDA@mail.gmail.com \
--to=peter.maydell@linaro.org \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=jsnow@redhat.com \
--cc=mdroth@linux.vnet.ibm.com \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).