qga/qapi-schema: Drop "This is a read-only operation"

[PATCH] qga/qapi-schema: Drop "This is a read-only operation"

Posted by Markus Armbruster 3 days, 12 hours ago

Documentation of guest-get-vcpus and guest-get-memory-blocks has "This
is a read-only operation".  Similar commands don't.  A "get" command
that actually writes would be in surprisingly bad taste.  Delete both
instances of the sentence.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qga/qapi-schema.json | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 8cd0ba048b..040c932310 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -769,8 +769,6 @@
 #
 # Retrieve the list of the guest's logical processors.
 #
-# This is a read-only operation.
-#
 # Returns: The list of all VCPUs the guest knows about.  Each VCPU is
 #     put on the list exactly once, but their order is unspecified.
 #
@@ -1133,8 +1131,6 @@
 #
 # Retrieve the list of the guest's memory blocks.
 #
-# This is a read-only operation.
-#
 # Returns: The list of all memory blocks the guest knows about.  Each
 #     memory block is put on the list exactly once, but their order is
 #     unspecified.
-- 
2.55.0

Re: [PATCH] qga/qapi-schema: Drop "This is a read-only operation"

Posted by John Snow 3 days, 1 hour ago

On Wed, Sep 23, 2026 at 2:42 AM Markus Armbruster <armbru@redhat.com> wrote:
>
> Documentation of guest-get-vcpus and guest-get-memory-blocks has "This
> is a read-only operation".  Similar commands don't.  A "get" command
> that actually writes would be in surprisingly bad taste.  Delete both
> instances of the sentence.
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qga/qapi-schema.json | 4 ----
>  1 file changed, 4 deletions(-)
>
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index 8cd0ba048b..040c932310 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -769,8 +769,6 @@
>  #
>  # Retrieve the list of the guest's logical processors.
>  #
> -# This is a read-only operation.
> -#
>  # Returns: The list of all VCPUs the guest knows about.  Each VCPU is
>  #     put on the list exactly once, but their order is unspecified.
>  #
> @@ -1133,8 +1131,6 @@
>  #
>  # Retrieve the list of the guest's memory blocks.
>  #
> -# This is a read-only operation.
> -#
>  # Returns: The list of all memory blocks the guest knows about.  Each
>  #     memory block is put on the list exactly once, but their order is
>  #     unspecified.
> --
> 2.55.0
>

Sure, why not?

Reviewed-by: John Snow <jsnow@redhat.com>