[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH for-2.9 21/47] qapi2texi: Present the table of m
From: |
Eric Blake |
Subject: |
Re: [Qemu-devel] [PATCH for-2.9 21/47] qapi2texi: Present the table of members more clearly |
Date: |
Tue, 14 Mar 2017 13:08:43 -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:
> The table of members follows the main descriptive text immediately.
> Makes it hard to see what it is about. Start a new paragraph, and
> lead with a line "Members:" for object and alternate types, "Values:"
> for enumeration types, and "Arguments:" for commands and events.
>
> Example change (qemu-qmp-ref.txt):
>
> -- Command: set_link
>
> Sets the link status of a virtual network adapter.
> +
> + Arguments:
> 'name'
> the device name of the virtual network adapter
> 'up'
> true to set the link status to be up
>
> Returns: Nothing on success If 'name' is not a valid network
> device, DeviceNotFound
>
> Signed-off-by: Markus Armbruster <address@hidden>
> ---
> scripts/qapi2texi.py | 19 ++++++++++---------
> 1 file changed, 10 insertions(+), 9 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 18/47] qapi: Use raw strings for regular expressions consistently, (continued)
- [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
- [Qemu-devel] [PATCH for-2.9 21/47] qapi2texi: Present the table of members more clearly, Markus Armbruster, 2017/03/13
- Re: [Qemu-devel] [PATCH for-2.9 21/47] qapi2texi: Present the table of members more clearly,
Eric Blake <=
- [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
- [Qemu-devel] [PATCH for-2.9 25/47] qapi2texi: Include member type in generated documentation, Markus Armbruster, 2017/03/13