qapi/block-core.json: Remove stale description of 'blockdev-add'
PATCH 1/1 qapi/block-core.json: Remove stale description of 'blockdev-add'
On a 'qemu-discuss' thread[1], Kevin identifies that the current doc blurb for @blockdev-add is stale:
This is actually a documentation bug. @id doesn't exist, blockdev-add never creates a BlockBackend. This was different in the very first versions of the patches to add blockdev-add and we probably just forgot to update the documentation after removing it.
So remove the stale bits.
And the requirement for 'node-name' is already mentioned in the documentation of @BlockdevOptions:
[...]
# @node-name: the node name of the new node (Since 2.0).
# This option is required on the top level of blockdev-add.
# Valid node names start with an alphabetic character and may
# contain only alphanumeric characters, '-', '.' and '_'. Their
# maximum length is 31 characters.
[...]
[1] https://lists.nongnu.org/archive/html/qemu-discuss/2020-07/msg00071.html
-- equivalent to "-drive if=ide,id=disk0....."
--- qapi/block-core.json | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)
qapi/block-core.json +1 -3
@@ -4049,9 +4049,7 @@ ## # @blockdev-add: # -# Creates a new block device. If the @id option is given at the top level, a -# BlockBackend will be created; otherwise, @node-name is mandatory at the top -# level and no BlockBackend will be created. +# Creates a new block device. # # Since: 2.9 #
Signature · 1 line
2.26.2
Quoted 21 lines · Kashyap Chamarthy
On a 'qemu-discuss' thread[1], Kevin identifies that the current doc blurb for @blockdev-add is stale:
This is actually a documentation bug. @id doesn't exist, blockdev-add never creates a BlockBackend. This was different in the very first versions of the patches to add blockdev-add and we probably just forgot to update the documentation after removing it.
So remove the stale bits.
And the requirement for 'node-name' is already mentioned in the documentation of @BlockdevOptions:
[...]
# @node-name: the node name of the new node (Since 2.0).
# This option is required on the top level of blockdev-add.
# Valid node names start with an alphabetic character and may
# contain only alphanumeric characters, '-', '.' and '_'. Their
# maximum length is 31 characters.
[...]
Quoted 5 lines
[1] https://lists.nongnu.org/archive/html/qemu-discuss/2020-07/msg00071.html
-- equivalent to "-drive if=ide,id=disk0....."Signed-off-by Kashyap Chamarthy <[email protected]>Identified-by Kevin Wolf <[email protected]>
This would be our first use of this unusual tag name; more typical is Suggested-by or Reported-by.
Is it worth a 'Fixes: be4b67bc7d' line?
Quoted 9 lines
--- qapi/block-core.json | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)qapi/block-core.json +0
-0
qapi/block-core.json line 4052
Quoted 7 lines
qapi/block-core.json +1
-3@@ -4049,9 +4049,7 @@ ## # @blockdev-add: # -# Creates a new block device. If the @id option is given at the top level, a -# BlockBackend will be created; otherwise, @node-name is mandatory at the top -# level and no BlockBackend will be created. +# Creates a new block device.
As a doc fix, it is safe for 5.1, but given the timing of -rc2 today, it's also okay if it slips into 5.2.
Signature · 3 lines
Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3226 Virtualization: qemu.org | libvirt.org
Quoted 1 line · Eric Blake
On 7/28/20 9:32 AM, Kashyap Chamarthy wrote:
[...]
Quoted 8 lines
Quoted 5 lines
[1] https://lists.nongnu.org/archive/html/qemu-discuss/2020-07/msg00071.html
-- equivalent to "-drive if=ide,id=disk0....."Signed-off-by Kashyap Chamarthy <[email protected]>Identified-by Kevin Wolf <[email protected]>This would be our first use of this unusual tag name; more typical is Suggested-by or Reported-by.
Yes, I agree, using predictable tags is better; so 'Suggested-by' is good.
(We perhaps don't have as many 'unusual tags' as the kernel does :-) —
https://lwn.net/Articles/503829/)
Quoted 1 line
Is it worth a 'Fixes:
be4b67bc7d' line?
Sure, including the provenance is always useful for later git sleuthing.
[...]
Quoted 6 lines
qapi/block-core.json line 4052
Quoted 4 lines
qapi/block-core.json +1
-3-# Creates a new block device. If the @id option is given at the top level, a -# BlockBackend will be created; otherwise, @node-name is mandatory at the top -# level and no BlockBackend will be created. +# Creates a new block device.Reviewed-by Eric Blake <[email protected]>
Thanks; shall I spin a v2? (I agree with both your suggestions above.)
Quoted 2 lines
As a doc fix, it is safe for 5.1, but given the timing of -rc2 today, it's also okay if it slips into 5.2.
Yeah, 5.1 or 5.2, both are fine by me.
[...]
Signature · 1 line
/kashyap