diff options
| author | Markus Armbruster <armbru@redhat.com> | 2025-07-17 13:52:43 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-07-28 13:44:44 +0200 |
| commit | bb743978f0aaf6aa7f7c796bae05bb9deb83b3f9 (patch) | |
| tree | ac079614598a8a3a1074f5ee0729ec227d6add6a | |
| parent | c017386f28c03a03b8f14444f8671d3d8f7180fe (diff) | |
| download | qemu-bb743978f0aaf6aa7f7c796bae05bb9deb83b3f9.zip qemu-bb743978f0aaf6aa7f7c796bae05bb9deb83b3f9.tar.gz qemu-bb743978f0aaf6aa7f7c796bae05bb9deb83b3f9.tar.bz2 | |
qga: Fix guest-network-get-route return value documentation
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>
| -rw-r--r-- | qga/qapi-schema.json | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index 6d770f7..a569a14 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -1966,6 +1966,7 @@ # @guest-network-get-route: # # Retrieve information about route of network. +# # Returns: List of route info of guest. # # Since: 9.1 |