]> www.infradead.org Git - users/dwmw2/qemu.git/commitdiff
qapi/pci: Clean up documentation around PciDeviceClass
authorMarkus Armbruster <armbru@redhat.com>
Thu, 11 Jul 2024 11:22:24 +0000 (13:22 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Wed, 17 Jul 2024 08:15:04 +0000 (10:15 +0200)
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>
qapi/pci.json

index 8287d15dd0b6ac30dad182a998a555e9d2636b3c..97179920fbff7983838e1d09fc7bf23dd9f28cea 100644 (file)
@@ -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
 #
 #
 # @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',