Skip to content

Commit

Permalink
qapi: Don't repeat member type in its documentation text
Browse files Browse the repository at this point in the history
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>
Message-ID: <20240322140910.328840-10-armbru@redhat.com>
  • Loading branch information
Markus Armbruster committed Mar 26, 2024
1 parent 73c67f3 commit 1e6b050
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions qapi/run-state.json
Original file line number Diff line number Diff line change
Expand Up @@ -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
#
Expand Down

0 comments on commit 1e6b050

Please sign in to comment.