[PATCH 1/5] qapi: Drop redundant documentation of inherited members

Markus Armbruster posted 5 patches 10 months ago
Maintainers: Eric Blake <eblake@redhat.com>, Markus Armbruster <armbru@redhat.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, Michael Roth <michael.roth@amd.com>, Konstantin Kostiuk <kkostiuk@redhat.com>
[PATCH 1/5] qapi: Drop redundant documentation of inherited members
Posted by Markus Armbruster 10 months ago
Documentation generated for SchemaInfo looks like

    The members of "SchemaInfoBuiltin" when "meta-type" is ""builtin""
    The members of "SchemaInfoEnum" when "meta-type" is ""enum""
    The members of "SchemaInfoArray" when "meta-type" is ""array""
    The members of "SchemaInfoObject" when "meta-type" is ""object""
    The members of "SchemaInfoAlternate" when "meta-type" is ""alternate""
    The members of "SchemaInfoCommand" when "meta-type" is ""command""
    The members of "SchemaInfoEvent" when "meta-type" is ""event""
    Additional members depend on the value of "meta-type".

The last line became redundant when commit 88f63467c57 (qapi2texi:
Generate reference to base type members) added the lines preceding it.
Drop it.

BlockdevOptions has the same issue.  Drop

    Remaining options are determined by the block driver.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/block-core.json | 2 --
 qapi/introspect.json | 2 --
 2 files changed, 4 deletions(-)

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 48c181e55d..530c4af50f 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -4665,8 +4665,6 @@
 # @force-share: force share all permission on added nodes.  Requires
 #     read-only=true.  (Since 2.10)
 #
-# Remaining options are determined by the block driver.
-#
 # Since: 2.9
 ##
 { 'union': 'BlockdevOptions',
diff --git a/qapi/introspect.json b/qapi/introspect.json
index 8df1ce85ed..b041b02ba8 100644
--- a/qapi/introspect.json
+++ b/qapi/introspect.json
@@ -93,8 +93,6 @@
 #     particular order.  (since 4.1 for object types, 4.2 for
 #     commands, 5.0 for the rest)
 #
-# Additional members depend on the value of @meta-type.
-#
 # Since: 2.5
 ##
 { 'union': 'SchemaInfo',
-- 
2.43.0
Re: [PATCH 1/5] qapi: Drop redundant documentation of inherited members
Posted by Eric Blake 10 months ago
On Mon, Jan 29, 2024 at 12:50:04PM +0100, Markus Armbruster wrote:
> Documentation generated for SchemaInfo looks like
> 
>     The members of "SchemaInfoBuiltin" when "meta-type" is ""builtin""
>     The members of "SchemaInfoEnum" when "meta-type" is ""enum""
>     The members of "SchemaInfoArray" when "meta-type" is ""array""
>     The members of "SchemaInfoObject" when "meta-type" is ""object""
>     The members of "SchemaInfoAlternate" when "meta-type" is ""alternate""
>     The members of "SchemaInfoCommand" when "meta-type" is ""command""
>     The members of "SchemaInfoEvent" when "meta-type" is ""event""
>     Additional members depend on the value of "meta-type".
> 
> The last line became redundant when commit 88f63467c57 (qapi2texi:
> Generate reference to base type members) added the lines preceding it.
> Drop it.
> 
> BlockdevOptions has the same issue.  Drop
> 
>     Remaining options are determined by the block driver.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/block-core.json | 2 --
>  qapi/introspect.json | 2 --
>  2 files changed, 4 deletions(-)

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.
Virtualization:  qemu.org | libguestfs.org