Re: [PATCH v4 13/15] qapi: use imperative style in documentation

2025-05-27 Thread Pierrick Bouvier

On 5/27/25 4:12 AM, Markus Armbruster wrote:

Pierrick Bouvier  writes:


As requested by Markus:

We prefer imperative mood "Return" over "Returns".


Signed-off-by: Pierrick Bouvier 


There are a few more:

/home/armbru/work/qemu/qapi/block.json:86:# Returns a list of information about 
each persistent reservation
/home/armbru/work/qemu/qapi/control.json:94:# Returns the current version of 
QEMU.
/home/armbru/work/qemu/qapi/dump.json:198:# Returns the available formats for 
dump-guest-memory
/home/armbru/work/qemu/qapi/machine.json:933:# Returns information for all 
memory backends.
/home/armbru/work/qemu/qapi/machine.json:1238:# Returns the hv-balloon driver 
data contained in the last received
/home/armbru/work/qemu/qapi/migration.json:2330:# Returns information of 
migration threads
/home/armbru/work/qemu/qapi/misc.json:104:# Returns a list of information about 
each iothread.
/home/armbru/work/qemu/qapi/ui.json:688:# Returns a list of vnc servers.  The 
list can be empty.
/home/armbru/work/qemu/qapi/virtio.json:27:# Returns a list of all realized 
VirtIODevices

If you need to respin for some other reason, then it would be nice to
change these, too.



No idea how I could missed them, sorry.



Re: [PATCH v4 13/15] qapi: use imperative style in documentation

2025-05-27 Thread Markus Armbruster
Pierrick Bouvier  writes:

> As requested by Markus:
>> We prefer imperative mood "Return" over "Returns".
>
> Signed-off-by: Pierrick Bouvier 

There are a few more:

/home/armbru/work/qemu/qapi/block.json:86:# Returns a list of information about 
each persistent reservation
/home/armbru/work/qemu/qapi/control.json:94:# Returns the current version of 
QEMU.
/home/armbru/work/qemu/qapi/dump.json:198:# Returns the available formats for 
dump-guest-memory
/home/armbru/work/qemu/qapi/machine.json:933:# Returns information for all 
memory backends.
/home/armbru/work/qemu/qapi/machine.json:1238:# Returns the hv-balloon driver 
data contained in the last received
/home/armbru/work/qemu/qapi/migration.json:2330:# Returns information of 
migration threads
/home/armbru/work/qemu/qapi/misc.json:104:# Returns a list of information about 
each iothread.
/home/armbru/work/qemu/qapi/ui.json:688:# Returns a list of vnc servers.  The 
list can be empty.
/home/armbru/work/qemu/qapi/virtio.json:27:# Returns a list of all realized 
VirtIODevices

If you need to respin for some other reason, then it would be nice to
change these, too.