Hello, this work converts "simple" intro sections for command 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 command definitions cannot be inlined by any other definition, the documentation text for commands 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 (12): qapi: convert simple command intros for ebpf.json qapi: convert simple command intros for yank.json qapi: convert simple command intros for replay.json qapi: convert simple command intros for machine-s390x.json qapi: convert simple command intros for dump.json qapi: convert simple command intros for block-export.json qapi: convert simple command intros for block.json qapi: convert simple command intros for cxl.json qapi: convert simple command intros for ui.json qapi: convert simple command intros for migration.json qapi: convert simple command intros for machine.json qapi: convert simple command intros for block-core.json qapi/block-core.json | 96 ++++++++++++++++++++--------------------- qapi/block-export.json | 18 ++++---- qapi/block.json | 8 ++-- qapi/cxl.json | 74 +++++++++++++++---------------- qapi/dump.json | 5 +-- qapi/ebpf.json | 8 ++-- qapi/machine-s390x.json | 7 ++- qapi/machine.json | 18 ++++---- qapi/migration.json | 51 ++++++++++------------ qapi/replay.json | 39 ++++++++--------- qapi/ui.json | 11 +++-- qapi/yank.json | 5 +-- 12 files changed, 157 insertions(+), 183 deletions(-) -- 2.55.0
