qemu-block
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 2/4] docs, qapi: generate undocumented return sections


From: John Snow
Subject: Re: [PATCH 2/4] docs, qapi: generate undocumented return sections
Date: Tue, 25 Mar 2025 14:13:35 -0400



On Tue, Mar 25, 2025 at 4:54 AM Markus Armbruster <armbru@redhat.com> wrote:
John Snow <jsnow@redhat.com> writes:

> This patch changes the qapidoc transmogrifier to generate Return value
> documentation for any command that has a return value but hasn't
> explicitly documented that return value.
>
> Signed-off-by: John Snow <jsnow@redhat.com>

A number of commands lack return value documentation before the patch.
These are:

QGA: guest-network-get-route

QMP: x-debug-query-block-graph, query-tpm, query-dirty-rate,
     query-vcpu-dirty-limit, query-vm-generation-id,
     query-memory-size-summary, query-memory-devices,
     query-acpi-ospm-status, query-stats-schemas, query-stats-schemas

This patch fixes that.  However, in my testing, it adds the missing
"Return:" doc *twice* for x-debug-query-block-graph and
query-dirty-rate.

Guess who forgot a "break" statement?

--js

reply via email to

[Prev in Thread] Current Thread [Next in Thread]