[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 14/20] qapi: fix non-compliant JSON examples
From: |
Markus Armbruster |
Subject: |
Re: [PATCH 14/20] qapi: fix non-compliant JSON examples |
Date: |
Fri, 14 Jun 2024 12:55:38 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) |
John Snow <jsnow@redhat.com> writes:
> If we parse all examples as QMP, we need them to conform to a standard
> so that they render correctly. Once the QMP lexer is active for
> examples, these will produce warning messages and fail the build.
>
> The QMP lexer still supports elisions, but they must be represented as
> the value "...", so two examples have been adjusted to support that
> format here.
I think this could use a bit more context. I believe you're referring
to docs/sphinx/qmp_lexer.py. It describes itself as "a Sphinx extension
that provides a QMP lexer for code blocks."
"If we parse all examples as QMP" and "Once the QMP lexer is active for
examples" suggests we're *not* using it for (some?) examples. So what
are we using it for?
> Signed-off-by: John Snow <jsnow@redhat.com>
Patch looks lovely.
Hat tip to Victor Toso, who fixed up most examples two years ago. Back
then we couldn't decide how to do elisions, so we left some unfixed.
- Re: [PATCH 14/20] qapi: fix non-compliant JSON examples,
Markus Armbruster <=