[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 9/9] docs: update the documentation about schema configuration
From: |
marcandre . lureau |
Subject: |
[PATCH v2 9/9] docs: update the documentation about schema configuration |
Date: |
Thu, 5 Nov 2020 16:28:08 +0400 |
From: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
docs/devel/qapi-code-gen.txt | 26 +++++++++++++++-----------
1 file changed, 15 insertions(+), 11 deletions(-)
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index 3d22a7ae21..c499352a74 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -772,26 +772,30 @@ downstream command __com.redhat_drive-mirror.
=== Configuring the schema ===
Syntax:
- COND = STRING
- | [ STRING, ... ]
+ COND = CFG-ID
+ | [ COND, ... ]
+ | { 'all: [ COND, ... ] }
+ | { 'any: [ COND, ... ] }
+ | { 'not': COND }
-All definitions take an optional 'if' member. Its value must be a
-string or a list of strings. A string is shorthand for a list
-containing just that string. The code generated for the definition
-will then be guarded by #if STRING for each STRING in the COND list.
+ CFG-ID = STRING
+
+All definitions take an optional 'if' member. Its value must be a string, a
list
+of strings or an object with a single member 'all', 'any' or 'not'. A string is
+shorthand for a list containing just that string. A list is a shorthand for a
+'all'-member object. The C code generated for the definition will then be
guarded
+by an #if precessor expression.
Example: a conditional struct
{ 'struct': 'IfStruct', 'data': { 'foo': 'int' },
- 'if': ['CONFIG_FOO', 'HAVE_BAR'] }
+ 'if': { 'all': [ 'CONFIG_FOO', 'HAVE_BAR' ] } }
gets its generated code guarded like this:
- #if defined(CONFIG_FOO)
- #if defined(HAVE_BAR)
+ #if defined(CONFIG_FOO) && defined(HAVE_BAR)
... generated code ...
- #endif /* defined(HAVE_BAR) */
- #endif /* defined(CONFIG_FOO) */
+ #endif /* defined(HAVE_BAR) && defined(CONFIG_FOO) */
Individual members of complex types, commands arguments, and
event-specific data can also be made conditional. This requires the
--
2.29.0
- [PATCH v2 0/9] qapi: untie 'if' conditions from C preprocessor, marcandre . lureau, 2020/11/05
- [PATCH v2 1/9] qapi: replace List[str] by QAPISchemaIf, marcandre . lureau, 2020/11/05
- [PATCH v2 2/9] qapi: move gen_if/gen_endif to QAPIIfSchema, marcandre . lureau, 2020/11/05
- [PATCH v2 3/9] qapi: start building an 'if' predicate tree, marcandre . lureau, 2020/11/05
- [PATCH v2 4/9] qapi: introduce IfPredicateList and IfAny, marcandre . lureau, 2020/11/05
- [PATCH v2 5/9] qapi: add IfNot, marcandre . lureau, 2020/11/05
- [PATCH v2 6/9] qapi: normalize 'if' condition to IfPredicate tree, marcandre . lureau, 2020/11/05
- [PATCH v2 7/9] qapi: convert 'if' C expressions to the new literal form, marcandre . lureau, 2020/11/05
- [PATCH v2 8/9] qapi: make 'if' condition strings simple identifiers, marcandre . lureau, 2020/11/05
- [PATCH v2 9/9] docs: update the documentation about schema configuration,
marcandre . lureau <=