[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 3/8] docs/qapidoc: add QMP highlighting to annotated qmp-exam
From: |
Markus Armbruster |
Subject: |
Re: [PATCH 3/8] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks |
Date: |
Tue, 09 Jul 2024 12:33:16 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) |
John Snow <jsnow@redhat.com> writes:
> For any code literal blocks inside of a qmp-example directive, apply and
> enforce the QMP lexer/highlighter to those blocks.
>
> This way, you won't need to write:
>
> ```
> .. qmp-example::
> :annotated:
>
> Blah blah
>
> .. code-block:: QMP
>
> -> { "lorem": "ipsum" }
> ```
>
> But instead, simply:
>
> ```
> .. qmp-example::
> :annotated:
>
> Blah blah::
>
> -> { "lorem": "ipsum" }
> ```
>
> Once the directive block is exited, whatever the previous default
> highlight language was will be restored; localizing the forced QMP
> lexing to exclusively this directive.
>
> Note, if the default language is *already* QMP, this directive will not
> generate and restore redundant highlight configuration nodes. We may
> well decide that the default language ought to be QMP for any QAPI
> reference pages, but this way the directive behaves consistently no
> matter where it is used.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
Sadly, the previous patch didn't add tests, so this patch's effect
isn't as easy to observe as it could be.
Acked-by: Markus Armbruster <armbru@redhat.com>
[PATCH 5/8] qapi: convert "Example" sections without titles, John Snow, 2024/07/03
[PATCH 6/8] qapi: convert "Example" sections with titles, John Snow, 2024/07/03