From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Michael S. Tsirkin" <mst@redhat.com>,
"Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
"John Snow" <jsnow@redhat.com>, "Eric Blake" <eblake@redhat.com>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Ani Sinha" <anisinha@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
qemu-block@nongnu.org, "Kevin Wolf" <kwolf@redhat.com>,
"Hanna Reitz" <hreitz@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Lukas Straub" <lukasstraub2@web.de>,
"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
"Zhao Liu" <zhao1.liu@intel.com>,
"Eduardo Habkost" <eduardo@habkost.net>,
"Peter Xu" <peterx@redhat.com>,
"Yanan Wang" <wangyanan55@huawei.com>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Jason Wang" <jasowang@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Igor Mammedov" <imammedo@redhat.com>,
"Fabiano Rosas" <farosas@suse.de>
Subject: [PATCH v2 11/18] qapi: add cross-references to QOM
Date: Fri, 11 Jul 2025 01:39:58 -0400 [thread overview]
Message-ID: <20250711054005.60969-12-jsnow@redhat.com> (raw)
In-Reply-To: <20250711054005.60969-1-jsnow@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
---
qapi/qdev.json | 4 ++--
qapi/qom.json | 13 +++++++------
2 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/qapi/qdev.json b/qapi/qdev.json
index 5d18fb8e0e0..ff3f06a36d6 100644
--- a/qapi/qdev.json
+++ b/qapi/qdev.json
@@ -95,10 +95,10 @@
# from the guest. Hot removal is an operation that requires guest
# cooperation. This command merely requests that the guest begin
# the hot removal process. Completion of the device removal
-# process is signaled with a DEVICE_DELETED event. Guest reset
+# process is signaled with a `DEVICE_DELETED` event. Guest reset
# will automatically complete removal for all devices. If a
# guest-side error in the hot removal process is detected, the
-# device will not be removed and a DEVICE_UNPLUG_GUEST_ERROR event
+# device will not be removed and a `DEVICE_UNPLUG_GUEST_ERROR` event
# is sent. Some errors cannot be detected.
#
# Since: 0.14
diff --git a/qapi/qom.json b/qapi/qom.json
index c6fdce7f7bc..e8ba3ee4907 100644
--- a/qapi/qom.json
+++ b/qapi/qom.json
@@ -51,7 +51,7 @@
# This command will list any properties of a object given a path in
# the object model.
#
-# @path: the path within the object model. See @qom-get for a
+# @path: the path within the object model. See `qom-get` for a
# description of this parameter.
#
# Returns: a list that describe the properties of the object.
@@ -129,12 +129,12 @@
#
# This command will set a property from a object model path.
#
-# @path: see @qom-get for a description of this parameter
+# @path: see `qom-get` for a description of this parameter
#
# @property: the property name to set
#
# @value: a value who's type is appropriate for the property type.
-# See @qom-get for a description of type mapping.
+# See `qom-get` for a description of type mapping.
#
# Since: 1.2
#
@@ -153,7 +153,7 @@
##
# @ObjectTypeInfo:
#
-# This structure describes a search result from @qom-list-types
+# This structure describes a search result from `qom-list-types`
#
# @name: the type name found in the search
#
@@ -193,6 +193,7 @@
#
# @typename: the type name of an object
#
+#
# .. note:: Objects can create properties at runtime, for example to
# describe links between different devices and/or objects. These
# properties are not included in the output of this command.
@@ -787,7 +788,7 @@
#
# Properties for x-remote-object objects.
#
-# @fd: file descriptor name previously passed via 'getfd' command
+# @fd: file descriptor name previously passed via `getfd` command
#
# @devid: the id of the device to be associated with the file
# descriptor
@@ -816,7 +817,7 @@
#
# Properties for iommufd objects.
#
-# @fd: file descriptor name previously passed via 'getfd' command,
+# @fd: file descriptor name previously passed via `getfd` command,
# which represents a pre-opened /dev/iommu. This allows the
# iommufd object to be shared across several subsystems (VFIO,
# VDPA, ...), and the file descriptor to be shared with other
--
2.50.0
next prev parent reply other threads:[~2025-07-11 5:42 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-11 5:39 [PATCH v2 00/18] QAPI: add cross-references to qapi docs John Snow
2025-07-11 5:39 ` [PATCH v2 01/18] qapi: add cross-references to acpi.json John Snow
2025-07-11 5:39 ` [PATCH v2 02/18] qapi: add cross-references to authz.json John Snow
2025-07-11 5:39 ` [PATCH v2 03/18] qapi: add cross-references to block layer John Snow
2025-07-11 8:48 ` Markus Armbruster
2025-07-11 5:39 ` [PATCH v2 04/18] qapi: add cross-references to crypto.json John Snow
2025-07-11 9:15 ` Markus Armbruster
2025-07-11 5:39 ` [PATCH v2 05/18] qapi: add cross-references to dump.json John Snow
2025-07-11 5:39 ` [PATCH v2 06/18] qapi: add cross-references to job.json John Snow
2025-07-11 8:33 ` Markus Armbruster
2025-07-11 5:39 ` [PATCH v2 07/18] qapi: add cross-references to Machine core John Snow
2025-07-11 5:39 ` [PATCH v2 08/18] qapi: add cross-references to migration.json John Snow
2025-07-11 8:55 ` Markus Armbruster
2025-07-11 14:29 ` John Snow
2025-07-11 5:39 ` [PATCH v2 09/18] qapi: add cross-references to net.json John Snow
2025-07-11 5:39 ` [PATCH v2 10/18] qapi: add cross-references to pci.json John Snow
2025-07-11 5:39 ` John Snow [this message]
2025-07-11 5:39 ` [PATCH v2 12/18] qapi: add cross-references to replay.json John Snow
2025-07-11 5:40 ` [PATCH v2 13/18] qapi: add cross-references to run-state.json John Snow
2025-07-11 5:40 ` [PATCH v2 14/18] qapi: add cross-references to sockets.json John Snow
2025-07-11 5:40 ` [PATCH v2 15/18] qapi: add cross-references to ui.json John Snow
2025-07-11 5:40 ` [PATCH v2 16/18] qapi: add cross-references to virtio.json John Snow
2025-07-11 5:40 ` [PATCH v2 17/18] qapi: add cross-references to yank.json John Snow
2025-07-11 5:40 ` [PATCH v2 18/18] qapi: add cross-references to misc modules John Snow
2025-07-11 9:04 ` [PATCH v2 00/18] QAPI: add cross-references to qapi docs Markus Armbruster
2025-07-11 9:26 ` Markus Armbruster
2025-07-11 15:13 ` John Snow
2025-07-14 13:41 ` Markus Armbruster
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=20250711054005.60969-12-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=anisinha@redhat.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eblake@redhat.com \
--cc=eduardo@habkost.net \
--cc=farosas@suse.de \
--cc=hreitz@redhat.com \
--cc=imammedo@redhat.com \
--cc=jasowang@redhat.com \
--cc=kwolf@redhat.com \
--cc=lukasstraub2@web.de \
--cc=marcandre.lureau@redhat.com \
--cc=marcel.apfelbaum@gmail.com \
--cc=mst@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peterx@redhat.com \
--cc=philmd@linaro.org \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=vsementsov@yandex-team.ru \
--cc=wangyanan55@huawei.com \
--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 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).