aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2024-07-11 13:22:24 +0200
committerMarkus Armbruster <armbru@redhat.com>2024-07-17 10:15:04 +0200
commitfbcb6e0c487abd09cf1fab7913302174c3a2fa16 (patch)
tree4794be45795ffe78b742911b2ef20d349f78e17d
parent3becc939081097ccfed6968771f33d65ce8551eb (diff)
downloadqemu-fbcb6e0c487abd09cf1fab7913302174c3a2fa16.zip
qemu-fbcb6e0c487abd09cf1fab7913302174c3a2fa16.tar.gz
qemu-fbcb6e0c487abd09cf1fab7913302174c3a2fa16.tar.bz2
qapi/pci: Clean up documentation around PciDeviceClass
PciDeviceInfo's doc comment has a note on PciDeviceClass member @desc. Since the note applies always, not just within PciDeviceInfo, merge it into PciDeviceClass's description of member @desc. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-ID: <20240711112228.2140606-2-armbru@redhat.com> Reviewed-by: Michael S. Tsirkin <mst@redhat.com> Reviewed-by: John Snow <jsnow@redhat.com>
-rw-r--r--qapi/pci.json6
1 files changed, 2 insertions, 4 deletions
diff --git a/qapi/pci.json b/qapi/pci.json
index 8287d15..9717992 100644
--- a/qapi/pci.json
+++ b/qapi/pci.json
@@ -93,7 +93,8 @@
#
# Information about the Class of a PCI device
#
-# @desc: a string description of the device's class
+# @desc: a string description of the device's class (not stable, and
+# should only be treated as informational)
#
# @class: the class code of the device
#
@@ -146,9 +147,6 @@
#
# @regions: a list of the PCI I/O regions associated with the device
#
-# .. note:: The contents of @class_info.desc are not stable and should
-# only be treated as informational.
-#
# Since: 0.14
##
{ 'struct': 'PciDeviceInfo',