All of lore.kernel.org
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: John Snow <jsnow@redhat.com>
Cc: qemu-devel@nongnu.org, "Michael S. Tsirkin" <mst@redhat.com>,
	"Peter Xu" <peterx@redhat.com>,
	qemu-block@nongnu.org,
	"Marc-André Lureau" <marcandre.lureau@redhat.com>,
	"Kevin Wolf" <kwolf@redhat.com>,
	"Philippe Mathieu-Daudé" <philmd@linaro.org>,
	"Peter Maydell" <peter.maydell@linaro.org>,
	"Cédric Le Goater" <clg@redhat.com>,
	"Eduardo Habkost" <eduardo@habkost.net>,
	"Daniel P. Berrangé" <berrange@redhat.com>,
	"Paolo Bonzini" <pbonzini@redhat.com>,
	"Fabiano Rosas" <farosas@suse.de>,
	"Pavel Dovgalyuk" <pavel.dovgaluk@ispras.ru>,
	"Stefan Hajnoczi" <stefanha@redhat.com>,
	"Jason Wang" <jasowang@redhat.com>,
	"Lukas Straub" <lukasstraub2@web.de>,
	"Ani Sinha" <anisinha@redhat.com>,
	"Igor Mammedov" <imammedo@redhat.com>,
	"Michael Roth" <michael.roth@amd.com>,
	"Hanna Reitz" <hreitz@redhat.com>, "Mads Ynddal" <mads@ynddal.dk>,
	"Alex Williamson" <alex.williamson@redhat.com>,
	"Eric Blake" <eblake@redhat.com>,
	"Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
	"Yanan Wang" <wangyanan55@huawei.com>,
	"Jiri Pirko" <jiri@resnulli.us>
Subject: Re: [PATCH 3/8] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks
Date: Tue, 09 Jul 2024 12:33:16 +0200	[thread overview]
Message-ID: <878qyaj1n7.fsf@pond.sub.org> (raw)
In-Reply-To: <20240703210144.339530-4-jsnow@redhat.com> (John Snow's message of "Wed, 3 Jul 2024 17:01:38 -0400")

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>



  reply	other threads:[~2024-07-09 10:34 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-03 21:01 [PATCH 0/8] qapi: convert example sections to qmp-example rST directives John Snow
2024-07-03 21:01 ` [PATCH 1/8] docs/qapidoc: factor out do_parse() John Snow
2024-07-06 14:47   ` Markus Armbruster
2024-07-06 19:57     ` John Snow
2024-07-09 10:28       ` Markus Armbruster
2024-07-03 21:01 ` [PATCH 2/8] docs/qapidoc: create qmp-example directive John Snow
2024-07-09 10:29   ` Markus Armbruster
2024-07-03 21:01 ` [PATCH 3/8] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks John Snow
2024-07-09 10:33   ` Markus Armbruster [this message]
2024-07-09 22:47     ` John Snow
2024-07-03 21:01 ` [PATCH 4/8] docs/sphinx: add CSS styling for qmp-example directive John Snow
2024-07-09 10:33   ` Markus Armbruster
2024-07-09 22:55     ` John Snow
2024-07-10  4:37       ` Markus Armbruster
2024-07-03 21:01 ` [PATCH 5/8] qapi: convert "Example" sections without titles John Snow
2024-07-06 14:42   ` Markus Armbruster
2024-07-06 19:56     ` John Snow
2024-07-09 11:16       ` Markus Armbruster
2024-07-03 21:01 ` [PATCH 6/8] qapi: convert "Example" sections with titles John Snow
2024-07-09 11:30   ` Markus Armbruster
2024-07-03 21:01 ` [PATCH 7/8] qapi: convert "Example" sections with longer prose John Snow
2024-07-09 11:35   ` Markus Armbruster
2024-07-09 22:57     ` John Snow
2024-07-03 21:01 ` [PATCH 8/8] qapi: remove "Example" doc section John Snow
2024-07-09 10:52   ` Markus Armbruster
2024-07-09 23:12     ` John Snow
2024-07-10  5:44       ` Markus Armbruster
2024-07-10 14:46         ` John Snow
2024-07-09 16:55 ` [PATCH 0/8] qapi: convert example sections to qmp-example rST directives 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=878qyaj1n7.fsf@pond.sub.org \
    --to=armbru@redhat.com \
    --cc=alex.williamson@redhat.com \
    --cc=anisinha@redhat.com \
    --cc=berrange@redhat.com \
    --cc=clg@redhat.com \
    --cc=eblake@redhat.com \
    --cc=eduardo@habkost.net \
    --cc=farosas@suse.de \
    --cc=hreitz@redhat.com \
    --cc=imammedo@redhat.com \
    --cc=jasowang@redhat.com \
    --cc=jiri@resnulli.us \
    --cc=jsnow@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=lukasstraub2@web.de \
    --cc=mads@ynddal.dk \
    --cc=marcandre.lureau@redhat.com \
    --cc=marcel.apfelbaum@gmail.com \
    --cc=michael.roth@amd.com \
    --cc=mst@redhat.com \
    --cc=pavel.dovgaluk@ispras.ru \
    --cc=pbonzini@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=peterx@redhat.com \
    --cc=philmd@linaro.org \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    --cc=wangyanan55@huawei.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.