From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: eblake@redhat.com, kwolf@redhat.com, hreitz@redhat.com,
michael.roth@amd.com, kkostiuk@redhat.com, qemu-block@nongnu.org
Subject: [PATCH 1/5] qapi: Drop redundant documentation of inherited members
Date: Mon, 29 Jan 2024 12:50:04 +0100 [thread overview]
Message-ID: <20240129115008.674248-2-armbru@redhat.com> (raw)
In-Reply-To: <20240129115008.674248-1-armbru@redhat.com>
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
next prev parent reply other threads:[~2024-01-29 11:51 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-29 11:50 [PATCH 0/5] qmp: Documentation cleanups Markus Armbruster
2024-01-29 11:50 ` Markus Armbruster [this message]
2024-01-29 19:46 ` [PATCH 1/5] qapi: Drop redundant documentation of inherited members Eric Blake
2024-01-29 11:50 ` [PATCH 2/5] qapi: Drop redundant documentation of conditional Markus Armbruster
2024-01-29 19:47 ` Eric Blake
2024-01-29 11:50 ` [PATCH 3/5] qapi: Elide "Potential additional modes" from generated docs Markus Armbruster
2024-01-29 19:43 ` Eric Blake
2024-01-29 11:50 ` [PATCH 4/5] qga: Move type description right after type name Markus Armbruster
2024-01-29 16:21 ` Konstantin Kostiuk
2024-01-29 11:50 ` [PATCH 5/5] qga/qapi-schema: Move command description right after command name Markus Armbruster
2024-01-29 16:20 ` Konstantin Kostiuk
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240129115008.674248-2-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=hreitz@redhat.com \
--cc=kkostiuk@redhat.com \
--cc=kwolf@redhat.com \
--cc=michael.roth@amd.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).