From patchwork Sat Aug 20 17:58:44 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Prasanna Kumar Kalever X-Patchwork-Id: 9291781 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 98FE8607FF for ; Sat, 20 Aug 2016 17:59:20 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 8E88A28BFE for ; Sat, 20 Aug 2016 17:59:20 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 802F328C00; Sat, 20 Aug 2016 17:59:20 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 1580D28BFE for ; Sat, 20 Aug 2016 17:59:19 +0000 (UTC) Received: from localhost ([::1]:33966 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bbAY8-0005L8-IS for patchwork-qemu-devel@patchwork.kernel.org; Sat, 20 Aug 2016 13:59:16 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:33619) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bbAXt-0005Kr-LW for qemu-devel@nongnu.org; Sat, 20 Aug 2016 13:59:02 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bbAXq-0005aj-Gx for qemu-devel@nongnu.org; Sat, 20 Aug 2016 13:59:01 -0400 Received: from mx1.redhat.com ([209.132.183.28]:33856) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bbAXq-0005ad-BZ for qemu-devel@nongnu.org; Sat, 20 Aug 2016 13:58:58 -0400 Received: from int-mx14.intmail.prod.int.phx2.redhat.com (int-mx14.intmail.prod.int.phx2.redhat.com [10.5.11.27]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 19DC8BAEC for ; Sat, 20 Aug 2016 17:58:57 +0000 (UTC) Received: from pkalever.blr.redhat.com (vpn1-7-24.sin2.redhat.com [10.67.7.24]) by int-mx14.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u7KHwodk024407; Sat, 20 Aug 2016 13:58:52 -0400 From: Prasanna Kumar Kalever To: qemu-devel@nongnu.org Date: Sat, 20 Aug 2016 23:28:44 +0530 Message-Id: <1471715924-3642-1-git-send-email-prasanna.kalever@redhat.com> X-Scanned-By: MIMEDefang 2.68 on 10.5.11.27 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.26]); Sat, 20 Aug 2016 17:58:57 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH v2 1/1] qapi/block-core: add doc describing GlusterServer vs. SocketAddress X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Prasanna Kumar Kalever , jcody@redhat.com, armbru@redhat.com, vbellur@redhat.com Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP Added documentation describing relation between GlusterServer and SocketAddress qapi schemas. Thanks to Markus Armbruster Signed-off-by: Prasanna Kumar Kalever Reviewed-by: Markus Armbruster --- 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',