]> git.proxmox.com Git - mirror_qemu.git/commit
qapi: Fix mangled "Returns" sections in documentation
authorMarkus Armbruster <armbru@redhat.com>
Sat, 20 Jan 2024 09:53:25 +0000 (10:53 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Fri, 26 Jan 2024 06:04:53 +0000 (07:04 +0100)
commitae7ccd50c37d1154acb0d1ed4b67388e3dd69061
treea1216324dac06590082c45c0f73a204d61ee9d57
parent7cbdabb5d688f9d616d6e609a12642a3a91e1888
qapi: Fix mangled "Returns" sections in documentation

Commit e050e426782e (qapi: Use explicit bulleted lists) added list
markup to correct bad rendering:

    A JSON block comment like this:
         Returns: nothing on success
                  If @node is not a valid block device, DeviceNotFound
                  If @name is not found, GenericError with an explanation

    renders like this:

         Returns: nothing on success If node is not a valid block device,
         DeviceNotFound If name is not found, GenericError with an explanation

    because whitespace is not significant.

    Use an actual bulleted list, so that the formatting is correct.

It missed a few instances.  Commit a937b6aa739 (qapi: Reformat doc
comments to conform to current conventions) then reflowed them.

Revert the reflowing, and add list markup.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240120095327.666239-6-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
qapi/net.json
qapi/qdev.json
qapi/qom.json