docs/devel/qapi-code-gen.rst

230 example above, the generator maps 'MyEnum' to MY_ENUM and 'value1' to
312 An example BlockdevOptionsGenericCOWFormat object on the wire could use
435 The example alternate declaration above allows using both of the
436 following example objects::
497 Some example commands::
532 example::
550 (OOB) execution.  It defaults to false.  For example::
584 before the machine is built.  It defaults to false.  For example::
657 An example event is::
740 problematic strings.  For example, a member named ``default`` in qapi
908     #   Text of the example, may span
1016 detailing a relevant error condition.  For example::
1029 QMP Examples can be added by using the ``.. qmp-example::`` directive.
1037 directive option.  If the title is omitted, the example title will
1040 A simple QMP example::
1042   # .. qmp-example::
1052 For example::
1054   # .. qmp-example::
1058   #    This is a more complex example that can use
1110  # .. qmp-example::
1127 example::
1136 Indentation matters.  Bad example::
1150 recognized after a blank line.  Good example::
1163 Likewise, member descriptions require a colon.  Good example::
1192 introspection stability.  For example, one version of qemu may provide
1423 flexibility; for example, when an optional 'buffer-size' argument is
1472 As an example, we'll use the following schema, which describes a
1480     $ cat example-schema.json
1493     --prefix="example-" example-schema.json
1519     $ cat qapi-generated/example-qapi-types.h
1556     $ cat qapi-generated/example-qapi-types.c
1623     $ cat qapi-generated/example-qapi-visit.h
1630     #include "example-qapi-types.h"
1644     $ cat qapi-generated/example-qapi-visit.c
1775     $ cat qapi-generated/example-qapi-commands.h
1781     #include "example-qapi-types.h"
1788     $ cat qapi-generated/example-qapi-commands.trace-events
1794     $ cat qapi-generated/example-qapi-commands.c
1863     $ cat qapi-generated/example-qapi-init-commands.h
1873     $ cat qapi-generated/example-qapi-init-commands.c
1913     $ cat qapi-generated/example-qapi-events.h
1920     #include "example-qapi-types.h"
1925     $ cat qapi-generated/example-qapi-events.c
1940     $ cat qapi-generated/example-qapi-emit-events.h
1961     $ cat qapi-generated/example-qapi-emit-events.c
1993     $ cat qapi-generated/example-qapi-introspect.h
2004     $ cat qapi-generated/example-qapi-introspect.c