aboutsummaryrefslogtreecommitdiff
path: root/qapi
diff options
context:
space:
mode:
authorPrasanna Kumar Kalever <prasanna.kalever@redhat.com>2016-08-20 23:28:44 +0530
committerJeff Cody <jcody@redhat.com>2016-09-13 01:34:55 -0400
commitc76d7aab81c264e3452e778f030fb3760e5edbb9 (patch)
tree88f935842ae57ee71e6b49da516ae19d4e3a4a60 /qapi
parente9db8ff38e539260a2cb5a7918d1155b7d92a264 (diff)
qapi/block-core: add doc describing GlusterServer vs. SocketAddress
Added documentation describing relation between GlusterServer and SocketAddress qapi schemas. Thanks to Markus Armbruster <armbru@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Jeff Cody <jcody@redhat.com> Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com> Message-id: 1471715924-3642-1-git-send-email-prasanna.kalever@redhat.com Signed-off-by: Jeff Cody <jcody@redhat.com>
Diffstat (limited to 'qapi')
-rw-r--r--qapi/block-core.json12
1 files changed, 12 insertions, 0 deletions
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 59128f7f89..173fb08ea3 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -2133,6 +2133,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',