All of lore.kernel.org
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Zhao Liu" <zhao1.liu@intel.com>,
	"Jason Wang" <jasowangio@gmail.com>,
	"Paolo Bonzini" <pbonzini@redhat.com>,
	"Fabiano Rosas" <farosas@suse.de>,
	"Philippe Mathieu-Daudé" <philmd@mailo.com>,
	"Hanna Reitz" <hreitz@redhat.com>,
	"Kevin Wolf" <kwolf@redhat.com>,
	"Markus Armbruster" <armbru@redhat.com>,
	"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
	qemu-block@nongnu.org, "John Snow" <jsnow@redhat.com>,
	"Eric Blake" <eblake@redhat.com>,
	"Igor Mammedov" <imammedo@redhat.com>,
	"Marc-André Lureau" <marcandre.lureau@redhat.com>,
	"Michael S. Tsirkin" <mst@redhat.com>,
	"Peter Xu" <peterx@redhat.com>,
	"Daniel P. Berrangé" <berrange@redhat.com>,
	"Ani Sinha" <anisinha@redhat.com>
Subject: [PATCH 0/9] qapi: convert/split remaining QAPI/QMP intro sections
Date: Fri, 11 Sep 2026 16:29:53 -0400	[thread overview]
Message-ID: <20260911203002.305316-1-jsnow@redhat.com> (raw)

Give or take any that snuck in during this conversion marathon, this
should be the rest - and the trickiest ones that involve multiple
paragraphs and decisions over where exactly to place the
split. Currently there are no prose rewrites, but it is not out of the
question that we will require some after review.

If you are a non-QAPI maintainer, the TL:DR here is:
    Take a look at what is being indented here and what is
    not. Anything that gets indented is text that is not eligible for
    inlining: that is, the intro text is not copied into command/event
    documentation to replace "The members of ..." placeholders in our
    generated documentation.

    If any text that you believe is important for end users to
    understand is in the indented section after these patches, please
    review and propose a different prose split.

    (More info: The intro text is not guaranteed to be dropped from
    generated docs. For example, if a struct is used as a type for an
    argument in its own right, it is guaranteed to be included in the
    generated documentation. It is also always included for commands,
    events, and enums. It is only for structs which are *only* ever
    used as command/event arguments or as a branch type where this
    text is at risk of not being reproduced at all in the output
    documentation.)

John Snow (9):
  qapi: convert remaining simple intros for block-export.json
  qapi: convert multi-paragraph intros (commands)
  qapi: convert multi-paragraph intros (enums)
  qapi: convert multi-paragraph intros (structs)
  qapi: split intro sections for commands
  qapi: split intro sections for events
  qapi: split intro sections for enums
  qapi: split intro sections for data structs
  qapi: split intro sections for inlinable structs

 qapi/acpi.json          |   3 +-
 qapi/block-core.json    | 130 ++++++++++++++++++----------------------
 qapi/block-export.json  |  27 ++++-----
 qapi/block.json         |  71 +++++++++++-----------
 qapi/compat.json        |   3 +-
 qapi/control.json       |   3 +-
 qapi/crypto.json        |   3 +-
 qapi/introspect.json    |  16 ++---
 qapi/job.json           |  43 ++++++-------
 qapi/machine-s390x.json |   3 +-
 qapi/machine.json       |  98 +++++++++++++++---------------
 qapi/migration.json     |  18 +++---
 qapi/misc-arm.json      |   9 ++-
 qapi/misc-i386.json     |  22 +++----
 qapi/misc.json          |  18 +++---
 qapi/net.json           |  37 +++++-------
 qapi/qdev.json          |  14 ++---
 qapi/qom.json           |  27 ++++-----
 qapi/stats.json         |   5 +-
 qapi/transaction.json   |   6 +-
 qapi/ui.json            |   8 +--
 21 files changed, 253 insertions(+), 311 deletions(-)

-- 
2.55.0




             reply	other threads:[~2026-09-11 20:31 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-11 20:29 John Snow [this message]
2026-09-11 20:29 ` [PATCH 1/9] qapi: convert remaining simple intros for block-export.json John Snow
2026-09-12  7:02   ` Markus Armbruster
2026-09-11 20:29 ` [PATCH 2/9] qapi: convert multi-paragraph intros (commands) John Snow
2026-09-11 20:29 ` [PATCH 3/9] qapi: convert multi-paragraph intros (enums) John Snow
2026-09-11 20:29 ` [PATCH 4/9] qapi: convert multi-paragraph intros (structs) John Snow
2026-09-11 20:29 ` [PATCH 5/9] qapi: split intro sections for commands John Snow
2026-09-11 20:29 ` [PATCH 6/9] qapi: split intro sections for events John Snow
2026-09-11 20:30 ` [PATCH 7/9] qapi: split intro sections for enums John Snow
2026-09-11 20:30 ` [PATCH 8/9] qapi: split intro sections for data structs John Snow
2026-09-11 20:30 ` [PATCH 9/9] qapi: split intro sections for inlinable structs 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=20260911203002.305316-1-jsnow@redhat.com \
    --to=jsnow@redhat.com \
    --cc=anisinha@redhat.com \
    --cc=armbru@redhat.com \
    --cc=berrange@redhat.com \
    --cc=eblake@redhat.com \
    --cc=farosas@suse.de \
    --cc=hreitz@redhat.com \
    --cc=imammedo@redhat.com \
    --cc=jasowangio@gmail.com \
    --cc=kwolf@redhat.com \
    --cc=marcandre.lureau@redhat.com \
    --cc=mst@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=peterx@redhat.com \
    --cc=philmd@mailo.com \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    --cc=vsementsov@yandex-team.ru \
    --cc=zhao1.liu@intel.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.