]> git.ipfire.org Git - thirdparty/qemu.git/commitdiff
qga: Fix guest-network-get-route return value documentation
authorMarkus Armbruster <armbru@redhat.com>
Thu, 17 Jul 2025 11:52:43 +0000 (13:52 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 28 Jul 2025 11:44:44 +0000 (13:44 +0200)
Tagged sections are only recognized at the beginning of a paragraph.
guest-network-get-route's Returns: isn't, and therefore gets rendered
as ordinary text within its paragraph:

    Retrieve information about route of network. Returns: List of route
    info of guest.

Since there is no (recognized) Returns: section, the doc generator
adds

    Return:
       [GuestNetworkRoute]

Note: only since recent commit 636c96cd77d (qapi: Fix undocumented
return values by generating something).

Insert the required blank line so that Returns: is recognized.
Result:

    Retrieve information about route of network.

    Return:
       [GuestNetworkRoute] -- List of route info of guest.

Fixes: commit 8e326d36dd16 (qga/linux: Add new api 'guest-network-get-route')
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Message-ID: <20250717115246.3830007-2-armbru@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
qga/qapi-schema.json

index 6d770f7b8e0a563ae4c2db1adfe8d6c8d260cc02..a569a14b555612ff600a353260891e9a8b7a5251 100644 (file)
 # @guest-network-get-route:
 #
 # Retrieve information about route of network.
+#
 # Returns: List of route info of guest.
 #
 # Since: 9.1