[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 02/14] qapi/pci: Clean up documentation around PciDeviceClass
From: |
Markus Armbruster |
Subject: |
[PULL 02/14] qapi/pci: Clean up documentation around PciDeviceClass |
Date: |
Wed, 17 Jul 2024 12:48:55 +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 | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/qapi/pci.json b/qapi/pci.json
index 8287d15dd0..97179920fb 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',
--
2.45.0
- [PULL 00/14] QAPI patches patches for 2024-07-17, Markus Armbruster, 2024/07/17
- [PULL 02/14] qapi/pci: Clean up documentation around PciDeviceClass,
Markus Armbruster <=
- [PULL 04/14] qapi/machine: Clarify query-uuid value when none has been specified, Markus Armbruster, 2024/07/17
- [PULL 03/14] qapi/machine: Clean up documentation around CpuInstanceProperties, Markus Armbruster, 2024/07/17
- [PULL 12/14] qapi: convert "Example" sections with titles, Markus Armbruster, 2024/07/17
- [PULL 06/14] qapi/ui: Drop note on naming of SpiceQueryMouseMode, Markus Armbruster, 2024/07/17
- [PULL 05/14] qapi/sockets: Move deprecation note out of SocketAddress doc comment, Markus Armbruster, 2024/07/17
- [PULL 01/14] qapi/qom: Document feature unstable of @x-vfio-user-server, Markus Armbruster, 2024/07/17
- [PULL 10/14] docs/sphinx: add CSS styling for qmp-example directive, Markus Armbruster, 2024/07/17
- [PULL 09/14] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks, Markus Armbruster, 2024/07/17
- [PULL 14/14] qapi: remove "Example" doc section, Markus Armbruster, 2024/07/17
- [PULL 07/14] docs/qapidoc: factor out do_parse(), Markus Armbruster, 2024/07/17