[PATCH v3 00/10] qapi: convert/split remaining QAPI/QMP intro sections

[John Snow <jsnow@redhat.com>]

This series is the last batch of intro conversions.

V2:
 - Address review comments
 - Adjust commit messages, add S-O-B

This series covers the trickiest bits of qapi/qapi-schema.json, ones
that involve multiple paragraphs and decisions over where exactly to
place the split. Currently there are only some very minor prose
rewrites the break apart intro statements from paragraphs where deemed
appropriate.

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 (10):
  qapi: split intro for HV_BALLOON_STATUS_REPORT
  qapi: convert/split intros for block-core.json commands
  qapi: convert/split intros for block commands
  qapi: convert/split intros for job.json commands
  qapi: convert/split intros for misc-i386.json commands
  qapi: convert/split intros for commands
  qapi: convert/split intros for enums
  qapi: split intro sections for events
  qapi: split intro sections for data structs
  qapi: split intro sections for inlinable structs

 qapi/acpi.json          |   3 +-
 qapi/block-core.json    | 131 +++++++++++++++++-----------------------
 qapi/block-export.json  |   8 +--
 qapi/block.json         |  33 +++++-----
 qapi/compat.json        |   5 +-
 qapi/control.json       |   3 +-
 qapi/crypto.json        |   3 +-
 qapi/introspect.json    |  16 ++---
 qapi/job.json           |  42 ++++++-------
 qapi/machine-s390x.json |   3 +-
 qapi/machine.json       |  78 +++++++++++-------------
 qapi/migration.json     |  12 ++--
 qapi/misc-arm.json      |   5 +-
 qapi/misc-i386.json     |  22 +++----
 qapi/misc.json          |   8 +--
 qapi/net.json           |  37 +++++-------
 qapi/qdev.json          |   9 ++-
 qapi/qom.json           |   9 +--
 qapi/stats.json         |   5 +-
 qapi/transaction.json   |   7 +--
 qapi/ui.json            |   8 +--
 21 files changed, 193 insertions(+), 254 deletions(-)

-- 
2.55.0