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
