diff options
| author | Markus Armbruster <armbru@redhat.com> | 2015-09-16 13:06:22 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2015-09-21 09:56:49 +0200 |
| commit | f133f2db1eedd409d3c1b0892f65b99f83c74754 (patch) | |
| tree | 5145738eddbd56291fc5ba59598620e065918a64 /docs | |
| parent | 56d92b003a223585980df5403ee9e3a55de90adf (diff) | |
qapi: Improve built-in type documentation
Clarify how they map to JSON. Add how they map to C. Fix the
reference to StringInputVisitor.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Daniel P. Berrange <berrange@redhat.com>
Message-Id: <1442401589-24189-20-git-send-email-armbru@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/qapi-code-gen.txt | 29 |
1 files changed, 18 insertions, 11 deletions
diff --git a/docs/qapi-code-gen.txt b/docs/qapi-code-gen.txt index 0884b5813c..5c2c278a60 100644 --- a/docs/qapi-code-gen.txt +++ b/docs/qapi-code-gen.txt @@ -140,17 +140,24 @@ must have a value that forms a struct name. === Built-in Types === -The following types are built-in to the parser: - 'str' - arbitrary UTF-8 string - 'int' - 64-bit signed integer (although the C code may place further - restrictions on acceptable range) - 'number' - floating point number - 'bool' - JSON value of true or false - 'int8', 'int16', 'int32', 'int64' - like 'int', but enforce maximum - bit size - 'uint8', 'uint16', 'uint32', 'uint64' - unsigned counterparts - 'size' - like 'uint64', but allows scaled suffix from command line - visitor +The following types are predefined, and map to C as follows: + + Schema C JSON + str char * any JSON string, UTF-8 + number double any JSON number + int int64_t a JSON number without fractional part + that fits into the C integer type + int8 int8_t likewise + int16 int16_t likewise + int32 int32_t likewise + int64 int64_t likewise + uint8 uint8_t likewise + uint16 uint16_t likewise + uint32 uint32_t likewise + uint64 uint64_t likewise + size uint64_t like uint64_t, except StringInputVisitor + accepts size suffixes + bool bool JSON true or false === Includes === |