Hello, this work converts the remaining "simple" intro sections 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.
This batch covers structures that *are* likely to be inlined, and thus have introductory paragraphs that are quite likely to be omitted when the member documentation is copied into other contexts (e.g. as arguments for command documentation, or as members of a branch for commands that accept union arguments.) "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. If you are a non-QAPI maintainer who has been CC'd on this series, you may wish to review what information is being codified as the "intro" (The indented paragraph) and keep in mind that in the future, this text may not be visible to the end-user reading our QMP documentation if this structure is utilized as the 'base' for another struct, used as the arguments for a command or event, or used as branch of a union. This series keeps it pretty simple, and every conversion herein is being codified as "the intro", i.e. "not crucial to understanding the behavior of the members of this struct". This is the last of the brain-dead, simple conversions apart from any new cases that may have been merged during the development of this series. The remaining patches all convert or split longer paragraphs and require more scrutiny. We're almost back to reviewing actual code! Hang in there, everybody. John Snow (6): qapi: convert remaining simple intros for block-export.json qapi: convert remaining simple intros for cxl.json qapi: convert remaining simple intros for machine.json qapi: convert remaining simple intros for block-core.json qapi: convert intro sections with "TODO" markers qapi: convert intro sections followed by notes/examples qapi/block-core.json | 45 ++++++++++++++++++------------------------ qapi/block-export.json | 19 ++++++++---------- qapi/cxl.json | 14 +++++-------- qapi/machine.json | 15 +++++--------- qapi/migration.json | 25 +++++++++-------------- qapi/misc.json | 3 +-- qapi/net.json | 9 +++------ qapi/run-state.json | 7 +++---- qapi/yank.json | 5 +---- 9 files changed, 54 insertions(+), 88 deletions(-) -- 2.55.0
