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.

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

2025-05-22 Thread Pierrick Bouvier 
As requested by Markus:
> We prefer imperative mood "Return" over "Returns".

Signed-off-by: Pierrick Bouvier 
---
 qapi/audio.json | 2 +-
 qapi/char.json  | 4 ++--
 qapi/cryptodev.json | 2 +-
 qapi/machine.json   | 4 ++--
 qapi/migration.json | 8 
 qapi/misc-i386.json | 6 +++---
 qapi/ui.json| 8 
 7 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/qapi/audio.json b/qapi/audio.json
index dd5a58d13e6..826477c3072 100644
--- a/qapi/audio.json
+++ b/qapi/audio.json
@@ -533,7 +533,7 @@
 ##
 # @query-audiodevs:
 #
-# Returns information about audiodev configuration
+# Return information about audiodev configuration
 #
 # Returns: array of @Audiodev
 #
diff --git a/qapi/char.json b/qapi/char.json
index dde2f9538f8..447c10b91a5 100644
--- a/qapi/char.json
+++ b/qapi/char.json
@@ -34,7 +34,7 @@
 ##
 # @query-chardev:
 #
-# Returns information about current character devices.
+# Return information about current character devices.
 #
 # Returns: a list of @ChardevInfo
 #
@@ -80,7 +80,7 @@
 ##
 # @query-chardev-backends:
 #
-# Returns information about character device backends.
+# Return information about character device backends.
 #
 # Returns: a list of @ChardevBackendInfo
 #
diff --git a/qapi/cryptodev.json b/qapi/cryptodev.json
index 04d0e21d209..28b97eb3da6 100644
--- a/qapi/cryptodev.json
+++ b/qapi/cryptodev.json
@@ -94,7 +94,7 @@
 ##
 # @query-cryptodev:
 #
-# Returns information about current crypto devices.
+# Return information about current crypto devices.
 #
 # Returns: a list of @QCryptodevInfo
 #
diff --git a/qapi/machine.json b/qapi/machine.json
index e6b4b2dfef8..7f3af355b36 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -99,7 +99,7 @@
 ##
 # @query-cpus-fast:
 #
-# Returns information about all virtual CPUs.
+# Return information about all virtual CPUs.
 #
 # Returns: list of @CpuInfoFast
 #
@@ -467,7 +467,7 @@
 ##
 # @query-kvm:
 #
-# Returns information about KVM acceleration
+# Return information about KVM acceleration
 #
 # Returns: @KvmInfo
 #
diff --git a/qapi/migration.json b/qapi/migration.json
index 8b9c53595c4..1278450e09d 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -282,7 +282,7 @@
 ##
 # @query-migrate:
 #
-# Returns information about current migration process.  If migration
+# Return information about current migration process.  If migration
 # is active there will be another json-object with RAM migration
 # status.
 #
@@ -535,7 +535,7 @@
 ##
 # @query-migrate-capabilities:
 #
-# Returns information about the current migration capabilities status
+# Return information about the current migration capabilities status
 #
 # Returns: @MigrationCapabilityStatus
 #
@@ -1320,7 +1320,7 @@
 ##
 # @query-migrate-parameters:
 #
-# Returns information about the current migration parameters
+# Return information about the current migration parameters
 #
 # Returns: @MigrationParameters
 #
@@ -2294,7 +2294,7 @@
 ##
 # @query-vcpu-dirty-limit:
 #
-# Returns information about virtual CPU dirty page rate limits, if
+# Return information about virtual CPU dirty page rate limits, if
 # any.
 #
 # Since: 7.1
diff --git a/qapi/misc-i386.json b/qapi/misc-i386.json
index cbf85233eba..3fda7a20bdd 100644
--- a/qapi/misc-i386.json
+++ b/qapi/misc-i386.json
@@ -126,7 +126,7 @@
 ##
 # @query-sev:
 #
-# Returns information about SEV/SEV-ES/SEV-SNP.
+# Return information about SEV/SEV-ES/SEV-SNP.
 #
 # If unavailable due to an incompatible configuration the
 # returned @enabled field will be set to 'false' and the
@@ -336,7 +336,7 @@
 ##
 # @query-sgx:
 #
-# Returns information about configured SGX capabilities of guest
+# Return information about configured SGX capabilities of guest
 #
 # Returns: @SgxInfo
 #
@@ -355,7 +355,7 @@
 ##
 # @query-sgx-capabilities:
 #
-# Returns information about SGX capabilities of host
+# Return information about SGX capabilities of host
 #
 # Returns: @SgxInfo
 #
diff --git a/qapi/ui.json b/qapi/ui.json
index c536d4e5241..59897fcb9f0 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -323,7 +323,7 @@
 ##
 # @query-spice:
 #
-# Returns information about the current SPICE server
+# Return information about the current SPICE server
 #
 # Returns: @SpiceInfo
 #
@@ -654,7 +654,7 @@
 ##
 # @query-vnc:
 #
-# Returns information about the current VNC server
+# Return information about the current VNC server
 #
 # Returns: @VncInfo
 #
@@ -820,7 +820,7 @@
 ##
 # @query-mice:
 #
-# Returns information about each active mouse device
+# Return information about each active mouse device
 #
 # Returns: a list of @MouseInfo for each device
 #
@@ -1562,7 +1562,7 @@
 ##
 # @query-display-options:
 #
-# Returns information about display configuration
+# Return information about display configuration
 #
 # Returns: @DisplayOptions
 #
-- 
2.47.2