On Wed, Feb 6, 2019 at 7:17 PM Markus Armbruster <arm...@redhat.com> wrote: > > 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 <arm...@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lur...@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: > > [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 >
