[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 09/12] qapi: Don't repeat member type in its documentation text
From: |
Markus Armbruster |
Subject: |
[PATCH 09/12] qapi: Don't repeat member type in its documentation text |
Date: |
Fri, 22 Mar 2024 15:09:07 +0100 |
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
- [PATCH 00/12] qapi: Fairly trivial documentation work, Markus Armbruster, 2024/03/22
- [PATCH 03/12] qapi: Tidy up block-latency-histogram-set documentation some more, Markus Armbruster, 2024/03/22
- [PATCH 04/12] qapi: Tidy up indentation of add_client's example, Markus Armbruster, 2024/03/22
- [PATCH 02/12] qapi: Expand a few awkward abbreviations in documentation, Markus Armbruster, 2024/03/22
- [PATCH 01/12] qapi: Drop stray Arguments: line from qmp_capabilities docs, Markus Armbruster, 2024/03/22
- [PATCH 08/12] qapi: Start sentences with a capital letter, end them with a period, Markus Armbruster, 2024/03/22
- [PATCH 05/12] qapi: Fix argument markup in drive-mirror documentation, Markus Armbruster, 2024/03/22
- [PATCH 07/12] qapi: Fix abbreviation punctuation in doc comments, Markus Armbruster, 2024/03/22
- [PATCH 09/12] qapi: Don't repeat member type in its documentation text,
Markus Armbruster <=
- [PATCH 11/12] qapi: Correct documentation indentation and whitespace, Markus Armbruster, 2024/03/22
- [PATCH 12/12] qga/qapi-schema: Refill doc comments to conform to current conventions, Markus Armbruster, 2024/03/22
- [PATCH 06/12] qapi: Fix typo in request-ebpf documentation, Markus Armbruster, 2024/03/22
- [PATCH 10/12] qapi: Refill doc comments to conform to current conventions, Markus Armbruster, 2024/03/22