]> git.proxmox.com Git - mirror_qemu.git/commit - scripts/qapi2texi.py
qapi2texi: Present the table of members more clearly
authorMarkus Armbruster <armbru@redhat.com>
Wed, 15 Mar 2017 12:57:10 +0000 (13:57 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Thu, 16 Mar 2017 06:13:03 +0000 (07:13 +0100)
commit2a1183ce9399657a896c51f388e6c7ca58f5d56d
tree0934bdd2b86086dbd9234dcbcb332552954eeed1
parent71d918a1b191adaabd009910163f996289666ee7
qapi2texi: Present the table of members more clearly

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 <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-22-git-send-email-armbru@redhat.com>
scripts/qapi2texi.py