diff mbox

[v2,1/1] qapi/block-core: add doc describing GlusterServer vs. SocketAddress

Message ID 1471715924-3642-1-git-send-email-prasanna.kalever@redhat.com
State New
Headers show

Commit Message

Prasanna Kumar Kalever Aug. 20, 2016, 5:58 p.m. UTC
Added documentation describing relation between GlusterServer and
SocketAddress qapi schemas.

Thanks to Markus Armbruster <armbru@redhat.com>

Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
---
v2: apply suggestions from Markus on v1
v1: initial doc changes
---
 qapi/block-core.json | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

Markus Armbruster Sept. 12, 2016, 3:05 p.m. UTC | #1
Prasanna Kumar Kalever <prasanna.kalever@redhat.com> writes:

> Added documentation describing relation between GlusterServer and
> SocketAddress qapi schemas.
>
> Thanks to Markus Armbruster <armbru@redhat.com>
>
> Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>

Reviewed-by: Markus Armbruster <armbru@redhat.com>
Jeff Cody Sept. 13, 2016, 5:22 a.m. UTC | #2
On Sat, Aug 20, 2016 at 11:28:44PM +0530, Prasanna Kumar Kalever wrote:
> Added documentation describing relation between GlusterServer and
> SocketAddress qapi schemas.
> 
> Thanks to Markus Armbruster <armbru@redhat.com>
> 
> Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
> ---
> v2: apply suggestions from Markus on v1
> v1: initial doc changes
> ---
>  qapi/block-core.json | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 5e2d7d7..4bd513f 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -2121,6 +2121,18 @@
>  #
>  # @tcp:        host address and port number
>  #
> +# This is similar to SocketAddress, only distinction:
> +#
> +# 1. GlusterServer is a flat union, SocketAddress is a simple union.
> +#    A flat union is nicer than simple because it avoids nesting
> +#    (i.e. more {}) on the wire.
> +#
> +# 2. GlusterServer lacks case 'fd', since gluster doesn't let you
> +#    pass in a file descriptor.
> +#
> +# GlusterServer is actually not Gluster-specific, its a
> +# compatibility evolved into an alternate for SocketAddress.
> +#
>  # Since: 2.7
>  ##
>  { 'union': 'GlusterServer',
> -- 
> 2.7.4
> 

Thanks,

Applied to my block branch:

git://github.com/codyprime/qemu-kvm-jtc.git block

-Jeff
diff mbox

Patch

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 5e2d7d7..4bd513f 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -2121,6 +2121,18 @@ 
 #
 # @tcp:        host address and port number
 #
+# This is similar to SocketAddress, only distinction:
+#
+# 1. GlusterServer is a flat union, SocketAddress is a simple union.
+#    A flat union is nicer than simple because it avoids nesting
+#    (i.e. more {}) on the wire.
+#
+# 2. GlusterServer lacks case 'fd', since gluster doesn't let you
+#    pass in a file descriptor.
+#
+# GlusterServer is actually not Gluster-specific, its a
+# compatibility evolved into an alternate for SocketAddress.
+#
 # Since: 2.7
 ##
 { 'union': 'GlusterServer',