From patchwork Wed Sep 11 11:25:38 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Markus Armbruster X-Patchwork-Id: 13800265 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 lists.gnu.org (lists.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 341E8EE4997 for ; Wed, 11 Sep 2024 11:27:14 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1soLU1-0005oz-N7; Wed, 11 Sep 2024 07:26:01 -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 1soLTy-0005bo-3w for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:25:58 -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 1soLTw-00012j-Ic for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:25:57 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1726053955; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=fs6bdi1/EIc6pBx4OI1+Xe9rX9HocIgI+f0VhexoxZI=; b=I01kBQH+sSZ1NFBGs3HuhJdfK0dzNrioKUhGgkm3Rsfk3gs9NgHMVuonZblQAA3YpBoIpZ HohLDpsbxdlOvFDylsMByDunS3/+hejn5Jjln1TyOuwNv7/XKsnKpiz4vezpeaj+AVd76/ DjTzr4lQmqDYXRwyc8gIEbjtzptXJrE= 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-597-38QjLM-PNHGYzRkosU_rBQ-1; Wed, 11 Sep 2024 07:25:50 -0400 X-MC-Unique: 38QjLM-PNHGYzRkosU_rBQ-1 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 D63C219560AB; Wed, 11 Sep 2024 11:25:48 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.112]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 83C2F1956086; Wed, 11 Sep 2024 11:25:47 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 1640C21E691E; Wed, 11 Sep 2024 13:25:45 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, arei.gonglei@huawei.com, pizhenwei@bytedance.com, jonathan.cameron@huawei.com, fan.ni@samsung.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com Subject: [PATCH v2 1/8] qapi/char: Supply missing member documentation Date: Wed, 11 Sep 2024 13:25:38 +0200 Message-ID: <20240911112545.2248881-2-armbru@redhat.com> In-Reply-To: <20240911112545.2248881-1-armbru@redhat.com> References: <20240911112545.2248881-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 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.144, 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, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Since we neglect to document several members of ChardevBackendKind, their description in the QEMU QMP Reference manual is "Not documented". Fix that, and improve the existing member documentation. Signed-off-by: Markus Armbruster --- qapi/char.json | 44 ++++++++++++++++++++++++++++---------------- qapi/pragma.json | 1 - 2 files changed, 28 insertions(+), 17 deletions(-) diff --git a/qapi/char.json b/qapi/char.json index ef58445cee..0d6de1ee35 100644 --- a/qapi/char.json +++ b/qapi/char.json @@ -434,37 +434,49 @@ ## # @ChardevBackendKind: # -# @pipe: Since 1.5 +# @file: regular files # -# @udp: Since 1.5 +# @serial: serial host device # -# @mux: Since 1.5 +# @parallel: parallel host device # -# @msmouse: Since 1.5 +# @pipe: pipes (since 1.5) # -# @wctablet: Since 2.9 +# @socket: stream socket # -# @braille: Since 1.5 +# @udp: datagram socket (since 1.5) # -# @testdev: Since 2.2 +# @pty: pseudo-terminal # -# @stdio: Since 1.5 +# @null: provides no input, throws away output # -# @console: Since 1.5 +# @mux: (since 1.5) # -# @spicevmc: Since 1.5 +# @msmouse: emulated Microsoft serial mouse (since 1.5) # -# @spiceport: Since 1.5 +# @wctablet: emulated Wacom Penpartner serial tablet (since 2.9) # -# @qemu-vdagent: Since 6.1 +# @braille: Baum Braille device (since 1.5) # -# @dbus: Since 7.0 +# @testdev: device for test-suite control (since 2.2) # -# @vc: v1.5 +# @stdio: standard I/O (since 1.5) # -# @ringbuf: Since 1.6 +# @console: Windows console (since 1.5) # -# @memory: Since 1.5 +# @spicevmc: spice vm channel (since 1.5) +# +# @spiceport: Spice port channel (since 1.5) +# +# @qemu-vdagent: Spice vdagent (since 6.1) +# +# @dbus: D-Bus channel (since 7.0) +# +# @vc: virtual console (since 1.5) +# +# @ringbuf: memory ring buffer (since 1.6) +# +# @memory: synonym for @ringbuf (since 1.5) # # Features: # diff --git a/qapi/pragma.json b/qapi/pragma.json index fad3a31628..d5ae397293 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -46,7 +46,6 @@ 'BlockdevSnapshotSyncWrapper', 'BlockdevSnapshotWrapper', 'BlockdevVmdkAdapterType', - 'ChardevBackendKind', 'CxlCorErrorType', 'DisplayProtocol', 'DriveBackupWrapper', From patchwork Wed Sep 11 11:25:39 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Markus Armbruster X-Patchwork-Id: 13800267 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 lists.gnu.org (lists.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 31E93EE4998 for ; Wed, 11 Sep 2024 11:27:29 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1soLTy-0005es-Vk; Wed, 11 Sep 2024 07:25:59 -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 1soLTw-0005aT-60 for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:25:56 -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 1soLTu-00012Q-Nt for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:25:55 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1726053954; 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=qeqf5AgbkNcW390+IsLJuKL3Hfk+l6HXOU9UltUvJxg=; b=X8B5jaOPjTK1hZhKld3WyUT7RHiAkwuTdt+hWPzZgNnDIFJsU38uLOu7/S9tpa0tOy35Qk wkvUq+aqhCdxIpZNzCDRGEXhxZ47M7m56w2m6v1dvQ/lttK5ddXqG+/VOj3hrZAurRpRxS yz9XZKrRjoqlEYgZ5akAahWbodSjA8w= 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-121-ORP5nkGUNjSWGHLQOixB5Q-1; Wed, 11 Sep 2024 07:25:50 -0400 X-MC-Unique: ORP5nkGUNjSWGHLQOixB5Q-1 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-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 9FD8019560B8; Wed, 11 Sep 2024 11:25:48 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.112]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 8281F19560A3; Wed, 11 Sep 2024 11:25:47 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 1A47D21E692E; Wed, 11 Sep 2024 13:25:45 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, arei.gonglei@huawei.com, pizhenwei@bytedance.com, jonathan.cameron@huawei.com, fan.ni@samsung.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com, =?utf-8?q?P?= =?utf-8?q?hilippe_Mathieu-Daud=C3=A9?= Subject: [PATCH v2 2/8] qapi/common: Supply missing member documentation Date: Wed, 11 Sep 2024 13:25:39 +0200 Message-ID: <20240911112545.2248881-3-armbru@redhat.com> In-Reply-To: <20240911112545.2248881-1-armbru@redhat.com> References: <20240911112545.2248881-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 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.144, 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, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Since we neglect to document the members of GrabToggleKeys, their description in the QEMU QMP Reference manual is "Not documented". Fix that. Signed-off-by: Markus Armbruster Reviewed-by: Philippe Mathieu-Daudé --- qapi/common.json | 14 +++++++++++++- qapi/pragma.json | 1 - 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/qapi/common.json b/qapi/common.json index 7558ce5430..6ffc7a3789 100644 --- a/qapi/common.json +++ b/qapi/common.json @@ -183,7 +183,19 @@ ## # @GrabToggleKeys: # -# Keys to toggle input-linux between host and guest. +# Key combinations to toggle input-linux between host and guest. +# +# @ctrl-ctrl: left and right control key +# +# @alt-alt: left and right alt key +# +# @shift-shift: left and right shift key +# +# @meta-meta: left and right meta key +# +# @scrolllock: scroll lock key +# +# @ctrl-scrolllock: either control key and scroll lock key # # Since: 4.0 ## diff --git a/qapi/pragma.json b/qapi/pragma.json index d5ae397293..f03b9cc444 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -52,7 +52,6 @@ 'DummyBlockCoreForceArrays', 'DummyForceArrays', 'DummyVirtioForceArrays', - 'GrabToggleKeys', 'HotKeyMod', 'ImageInfoSpecificKind', 'InputAxis', From patchwork Wed Sep 11 11:25:40 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Markus Armbruster X-Patchwork-Id: 13800264 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 lists.gnu.org (lists.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 6AA92EE4995 for ; Wed, 11 Sep 2024 11:27:12 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1soLU1-0005oy-NG; Wed, 11 Sep 2024 07:26:01 -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 1soLTx-0005b1-6T for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:25:57 -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 1soLTv-00012X-F6 for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:25:56 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1726053954; 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=EUsgEtQm7fnZMudj9WjI0fHYzHDLO+OTqJXQ84p4BdI=; b=Ydu7rOfnOD6HB1Ut8ox4++AKUK+Bjj9AhdMg9jW34eKZgoumro+fsj3vwjiY261wuJpDqi ij0ngaQPD6VOTxMg86kz2tNldfK2oKl4iJofr31zc3r+RKDEfu3vuQ0XtpCImo0ZEJuRBT pHxUeHZ+W+ZWsTivAB9+xMuurZGXDUM= Received: from mx-prod-mc-01.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-94-ioDD-BgzPSqbJeNHj7v3vw-1; Wed, 11 Sep 2024 07:25:50 -0400 X-MC-Unique: ioDD-BgzPSqbJeNHj7v3vw-1 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-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 8D10A1956089; Wed, 11 Sep 2024 11:25:48 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.112]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 94BD830001AB; Wed, 11 Sep 2024 11:25:47 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 1D89021E6939; Wed, 11 Sep 2024 13:25:45 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, arei.gonglei@huawei.com, pizhenwei@bytedance.com, jonathan.cameron@huawei.com, fan.ni@samsung.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com, =?utf-8?q?P?= =?utf-8?q?hilippe_Mathieu-Daud=C3=A9?= Subject: [PATCH v2 3/8] qapi/crypto: Supply missing member documentation Date: Wed, 11 Sep 2024 13:25:40 +0200 Message-ID: <20240911112545.2248881-4-armbru@redhat.com> In-Reply-To: <20240911112545.2248881-1-armbru@redhat.com> References: <20240911112545.2248881-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 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.144, 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, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Since we neglect to document the members of QCryptoAkCipherKeyType, their description in the QEMU QMP Reference manual is "Not documented". Fix that. Signed-off-by: Markus Armbruster Reviewed-by: Philippe Mathieu-Daudé --- qapi/crypto.json | 4 ++++ qapi/pragma.json | 1 - 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/qapi/crypto.json b/qapi/crypto.json index 867b09d322..9431522768 100644 --- a/qapi/crypto.json +++ b/qapi/crypto.json @@ -602,6 +602,10 @@ # # The type of asymmetric keys. # +# @public: public key +# +# @private: private key +# # Since: 7.1 ## { 'enum': 'QCryptoAkCipherKeyType', diff --git a/qapi/pragma.json b/qapi/pragma.json index f03b9cc444..625eac99df 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -64,7 +64,6 @@ 'NetClientDriver', 'ObjectType', 'PciMemoryRegion', - 'QCryptoAkCipherKeyType', 'QCryptodevBackendServiceType', 'QKeyCode', 'RbdAuthMode', From patchwork Wed Sep 11 11:25:41 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Markus Armbruster X-Patchwork-Id: 13800262 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 lists.gnu.org (lists.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 C8764EE4995 for ; Wed, 11 Sep 2024 11:27:00 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1soLTz-0005fR-45; Wed, 11 Sep 2024 07:25:59 -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 1soLTv-0005aD-V5 for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:25:56 -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 1soLTu-00012I-EG for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:25:55 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1726053953; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=jPap5rPhgh2dW/X03TfOVy+09igrDU42hFAAY4BhjBo=; b=BJqRDs1n6jaeFZfYygHP4HQJwZnmYYrIQ9/zcUzOiaaEuct++c3ZSJFs++4SH+CRHHrKH2 7pYU3Hr58W+9NX8heZ1vfNChaTt8eb9VHaoxz88driIDDAjZbZkrmxZE1H8UBkjGkEvMXF kC4tjLvYldPASTSb4U8meFOAiW3/z00= 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-591-L_UX2JqgOqSPwQTm-vaU2g-1; Wed, 11 Sep 2024 07:25:50 -0400 X-MC-Unique: L_UX2JqgOqSPwQTm-vaU2g-1 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-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 9193219560B1; Wed, 11 Sep 2024 11:25:48 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.112]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 8F63730001A1; Wed, 11 Sep 2024 11:25:47 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 2183F21E6889; Wed, 11 Sep 2024 13:25:45 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, arei.gonglei@huawei.com, pizhenwei@bytedance.com, jonathan.cameron@huawei.com, fan.ni@samsung.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com Subject: [PATCH v2 4/8] qapi/introspect: Supply missing member documentation Date: Wed, 11 Sep 2024 13:25:41 +0200 Message-ID: <20240911112545.2248881-5-armbru@redhat.com> In-Reply-To: <20240911112545.2248881-1-armbru@redhat.com> References: <20240911112545.2248881-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.4 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.144, 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, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Since we neglect to document the members of JSONType, their description in the QEMU QMP Reference manual is "Not documented". Fix that. Signed-off-by: Markus Armbruster Reviewed-by: Eric Blake --- qapi/introspect.json | 16 ++++++++++++++++ qapi/pragma.json | 1 - 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/qapi/introspect.json b/qapi/introspect.json index 14df049580..01bb242947 100644 --- a/qapi/introspect.json +++ b/qapi/introspect.json @@ -127,6 +127,22 @@ # section 1, plus 'int' (split off 'number'), plus the obvious top # type 'value'. # +# @string: JSON string +# +# @number: JSON number +# +# @int: JSON number that is an integer +# +# @boolean: literal ``false`` or ``true`` +# +# @null: literal ``null`` +# +# @object: JSON object +# +# @array: JSON array +# +# @value: any JSON value +# # Since: 2.5 ## { 'enum': 'JSONType', diff --git a/qapi/pragma.json b/qapi/pragma.json index 625eac99df..7b0e12f42b 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -58,7 +58,6 @@ 'InputButton', 'IscsiHeaderDigest', 'IscsiTransport', - 'JSONType', 'KeyValueKind', 'MemoryDeviceInfoKind', 'NetClientDriver', From patchwork Wed Sep 11 11:25:42 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Markus Armbruster X-Patchwork-Id: 13800266 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 lists.gnu.org (lists.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 ADB91EE4995 for ; Wed, 11 Sep 2024 11:27:21 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1soLU3-0005vc-JI; Wed, 11 Sep 2024 07:26: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 1soLU1-0005pD-NK for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:26: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 1soLTz-00013A-2l for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:26:01 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1726053958; 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=fcS5imXC/3N5hNbe0MVSPLOyQDOUu4SOQoOQxS4oAXw=; b=c3I1aYMGBKhkYJZjPDW/SgtldinmCjgQANNtXGabmOFPbc/ZDSsJy674W3m+kXfWOj+lXo B/K/D6e/jh5vCSE/k4DUaxQUVkDT0YKvatwsSLAQv7/VJpEYuVkU7711Gg5zq5lhVhK1ZH gPBm5RNrgth3owfQy0Qp7HQ36eGdDPk= Received: from mx-prod-mc-01.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-641-_gNmbgBXMfCIyc0utqfe5g-1; Wed, 11 Sep 2024 07:25:53 -0400 X-MC-Unique: _gNmbgBXMfCIyc0utqfe5g-1 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-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 875AF19560B5; Wed, 11 Sep 2024 11:25:51 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.112]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 048BB195608A; Wed, 11 Sep 2024 11:25:51 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 24A1E21E688F; Wed, 11 Sep 2024 13:25:45 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, arei.gonglei@huawei.com, pizhenwei@bytedance.com, jonathan.cameron@huawei.com, fan.ni@samsung.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com, =?utf-8?q?P?= =?utf-8?q?hilippe_Mathieu-Daud=C3=A9?= Subject: [PATCH v2 5/8] qapi/pci: Supply missing member documentation Date: Wed, 11 Sep 2024 13:25:42 +0200 Message-ID: <20240911112545.2248881-6-armbru@redhat.com> In-Reply-To: <20240911112545.2248881-1-armbru@redhat.com> References: <20240911112545.2248881-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 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.144, 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, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Since we neglect to document a member of PciMemoryRegion, its description in the QEMU QMP Reference manual is "Not documented". Fix that. Signed-off-by: Markus Armbruster Reviewed-by: Philippe Mathieu-Daudé Reviewed-by: Michael S. Tsirkin --- qapi/pci.json | 2 ++ qapi/pragma.json | 1 - 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/qapi/pci.json b/qapi/pci.json index 78bee57b77..dc85a41d28 100644 --- a/qapi/pci.json +++ b/qapi/pci.json @@ -33,6 +33,8 @@ # - 'io' if the region is a PIO region # - 'memory' if the region is a MMIO region # +# @address: memory address +# # @size: memory size # # @prefetch: if @type is 'memory', true if the memory is prefetchable diff --git a/qapi/pragma.json b/qapi/pragma.json index 7b0e12f42b..baeae5bf52 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -62,7 +62,6 @@ 'MemoryDeviceInfoKind', 'NetClientDriver', 'ObjectType', - 'PciMemoryRegion', 'QCryptodevBackendServiceType', 'QKeyCode', 'RbdAuthMode', From patchwork Wed Sep 11 11:25:43 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Markus Armbruster X-Patchwork-Id: 13800260 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 lists.gnu.org (lists.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 60B39EE4995 for ; Wed, 11 Sep 2024 11:26:38 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1soLU2-0005sx-S9; Wed, 11 Sep 2024 07:26:02 -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 1soLU0-0005kG-E6 for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:26: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 1soLTy-000138-RZ for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:26:00 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1726053958; 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=HdY2nKx4FEdpneO0t6phY+EdbrYanOOmNGn+pWIEkHc=; b=bBXtaHoTttZ82oZbWF221Zkm4VJJSBrvie9dMKQfaVTmzBIR/nz53c6yaNxnxTp2avR/Tt Iw8D/2zRqoDTu+URbibcPV4uvOff5FtC6ZplOeXsex7gM65GFqwxgT4Y90APLF79r2Fgtx 1Y12M05Tt4WkiNhi+78rP4wSjErwi3o= Received: from mx-prod-mc-01.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-66-N7_Vjz1sORqpLLSq8_7WiA-1; Wed, 11 Sep 2024 07:25:53 -0400 X-MC-Unique: N7_Vjz1sORqpLLSq8_7WiA-1 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-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 7DEE91956089; Wed, 11 Sep 2024 11:25:51 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.112]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 1D1DE19560A3; Wed, 11 Sep 2024 11:25:50 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 281F921E6891; Wed, 11 Sep 2024 13:25:45 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, arei.gonglei@huawei.com, pizhenwei@bytedance.com, jonathan.cameron@huawei.com, fan.ni@samsung.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com, =?utf-8?q?P?= =?utf-8?q?hilippe_Mathieu-Daud=C3=A9?= Subject: [PATCH v2 6/8] qapi/rocker: Supply missing member documentation Date: Wed, 11 Sep 2024 13:25:43 +0200 Message-ID: <20240911112545.2248881-7-armbru@redhat.com> In-Reply-To: <20240911112545.2248881-1-armbru@redhat.com> References: <20240911112545.2248881-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 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.144, 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, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Since we neglect to document the argument of query-rocker and query-rocker-ports, their description in the QEMU QMP Reference manual is "Not documented". Fix that. Signed-off-by: Markus Armbruster Reviewed-by: Philippe Mathieu-Daudé --- qapi/pragma.json | 4 +--- qapi/rocker.json | 4 ++++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/qapi/pragma.json b/qapi/pragma.json index baeae5bf52..feb7981700 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -78,9 +78,7 @@ 'X86CPURegister32', 'XDbgBlockGraph', 'YankInstanceType', - 'blockdev-reopen', - 'query-rocker', - 'query-rocker-ports' ], + 'blockdev-reopen' ], # Externally visible types whose member names may use uppercase 'member-name-exceptions': [ # visible in: 'ACPISlotType', # query-acpi-ospm-status diff --git a/qapi/rocker.json b/qapi/rocker.json index 73c7363b16..51aa5b4930 100644 --- a/qapi/rocker.json +++ b/qapi/rocker.json @@ -26,6 +26,8 @@ # # Return rocker switch information. # +# @name: switch name +# # Returns: @Rocker information # # Since: 2.4 @@ -94,6 +96,8 @@ # # Return rocker switch port information. # +# @name: port name +# # Returns: a list of @RockerPort information # # Since: 2.4 From patchwork Wed Sep 11 11:25:44 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Markus Armbruster X-Patchwork-Id: 13800263 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 lists.gnu.org (lists.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 69B19EE4997 for ; Wed, 11 Sep 2024 11:27:02 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1soLU3-0005vj-KW; Wed, 11 Sep 2024 07:26: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 1soLU1-0005pW-QN for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:26: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 1soLTz-00013G-J2 for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:26:01 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1726053958; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=x+TXE6moC3ZQS75kAlVK5kKObKsczRfd3IuyHbYO8VQ=; b=bhVy9kXk3vKPBoaV693NdQDadzOGBqlFTir2+QvuqlpWboKvDg/gE2D/Ykq0dW1bgOXDQr w6uGiPJEWpQAmce9IRdgWPeD4N7yDZcHBfnLDgO25u2WTmaSA/Thr2XXagOdeIiDgupNYT rgnDvYseHsdSm7ir+VN2QxCda5nqwFM= 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-379-Kdz3VcrsNFqUz3Dwyuwm8Q-1; Wed, 11 Sep 2024 07:25:53 -0400 X-MC-Unique: Kdz3VcrsNFqUz3Dwyuwm8Q-1 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-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id C55571956083; Wed, 11 Sep 2024 11:25:51 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.112]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 1CFDB195605A; Wed, 11 Sep 2024 11:25:51 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 2B59D21E68B2; Wed, 11 Sep 2024 13:25:45 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, arei.gonglei@huawei.com, pizhenwei@bytedance.com, jonathan.cameron@huawei.com, fan.ni@samsung.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com Subject: [PATCH v2 7/8] qapi/cxl: Supply missing member documentation Date: Wed, 11 Sep 2024 13:25:44 +0200 Message-ID: <20240911112545.2248881-8-armbru@redhat.com> In-Reply-To: <20240911112545.2248881-1-armbru@redhat.com> References: <20240911112545.2248881-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 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.144, 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, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Since we neglect to document a member of CxlCorErrorType, its description in the QEMU QMP Reference manual is "Not documented". Fix that. Signed-off-by: Markus Armbruster --- qapi/cxl.json | 3 +++ qapi/pragma.json | 1 - 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/qapi/cxl.json b/qapi/cxl.json index e9315d5b4d..9f65589bce 100644 --- a/qapi/cxl.json +++ b/qapi/cxl.json @@ -326,6 +326,9 @@ # @crc-threshold: Component specific and applicable to 68 byte Flit # mode only. # +# @retry-threshold: Retry threshold hit in the Local Retry State +# Machine, 68B Flits only. +# # @cache-poison-received: Received poison from a peer on CXL.cache. # # @mem-poison-received: Received poison from a peer on CXL.mem diff --git a/qapi/pragma.json b/qapi/pragma.json index feb7981700..108e574678 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -46,7 +46,6 @@ 'BlockdevSnapshotSyncWrapper', 'BlockdevSnapshotWrapper', 'BlockdevVmdkAdapterType', - 'CxlCorErrorType', 'DisplayProtocol', 'DriveBackupWrapper', 'DummyBlockCoreForceArrays', From patchwork Wed Sep 11 11:25:45 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Markus Armbruster X-Patchwork-Id: 13800261 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 lists.gnu.org (lists.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 516DFEE4995 for ; Wed, 11 Sep 2024 11:26:44 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1soLU3-0005vY-J0; Wed, 11 Sep 2024 07:26: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 1soLU1-0005pl-SY for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:26: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 1soLTz-00013K-Vy for qemu-devel@nongnu.org; Wed, 11 Sep 2024 07:26:01 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1726053959; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=jcDBU4owQbBxkclDor65l8lSzSIuAVoWdS2D2Q1iluo=; b=A12P1J93C+zP+g0wBVpXNu8T2bmNCbgRdSbZvr0Kg4/kzGYttmOh1Wl/d6EJQFqTzAkvr3 zu+vVrA4mt7giIBa8/1hubKaZGm68TR/jLPBJ01AlQ2QBjEH5gvAZi83SsQ1POorsoZHYS Kq7kum9AWJrD3hkytHQfp63FVkfdqSg= 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-501-CdlHh2SYNguXfoWI6xwnPQ-1; Wed, 11 Sep 2024 07:25:53 -0400 X-MC-Unique: CdlHh2SYNguXfoWI6xwnPQ-1 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-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 9A3021956088; Wed, 11 Sep 2024 11:25:51 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.112]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 1AC0B19560AD; Wed, 11 Sep 2024 11:25:51 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 2EA3021E68BD; Wed, 11 Sep 2024 13:25:45 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, arei.gonglei@huawei.com, pizhenwei@bytedance.com, jonathan.cameron@huawei.com, fan.ni@samsung.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com Subject: [PATCH v2 8/8] qapi: Document QCryptodevBackendServiceType Date: Wed, 11 Sep 2024 13:25:45 +0200 Message-ID: <20240911112545.2248881-9-armbru@redhat.com> In-Reply-To: <20240911112545.2248881-1-armbru@redhat.com> References: <20240911112545.2248881-1-armbru@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 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.144, 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, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org From: zhenwei pi QCryptodevBackendServiceType was introduced by bc304a6442e (cryptodev: Introduce server type in QAPI). However there is a lack of member description. Reported-by: Markus Armbruster Signed-off-by: zhenwei pi Reviewed-by: Markus Armbruster [Drop QCryptodevBackendServiceType from pragma documentation-exceptions] Signed-off-by: Markus Armbruster --- qapi/cryptodev.json | 10 ++++++++++ qapi/pragma.json | 1 - 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/qapi/cryptodev.json b/qapi/cryptodev.json index 5e417340dc..04d0e21d20 100644 --- a/qapi/cryptodev.json +++ b/qapi/cryptodev.json @@ -27,6 +27,16 @@ # # The supported service types of a crypto device. # +# @cipher: Symmetric Key Cipher service +# +# @hash: Hash service +# +# @mac: Message Authentication Codes service +# +# @aead: Authenticated Encryption with Associated Data service +# +# @akcipher: Asymmetric Key Cipher service +# # Since: 8.0 ## { 'enum': 'QCryptodevBackendServiceType', diff --git a/qapi/pragma.json b/qapi/pragma.json index 108e574678..023a2ef7bc 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -61,7 +61,6 @@ 'MemoryDeviceInfoKind', 'NetClientDriver', 'ObjectType', - 'QCryptodevBackendServiceType', 'QKeyCode', 'RbdAuthMode', 'RbdImageEncryptionFormat',