[v2] qapi: Supply some of the missing member documentation

[PATCH v2 5/8] qapi/pci: Supply missing member documentation

Posted by Markus Armbruster 2 months, 1 week ago

Since we neglect to document a member of PciMemoryRegion, its
description in the QEMU QMP Reference manual is "Not documented".  Fix
that.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
---
 qapi/pci.json    | 2 ++
 qapi/pragma.json | 1 -
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/qapi/pci.json b/qapi/pci.json
index 78bee57b77..dc85a41d28 100644
--- a/qapi/pci.json
+++ b/qapi/pci.json
@@ -33,6 +33,8 @@
 #     - 'io' if the region is a PIO region
 #     - 'memory' if the region is a MMIO region
 #
+# @address: memory address
+#
 # @size: memory size
 #
 # @prefetch: if @type is 'memory', true if the memory is prefetchable
diff --git a/qapi/pragma.json b/qapi/pragma.json
index 7b0e12f42b..baeae5bf52 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -62,7 +62,6 @@
         'MemoryDeviceInfoKind',
         'NetClientDriver',
         'ObjectType',
-        'PciMemoryRegion',
         'QCryptodevBackendServiceType',
         'QKeyCode',
         'RbdAuthMode',
-- 
2.46.0

Re: [PATCH v2 5/8] qapi/pci: Supply missing member documentation

Posted by Michael S. Tsirkin 2 months, 1 week ago

On Wed, Sep 11, 2024 at 01:25:42PM +0200, Markus Armbruster wrote:
> Since we neglect to document a member of PciMemoryRegion, its
> description in the QEMU QMP Reference manual is "Not documented".  Fix
> that.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>

Reviewed-by: Michael S. Tsirkin <mst@redhat.com>


can you merge this?

> ---
>  qapi/pci.json    | 2 ++
>  qapi/pragma.json | 1 -
>  2 files changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/qapi/pci.json b/qapi/pci.json
> index 78bee57b77..dc85a41d28 100644
> --- a/qapi/pci.json
> +++ b/qapi/pci.json
> @@ -33,6 +33,8 @@
>  #     - 'io' if the region is a PIO region
>  #     - 'memory' if the region is a MMIO region
>  #
> +# @address: memory address
> +#
>  # @size: memory size
>  #
>  # @prefetch: if @type is 'memory', true if the memory is prefetchable
> diff --git a/qapi/pragma.json b/qapi/pragma.json
> index 7b0e12f42b..baeae5bf52 100644
> --- a/qapi/pragma.json
> +++ b/qapi/pragma.json
> @@ -62,7 +62,6 @@
>          'MemoryDeviceInfoKind',
>          'NetClientDriver',
>          'ObjectType',
> -        'PciMemoryRegion',
>          'QCryptodevBackendServiceType',
>          'QKeyCode',
>          'RbdAuthMode',
> -- 
> 2.46.0

Re: [PATCH v2 5/8] qapi/pci: Supply missing member documentation

Posted by Markus Armbruster 2 months, 1 week ago

"Michael S. Tsirkin" <mst@redhat.com> writes:

> On Wed, Sep 11, 2024 at 01:25:42PM +0200, Markus Armbruster wrote:
>> Since we neglect to document a member of PciMemoryRegion, its
>> description in the QEMU QMP Reference manual is "Not documented".  Fix
>> that.
>> 
>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>> Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
>
> Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
>
>
> can you merge this?

Gladly!