From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists1p.gnu.org (lists1p.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id CE5EBC982FA for ; Tue, 22 Sep 2026 15:22:37 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists1p.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1x92Jk-0002gK-Ta; Tue, 22 Sep 2026 11:22:00 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists1p.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1x92Jk-0002fw-0w for qemu-devel@nongnu.org; Tue, 22 Sep 2026 11:22:00 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1x92Jh-00023p-I3 for qemu-devel@nongnu.org; Tue, 22 Sep 2026 11:21:59 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1790090516; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=VIYHZArNfFwX+T5MM5k6jYfnlC7ChnSFULrG05SpifI=; b=Wyh3AoYtLBK41ho5PwhhNTDQAlrgEZA8rZTlstZuy2v3NT8Dt4Jh9zrkWtVr7I9D1m0tQn auYf9FyLFuvl01s/MqZVCBrHI8PaIwXKFH4sKQXc30nTc3j0O+5ThIbA1sflwNjzwDGYaR u59g2y7FfRGIywJaDFEFDOYmOSpsxlU= Received: from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-142-UbKa-tZVMUOnDEB_TNI-sw-1; Tue, 22 Sep 2026 11:21:52 -0400 X-MC-Unique: UbKa-tZVMUOnDEB_TNI-sw-1 X-Mimecast-MFC-AGG-ID: UbKa-tZVMUOnDEB_TNI-sw_1790090511 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id DA31D18007FD; Tue, 22 Sep 2026 15:21:50 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.44.22.5]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 77CEE180056E; Tue, 22 Sep 2026 15:21:49 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 24CDC21E6A04; Tue, 22 Sep 2026 17:21:47 +0200 (CEST) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Michael Roth , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Kashyap Chamarthy , Kevin Wolf , Michael Tokarev , Hanna Reitz , Stefano Garzarella , Jason Wang , Zhao Liu , Kostiantyn Kostiuk , Philippe =?utf-8?Q?Mathieu-Da?= =?utf-8?Q?ud=C3=A9?= , qemu-block@nongnu.org, qemu-trivial@nongnu.org, Laurent Vivier , Eric Blake , "Michael S. Tsirkin" , Pierrick Bouvier Subject: Re: [PATCH 6/9] qapi: split intros for qga/qapi-schema.json In-Reply-To: <20260921205147.1857168-7-jsnow@redhat.com> (John Snow's message of "Mon, 21 Sep 2026 16:51:44 -0400") References: <20260921205147.1857168-1-jsnow@redhat.com> <20260921205147.1857168-7-jsnow@redhat.com> Date: Tue, 22 Sep 2026 17:21:47 +0200 Message-ID: <87mrt92tx0.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 Received-SPF: pass client-ip=170.10.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: qemu development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org John Snow writes: > These intro section conversions all create a new insertion point that > follow the introduction, but precede what now constitutes the details > text. Like other intro section conversions, the details text will be > moved en-masse in a later patch. > > Signed-off-by: John Snow > --- > qga/qapi-schema.json | 61 +++++++++++++++++++------------------------- > 1 file changed, 26 insertions(+), 35 deletions(-) > > diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json > index 19b0958b84e..05fe4ea484d 100644 > --- a/qga/qapi-schema.json > +++ b/qga/qapi-schema.json > @@ -48,9 +48,8 @@ > > ## > # @guest-sync-delimited: > -# > -# Echo back a unique integer value, and prepend to response a leading > -# sentinel byte (0xFF) the client can check scan for. > +# Echo back a unique integer value, and prepend to response a > +# leading sentinel byte (0xFF) the client can check scan for. > # > # This is used by clients talking to the guest agent over the wire to > # ensure the stream is in sync and doesn't contain stale data from > @@ -83,8 +82,7 @@ > > ## > # @guest-sync: > -# > -# Echo back a unique integer value > +# Echo back a unique integer value > # > # This is used by clients talking to the guest agent over the wire to > # ensure the stream is in sync and doesn't contain stale data from > @@ -140,8 +138,7 @@ > > ## > # @guest-set-time: > -# > -# Set guest time. > +# Set guest time. > # > # When a guest is paused or migrated to a file then loaded from that > # file, the guest OS has no idea that there was a big gap in the time. > @@ -415,14 +412,14 @@ > > ## > # @guest-fsfreeze-freeze: > +# Sync and freeze all freezable, local guest filesystems. If this > +# command succeeded, you may call `guest-fsfreeze-thaw` later to > +# unfreeze. > # > -# Sync and freeze all freezable, local guest filesystems. If this > -# command succeeded, you may call `guest-fsfreeze-thaw` later to > -# unfreeze. > -# > -# On error, all filesystems will be thawed. If no filesystems are > -# frozen as a result of this call, then `guest-fsfreeze-status` will > -# remain "thawed" and calling `guest-fsfreeze-thaw` is not necessary. > +# On error, all filesystems will be thawed. If no filesystems are > +# frozen as a result of this call, then `guest-fsfreeze-status` > +# will remain "thawed" and calling `guest-fsfreeze-thaw` is not > +# necessary. More of what I noted in earlier series: 3. Review and improve doc comments where the intro talks about failure modes. Moving on. > # > # Returns: Number of file systems currently frozen. > # > @@ -438,11 +435,10 @@ > > ## > # @guest-fsfreeze-freeze-list: > +# Sync and freeze specified guest filesystems. See also > +# `guest-fsfreeze-freeze`. > # > -# Sync and freeze specified guest filesystems. See also > -# `guest-fsfreeze-freeze`. > -# > -# On error, all filesystems will be thawed. > +# On error, all filesystems will be thawed. Likewise. > # > # @mountpoints: an array of mountpoints of filesystems to be frozen. > # If omitted, every mounted filesystem is frozen. Invalid mount > @@ -528,8 +524,7 @@ > > ## > # @guest-suspend-disk: > -# > -# Suspend guest to disk. > +# Suspend guest to disk. > # > # This command attempts to suspend the guest using three strategies, > # in this order: > @@ -558,8 +553,7 @@ > > ## > # @guest-suspend-ram: > -# > -# Suspend guest to ram. > +# Suspend guest to ram. > # > # This command attempts to suspend the guest using three strategies, > # in this order: > @@ -595,8 +589,7 @@ > > ## > # @guest-suspend-hybrid: > -# > -# Save guest state to disk and suspend to ram. > +# Save guest state to disk and suspend to ram. > # > # This command attempts to suspend the guest by executing, in this > # order: > @@ -746,10 +739,9 @@ > > ## > # @guest-get-vcpus: > +# Retrieve the list of the guest's logical processors. > # > -# Retrieve the list of the guest's logical processors. > -# > -# This is a read-only operation. > +# This is a read-only operation. If a command is called "get something", it's certainly not supposed to change something! Not this patch's problem, moving on... > # > # Returns: The list of all VCPUs the guest knows about. Each VCPU is > # put on the list exactly once, but their order is unspecified. > @@ -1106,10 +1098,9 @@ > > ## > # @guest-get-memory-blocks: > +# Retrieve the list of the guest's memory blocks. > # > -# Retrieve the list of the guest's memory blocks. > -# > -# This is a read-only operation. > +# This is a read-only operation. Likewise. > # > # 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 > @@ -1346,12 +1337,12 @@ > > ## > # @guest-get-host-name: > +# Return a name for the machine. > # > -# Return a name for the machine. > -# > -# The returned name is not necessarily a fully-qualified domain name, > -# or even present in DNS or some other name service at all. It need > -# not even be unique on your local network or site, but usually it is. > +# The returned name is not necessarily a fully-qualified domain > +# name, or even present in DNS or some other name service at all. > +# It need not even be unique on your local network or site, but > +# usually it is. This should perhaps be worked into Returns: ... Not this patch's problem, moving on... > # > # Returns: the host name of the machine > #