| Message ID | 20240711112228.2140606-2-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi: Doc comment cleanups | expand |
On Thu, Jul 11, 2024, 7:24 AM Markus Armbruster <armbru@redhat.com> wrote: > 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> > 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 > > >
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',
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> --- qapi/pci.json | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-)