From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: eblake@redhat.com, michael.roth@amd.com, kkostiuk@redhat.com
Subject: [PATCH 09/12] qapi: Don't repeat member type in its documentation text
Date: Fri, 22 Mar 2024 15:09:07 +0100 [thread overview]
Message-ID: <20240322140910.328840-10-armbru@redhat.com> (raw)
In-Reply-To: <20240322140910.328840-1-armbru@redhat.com>
Documentation generated for the arguments of MEMORY_FAILURE looks like
"recipient": "MemoryFailureRecipient"
recipient is defined as "MemoryFailureRecipient".
"action": "MemoryFailureAction"
action that has been taken. action is defined as
"MemoryFailureAction".
"flags": "MemoryFailureFlags"
flags for MemoryFailureAction. action is defined as
"MemoryFailureFlags".
The "action is defined as ..." are redundant. Drop.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/run-state.json | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/qapi/run-state.json b/qapi/run-state.json
index 789fc34559..ae084e13a0 100644
--- a/qapi/run-state.json
+++ b/qapi/run-state.json
@@ -568,11 +568,9 @@
#
# @recipient: recipient is defined as @MemoryFailureRecipient.
#
-# @action: action that has been taken. action is defined as
-# @MemoryFailureAction.
+# @action: action that has been taken.
#
-# @flags: flags for MemoryFailureAction. action is defined as
-# @MemoryFailureFlags.
+# @flags: flags for MemoryFailureAction.
#
# Since: 5.2
#
--
2.44.0
next prev parent reply other threads:[~2024-03-22 14:11 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-22 14:08 [PATCH 00/12] qapi: Fairly trivial documentation work Markus Armbruster
2024-03-22 14:08 ` [PATCH 01/12] qapi: Drop stray Arguments: line from qmp_capabilities docs Markus Armbruster
2024-03-22 15:24 ` John Snow
2024-03-22 14:09 ` [PATCH 02/12] qapi: Expand a few awkward abbreviations in documentation Markus Armbruster
2024-03-22 14:09 ` [PATCH 03/12] qapi: Tidy up block-latency-histogram-set documentation some more Markus Armbruster
2024-03-22 14:09 ` [PATCH 04/12] qapi: Tidy up indentation of add_client's example Markus Armbruster
2024-03-25 5:49 ` Markus Armbruster
2024-03-22 14:09 ` [PATCH 05/12] qapi: Fix argument markup in drive-mirror documentation Markus Armbruster
2024-03-22 14:09 ` [PATCH 06/12] qapi: Fix typo in request-ebpf documentation Markus Armbruster
2024-03-22 14:09 ` [PATCH 07/12] qapi: Fix abbreviation punctuation in doc comments Markus Armbruster
2024-03-22 14:09 ` [PATCH 08/12] qapi: Start sentences with a capital letter, end them with a period Markus Armbruster
2024-03-22 14:09 ` Markus Armbruster [this message]
2024-03-22 14:09 ` [PATCH 10/12] qapi: Refill doc comments to conform to current conventions Markus Armbruster
2024-03-22 14:09 ` [PATCH 11/12] qapi: Correct documentation indentation and whitespace Markus Armbruster
2024-03-22 14:09 ` [PATCH 12/12] qga/qapi-schema: Refill doc comments to conform to current conventions Markus Armbruster
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=20240322140910.328840-10-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=kkostiuk@redhat.com \
--cc=michael.roth@amd.com \
--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).