{"id":812358,"url":"http://patchwork.ozlabs.org/api/patches/812358/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170911110623.24981-32-marcandre.lureau@redhat.com/","project":{"id":14,"url":"http://patchwork.ozlabs.org/api/projects/14/?format=json","name":"QEMU Development","link_name":"qemu-devel","list_id":"qemu-devel.nongnu.org","list_email":"qemu-devel@nongnu.org","web_url":"","scm_url":"","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20170911110623.24981-32-marcandre.lureau@redhat.com>","list_archive_url":null,"date":"2017-09-11T11:06:04","name":"[v3,31/50] docs: document schema configuration","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"7744d32bb228737c67fa0a8839d2ab83b516d6c3","submitter":{"id":66774,"url":"http://patchwork.ozlabs.org/api/people/66774/?format=json","name":"Marc-André Lureau","email":"marcandre.lureau@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170911110623.24981-32-marcandre.lureau@redhat.com/mbox/","series":[{"id":2480,"url":"http://patchwork.ozlabs.org/api/series/2480/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=2480","date":"2017-09-11T11:05:33","name":"Hi,","version":3,"mbox":"http://patchwork.ozlabs.org/series/2480/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/812358/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/812358/checks/","tags":{},"related":[],"headers":{"Return-Path":"","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@bilbo.ozlabs.org","Authentication-Results":["ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=nongnu.org\n\t(client-ip=2001:4830:134:3::11; helo=lists.gnu.org;\n\tenvelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n\treceiver=)","ext-mx04.extmail.prod.ext.phx2.redhat.com;\n\tdmarc=none (p=none dis=none) header.from=redhat.com","ext-mx04.extmail.prod.ext.phx2.redhat.com;\n\tspf=fail smtp.mailfrom=marcandre.lureau@redhat.com"],"Received":["from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11])\n\t(using TLSv1 with cipher AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3xrQz72z31z9rxl\n\tfor ;\n\tMon, 11 Sep 2017 21:42:59 +1000 (AEST)","from localhost ([::1]:56924 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t)\n\tid 1drN7B-0002yQ-F8\n\tfor incoming@patchwork.ozlabs.org; Mon, 11 Sep 2017 07:42:57 -0400","from eggs.gnu.org ([2001:4830:134:3::10]:43393)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from ) id 1drMZB-00063t-IL\n\tfor qemu-devel@nongnu.org; Mon, 11 Sep 2017 07:07:55 -0400","from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from ) id 1drMZA-0006u4-H4\n\tfor qemu-devel@nongnu.org; Mon, 11 Sep 2017 07:07:49 -0400","from mx1.redhat.com ([209.132.183.28]:33638)\n\tby eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)\n\t(Exim 4.71) (envelope-from )\n\tid 1drMZA-0006tb-BU\n\tfor qemu-devel@nongnu.org; Mon, 11 Sep 2017 07:07:48 -0400","from smtp.corp.redhat.com\n\t(int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11])\n\t(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby mx1.redhat.com (Postfix) with ESMTPS id 83AC910B1A2\n\tfor ; Mon, 11 Sep 2017 11:07:47 +0000 (UTC)","from localhost (ovpn-112-47.ams2.redhat.com [10.36.112.47])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id 173B960179;\n\tMon, 11 Sep 2017 11:07:44 +0000 (UTC)"],"DMARC-Filter":"OpenDMARC Filter v1.3.2 mx1.redhat.com 83AC910B1A2","From":"=?utf-8?q?Marc-Andr=C3=A9_Lureau?= ","To":"qemu-devel@nongnu.org","Date":"Mon, 11 Sep 2017 13:06:04 +0200","Message-Id":"<20170911110623.24981-32-marcandre.lureau@redhat.com>","In-Reply-To":"<20170911110623.24981-1-marcandre.lureau@redhat.com>","References":"<20170911110623.24981-1-marcandre.lureau@redhat.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","X-Scanned-By":"MIMEDefang 2.79 on 10.5.11.11","X-Greylist":"Sender IP whitelisted, not delayed by milter-greylist-4.5.16\n\t(mx1.redhat.com [10.5.110.28]);\n\tMon, 11 Sep 2017 11:07:47 +0000 (UTC)","Content-Transfer-Encoding":"quoted-printable","X-detected-operating-system":"by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]\n\t[fuzzy]","X-Received-From":"209.132.183.28","Subject":"[Qemu-devel] [PATCH v3 31/50] docs: document schema configuration","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.21","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Cc":"=?utf-8?q?Marc-Andr=C3=A9_Lureau?= ,\n\tarmbru@redhat.com","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n\t"},"content":"Signed-off-by: Marc-André Lureau \n---\n docs/devel/qapi-code-gen.txt | 37 +++++++++++++++++++++++++++++++++++++\n 1 file changed, 37 insertions(+)","diff":"diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt\nindex 0a90f2278a..24fc6f74ee 100644\n--- a/docs/devel/qapi-code-gen.txt\n+++ b/docs/devel/qapi-code-gen.txt\n@@ -682,6 +682,43 @@ Example: Red Hat, Inc. controls redhat.com, and may therefore add a\n downstream command __com.redhat_drive-mirror.\n \n \n+=== Configuring the schema ===\n+\n+'struct', 'enum', 'union', 'alternate', 'command' and 'event'\n+top-level QAPI expressions can take a 'if' keyword like:\n+\n+{ 'struct': 'IfStruct', 'data': { 'foo': 'int' },\n+ 'if': 'defined(IF_STRUCT) && defined(FOO)' }\n+\n+Members can be exploded as dictionnary with 'type' & 'if' keys:\n+\n+{ 'struct': 'IfStruct', 'data':\n+ { 'foo': 'int',\n+ 'bar': { 'type': 'int', 'if': 'defined(IF_STRUCT_BAR)'} } }\n+\n+Enum values can be exploded as dictionnary with 'name' & 'if' keys:\n+\n+{ 'enum': 'IfEnum', 'data':\n+ [ 'foo',\n+ { 'name' : 'bar', 'if': 'defined(IF_ENUM_BAR)' } ] }\n+\n+The C code generators will wrap the corresponding lines with #if / #endif\n+pre-processor conditions for a given 'if' value.\n+\n+Example for enum values:\n+\n+enum IfEnum {\n+ IF_ENUM_FOO,\n+#if defined(IF_ENUM_BAR)\n+ IF_ENUM_BAR,\n+#endif /* defined(IF_ENUM_BAR) */\n+ IF_ENUM__MAX\n+}\n+\n+Please note that you are responsbile to ensure that the C code will\n+compile with an arbitrary combination of conditions, since the\n+generators are unable to check it at this point.\n+\n == Client JSON Protocol introspection ==\n \n Clients of a Client JSON Protocol commonly need to figure out what\n","prefixes":["v3","31/50"]}