diff options
| author | Markus Armbruster <armbru@redhat.com> | 2025-07-08 09:28:27 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-07-14 10:13:30 +0200 |
| commit | c13ceeb42df5452690fc530269696f59da921b31 (patch) | |
| tree | 137b97ae5c31a02f8e8747aaa52c00c3497d8ab9 | |
| parent | 62c4dc4b69ef7dcfcc476913a9c5fc15329e0290 (diff) | |
| download | qemu-c13ceeb42df5452690fc530269696f59da921b31.zip qemu-c13ceeb42df5452690fc530269696f59da921b31.tar.gz qemu-c13ceeb42df5452690fc530269696f59da921b31.tar.bz2 | |
qapi: Clean up "This command will do ..." command descriptions
Use imperative mood "Do ..." instead.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20250708072828.105185-2-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
| -rw-r--r-- | qapi/control.json | 9 | ||||
| -rw-r--r-- | qapi/misc-i386.json | 11 | ||||
| -rw-r--r-- | qapi/qom.json | 10 |
3 files changed, 14 insertions, 16 deletions
diff --git a/qapi/control.json b/qapi/control.json index ab0b3a3..5fed070 100644 --- a/qapi/control.json +++ b/qapi/control.json @@ -160,10 +160,11 @@ ## # @quit: # -# This command will cause the QEMU process to exit gracefully. While -# every attempt is made to send the QMP response before terminating, -# this is not guaranteed. When using this interface, a premature EOF -# would not be unexpected. +# Request graceful QEMU process termination. +# +# While every attempt is made to send the QMP response before +# terminating, this is not guaranteed. When using this interface, a +# premature EOF would not be unexpected. # # Since: 0.14 # diff --git a/qapi/misc-i386.json b/qapi/misc-i386.json index 5fefa0a..b53ed39 100644 --- a/qapi/misc-i386.json +++ b/qapi/misc-i386.json @@ -6,9 +6,9 @@ ## # @rtc-reset-reinjection: # -# This command will reset the RTC interrupt reinjection backlog. Can -# be used if another mechanism to synchronize guest time is in effect, -# for example QEMU guest agent's guest-set-time command. +# Reset the RTC interrupt reinjection backlog. Can be used if another +# mechanism to synchronize guest time is in effect, for example QEMU +# guest agent's guest-set-time command. # # Use of this command is only applicable for x86 machines with an RTC, # and on other machines will silently return without performing any @@ -233,8 +233,7 @@ ## # @sev-inject-launch-secret: # -# This command injects a secret blob into memory of a SEV/SEV-ES -# guest. +# Inject a secret blob into a SEV/SEV-ES guest's memory. # # This is only valid on x86 machines configured with KVM and the # 'sev-guest' confidential virtualization object. SEV-SNP guests do @@ -272,7 +271,7 @@ ## # @query-sev-attestation-report: # -# This command is used to get the SEV attestation report. +# Get the SEV attestation report. # # This is only valid on x86 machines configured with KVM and the # 'sev-guest' confidential virtualization object. The attestation diff --git a/qapi/qom.json b/qapi/qom.json index f68f72f..6c38e86 100644 --- a/qapi/qom.json +++ b/qapi/qom.json @@ -50,8 +50,7 @@ ## # @qom-list: # -# This command will list any properties of a object given a path in -# the object model. +# List properties of a object given a path in the object model. # # @path: the path within the object model. See @qom-get for a # description of this parameter. @@ -78,8 +77,7 @@ ## # @qom-get: # -# This command will get a property from a object model path and return -# the value. +# Get a property value. # # @path: The path within the object model. There are two forms of # supported paths--absolute and partial paths. @@ -130,7 +128,7 @@ ## # @qom-set: # -# This command will set a property from a object model path. +# Set a property value. # # @path: see @qom-get for a description of this parameter # @@ -173,7 +171,7 @@ ## # @qom-list-types: # -# This command will return a list of types given search parameters +# Return a list of types given search parameters. # # @implements: if specified, only return types that implement this # type name |