From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([209.51.188.92]:60026) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gvjYu-0001yI-Sw for qemu-devel@nongnu.org; Mon, 18 Feb 2019 09:06:34 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gvjYm-0005SF-Nn for qemu-devel@nongnu.org; Mon, 18 Feb 2019 09:06:24 -0500 Received: from mx1.redhat.com ([209.132.183.28]:51760) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gvjYm-0005OM-AF for qemu-devel@nongnu.org; Mon, 18 Feb 2019 09:06:16 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id B5325C068BF8 for ; Mon, 18 Feb 2019 14:06:09 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-116-92.ams2.redhat.com [10.36.116.92]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 80711104811F for ; Mon, 18 Feb 2019 14:06:09 +0000 (UTC) From: Markus Armbruster Date: Mon, 18 Feb 2019 15:05:50 +0100 Message-Id: <20190218140607.31998-2-armbru@redhat.com> In-Reply-To: <20190218140607.31998-1-armbru@redhat.com> References: <20190218140607.31998-1-armbru@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Subject: [Qemu-devel] [PULL 01/18] qapi: Belatedly document modular code generation List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org We generate code for built-ins and sub-modules into separate files since commit cdb6610ae42 and 252dc3105fc (v2.12.0). Both commits neglected to update documentation. Do that now. Signed-off-by: Markus Armbruster Reviewed-by: Marc-Andr=C3=A9 Lureau Message-Id: <20190214152251.2073-2-armbru@redhat.com> --- docs/devel/qapi-code-gen.txt | 38 ++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt index 87183d3a09..b91bde647c 100644 --- a/docs/devel/qapi-code-gen.txt +++ b/docs/devel/qapi-code-gen.txt @@ -1113,6 +1113,19 @@ Example: =20 [Uninteresting stuff omitted...] =20 +For a modular QAPI schema (see section Include directives), code for +each sub-module SUBDIR/SUBMODULE.json is actually generated into + +SUBDIR/$(prefix)qapi-types-SUBMODULE.h +SUBDIR/$(prefix)qapi-types-SUBMODULE.c + +If qapi-gen.py is run with option --builtins, additional files are +created: + +qapi-builtin-types.h - C types corresponding to built-in types + +qapi-builtin-types.c - Cleanup functions for the above C types + =3D=3D=3D Code generated for visiting QAPI types =3D=3D=3D =20 These are the visitor functions used to walk through and convert @@ -1244,6 +1257,19 @@ Example: =20 [Uninteresting stuff omitted...] =20 +For a modular QAPI schema (see section Include directives), code for +each sub-module SUBDIR/SUBMODULE.json is actually generated into + +SUBDIR/$(prefix)qapi-visit-SUBMODULE.h +SUBDIR/$(prefix)qapi-visit-SUBMODULE.c + +If qapi-gen.py is run with option --builtins, additional files are +created: + +qapi-builtin-visit.h - Visitor functions for built-in types + +qapi-builtin-visit.c - Declarations for these visitor functions + =3D=3D=3D Code generated for commands =3D=3D=3D =20 These are the marshaling/dispatch functions for the commands defined @@ -1342,6 +1368,12 @@ Example: =20 [Uninteresting stuff omitted...] =20 +For a modular QAPI schema (see section Include directives), code for +each sub-module SUBDIR/SUBMODULE.json is actually generated into + +SUBDIR/$(prefix)qapi-commands-SUBMODULE.h +SUBDIR/$(prefix)qapi-commands-SUBMODULE.c + =3D=3D=3D Code generated for events =3D=3D=3D =20 This is the code related to events defined in the schema, providing @@ -1402,6 +1434,12 @@ Example: =20 [Uninteresting stuff omitted...] =20 +For a modular QAPI schema (see section Include directives), code for +each sub-module SUBDIR/SUBMODULE.json is actually generated into + +SUBDIR/$(prefix)qapi-events-SUBMODULE.h +SUBDIR/$(prefix)qapi-events-SUBMODULE.c + =3D=3D=3D Code generated for introspection =3D=3D=3D =20 The following files are created: --=20 2.17.2