From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Zhao Liu" <zhao1.liu@intel.com>,
"Jason Wang" <jasowangio@gmail.com>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Fabiano Rosas" <farosas@suse.de>,
"Philippe Mathieu-Daudé" <philmd@mailo.com>,
"Hanna Reitz" <hreitz@redhat.com>,
"Kevin Wolf" <kwolf@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
qemu-block@nongnu.org, "John Snow" <jsnow@redhat.com>,
"Eric Blake" <eblake@redhat.com>,
"Igor Mammedov" <imammedo@redhat.com>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
"Peter Xu" <peterx@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Ani Sinha" <anisinha@redhat.com>
Subject: [PATCH 4/9] qapi: convert multi-paragraph intros (structs)
Date: Fri, 11 Sep 2026 16:29:57 -0400 [thread overview]
Message-ID: <20260911203002.305316-5-jsnow@redhat.com> (raw)
In-Reply-To: <20260911203002.305316-1-jsnow@redhat.com>
This patch converts some slightly-non-trivial intros with more than
one paragraph, but doesn't create any new intro/details splits.
Review notes: Again, the Numa Hmat options have text that are prime
candidates for a ".. seealso::" admonition, but I was uncertain as to
whether this information was principally for developers or for
users. If it's for developers, it can stay in the intro where it will
be dropped when inlined. If it is for users, they should be moved into
the details region.
The remaining structs have an awful lot of text, but I was not
immediately sure of which information we wanted to preserve when
inlined or not; these structures tend to be written as if they are
describing a command, but they actually only define a set of
arguments.
Advice? Opinions?
Signed-off-by: John Snow <jsnow@redhat.com>
---
qapi/machine.json | 17 ++++++++---------
qapi/net.json | 34 +++++++++++++++-------------------
qapi/qom.json | 18 +++++++++---------
3 files changed, 32 insertions(+), 37 deletions(-)
diff --git a/qapi/machine.json b/qapi/machine.json
index 710b638b3bf..aaecd151407 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -657,12 +657,11 @@
##
# @NumaHmatLBOptions:
+# Set the system locality latency and bandwidth information
+# between Initiator and Target proximity Domains.
#
-# Set the system locality latency and bandwidth information between
-# Initiator and Target proximity Domains.
-#
-# For more information about `NumaHmatLBOptions`, see chapter
-# 5.2.27.4: Table 5-146 of ACPI 6.3 spec.
+# For more information about `NumaHmatLBOptions`, see chapter
+# 5.2.27.4: Table 5-146 of ACPI 6.3 spec.
#
# @initiator: the Initiator Proximity Domain.
#
@@ -734,11 +733,11 @@
##
# @NumaHmatCacheOptions:
+# Set the memory side cache information for a given memory domain.
#
-# Set the memory side cache information for a given memory domain.
-#
-# For more information of `NumaHmatCacheOptions`, see chapter
-# 5.2.27.5: Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec.
+# For more information of `NumaHmatCacheOptions`, see chapter
+# 5.2.27.5: Table 5-147: Field "Cache Attributes" of ACPI 6.3
+# spec.
#
# @node-id: the memory proximity domain to which the memory belongs.
#
diff --git a/qapi/net.json b/qapi/net.json
index 7aabd8b9260..50dc3137182 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -681,11 +681,10 @@
##
# @NetdevVhostVDPAOptions:
+# Vhost-vdpa network backend
#
-# Vhost-vdpa network backend
-#
-# vDPA device is a device that uses a datapath which complies with the
-# virtio specifications with a vendor specific control path.
+# vDPA device is a device that uses a datapath which complies with
+# the virtio specifications with a vendor specific control path.
#
# @vhostdev: path of vhost-vdpa device (default:'/dev/vhost-vdpa-0')
#
@@ -712,11 +711,10 @@
##
# @NetdevVmnetHostOptions:
+# vmnet (host mode) network backend.
#
-# vmnet (host mode) network backend.
-#
-# Allows the vmnet interface to communicate with other vmnet
-# interfaces that are in host mode and also with the host.
+# Allows the vmnet interface to communicate with other vmnet
+# interfaces that are in host mode and also with the host.
#
# @start-address: The starting IPv4 address to use for the interface.
# Must be in the private IP range (RFC 1918). Must be specified
@@ -755,15 +753,14 @@
##
# @NetdevVmnetSharedOptions:
+# vmnet (shared mode) network backend.
#
-# vmnet (shared mode) network backend.
-#
-# Allows traffic originating from the vmnet interface to reach the
-# Internet through a network address translator (NAT). The vmnet
-# interface can communicate with the host and with other shared mode
-# interfaces on the same subnet. If no DHCP settings, subnet mask and
-# IPv6 prefix specified, the interface can communicate with any of
-# other interfaces in shared mode.
+# Allows traffic originating from the vmnet interface to reach the
+# Internet through a network address translator (NAT). The vmnet
+# interface can communicate with the host and with other shared
+# mode interfaces on the same subnet. If no DHCP settings, subnet
+# mask and IPv6 prefix specified, the interface can communicate
+# with any of other interfaces in shared mode.
#
# @start-address: The starting IPv4 address to use for the interface.
# Must be in the private IP range (RFC 1918). Must be specified
@@ -800,10 +797,9 @@
##
# @NetdevVmnetBridgedOptions:
+# vmnet (bridged mode) network backend.
#
-# vmnet (bridged mode) network backend.
-#
-# Bridges the vmnet interface with a physical network interface.
+# Bridges the vmnet interface with a physical network interface.
#
# @ifname: The name of the physical interface to be bridged.
#
diff --git a/qapi/qom.json b/qapi/qom.json
index 51af9485e6d..3de06488768 100644
--- a/qapi/qom.json
+++ b/qapi/qom.json
@@ -1033,16 +1033,16 @@
##
# @SevSnpGuestProperties:
+# Properties for sev-snp-guest objects. Most of these are direct
+# arguments for the KVM_SNP_* interfaces documented in the Linux
+# kernel source under
+# Documentation/arch/x86/amd-memory-encryption.rst, which are in
+# turn closely coupled with the SNP_INIT/SNP_LAUNCH_* firmware
+# commands documented in the SEV-SNP Firmware ABI Specification
+# (Rev 0.9).
#
-# Properties for sev-snp-guest objects. Most of these are direct
-# arguments for the KVM_SNP_* interfaces documented in the Linux
-# kernel source under
-# Documentation/arch/x86/amd-memory-encryption.rst, which are in turn
-# closely coupled with the SNP_INIT/SNP_LAUNCH_* firmware commands
-# documented in the SEV-SNP Firmware ABI Specification (Rev 0.9).
-#
-# More usage information is also available in the QEMU source tree
-# under docs/amd-memory-encryption.
+# More usage information is also available in the QEMU source tree
+# under docs/amd-memory-encryption.
#
# @policy: the 'POLICY' parameter to the SNP_LAUNCH_START command, as
# defined in the SEV-SNP firmware ABI (default: 0x30000)
--
2.55.0
next prev parent reply other threads:[~2026-09-11 20:32 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-11 20:29 [PATCH 0/9] qapi: convert/split remaining QAPI/QMP intro sections John Snow
2026-09-11 20:29 ` [PATCH 1/9] qapi: convert remaining simple intros for block-export.json John Snow
2026-09-12 7:02 ` Markus Armbruster
2026-09-14 19:17 ` John Snow
2026-09-11 20:29 ` [PATCH 2/9] qapi: convert multi-paragraph intros (commands) John Snow
2026-09-16 9:38 ` Markus Armbruster
2026-09-17 20:09 ` John Snow
2026-09-18 6:41 ` Markus Armbruster
2026-09-11 20:29 ` [PATCH 3/9] qapi: convert multi-paragraph intros (enums) John Snow
2026-09-16 9:47 ` Markus Armbruster
2026-09-17 20:13 ` John Snow
2026-09-18 6:49 ` Markus Armbruster
2026-09-11 20:29 ` John Snow [this message]
2026-09-16 12:08 ` [PATCH 4/9] qapi: convert multi-paragraph intros (structs) Markus Armbruster
2026-09-11 20:29 ` [PATCH 5/9] qapi: split intro sections for commands John Snow
2026-09-16 11:41 ` Markus Armbruster
2026-09-11 20:29 ` [PATCH 6/9] qapi: split intro sections for events John Snow
2026-09-16 11:47 ` Markus Armbruster
2026-09-11 20:30 ` [PATCH 7/9] qapi: split intro sections for enums John Snow
2026-09-11 20:30 ` [PATCH 8/9] qapi: split intro sections for data structs John Snow
2026-09-11 20:30 ` [PATCH 9/9] qapi: split intro sections for inlinable structs John Snow
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260911203002.305316-5-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=anisinha@redhat.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eblake@redhat.com \
--cc=farosas@suse.de \
--cc=hreitz@redhat.com \
--cc=imammedo@redhat.com \
--cc=jasowangio@gmail.com \
--cc=kwolf@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=mst@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peterx@redhat.com \
--cc=philmd@mailo.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=vsementsov@yandex-team.ru \
--cc=zhao1.liu@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.