[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH for-2.9 28/47] qapi2texi: Generate descriptions
From: |
Eric Blake |
Subject: |
Re: [Qemu-devel] [PATCH for-2.9 28/47] qapi2texi: Generate descriptions for simple union tags |
Date: |
Tue, 14 Mar 2017 14:54:47 -0500 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.8.0 |
On 03/13/2017 01:18 AM, Markus Armbruster wrote:
> Simple union tags carry no type information, because their type is
> implicit. Their description should make up for it, but many have
> none. Generate one automatically then.
>
> Example change (qemu-qmp-ref.txt):
>
> -- Simple Union: ImageInfoSpecific
>
> A discriminated record of image format specific information
> structures.
>
> Members:
> 'type'
> - Not documented
> + One of "qcow2", "vmdk", "luks"
Yes, that's nicer.
> 'data: ImageInfoSpecificQCow2' when 'type' is "qcow2"
> 'data: ImageInfoSpecificVmdk' when 'type' is "vmdk"
> 'data: QCryptoBlockInfoLUKS' when 'type' is "luks"
>
> Signed-off-by: Markus Armbruster <address@hidden>
> ---
> scripts/qapi2texi.py | 9 +++++++--
> 1 file changed, 7 insertions(+), 2 deletions(-)
>
Reviewed-by: Eric Blake <address@hidden>
--
Eric Blake eblake redhat com +1-919-301-3266
Libvirt virtualization library http://libvirt.org
signature.asc
Description: OpenPGP digital signature
- Re: [Qemu-devel] [PATCH for-2.9 07/47] qapi: Clean up build of generated documentation, (continued)
- [Qemu-devel] [PATCH for-2.9 22/47] qapi2texi: Explain enum value undocumentedness more clearly, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 12/47] qapi/rocker: Fix up doc comment notes on optional members, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 18/47] qapi: Use raw strings for regular expressions consistently, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 23/47] qapi2texi: Don't hide undocumented members and arguments, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 28/47] qapi2texi: Generate descriptions for simple union tags, Markus Armbruster, 2017/03/13
- Re: [Qemu-devel] [PATCH for-2.9 28/47] qapi2texi: Generate descriptions for simple union tags,
Eric Blake <=
- [Qemu-devel] [PATCH for-2.9 39/47] qapi: Drop unused variable events, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 29/47] qapi2texi: Use category "Object" for all object types, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 21/47] qapi2texi: Present the table of members more clearly, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 11/47] qapi: Avoid unwanted blank lines in QAPIDoc, Markus Armbruster, 2017/03/13
- [Qemu-devel] [PATCH for-2.9 05/47] qapi: Have each QAPI schema declare its returns white-list, Markus Armbruster, 2017/03/13