From c76d7aab81c264e3452e778f030fb3760e5edbb9 Mon Sep 17 00:00:00 2001 From: Prasanna Kumar Kalever Date: Sat, 20 Aug 2016 23:28:44 +0530 Subject: [PATCH] qapi/block-core: add doc describing GlusterServer vs. SocketAddress Added documentation describing relation between GlusterServer and SocketAddress qapi schemas. Thanks to Markus Armbruster Reviewed-by: Markus Armbruster Reviewed-by: Jeff Cody Signed-off-by: Prasanna Kumar Kalever Message-id: 1471715924-3642-1-git-send-email-prasanna.kalever@redhat.com Signed-off-by: Jeff Cody --- qapi/block-core.json | 12 ++++++++++++ 1 file changed, 12 insertions(+) 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',