From nobody Sun Nov 24 17:52:00 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=1720697088; cv=none; d=zohomail.com; s=zohoarc; b=hm62qQBZCgEW3Netqn4rIjAHCL4k7jiuvOeDDXooc67eBEE3qvg3jMJrwFfTsijLVt8fLD83q+PBMqFMWhW3qYbMeBaCBcfSK/IKLw3JZTBsezjAJCPyN40u2i8XpqS1BN12apenbz3JSx0OQsGZSj+/D6ZoMTTFbEK5FMx9YPM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1720697088; 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=viR0ny/v2bN0I/B3BRJxlIFosN9ydnJSUgBurjxml5M=; b=LA3My4sgydJ6UCt1owu5cmU01XJGwyK3BdZdUaoGau0dNIoEBjQz5ocC35DLsCvIvwqTGXngXhyrXyRXmCQ9Wgl0juzCTKHmIRAI42BPK/9UnOHWZFtbwady+ODfzB/QT/EdUXjL/Ddjhsq0Di5ez/5k9TaKZJ+zfUOyeHuJxDU= 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 172069708886566.72745836095328; Thu, 11 Jul 2024 04:24:48 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sRrsy-00020R-EF; Thu, 11 Jul 2024 07:22:52 -0400 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 1sRrsw-0001xO-Jx for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:22:50 -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 1sRrsk-0000Hl-Nx for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:22:50 -0400 Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-648-Bm4MCkjfMniaZp_8NmHIRg-1; Thu, 11 Jul 2024 07:22:32 -0400 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (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-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 574231956048; Thu, 11 Jul 2024 11:22:31 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.4]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 9E3E21955E85; Thu, 11 Jul 2024 11:22:30 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id BD2F621E6697; Thu, 11 Jul 2024 13:22:28 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1720696956; 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=viR0ny/v2bN0I/B3BRJxlIFosN9ydnJSUgBurjxml5M=; b=VIBj34LNF5HMKJHrJkg0aIoYqOtlfRAOGd9DCQZoHn8+dz8tnIy0O3/KNJGd4RPzZ/YJLy v3cxGTEp555PIowcQy3iPGmHDz+X1CliMxiA/G+NAYH8XqADeFD6rWbDgfxWL4oygRb+wS 6evXD9FU4lvlp5rhqjrwYLJKdRtZFuY= X-MC-Unique: Bm4MCkjfMniaZp_8NmHIRg-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eduardo@habkost.net, marcel.apfelbaum@gmail.com, philmd@linaro.org, wangyanan55@huawei.com, eblake@redhat.com, mst@redhat.com, berrange@redhat.com, marcandre.lureau@redhat.com, jsnow@redhat.com, imammedo@redhat.com Subject: [PATCH 1/5] qapi/pci: Clean up documentation around PciDeviceClass Date: Thu, 11 Jul 2024 13:22:24 +0200 Message-ID: <20240711112228.2140606-2-armbru@redhat.com> In-Reply-To: <20240711112228.2140606-1-armbru@redhat.com> References: <20240711112228.2140606-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 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.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.142, 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 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: 1720697090142116600 Content-Type: text/plain; charset="utf-8" PciDeviceInfo's doc comment has a note on PciDeviceClass member @desc. Since the note applies always, not just within PciDeviceInfo, merge it into PciDeviceClass's description of member @desc. Signed-off-by: Markus Armbruster Reviewed-by: John Snow Reviewed-by: Michael S. Tsirkin --- qapi/pci.json | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/qapi/pci.json b/qapi/pci.json index 8287d15dd0..97179920fb 100644 --- a/qapi/pci.json +++ b/qapi/pci.json @@ -93,7 +93,8 @@ # # Information about the Class of a PCI device # -# @desc: a string description of the device's class +# @desc: a string description of the device's class (not stable, and +# should only be treated as informational) # # @class: the class code of the device # @@ -146,9 +147,6 @@ # # @regions: a list of the PCI I/O regions associated with the device # -# .. note:: The contents of @class_info.desc are not stable and should -# only be treated as informational. -# # Since: 0.14 ## { 'struct': 'PciDeviceInfo', --=20 2.45.0 From nobody Sun Nov 24 17:52:00 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=1720697080; cv=none; d=zohomail.com; s=zohoarc; b=faB0NvueZGZ06MAGF0cvpwljG44qsMKTn4ESuO5d7YZ9wgdoR6hTjc/5UHHsbby2HiTlOOgc1ewSUDSostMOSrGyNGDzV9M/0ahpXORZEkdXKBRILQVOr6vRKDEinkV2ZxuDsOVR7GymUbCLV3LqdvyRgRLzk9C9nd1BL9DY01w= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1720697080; 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=YU7xs11XhRlHNIpzICKn4uyHn0I3g/6fy33p2Sv/Cqg=; b=U8ZzWeZHHEtrMm7IiJJcsG9No4Bg9fxvB7RqfbxPAS2fYO/IOEnCyefQ9L7v2JhshddffXkdxhM/NTkIxgFAhJG/q1ezx+3QQW03nsnhzD6Z6S9Ntzt35ZUuvTlTJldIYOmpxTmMP/Jsr4trmvjOeOJsS4R/4UwvrPRcbOc6SNc= 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 1720697080079170.17742532088482; Thu, 11 Jul 2024 04:24:40 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sRrt1-0002B1-83; Thu, 11 Jul 2024 07:22:55 -0400 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 1sRrsz-00023M-6R for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:22:53 -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 1sRrsk-0000Ho-7w for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:22:52 -0400 Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-20-mz5mCdS1OFCBes5FPBLitA-1; Thu, 11 Jul 2024 07:22:32 -0400 Received: from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4]) (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-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 5AC621955F65; Thu, 11 Jul 2024 11:22:31 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.4]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 9D25E3000184; Thu, 11 Jul 2024 11:22:30 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id C07F521E6601; Thu, 11 Jul 2024 13:22:28 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1720696956; 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=YU7xs11XhRlHNIpzICKn4uyHn0I3g/6fy33p2Sv/Cqg=; b=IMQ+KtQods7TVkz8GLMmgoZKc/uEB3r2/6Z8EKv2GaWsgor262umfkpfXZpVKYxg18dcdj 0cMqeSIRo3e6LYPwjbe/yr2v5VSW8a+zC8ugR3X7R/NvtNAXTliQOQBCg0Ltfo6O6zsunI 4fo1O1Kz/5cqgefBq5n3FDpiZ/6stBQ= X-MC-Unique: mz5mCdS1OFCBes5FPBLitA-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eduardo@habkost.net, marcel.apfelbaum@gmail.com, philmd@linaro.org, wangyanan55@huawei.com, eblake@redhat.com, mst@redhat.com, berrange@redhat.com, marcandre.lureau@redhat.com, jsnow@redhat.com, imammedo@redhat.com Subject: [PATCH 2/5] qapi/machine: Clean up documentation around CpuInstanceProperties Date: Thu, 11 Jul 2024 13:22:25 +0200 Message-ID: <20240711112228.2140606-3-armbru@redhat.com> In-Reply-To: <20240711112228.2140606-1-armbru@redhat.com> References: <20240711112228.2140606-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 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.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.142, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 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: 1720697082400116600 Content-Type: text/plain; charset="utf-8" CpuInstanceProperties' doc comment describes its members as properties to be passed to device_add when hot-plugging a CPU. This was in fact the initial use of this type, with query-hotpluggable-cpus: letting management applications find out what properties need to be passed with device_add to hot-plug a CPU. We've since added other uses: set-numa-node (commit 419fcdec3c1 and f3be67812c2), and query-cpus-fast (commit ce74ee3dea6). These are not about device-add. query-hotpluggable-cpus uses CpuInstanceProperties within HotpluggableCPU. Lift the documentation related to device-add from CpuInstanceProperties to HotpluggableCPU. Signed-off-by: Markus Armbruster Reviewed-by: John Snow Reviewed-by: Michael S. Tsirkin --- qapi/machine.json | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/qapi/machine.json b/qapi/machine.json index f15ad1b43e..50ff102d56 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -960,9 +960,7 @@ ## # @CpuInstanceProperties: # -# List of properties to be used for hotplugging a CPU instance, it -# should be passed by management with device_add command when a CPU is -# being hotplugged. +# Properties identifying a CPU. # # Which members are optional and which mandatory depends on the # architecture and board. @@ -996,9 +994,6 @@ # # @thread-id: thread number within the core the CPU belongs to # -# .. note:: Management should be prepared to pass through additional -# properties with device_add. -# # Since: 2.7 ## { 'struct': 'CpuInstanceProperties', @@ -1020,7 +1015,8 @@ # # @type: CPU object type for usage with device_add command # -# @props: list of properties to be used for hotplugging CPU +# @props: list of properties to pass for hotplugging a CPU with +# device_add # # @vcpus-count: number of logical VCPU threads @HotpluggableCPU # provides @@ -1028,6 +1024,9 @@ # @qom-path: link to existing CPU object if CPU is present or omitted # if CPU is not present. # +# .. note:: Management should be prepared to pass through additional +# properties with device_add. +# # Since: 2.7 ## { 'struct': 'HotpluggableCPU', --=20 2.45.0 From nobody Sun Nov 24 17:52:00 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=1720697020; cv=none; d=zohomail.com; s=zohoarc; b=Rhm4ZK9xhQsDLhH5Y34HR0xOFMgKMNuGyfmH++fv74AmexP3Hweig8OiLa3P+XGLfMGfIO/+ZUE/I7l05aVCj1NxDNGVz2mZxJwlVfkrYKFJ6YDHsmIoUbgSW8EYPvtvVZid5ar6kNmZGIqJjYVbyKbbbwbxt3kpoNzN2DAbMnY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1720697020; 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=t8pcV9f7oeZ3RzXKwBLGepvy1GNEY0pOyAShA1+demo=; b=SJnfsnulOEyIgccDBprgF83xb7MSmNvZZd6fXSxGrVYosfx/T50q8ZrrRzoA/4YpG+FUOrrLATmoNfNYiiF9pd3X3TE5IDceiyHkkUpbGmHSPPzZ98uapK6a7BMKyjOcHGA2RSBaZ7wyBalU+yZrVDXpGhV0l7++7SkHIZLZB44= 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 1720697020752619.1576396177882; Thu, 11 Jul 2024 04:23:40 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sRrtD-0002od-Sz; Thu, 11 Jul 2024 07:23:08 -0400 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 1sRrtA-0002hX-Gb for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:23:04 -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 1sRrsk-0000I0-Uf for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:23:04 -0400 Received: from mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-606-3TvJNfCOMGW5m52mH08SXg-1; Thu, 11 Jul 2024 07:22:32 -0400 Received: from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.17]) (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-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 3FFE61910403; Thu, 11 Jul 2024 11:22:31 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.4]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A5D241955F40; Thu, 11 Jul 2024 11:22:30 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id C375A21E6605; Thu, 11 Jul 2024 13:22:28 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1720696957; 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=t8pcV9f7oeZ3RzXKwBLGepvy1GNEY0pOyAShA1+demo=; b=Ldq957BK2AkqiqsQ83UI2L5+6qxux+jytU46n33AROGSfy28JdR9zuuaovoyxltxjxOxJ8 8RV60+IYxLnzrdF2Elv/Dv6/qnvu3DT6RhV2KgvpgAoD/nRcr1sCMUGC3GibmGIAS1KK90 wi1IUypZ8YaJxaUqUip5r9mdy8z7uBQ= X-MC-Unique: 3TvJNfCOMGW5m52mH08SXg-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eduardo@habkost.net, marcel.apfelbaum@gmail.com, philmd@linaro.org, wangyanan55@huawei.com, eblake@redhat.com, mst@redhat.com, berrange@redhat.com, marcandre.lureau@redhat.com, jsnow@redhat.com, imammedo@redhat.com Subject: [PATCH 3/5] qapi/machine: Clarify query-uuid value when none has been specified Date: Thu, 11 Jul 2024 13:22:26 +0200 Message-ID: <20240711112228.2140606-4-armbru@redhat.com> In-Reply-To: <20240711112228.2140606-1-armbru@redhat.com> References: <20240711112228.2140606-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 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.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.142, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 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: 1720697022009116600 Content-Type: text/plain; charset="utf-8" When no UUID has been specified, query-uuid returns {"UUID": "00000000-0000-0000-0000-000000000000"} The doc comment calls this "a null UUID", which I find less than clear. Change it to "an all-zero UUID". Signed-off-by: Markus Armbruster Reviewed-by: John Snow Reviewed-by: Michael S. Tsirkin Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- qapi/machine.json | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/qapi/machine.json b/qapi/machine.json index 50ff102d56..f40427f21a 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -305,9 +305,8 @@ # # Since: 0.14 # -# .. note:: If no UUID was specified for the guest, a null UUID is -# returned. -# +# .. note:: If no UUID was specified for the guest, an all-zero UUID +# is returned. ## { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} } =20 --=20 2.45.0 From nobody Sun Nov 24 17:52:00 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=1720697020; cv=none; d=zohomail.com; s=zohoarc; b=cLQ9dBbXEThbRJpVoYMT6zmY9Zdh79fdb+mQDdJrAllKwFejjGw8HBPge3LFNK/TaE8BcSva6mW+KFV2fpJVlgFfmRMH8M6FPqbopRCXq/EE+sY5nqQ4k5xDnPWGpVABMdACmtAYqIco+oUIZ7c2uInaMpuarJg9cB1ApLfBsBg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1720697020; 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=tlY8XxdvjNE4b+PNvPu3Q90WCm87FDJnbmvPnGSRdCI=; b=M3Y3zYKt1m1wEwDjs9CSok1WxHgFeZJWlQP3fL7bAEDeBlGkljYmhaCM2mBSpqeP1r4+m688GDkYtl9t7qvjddKpB76FyowM+GhH7e1c6Z2piJWEL7X9fnBTXJFjbbSHT4/Jxv+t3+k61zdHTEUHbtmsv3Bd1RTIy2IrTplUZHg= 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 1720697020972963.1015761804526; Thu, 11 Jul 2024 04:23:40 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sRrsx-0001y4-ND; Thu, 11 Jul 2024 07:22:51 -0400 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 1sRrsw-0001x1-9g for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:22:50 -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 1sRrsk-0000Hk-9K for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:22:49 -0400 Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-662-i2YffhhyPZKwDwzjGLMh_A-1; Thu, 11 Jul 2024 07:22:33 -0400 Received: from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.40]) (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-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 27F16195420F; Thu, 11 Jul 2024 11:22:32 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.4]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A3EFD19560AA; Thu, 11 Jul 2024 11:22:30 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id C670421E65D1; Thu, 11 Jul 2024 13:22:28 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1720696955; 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=tlY8XxdvjNE4b+PNvPu3Q90WCm87FDJnbmvPnGSRdCI=; b=ars8oq9Os4mYtFYxppDCMvr94NW47JdvkR1Jf3thn7G3PBuPmk0kVQ6J3uFbi++w3d4Erg do+M+1se61V19qBWSAdHs0jy7GVEqGVAnq43egPyhdcXWwVYr0b0q5vt6N2I+bmkV4ps3x ePPjWSAPw+mVbVodfypuDPhOs26W9fA= X-MC-Unique: i2YffhhyPZKwDwzjGLMh_A-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eduardo@habkost.net, marcel.apfelbaum@gmail.com, philmd@linaro.org, wangyanan55@huawei.com, eblake@redhat.com, mst@redhat.com, berrange@redhat.com, marcandre.lureau@redhat.com, jsnow@redhat.com, imammedo@redhat.com Subject: [PATCH 4/5] qapi/sockets: Move deprecation note out of SocketAddress doc comment Date: Thu, 11 Jul 2024 13:22:27 +0200 Message-ID: <20240711112228.2140606-5-armbru@redhat.com> In-Reply-To: <20240711112228.2140606-1-armbru@redhat.com> References: <20240711112228.2140606-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 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.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.142, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 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: 1720697022010116600 Content-Type: text/plain; charset="utf-8" Doc comments are reference documentation for users of QMP. SocketAddress's doc comment contains a deprecation note advising developers to use SocketAddress for new code. Irrelevant for users of QMP. Move the note out of the doc comment. Signed-off-by: Markus Armbruster Reviewed-by: John Snow Reviewed-by: Michael S. Tsirkin Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- qapi/sockets.json | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/qapi/sockets.json b/qapi/sockets.json index 4d78d2ccb7..e76fdb9925 100644 --- a/qapi/sockets.json +++ b/qapi/sockets.json @@ -179,10 +179,6 @@ # # @type: Transport type # -# .. note:: This type is deprecated in favor of SocketAddress. The -# difference between SocketAddressLegacy and SocketAddress is that -# the latter has fewer ``{}`` on the wire. -# # Since: 1.3 ## { 'union': 'SocketAddressLegacy', @@ -193,6 +189,9 @@ 'unix': 'UnixSocketAddressWrapper', 'vsock': 'VsockSocketAddressWrapper', 'fd': 'FdSocketAddressWrapper' } } +# Note: This type is deprecated in favor of SocketAddress. The +# difference between SocketAddressLegacy and SocketAddress is that the +# latter has fewer ``{}`` on the wire. =20 ## # @SocketAddressType: --=20 2.45.0 From nobody Sun Nov 24 17:52:00 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=1720697021; cv=none; d=zohomail.com; s=zohoarc; b=aMNurPW5DPNcXPdAQB08i7hBOZLcIb2xIRCHSILeRkm8gGMbJZ8dlfuNiTDjdUnNH0gGf+rxpqeo8WQkZQ5Kua3bCQefCcyk5xEYNNRM2dnz/vJl8/L26I93UbfYJ+PxBIp0pgqKoZ9np8rvHrXBMIh2cRO0VCDEM6BqzljoyCU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1720697021; 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=Z51YT5BWwNXnxdLcMmrlcX+tVbWHhVGmjSqtoeX7tTQ=; b=Bl+kW6kthkDDqrPk4IsnfNTfFHEuRIfKOK+3tpJRJDTS/oShn23K3gc+u/IF64s90KvTztXny2FUa9xaSlxN67h8RItD1iBStBbbkJaDH0kbJRCQTLouYF5ZAqiZ/d1xlmec0Jpuw7q87NC5j22uvHjHvinI+J+6qq0t7j0oQJA= 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 1720697021736573.1489126918858; Thu, 11 Jul 2024 04:23:41 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sRrt9-0002cP-L9; Thu, 11 Jul 2024 07:23:03 -0400 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 1sRrt7-0002WU-8o for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:23:01 -0400 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 1sRrsl-0000I2-Qi for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:23:00 -0400 Received: from mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-393-IqeeGG6RMA-qlFvEre1CQg-1; Thu, 11 Jul 2024 07:22:34 -0400 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (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-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id ABD30193579C; Thu, 11 Jul 2024 11:22:33 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.4]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 358301955E85; Thu, 11 Jul 2024 11:22:33 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id C97E821E65D7; Thu, 11 Jul 2024 13:22:28 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1720696957; 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=Z51YT5BWwNXnxdLcMmrlcX+tVbWHhVGmjSqtoeX7tTQ=; b=MbVMrdRku6fGa7x8IPOmYInPUuDVu1p/PyXZOpS1MxB8XlIfLdHwR5Nw9p9KjibhK0QSQC ec6knSy2EXZ4lvkIY+UnxNpQquSNCin6hsYWGqH6TWkPC4rqcLGx8hYLFzQ8a6iToyodxL 2bqjsGqa8H7gguhUMQim4K+jJdO/v6s= X-MC-Unique: IqeeGG6RMA-qlFvEre1CQg-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eduardo@habkost.net, marcel.apfelbaum@gmail.com, philmd@linaro.org, wangyanan55@huawei.com, eblake@redhat.com, mst@redhat.com, berrange@redhat.com, marcandre.lureau@redhat.com, jsnow@redhat.com, imammedo@redhat.com Subject: [PATCH 5/5] qapi/ui: Drop note on naming of SpiceQueryMouseMode Date: Thu, 11 Jul 2024 13:22:28 +0200 Message-ID: <20240711112228.2140606-6-armbru@redhat.com> In-Reply-To: <20240711112228.2140606-1-armbru@redhat.com> References: <20240711112228.2140606-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 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: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.142, 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 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: 1720697022011116600 Content-Type: text/plain; charset="utf-8" Doc comments are reference documentation for users of QMP. SpiceQueryMouseMode's doc comment contains a note explaining why it's not named SpiceMouseMode: spice/enums.h has it already. Irrelevant for users of QMP; delete the note. Signed-off-by: Markus Armbruster Reviewed-by: John Snow Reviewed-by: Michael S. Tsirkin --- qapi/ui.json | 2 -- 1 file changed, 2 deletions(-) diff --git a/qapi/ui.json b/qapi/ui.json index 5bcccbfc93..df089869a5 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -273,8 +273,6 @@ # @unknown: No information is available about mouse mode used by the # spice server. # -# .. note:: spice/enums.h has a SpiceMouseMode already, hence the name. -# # Since: 1.1 ## { 'enum': 'SpiceQueryMouseMode', --=20 2.45.0