linux-cxl.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 00/10] qapi: convert simple enum intro sections
@ 2026-09-09  4:16 John Snow
  2026-09-09  4:16 ` [PATCH 01/10] qapi: convert simple enum intros for vfio.json John Snow
                   ` (10 more replies)
  0 siblings, 11 replies; 14+ messages in thread
From: John Snow @ 2026-09-09  4:16 UTC (permalink / raw)
  To: qemu-devel
  Cc: Markus Armbruster, Peter Xu, Fabiano Rosas, qemu-block,
	Eric Blake, Cédric Le Goater, Alex Williamson,
	Daniel P. Berrangé, Jonathan Cameron, Lukas Straub,
	Philippe Mathieu-Daudé, Zhao Liu, Hanna Reitz, linux-cxl,
	Kevin Wolf, John Snow

Hello, this work converts "simple" intro sections for enum
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 enum definitions cannot be inlined by any other definition, the
documentation text for enums 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:
features will always be inserted "after the intro". (Note that at
present, features do not have any stub text that is automatically
generated.)

John Snow (10):
  qapi: convert simple enum intros for vfio.json
  qapi: convert simple enum intros for machine-common.json
  qapi: convert simple enum intros for introspect.json
  qapi: convert simple enum intros for block.json
  qapi: convert simple enum intros for cypto.json
  qapi: convert simple enum intros for cxl.json
  qapi: convert simple enum intros for yank.json
  qapi: convert simple enum intros for migration.json
  qapi: convert simple enum intros for machine.json
  qapi: convert simple enum intros for block-core.json

 qapi/block-core.json     |  7 +++----
 qapi/block.json          |  9 ++++-----
 qapi/crypto.json         | 18 +++++++++---------
 qapi/cxl.json            | 27 ++++++++++++---------------
 qapi/introspect.json     |  5 ++---
 qapi/machine-common.json |  5 ++---
 qapi/machine.json        | 21 +++++++++------------
 qapi/migration.json      | 10 ++++------
 qapi/vfio.json           | 15 +++++++--------
 qapi/yank.json           |  5 ++---
 10 files changed, 54 insertions(+), 68 deletions(-)

-- 
2.55.0



^ permalink raw reply	[flat|nested] 14+ messages in thread
end of thread, other threads:[~2026-09-10  4:47 UTC | newest]

Thread overview: 14+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-09-09  4:16 [PATCH 00/10] qapi: convert simple enum intro sections John Snow
2026-09-09  4:16 ` [PATCH 01/10] qapi: convert simple enum intros for vfio.json John Snow
2026-09-09  5:45   ` Cédric Le Goater
2026-09-09  4:16 ` [PATCH 02/10] qapi: convert simple enum intros for machine-common.json John Snow
2026-09-09  4:16 ` [PATCH 03/10] qapi: convert simple enum intros for introspect.json John Snow
2026-09-09  4:16 ` [PATCH 04/10] qapi: convert simple enum intros for block.json John Snow
2026-09-09  4:16 ` [PATCH 05/10] qapi: convert simple enum intros for cypto.json John Snow
2026-09-10  4:47   ` Markus Armbruster
2026-09-09  4:16 ` [PATCH 06/10] qapi: convert simple enum intros for cxl.json John Snow
2026-09-09  4:16 ` [PATCH 07/10] qapi: convert simple enum intros for yank.json John Snow
2026-09-09  4:16 ` [PATCH 08/10] qapi: convert simple enum intros for migration.json John Snow
2026-09-09  4:16 ` [PATCH 09/10] qapi: convert simple enum intros for machine.json John Snow
2026-09-09  4:16 ` [PATCH 10/10] qapi: convert simple enum intros for block-core.json John Snow
2026-09-09  6:31 ` [PATCH 00/10] qapi: convert simple enum intro sections Markus Armbruster

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).