qapi: Document new 'alternate' meta-type
commit7b1b98c420355ccea98d8bd55c9193ee6b7cef97
authorEric Blake <eblake@redhat.com>
Mon, 4 May 2015 15:05:12 +0000 (4 09:05 -0600)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 5 May 2015 16:39:00 +0000 (5 18:39 +0200)
tree0ceec0f9a47f2526cbc8feadf1d0faff480525af
parentab045267447d52e63a79c0e18f89ae4411f5420b
qapi: Document new 'alternate' meta-type

The next patch will quit special-casing "'union':'Foo',
'discriminator':{}" and instead use "'alternate':'Foo'".

Separating docs from implementation makes it easier to focus
on wording without holding up code.  In particular, making
alternate a separate type makes for a nice type hierarchy:

          /-------- meta-type ------\
         /              |            \
    simple types    alternate     complex types
    |         |                   |           |
 built-in   enum             type(struct)   union
 |       \    /                            /    \
numeric  string                         simple  flat

A later patch will then clean up 'type' vs. 'struct'
confusion.

Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
docs/qapi-code-gen.txt