* [PATCH] qapi/block-core.json: Remove stale description of 'blockdev-add'
@ 2020-07-28 14:32 Kashyap Chamarthy
2020-07-28 14:50 ` [PATCH for-5.1?] " Eric Blake
0 siblings, 1 reply; 3+ messages in thread
From: Kashyap Chamarthy @ 2020-07-28 14:32 UTC (permalink / raw)
To: qemu-devel; +Cc: Kevin Wolf, Markus Armbruster, 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.
[...]
[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 <kchamart@redhat.com>
Identified-by: Kevin Wolf <kwolf@redhat.com>
---
qapi/block-core.json | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 463ffd83da..3575d73ebf 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -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
#
--
2.26.2
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH for-5.1?] qapi/block-core.json: Remove stale description of 'blockdev-add'
2020-07-28 14:32 [PATCH] qapi/block-core.json: Remove stale description of 'blockdev-add' Kashyap Chamarthy
@ 2020-07-28 14:50 ` Eric Blake
2020-07-29 9:22 ` Kashyap Chamarthy
0 siblings, 1 reply; 3+ messages in thread
From: Eric Blake @ 2020-07-28 14:50 UTC (permalink / raw)
To: Kashyap Chamarthy, qemu-devel; +Cc: Kevin Wolf, Markus Armbruster
On 7/28/20 9:32 AM, Kashyap Chamarthy wrote:
> 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....."
>
> Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
> Identified-by: Kevin Wolf <kwolf@redhat.com>
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?
> ---
> qapi/block-core.json | 4 +---
> 1 file changed, 1 insertion(+), 3 deletions(-)
>
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 463ffd83da..3575d73ebf 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -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.
Reviewed-by: Eric Blake <eblake@redhat.com>
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.
--
Eric Blake, Principal Software Engineer
Red Hat, Inc. +1-919-301-3226
Virtualization: qemu.org | libvirt.org
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH for-5.1?] qapi/block-core.json: Remove stale description of 'blockdev-add'
2020-07-28 14:50 ` [PATCH for-5.1?] " Eric Blake
@ 2020-07-29 9:22 ` Kashyap Chamarthy
0 siblings, 0 replies; 3+ messages in thread
From: Kashyap Chamarthy @ 2020-07-29 9:22 UTC (permalink / raw)
To: Eric Blake; +Cc: Kevin Wolf, qemu-devel, Markus Armbruster
On Tue, Jul 28, 2020 at 09:50:39AM -0500, Eric Blake wrote:
> On 7/28/20 9:32 AM, Kashyap Chamarthy wrote:
[...]
> > [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 <kchamart@redhat.com>
> > Identified-by: Kevin Wolf <kwolf@redhat.com>
>
> 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/)
> Is it worth a 'Fixes: be4b67bc7d' line?
Sure, including the provenance is always useful for later `git`
sleuthing.
[...]
> > -# 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 <eblake@redhat.com>
Thanks; shall I spin a v2? (I agree with both your suggestions above.)
> 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.
[...]
--
/kashyap
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-07-29 9:23 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-28 14:32 [PATCH] qapi/block-core.json: Remove stale description of 'blockdev-add' Kashyap Chamarthy
2020-07-28 14:50 ` [PATCH for-5.1?] " Eric Blake
2020-07-29 9:22 ` Kashyap Chamarthy
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.