[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH for-2.9 29/47] qapi2texi: Use category "Object"
From: |
Eric Blake |
Subject: |
Re: [Qemu-devel] [PATCH for-2.9 29/47] qapi2texi: Use category "Object" for all object types |
Date: |
Tue, 14 Mar 2017 14:56:39 -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:
> At the protocol level, the distinction between struct, flat union and
> simple union is meaningless, they are all JSON objects. Document them
> that way.
>
> Example change (qemu-qmp-ref.txt):
>
> - -- Simple Union: InputEvent
> + -- Object: InputEvent
>
> Input event union.
Yay - and even addresses one of my comments earlier in the series about
a needless distinction between simple and flat unions.
>
> This also fixes the completely broken headings for flat and simple
> unions in qemu-qmp-ref.7 and qemu-ga-ref.7, by sidestepping a bug in
> texi2pod.pl. For instance, it mistranslates "@deftp {Simple Union}
> InputEvent" to "B<Union> (Simple)", but translates "@deftp Object
> InputEvent" to "B<SocketAddress> (Object)".
>
> Signed-off-by: Markus Armbruster <address@hidden>
> ---
> scripts/qapi2texi.py | 8 +-------
> 1 file changed, 1 insertion(+), 7 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 12/47] qapi/rocker: Fix up doc comment notes on optional members, (continued)
- [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
- [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
- Re: [Qemu-devel] [PATCH for-2.9 29/47] qapi2texi: Use category "Object" for all object types,
Eric Blake <=
- [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
- [Qemu-devel] [PATCH for-2.9 24/47] qapi2texi: Implement boxed argument documentation, Markus Armbruster, 2017/03/13