From nobody Tue Nov 26 09:41:41 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1709534086; cv=none; d=zohomail.com; s=zohoarc; b=b3y1wDknyeY5S63QAmRFKCMSp4FZfycA8bo0un54jxRSZ9eR0NEAPH10EMT3U0UTVDR73uOCq7q/AcwzS1gPsZrhstxQBtjig/oxMJiYWXP9Bvdivklj94gxCkfNO1bRt16wGHRGr3Fn16w25amBCMbdN47hK0Iuse+F+8KWbL4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1709534086; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=brIXQLgcIaTCqH8Gr/w1n9NP7xEZZJ2uDmD+ytlTOcU=; b=DsOeVkzLr04gfKH9k325yscC/gPinKOuok4+MflZl5LdHkuEAXHPXdJ8T3Z4w2JlgSebKoJRAVcEhJ7Gh3UbdsBD5eMHT54Xzv2twWzYsU9raRbdkQvMBmluCnJw9br+pcqWGVpLP9qg6Q/6Kb3tcf2npxrR2LiMtKMqaK78hos= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1709534086535304.12092577596707; Sun, 3 Mar 2024 22:34:46 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rh1t7-0005ij-Ns; Mon, 04 Mar 2024 01:33:25 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rh1sZ-0005YW-V5 for qemu-devel@nongnu.org; Mon, 04 Mar 2024 01:32:53 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rh1sT-0000AE-DM for qemu-devel@nongnu.org; Mon, 04 Mar 2024 01:32:51 -0500 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-117-k0Evv4_fO_aHIGgfmAVGqA-1; Mon, 04 Mar 2024 01:32:39 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id 339A81064F80; Mon, 4 Mar 2024 06:32:39 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.3]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 0F6AE1C06532; Mon, 4 Mar 2024 06:32:39 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 81AD621E68B2; Mon, 4 Mar 2024 07:32:36 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1709533963; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=brIXQLgcIaTCqH8Gr/w1n9NP7xEZZJ2uDmD+ytlTOcU=; b=RYc91HUoE3t8Hh0i71+sXqMSv84ilX9OncYfiUf9i+wbmFdTtj5fcjqd0BPQtEuCa/avhn CDXVIzOwRromqnhTEn4LhRop5TRRVSdNxhjLGXepx+X6drkMssK9p1WB6RgaNrt3XFfxM7 iNaRxxy3lkCNH1Z2iYJCirGQs4QMhuI= X-MC-Unique: k0Evv4_fO_aHIGgfmAVGqA-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: peter.maydell@linaro.org Subject: [PULL 08/18] qga/qapi-schema: Move error documentation to new "Errors" sections Date: Mon, 4 Mar 2024 07:32:26 +0100 Message-ID: <20240304063236.213955-9-armbru@redhat.com> In-Reply-To: <20240304063236.213955-1-armbru@redhat.com> References: <20240304063236.213955-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.7 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -26 X-Spam_score: -2.7 X-Spam_bar: -- X-Spam_report: (-2.7 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.589, 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_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1709534087642100003 Content-Type: text/plain; charset="utf-8" Signed-off-by: Markus Armbruster Message-ID: <20240227113921.236097-9-armbru@redhat.com> --- qga/qapi-schema.json | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index b8efe31897..c5f2ac8f59 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -561,9 +561,8 @@ # could also exit (or set its status to "shutdown") due to other # reasons. # -# The following errors may be returned: -# -# - If suspend to disk is not supported, Unsupported +# Errors: +# - If suspend to disk is not supported, Unsupported # # Notes: It's strongly recommended to issue the guest-sync command # before sending commands when the guest resumes @@ -598,9 +597,8 @@ # 2. Issue the query-status QMP command to confirm the VM status is # "suspended" # -# The following errors may be returned: -# -# - If suspend to ram is not supported, Unsupported +# Errors: +# - If suspend to ram is not supported, Unsupported # # Notes: It's strongly recommended to issue the guest-sync command # before sending commands when the guest resumes @@ -634,9 +632,8 @@ # 2. Issue the query-status QMP command to confirm the VM status is # "suspended" # -# The following errors may be returned: -# -# - If hybrid suspend is not supported, Unsupported +# Errors: +# - If hybrid suspend is not supported, Unsupported # # Notes: It's strongly recommended to issue the guest-sync command # before sending commands when the guest resumes @@ -796,9 +793,6 @@ # - 0: # if the @vcpus list was empty on input. Guest state has not # been changed. Otherwise, -# - Error: -# processing the first node of @vcpus failed for the reason -# returned. Guest state has not been changed. Otherwise, # - < length(@vcpus): # more than zero initial nodes have been processed, but not the # entire @vcpus list. Guest state has changed accordingly. To @@ -808,6 +802,10 @@ # - length(@vcpus): # call successful. # +# Errors: +# - If the reconfiguration of the first node in @vcpus failed. +# Guest state has not been changed. +# # Since: 1.5 ## { 'command': 'guest-set-vcpus', --=20 2.44.0