[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH RFC v5 25/32] qapi: Improve built-in type documentat
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PATCH RFC v5 25/32] qapi: Improve built-in type documentation |
Date: |
Mon, 7 Sep 2015 12:16:36 +0200 |
Clarify how they map to JSON. Add how they map to C. Fix the
reference to StringInputVisitor.
Signed-off-by: Markus Armbruster <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
---
docs/qapi-code-gen.txt | 29 ++++++++++++++++++-----------
1 file changed, 18 insertions(+), 11 deletions(-)
diff --git a/docs/qapi-code-gen.txt b/docs/qapi-code-gen.txt
index 147638f..35a4a0f 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 ===
--
2.4.3
- [Qemu-devel] [PATCH RFC v5 10/32] qapi-types: Convert to QAPISchemaVisitor, fixing flat unions, (continued)
- [Qemu-devel] [PATCH RFC v5 10/32] qapi-types: Convert to QAPISchemaVisitor, fixing flat unions, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 13/32] qapi: De-duplicate enum code generation, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 08/32] Revert "qapi: Generate comments to simplify splitting for review", Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 12/32] qapi-commands: Convert to QAPISchemaVisitor, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 05/32] tests/qapi-schema: Convert test harness to QAPISchemaVisitor, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 18/32] qapi: Replace dirty is_c_ptr() by method c_null(), Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 02/32] qapi: New QAPISchema intermediate reperesentation, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 15/32] qapi-event: Convert to QAPISchemaVisitor, fixing data with base, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 11/32] qapi-visit: Convert to QAPISchemaVisitor, fixing bugs, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 20/32] qapi-visit: Rearrange code a bit, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 25/32] qapi: Improve built-in type documentation,
Markus Armbruster <=
- [Qemu-devel] [PATCH RFC v5 31/32] qapi-introspect: Map all integer types to 'int', Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 23/32] qapi: De-duplicate parameter list generation, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 16/32] qapi: Generate comments to simplify splitting for review, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 28/32] qapi-schema: Fix up misleading specification of netdev_add, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 17/32] Revert "qapi: Generate comments to simplify splitting for review", Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 24/32] qapi-commands: De-duplicate output marshaling functions, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 32/32] qapi-introspect: Hide type names, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 27/32] qom: Don't use 'gen': false for qom-get, qom-set, object-add, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 26/32] qapi: Introduce a first class 'any' type, Markus Armbruster, 2015/09/07
- [Qemu-devel] [PATCH RFC v5 29/32] qapi: Pseudo-type '**' is now unused, drop it, Markus Armbruster, 2015/09/07