[Qemu-devel] [PATCH] block/gluster: fix doc in the qapi schema

[Qemu-devel] [PATCH] block/gluster: fix doc in the qapi schema

[Prasanna Kumar Kalever]

1. s/@debug-level/@debug_level/
2. rearrange the versioning
3. s/server description/servers description/

Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
---
 qapi/block-core.json | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/qapi/block-core.json b/qapi/block-core.json
index f462345..5af0ffd 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1689,8 +1689,9 @@
 #
 # @host_device, @host_cdrom: Since 2.1
 #
-# Since: 2.0
 # @gluster: Since 2.7
+#
+# Since: 2.0
 ##
 { 'enum': 'BlockdevDriver',
   'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop',
@@ -2134,9 +2135,9 @@
 #
 # @path:        absolute path to image file in gluster volume
 #
-# @server:      gluster server description
+# @server:      gluster servers description
 #
-# @debug-level: #optional libgfapi log level (default '4' which is Error)
+# @debug_level: #optional libgfapi log level (default '4' which is Error)
 #
 # Since: 2.7
 ##
-- 
2.7.4

Re: [Qemu-devel] [PATCH] block/gluster: fix doc in the qapi schema

[Eric Blake]

[-- Attachment #1: Type: text/plain, Size: 1693 bytes --]

On 07/22/2016 04:05 AM, Prasanna Kumar Kalever wrote:
> 1. s/@debug-level/@debug_level/

Wrong.  I asked for the opposite, s/debug_level/debug-level/

> 2. rearrange the versioning
> 3. s/server description/servers description/
> 
> Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
> ---
>  qapi/block-core.json | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index f462345..5af0ffd 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -1689,8 +1689,9 @@
>  #
>  # @host_device, @host_cdrom: Since 2.1
>  #
> -# Since: 2.0
>  # @gluster: Since 2.7

I don't think you need a blank line before this one; but that's cosmetic.

> +#
> +# Since: 2.0
>  ##
>  { 'enum': 'BlockdevDriver',
>    'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop',
> @@ -2134,9 +2135,9 @@
>  #
>  # @path:        absolute path to image file in gluster volume
>  #
> -# @server:      gluster server description
> +# @server:      gluster servers description

This part is okay.

>  #
> -# @debug-level: #optional libgfapi log level (default '4' which is Error)
> +# @debug_level: #optional libgfapi log level (default '4' which is Error)

The docs were right, it was the code below that used _ when it should use -.

Looking forward to v2; this qualifies as a bugfix, so it is safe during
hard freeze (and in fact necessary, so that we aren't baking in the
wrong spelling in introspection and breaking ABI to fix it later on).


-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 604 bytes --]

Re: [Qemu-devel] [PATCH] block/gluster: fix doc in the qapi schema

[Prasanna Kalever]

On Fri, Jul 22, 2016 at 7:39 PM, Eric Blake <eblake@redhat.com> wrote:
>
> On 07/22/2016 04:05 AM, Prasanna Kumar Kalever wrote:
> > 1. s/@debug-level/@debug_level/
>
> Wrong.  I asked for the opposite, s/debug_level/debug-level/

oops!

>
> > 2. rearrange the versioning
> > 3. s/server description/servers description/
> >
> > Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
> > ---
> >  qapi/block-core.json | 7 ++++---
> >  1 file changed, 4 insertions(+), 3 deletions(-)
> >
> > diff --git a/qapi/block-core.json b/qapi/block-core.json
> > index f462345..5af0ffd 100644
> > --- a/qapi/block-core.json
> > +++ b/qapi/block-core.json
> > @@ -1689,8 +1689,9 @@
> >  #
> >  # @host_device, @host_cdrom: Since 2.1
> >  #
> > -# Since: 2.0
> >  # @gluster: Since 2.7
>
> I don't think you need a blank line before this one; but that's cosmetic.

done

>
> > +#
> > +# Since: 2.0
> >  ##
> >  { 'enum': 'BlockdevDriver',
> >    'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop',
> > @@ -2134,9 +2135,9 @@
> >  #
> >  # @path:        absolute path to image file in gluster volume
> >  #
> > -# @server:      gluster server description
> > +# @server:      gluster servers description
>
> This part is okay.
>
> >  #
> > -# @debug-level: #optional libgfapi log level (default '4' which is Error)
> > +# @debug_level: #optional libgfapi log level (default '4' which is Error)
>
> The docs were right, it was the code below that used _ when it should use -.
>
> Looking forward to v2; this qualifies as a bugfix, so it is safe during
> hard freeze (and in fact necessary, so that we aren't baking in the
> wrong spelling in introspection and breaking ABI to fix it later on).

Just post v2, please have a glance;

Thanks Eric,
--
Prasanna

>
>
> --
> Eric Blake   eblake redhat com    +1-919-301-3266
> Libvirt virtualization library http://libvirt.org
>