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, "Cédric Le Goater" <clg@redhat.com>,
	"Kevin Wolf" <kwolf@redhat.com>,
	"Fabiano Rosas" <farosas@suse.de>,
	"Daniel P. Berrangé" <berrange@redhat.com>,
	"Peter Xu" <peterx@redhat.com>,
	"Jason Wang" <jasowang@redhat.com>,
	"Igor Mammedov" <imammedo@redhat.com>,
	qemu-block@nongnu.org, "Lukas Straub" <lukasstraub2@web.de>,
	"Paolo Bonzini" <pbonzini@redhat.com>,
	"Peter Maydell" <peter.maydell@linaro.org>,
	"Eric Blake" <eblake@redhat.com>,
	"Marc-André Lureau" <marcandre.lureau@redhat.com>,
	"Jiri Pirko" <jiri@resnulli.us>,
	"Philippe Mathieu-Daudé" <philmd@linaro.org>,
	"Mads Ynddal" <mads@ynddal.dk>,
	"Stefan Berger" <stefanb@linux.vnet.ibm.com>,
	"Pavel Dovgalyuk" <pavel.dovgaluk@ispras.ru>,
	"Michael Roth" <michael.roth@amd.com>,
	"Stefan Hajnoczi" <stefanha@redhat.com>,
	"Alex Williamson" <alex.williamson@redhat.com>,
	"Yanan Wang" <wangyanan55@huawei.com>,
	"Eduardo Habkost" <eduardo@habkost.net>,
	"Ani Sinha" <anisinha@redhat.com>,
	"Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
	"Michael S. Tsirkin" <mst@redhat.com>,
	"Hanna Reitz" <hreitz@redhat.com>
Subject: Re: [PATCH v2 6/9] qapi: convert "Example" sections without titles
Date: Wed, 17 Jul 2024 09:43:55 +0200	[thread overview]
Message-ID: <87ttgoh39g.fsf@pond.sub.org> (raw)
In-Reply-To: <20240717021312.606116-7-jsnow@redhat.com> (John Snow's message of "Tue, 16 Jul 2024 22:13:08 -0400")

John Snow <jsnow@redhat.com> writes:

> Use the no-option form of ".. qmp-example::" to convert any Examples
> that do not have any form of caption or explanation whatsoever. Note
> that in a few cases, example sections are split into two or more
> separate example blocks. This is only done stylistically to create a
> delineation between two or more logically independent examples.
>
> See commit-3: "docs/qapidoc: create qmp-example directive", for a
>               detailed explanation of this custom directive syntax.
>
> See commit+3: "qapi: remove "Example" doc section" for a detailed
>               explanation of why.
>
> Note: an empty "TODO" line was added to announce-self to keep the
> example from floating up into the body; this will be addressed more
> rigorously in the new qapidoc generator.
>
> Signed-off-by: John Snow <jsnow@redhat.com>

[...]

> diff --git a/qapi/run-state.json b/qapi/run-state.json
> index 4d40c88876c..ab7116680b3 100644
> --- a/qapi/run-state.json
> +++ b/qapi/run-state.json

[...]

> @@ -469,7 +469,7 @@
>  #
>  # Since: 9.1
>  #
> -# Example:
> +# ..qmp-example::

Lacks a space, output is messed up.  Can fix in my tree.

>  #
>  #     <- { "event": "GUEST_PVSHUTDOWN",
>  #          "timestamp": { "seconds": 1648245259, "microseconds": 893771 } }

[...]

R-by stands.



  reply	other threads:[~2024-07-17  7:45 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-17  2:13 [PATCH v2 0/9] qapi: convert example sections to qmp-example rST directives John Snow
2024-07-17  2:13 ` [PATCH v2 1/9] [DO-NOT-MERGE]: Add some ad-hoc linting helpers John Snow
2024-07-17  2:13 ` [PATCH v2 2/9] docs/qapidoc: factor out do_parse() John Snow
2024-07-17  2:13 ` [PATCH v2 3/9] docs/qapidoc: create qmp-example directive John Snow
2024-07-17  2:13 ` [PATCH v2 4/9] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks John Snow
2024-07-17  2:13 ` [PATCH v2 5/9] docs/sphinx: add CSS styling for qmp-example directive John Snow
2024-07-17  2:13 ` [PATCH v2 6/9] qapi: convert "Example" sections without titles John Snow
2024-07-17  7:43   ` Markus Armbruster [this message]
2024-07-17 20:15     ` John Snow
2024-07-18  4:21       ` Markus Armbruster
2024-07-17  2:13 ` [PATCH v2 7/9] qapi: convert "Example" sections with titles John Snow
2024-07-17  2:13 ` [PATCH v2 8/9] qapi: convert "Example" sections with longer prose John Snow
2024-07-17  2:13 ` [PATCH v2 9/9] qapi: remove "Example" doc section John Snow
2024-07-17  7:48   ` Markus Armbruster
2024-07-17 10:47 ` [PATCH v2 0/9] qapi: convert example sections to qmp-example rST directives Markus Armbruster
2024-07-17 20:13   ` John Snow

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=87ttgoh39g.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=stefanb@linux.vnet.ibm.com \
    --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.