Added documentation describing relation between GlusterServer and
SocketAddress qapi schemas.
Thanks to Markus Armbruster <arm...@redhat.com>
Signed-off-by: Prasanna Kumar Kalever <prasanna.kale...@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
