qapi/block-core: add doc describing GlusterServer vs. SocketAddress

Added documentation describing relation between GlusterServer and SocketAddress qapi schemas. Thanks to Markus Armbruster <[email protected]> Reviewed-by: Markus Armbruster <[email protected]> Reviewed-by: Jeff Cody <[email protected]> Signed-off-by: Prasanna Kumar Kalever <[email protected]> Message-id: [email protected] Signed-off-by: Jeff Cody <[email protected]>
pfliu · Sep 13, 2016 · c76d7aa · c76d7aa
1 parent e9db8ff
commit c76d7aa
Showing 1 changed file with 12 additions and 0 deletions.
diff --git 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',