diff mbox

[32/33] docs/qapi-code-gen.txt: Fix QAPI schema examples

Message ID 1441274118-13702-1-git-send-email-armbru@redhat.com
State New
Headers show

Commit Message

Markus Armbruster Sept. 3, 2015, 9:55 a.m. UTC
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 docs/qapi-code-gen.txt | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

Eric Blake Sept. 3, 2015, 2:32 p.m. UTC | #1
On 09/03/2015 03:55 AM, Markus Armbruster wrote:
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  docs/qapi-code-gen.txt | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 

>  
> - { 'enum': 'BlockdevDriver', 'data': [ 'raw', 'qcow2' ] }
> + { 'enum': 'BlockdevDriver', 'data': [ 'file', 'qcow2' ] }

Done to match actual usage.

>   { 'struct': 'BlockdevCommonOptions',
>     'data': { 'driver': 'BlockdevDriver', 'readonly': 'bool' } }
>   { 'union': 'BlockdevOptions',
> @@ -350,7 +349,7 @@ is identical on the wire to:
>   { 'struct': 'Base', 'data': { 'type': 'Enum' } }
>   { 'struct': 'Branch1', 'data': { 'data': 'str' } }
>   { 'struct': 'Branch2', 'data': { 'data': 'int' } }
> - { 'union': 'Flat': 'base': 'Base', 'discriminator': 'type',
> + { 'union': 'Flat', 'base': 'Base', 'discriminator': 'type',

and done to fix a blatant type of : instead of ,

Reviewed-by: Eric Blake <eblake@redhat.com>
diff mbox

Patch

diff --git a/docs/qapi-code-gen.txt b/docs/qapi-code-gen.txt
index b4d4a01..ff16df2 100644
--- a/docs/qapi-code-gen.txt
+++ b/docs/qapi-code-gen.txt
@@ -300,7 +300,6 @@  an implicit C enum 'NameKind' is created, corresponding to the union
 the union can be named 'max', as this would collide with the implicit
 enum.  The value for each branch can be of any type.
 
-
 A flat union definition specifies a struct as its base, and
 avoids nesting on the wire.  All branches of the union must be
 complex types, and the top-level fields of the union dictionary on
@@ -314,7 +313,7 @@  adding a common field 'readonly', renaming the discriminator to
 something more applicable, and reducing the number of {} required on
 the wire:
 
- { 'enum': 'BlockdevDriver', 'data': [ 'raw', 'qcow2' ] }
+ { 'enum': 'BlockdevDriver', 'data': [ 'file', 'qcow2' ] }
  { 'struct': 'BlockdevCommonOptions',
    'data': { 'driver': 'BlockdevDriver', 'readonly': 'bool' } }
  { 'union': 'BlockdevOptions',
@@ -350,7 +349,7 @@  is identical on the wire to:
  { 'struct': 'Base', 'data': { 'type': 'Enum' } }
  { 'struct': 'Branch1', 'data': { 'data': 'str' } }
  { 'struct': 'Branch2', 'data': { 'data': 'int' } }
- { 'union': 'Flat': 'base': 'Base', 'discriminator': 'type',
+ { 'union': 'Flat', 'base': 'Base', 'discriminator': 'type',
    'data': { 'one': 'Branch1', 'two': 'Branch2' } }