[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v4 01/18] qapi: Belatedly document modular code gene
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PATCH v4 01/18] qapi: Belatedly document modular code generation |
Date: |
Thu, 14 Feb 2019 10:30:36 +0100 |
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 <address@hidden>
Reviewed-by: Marc-André Lureau <address@hidden>
---
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:
[Uninteresting stuff omitted...]
+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
+
=== Code generated for visiting QAPI types ===
These are the visitor functions used to walk through and convert
@@ -1244,6 +1257,19 @@ Example:
[Uninteresting stuff omitted...]
+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
+
=== Code generated for commands ===
These are the marshaling/dispatch functions for the commands defined
@@ -1342,6 +1368,12 @@ Example:
[Uninteresting stuff omitted...]
+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
+
=== Code generated for events ===
This is the code related to events defined in the schema, providing
@@ -1402,6 +1434,12 @@ Example:
[Uninteresting stuff omitted...]
+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
+
=== Code generated for introspection ===
The following files are created:
--
2.17.2
- [Qemu-devel] [PATCH v4 04/18] qapi: Prepare for system modules other than 'builtin', (continued)
- [Qemu-devel] [PATCH v4 04/18] qapi: Prepare for system modules other than 'builtin', Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 08/18] qapi: New module target.json, Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 05/18] qapi: Generate QAPIEvent stuff into separate files, Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 15/18] qapi: remove qmp_unregister_command(), Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 13/18] qapi: make query-cpu-model-expansion depend on s390 or x86, Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 06/18] build-sys: move qmp-introspect per target, Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 07/18] build: Deal with all of QAPI's .o in qapi/Makefile.objs, Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 01/18] qapi: Belatedly document modular code generation,
Markus Armbruster <=
- [Qemu-devel] [PATCH v4 09/18] qapi: make rtc-reset-reinjection and SEV depend on TARGET_I386, Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 12/18] qapi: make query-gic-capabilities depend on TARGET_ARM, Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 14/18] qapi: make query-cpu-definitions depend on specific targets, Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 03/18] qapi: Clean up modular built-in code generation a bit, Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 17/18] qmp: Deprecate query-events in favor of query-qmp-schema, Markus Armbruster, 2019/02/14
- [Qemu-devel] [PATCH v4 10/18] qapi: make s390 commands depend on TARGET_S390X, Markus Armbruster, 2019/02/14