All of lore.kernel.org
 help / color / mirror / Atom feed
From: marcandre.lureau@redhat.com
To: qemu-devel@nongnu.org
Cc: "Marc-André Lureau" <marcandre.lureau@redhat.com>,
	jsnow@redhat.com, "Markus Armbruster" <armbru@redhat.com>,
	stefanha@redhat.com
Subject: [PATCH v4 9/9] docs: update the documentation about schema configuration
Date: Mon, 17 May 2021 20:30:40 +0400	[thread overview]
Message-ID: <20210517163040.2308926-10-marcandre.lureau@redhat.com> (raw)
In-Reply-To: <20210517163040.2308926-1-marcandre.lureau@redhat.com>

From: Marc-André Lureau <marcandre.lureau@redhat.com>

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Tested-by: John Snow <jsnow@redhat.com>
---
 docs/devel/qapi-code-gen.txt | 27 ++++++++++++++++-----------
 1 file changed, 16 insertions(+), 11 deletions(-)

diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index edaaf7ec40..4a3fd02723 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -780,26 +780,31 @@ 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 generated from that condition: 'all': [COND, ...]
+will generate '(COND && ...)', 'any': [COND, ...] '(COND || ...)', 'not': COND '!COND'.
 
 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



  parent reply	other threads:[~2021-05-17 17:00 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-17 16:30 [PATCH v4 0/9] qapi: untie 'if' conditions from C preprocessor marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 1/9] qapi: replace List[str] by QAPISchemaIfCond marcandre.lureau
2021-06-07 14:18   ` Eric Blake
2021-06-08 11:38     ` Marc-André Lureau
2021-05-17 16:30 ` [PATCH v4 2/9] qapi: make gen_if/gen_endif take a simple string marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 3/9] qapi: start building an 'if' predicate tree marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 4/9] qapi: introduce IfPredicateList and IfAny marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 5/9] qapi: add IfNot marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 6/9] qapi: normalize 'if' condition to IfPredicate tree marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 7/9] qapi: convert 'if' C-expressions to the new syntax tree marcandre.lureau
2021-05-17 16:30 ` [PATCH v4 8/9] qapi: make 'if' condition strings simple identifiers marcandre.lureau
2021-05-21 12:02   ` Markus Armbruster
2021-05-21 12:26     ` Marc-André Lureau
2021-05-21 15:07       ` Markus Armbruster
2021-05-17 16:30 ` marcandre.lureau [this message]
2021-05-21 11:56   ` [PATCH v4 9/9] docs: update the documentation about schema configuration Markus Armbruster
2021-05-21 12:29     ` Marc-André Lureau
2021-05-21 15:24 ` [PATCH v4 0/9] qapi: untie 'if' conditions from C preprocessor Markus Armbruster

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210517163040.2308926-10-marcandre.lureau@redhat.com \
    --to=marcandre.lureau@redhat.com \
    --cc=armbru@redhat.com \
    --cc=jsnow@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.