Hello, this work converts "simple" intro sections for event
definitions in the QAPI schema to use the new syntax. This is part of
our ongoing effort to add the mythical "inliner" to our generated QMP
documentation.
"simple" here is a non-technical distinction that means a single
paragraph of text followed by an existing section boundary that
naturally already delineates what comprises the intro.
(This is about 25% of the remaining conversions.)
If you are a non-QAPI maintainer who has been CC'd on this series,
there is likely very little for you to look at in this series. What
you need to know is that indented paragraphs become part of a
command's "intro" and will appear "above the fold" - above additional
detail in our generated QMP documentation (i.e. features, arguments,
return value, errors, etc) and anything else will eventually appear
"below the fold" - below the detail table, alongside examples, notes,
and more verbose prose.
As event definitions cannot be inlined by any other definition, the
documentation text for events will never be re-written or reproduced
in any other context. As such, the distinction between "intro" and
"details" are less important here, but the distinction does still
determine where auto-generated documentation will be inserted, if any:
i.e. features, arguments, and return values will always be inserted
"after the intro".
John Snow (5):
qapi: convert simple event intros for qdev.json
qapi: convert simple event intros for net.json
qapi: convert simple event intros for migration.json
qapi: convert simple event intros for machine.json
qapi: convert simple event intros for block-core.json
qapi/block-core.json | 30 ++++++++++++++----------------
qapi/machine.json | 14 ++++++--------
qapi/migration.json | 9 ++++-----
qapi/net.json | 9 ++++-----
qapi/qdev.json | 9 ++++-----
5 files changed, 32 insertions(+), 39 deletions(-)
--
2.55.0