Skip to content

Commit cbb698a

Browse files
author
Markus Armbruster
committed
qapi/block-core: Improve x-blockdev-change documentation
The description of feature @unstable is three paragraphs. The second and third became part of the description by accident in commit 9fb49da (qapi: Mark unstable QMP parts with feature 'unstable'). The second paragraph describes a defect in terms of the implementation. Fine, but doesn't belong into user-facing documentation. Turn it into a TODO section. Rewrite everything else for clarity and completeness. Signed-off-by: Markus Armbruster <[email protected]> Message-ID: <[email protected]> Acked-by: Alberto Garcia <[email protected]>
1 parent 0462a32 commit cbb698a

File tree

1 file changed

+12
-16
lines changed

1 file changed

+12
-16
lines changed

qapi/block-core.json

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5913,35 +5913,31 @@
59135913
##
59145914
# @x-blockdev-change:
59155915
#
5916-
# Dynamically reconfigure the block driver state graph. It can be
5917-
# used to add, remove, insert or replace a graph node. Currently only
5918-
# the Quorum driver implements this feature to add or remove its
5919-
# child. This is useful to fix a broken quorum child.
5916+
# Dynamically reconfigure the block driver state graph.
59205917
#
5921-
# If @node is specified, it will be inserted under @parent. @child
5922-
# may not be specified in this case. If both @parent and @child are
5923-
# specified but @node is not, @child will be detached from @parent.
5918+
# Currently only supports adding and deleting quorum children. A
5919+
# child will be added at the end of the list of children. Its
5920+
# contents *must* be consistent with the other childrens' contents.
5921+
# Deleting a child that is not last in the list of children is
5922+
# problematic, because it "renumbers" the children following it.
59245923
#
59255924
# @parent: the id or name of the parent node.
59265925
#
5927-
# @child: the name of a child under the given parent node.
5926+
# @child: the name of a child to be deleted. Mutually exclusive with
5927+
# @node.
59285928
#
5929-
# @node: the name of the node that will be added.
5929+
# @node: the name of the node to be added. Mutually exclusive with
5930+
# @child.
59305931
#
59315932
# Features:
59325933
#
5933-
# @unstable: This command is experimental, and its API is not stable.
5934-
# It does not support all kinds of operations, all kinds of
5935-
# children, nor all block drivers.
5934+
# @unstable: This command is experimental.
59365935
#
5937-
# FIXME Removing children from a quorum node means introducing
5936+
# TODO: Removing children from a quorum node means introducing
59385937
# gaps in the child indices. This cannot be represented in the
59395938
# 'children' list of BlockdevOptionsQuorum, as returned by
59405939
# .bdrv_refresh_filename().
59415940
#
5942-
# Warning: The data in a new quorum child MUST be consistent with
5943-
# that of the rest of the array.
5944-
#
59455941
# Since: 2.7
59465942
#
59475943
# .. qmp-example::

0 commit comments

Comments
 (0)