Re: [PATCH 1/4] qga: Fix guest-network-get-route return value documentation

["Daniel P. Berrangé" <berrange@redhat.com>]

On Thu, Jul 17, 2025 at 10:21:14AM +0200, Markus Armbruster wrote:
> 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>
> ---
>  qga/qapi-schema.json | 1 +
>  1 file changed, 1 insertion(+)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


With regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|