mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

qapi: Fix mangled "Returns" sections in documentation

Browse Source 
Commit e050e42678 (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 a937b6aa73 (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>
This commit is contained in:
Markus Armbruster 2024-01-20 10:53:25 +01:00
parent 7cbdabb5d6
commit ae7ccd50c3
3 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
qapi/net.json
View File

@ -18,8 +18,9 @@
# #
# @up: true to set the link status to be up # @up: true to set the link status to be up
# #
# Returns: Nothing on success If @name is not a valid network device, # Returns:
# DeviceNotFound # - Nothing on success
# - If @name is not a valid network device, DeviceNotFound
# #
# Since: 0.14 # Since: 0.14
# #
@ -44,8 +45,9 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Returns: Nothing on success If @type is not a valid network backend, # Returns:
# DeviceNotFound # - Nothing on success
# - If @type is not a valid network backend, DeviceNotFound
# #
# Example: # Example:
# #
@ -64,8 +66,9 @@
# #
# @id: the name of the network backend to remove # @id: the name of the network backend to remove
# #
# Returns: Nothing on success If @id is not a valid network backend, # Returns:
# DeviceNotFound # - Nothing on success
# - If @id is not a valid network backend, DeviceNotFound
# #
# Since: 0.14 # Since: 0.14
# #

5
qapi/qdev.json
View File

@ -89,8 +89,9 @@
# #
# @id: the device's ID or QOM path # @id: the device's ID or QOM path
# #
# Returns: Nothing on success If @id is not a valid device, # Returns:
# DeviceNotFound # - Nothing on success
# - If @id is not a valid device, DeviceNotFound
# #
# Notes: When this command completes, the device may not be removed # Notes: When this command completes, the device may not be removed
# from the guest. Hot removal is an operation that requires guest # from the guest. Hot removal is an operation that requires guest

10
qapi/qom.json
View File

@ -1056,8 +1056,9 @@
# #
# Create a QOM object. # Create a QOM object.
# #
# Returns: Nothing on success Error if @qom-type is not a valid class # Returns:
# name # - Nothing on success
# - Error if @qom-type is not a valid class name
# #
# Since: 2.0 # Since: 2.0
# #
@ -1078,8 +1079,9 @@
# #
# @id: the name of the QOM object to remove # @id: the name of the QOM object to remove
# #
# Returns: Nothing on success Error if @id is not a valid id for a QOM # Returns:
# object # - Nothing on success
# - Error if @id is not a valid id for a QOM object
# #
# Since: 2.0 # Since: 2.0
# #