From nobody Sun Nov 24 11:27:51 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=1723141626; cv=none; d=zohomail.com; s=zohoarc; b=kj/ye2Fe6123dEklLpeBiNux0XJIdlY0jmkHBPpQ3e2TTGYfwuL3uypxgeQFe9CFBDXMtjhnkmITkERC98kHc5Dem1C6G4ZrYkVxRRROtLdAL6CDxMKvDlF0+cFfuGBbd99IB4P4xYcZZHYRmqaZCg1PsxW+4oRtluwtNyt1zuA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723141626; 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=XPzDwnV7bltr5P6E7tqUg1PVMwh8QxRkScJ+Mwg6V7Q=; b=bzBSz4jxOmJAqNwA+vSk1cNWUJlxC7WTQ2qiIi2xH9VVoJQAxwA8TlKd2YBfOkt0hGhH0VCzj/PT7bcnS7oiTaPuRWZl4Y9NjyZ9ZfqIwWU3OWzt1guRo3TLbxn0z+NiJHd7SiMgBr2gYW0voBhd3U2afDA7lhVyLKtAr/v5h5o= 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 1723141626396190.22436086653647; Thu, 8 Aug 2024 11:27:06 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sc7qf-00075c-0v; Thu, 08 Aug 2024 14:26:53 -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 1sc7qb-0006vk-6r for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26: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 1sc7qX-0000zl-6d for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:47 -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-232-IxSSjyQGNAO3ePcIaay1pw-1; Thu, 08 Aug 2024 14:26:41 -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-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 1BAB71944AA8; Thu, 8 Aug 2024 18:26:39 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.193.245]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 774EB1956052; Thu, 8 Aug 2024 18:26:38 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 264C521E5A5E; Thu, 8 Aug 2024 20:26:36 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1723141604; 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=XPzDwnV7bltr5P6E7tqUg1PVMwh8QxRkScJ+Mwg6V7Q=; b=ghUyPj/7oslU6oV6ybrLNG8mxSJxm75YvxokbM3t40rW95r8nnjdiRJV4c2UJ+yFa4ewGS suLj3DUejBUEzwTTb3DSeDkVDuT2assRASopIUKg7YSCjL5fpDPxGsUIhC4h2n2eqlxpmm yHYUktgxikaiRuRaHokAp3QYQhROOCI= X-MC-Unique: IxSSjyQGNAO3ePcIaay1pw-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com Subject: [PATCH 1/6] qapi/char: Supply missing member documentation Date: Thu, 8 Aug 2024 20:26:31 +0200 Message-ID: <20240808182636.3657537-2-armbru@redhat.com> In-Reply-To: <20240808182636.3657537-1-armbru@redhat.com> References: <20240808182636.3657537-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.141, 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: 1723141626774116600 Content-Type: text/plain; charset="utf-8" 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..8a4a87c95c 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 v1.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 59fbe74b8c..39a424303b 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -46,7 +46,6 @@ 'BlockdevSnapshotSyncWrapper', 'BlockdevSnapshotWrapper', 'BlockdevVmdkAdapterType', - 'ChardevBackendKind', 'CpuS390Entitlement', 'CpuS390Polarization', 'CpuS390State', --=20 2.45.0 From nobody Sun Nov 24 11:27:51 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=1723141684; cv=none; d=zohomail.com; s=zohoarc; b=NhvAizaIB4nvYK7zhWGRUVUQD/kxxq6wZuPc+gATMgDRQTrj7g5mUL9VQPAcnu0ES8ve37dGrDxjyb4L2JuA1TzXGlo7CS8y4Xddcazj7lZ0d7NGyJzlzFU0fC7HuNwEsUKd9XcB3qC/oueOxvpKS4oS828Dv9MCw3hiHUsHIwc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723141684; 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=TCyr7FYSBNpBY8JP2h8Gp4KgWb+w+sLKTsRT6zhiF2k=; b=RYCJ8n0ld1x5esGIUq/XLbwyz215w1nARPqYPDgjjkBx8dlPPB7YZCCUG7/ouf6STlWcCyi5LcgFyPS0O/kDHJA4PNon79xjJhXB8h1c9qMMKwF1S+K5+u9KUdsJmKGmw58jnX8UHFWTEUYHSVHYLnKqBXateIipMeAqvrF+k00= 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 17231416848511004.3043720530868; Thu, 8 Aug 2024 11:28:04 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sc7qi-0007JU-FF; Thu, 08 Aug 2024 14:26:56 -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 1sc7qe-00075E-Te for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:52 -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 1sc7qa-00010P-TN for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:51 -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-330-ft6mSj8SOzKUYa7gp0tHrQ-1; Thu, 08 Aug 2024 14:26:42 -0400 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (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 13B501944B2F; Thu, 8 Aug 2024 18:26:39 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.193.245]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 5B58E1955E99; Thu, 8 Aug 2024 18:26:38 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 29B4621E5A5F; Thu, 8 Aug 2024 20:26:36 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1723141607; 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=TCyr7FYSBNpBY8JP2h8Gp4KgWb+w+sLKTsRT6zhiF2k=; b=Dz3HwwQkpNMg5Qw6+ya6boMINanot+sJp8ssMpeJBiU9r25q+cBg/WdFmI1yy1Ck5EVxhQ x7YCYBNMRlEVbVxvNi2IvI3iBPZYzKHpaMAUxQigUJDEQOEvhlULunargXs5LDNEpJ6ZuW dNxAzp1iccM094UGHXeXX4f8otTtnYA= X-MC-Unique: ft6mSj8SOzKUYa7gp0tHrQ-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com Subject: [PATCH 2/6] qapi/common: Supply missing member documentation Date: Thu, 8 Aug 2024 20:26:32 +0200 Message-ID: <20240808182636.3657537-3-armbru@redhat.com> In-Reply-To: <20240808182636.3657537-1-armbru@redhat.com> References: <20240808182636.3657537-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 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.141, 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: 1723141687237116600 Content-Type: text/plain; charset="utf-8" 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=C3=A9 --- 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 39a424303b..6ff135d8d2 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -55,7 +55,6 @@ 'DummyBlockCoreForceArrays', 'DummyForceArrays', 'DummyVirtioForceArrays', - 'GrabToggleKeys', 'HotKeyMod', 'ImageInfoSpecificKind', 'InputAxis', --=20 2.45.0 From nobody Sun Nov 24 11:27:51 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=1723141673; cv=none; d=zohomail.com; s=zohoarc; b=MrTwQ7jGRNb5hTPbWDSL+T8qq4NmIDUhZxg7LiI9IYm8QUhamMjh/0dHjJT/f3zkkO392Vnva9bPsorZS8hE5LdKR9Oq/EfnrVjgSxRGotfUN1+Cz0ln/PimoeFz+Xv16IVcfKPmch/rPDwmY5woO616ozQw2HddB0rcuovX4CA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723141673; 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=SncE1h/EeL+j/tz8NjXwJJEqHu/BANr04XTQmYyojaQ=; b=n1TqiCs5dziCyPBu/Ql2bqbkEoeLfl2LzHnVJnCQeJZLx457r6wLt5Lv6x8ygwLLgbaoz0T47A1KvHSj3RWouriVGbXokkd4BRIhFJHzx0OVhrQRuOuripAuWTOJZimy2gr0mCTXXSATpMdaLc+ko/P5wiR9GGBSmDz4Ystc28A= 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 172314167305259.28650654085777; Thu, 8 Aug 2024 11:27:53 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sc7qg-0007DE-Tx; Thu, 08 Aug 2024 14:26: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 1sc7qb-0006vi-5i for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26: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 1sc7qW-0000zg-EW for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:46 -0400 Received: from mx-prod-mc-02.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-302-J8tZnwXcNkG83xDrUGw44w-1; Thu, 08 Aug 2024 14:26:40 -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-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 1EDEB19541A0; Thu, 8 Aug 2024 18:26:39 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.193.245]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 7DE5D1955F40; Thu, 8 Aug 2024 18:26:38 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 2CCB121E5A6B; Thu, 8 Aug 2024 20:26:36 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1723141603; 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=SncE1h/EeL+j/tz8NjXwJJEqHu/BANr04XTQmYyojaQ=; b=ALGLFEFl+lfXgmyvSZ/CZ3AaLkjn/RSxg7/XSLHwBhehKipd27lc8X3HoXa3wdWFgMhSaC iU+6emuBJkalxZIxyRk047X6ctyuCaO9DhXsIU88qaoz/nTbFmgDwRVVfNIVnfwiE4zgDi +uTvUdvKRkPFTnrBiBt3A2xStTKXSrc= X-MC-Unique: J8tZnwXcNkG83xDrUGw44w-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com Subject: [PATCH 3/6] qapi/crypto: Supply missing member documentation Date: Thu, 8 Aug 2024 20:26:33 +0200 Message-ID: <20240808182636.3657537-4-armbru@redhat.com> In-Reply-To: <20240808182636.3657537-1-armbru@redhat.com> References: <20240808182636.3657537-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.141, 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: 1723141675236116600 Content-Type: text/plain; charset="utf-8" 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=C3=A9 --- 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 97e02dbd59..67f5855a96 100644 --- a/qapi/crypto.json +++ b/qapi/crypto.json @@ -610,6 +610,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 6ff135d8d2..fd6bdcaa6d 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -67,7 +67,6 @@ 'NetClientDriver', 'ObjectType', 'PciMemoryRegion', - 'QCryptoAkCipherKeyType', 'QCryptodevBackendServiceType', 'QKeyCode', 'RbdAuthMode', --=20 2.45.0 From nobody Sun Nov 24 11:27:51 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=1723141650; cv=none; d=zohomail.com; s=zohoarc; b=DNRbYqXXfbSuewT1WuYeLn7LNbeM1lh2oYl2DzA4MiTMKZHGP/7htkUVAtQbnd4JLYeuhvQZDumfns1/KF+ZK31l5oGffEDP2GXDsRkRNLw1VM8k4HDVikOM93knhgoTHVoGdVrJ69+0g2GEoymrFQqkYYl+YTAqsIUKLWhwVwE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723141650; 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=F60fn+DU7y2UFpS2mlSGFgLI3fELnhDOWJV9wLp+hf8=; b=b/zVfQTZxNKeO7nlfgqNWB5OzgW7D92fhKMGAdikjRn7sqpQhlO1h2KZWccpOahQUUXE4PLs2+bRT2t7apfmL0oq954plnHLeFN6kZEqTna7VpbzQq5T/FuP9pOgFYLoeSC0DXX8zAN5/Ads73js0yNmGUbPBEcjSYSAWSKEncE= 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 1723141650717280.48099226634463; Thu, 8 Aug 2024 11:27:30 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sc7qe-00074k-S8; Thu, 08 Aug 2024 14:26: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 1sc7qb-0006vj-5d for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:50 -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 1sc7qX-0000zp-B4 for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:47 -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-397-MumiyUQ5O_GqMe9O_Ex7xw-1; Thu, 08 Aug 2024 14:26:41 -0400 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (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 4FBA41944D30; Thu, 8 Aug 2024 18:26:39 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.193.245]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 747F61955E9C; Thu, 8 Aug 2024 18:26:38 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 2FB4721E5A6D; Thu, 8 Aug 2024 20:26:36 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1723141604; 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=F60fn+DU7y2UFpS2mlSGFgLI3fELnhDOWJV9wLp+hf8=; b=GeHR/oq06ZKgUVASPY63KY6QlJkXfRPAv1etX62vs3GPF7+FPwJX9MtKTKKKds9PAE+CX7 GcaKtkAuT+ZWUUt9u5RrUJ8lpFQSmMFl+5y+3q7mzjsLtoapP957V338iAaUah2pa0Vzy6 halc7v/6O+amZntxUMhoMewLHw/oP6A= X-MC-Unique: MumiyUQ5O_GqMe9O_Ex7xw-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com Subject: [PATCH 4/6] qapi/introspect: Supply missing member documentation Date: Thu, 8 Aug 2024 20:26:34 +0200 Message-ID: <20240808182636.3657537-5-armbru@redhat.com> In-Reply-To: <20240808182636.3657537-1-armbru@redhat.com> References: <20240808182636.3657537-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 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.141, 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_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: 1723141650851116600 Content-Type: text/plain; charset="utf-8" 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 fd6bdcaa6d..cc218f64b8 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -61,7 +61,6 @@ 'InputButton', 'IscsiHeaderDigest', 'IscsiTransport', - 'JSONType', 'KeyValueKind', 'MemoryDeviceInfoKind', 'NetClientDriver', --=20 2.45.0 From nobody Sun Nov 24 11:27:51 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=1723141704; cv=none; d=zohomail.com; s=zohoarc; b=DcLAusP8Es/qxhSpqhCYF20WXf7ZFD1+AguRvsVie1tVEWcDxvM8TbcFZpnZX4FM2rVlFMc8YREa6vWP7a/hkH4aYaEarlKVpRwZ4XinAXbGf3fE5XL0nbX35d7FsL3bxBcAZ048WUu/sDpPS9w6aSkTlkdyH4lyPP9MMF/JA4o= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723141704; 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=xfEc3jbkgZLSwoEIQADz8z8ebGdvVP2+aqbx5tlP2Nc=; b=mTvLNza6jCNQWMAWELDGNP4PIVXMe8xaKLaZ6EnneOk3TQfztdDSjQm9am8cUCd9k9xITl95DNmunMDbazKk7IAlDTMJZgvis+8CeHoFsOC8qmwUwU4mzQ6wBQseMv6VQp+lvheZ7ReJIe3kTJw6KCOKKNnV93GuRWoy0HlEjwU= 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 1723141704196580.9934812226603; Thu, 8 Aug 2024 11:28:24 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sc7qi-0007GX-Cx; Thu, 08 Aug 2024 14:26:56 -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 1sc7qe-000756-SZ for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:52 -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 1sc7qa-000105-GR for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:50 -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-29-uFLHOI5sOYS4tIY0RfzLaQ-1; Thu, 08 Aug 2024 14:26:43 -0400 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (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 3B2331944D30; Thu, 8 Aug 2024 18:26:42 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.193.245]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id D1A4A1955E9C; Thu, 8 Aug 2024 18:26:41 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 32BF721EC369; Thu, 8 Aug 2024 20:26:36 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1723141606; 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=xfEc3jbkgZLSwoEIQADz8z8ebGdvVP2+aqbx5tlP2Nc=; b=Ab35Noqe/sextR1YLjGzNVxxt+Nz0nGguW3DQEKV0xnsg+J5gSo57GcNahXUyYSYEfvK3R 8va1HDGOpo/u0dm9wF3mnirwrK1yJqmekzJPxi4s8x9SdY2VrY9B63vapU13eUUbEKAmfU HK44+wOuP87Ur43JFqw2TbKeC2nYhuo= X-MC-Unique: uFLHOI5sOYS4tIY0RfzLaQ-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com Subject: [PATCH 5/6] qapi/pci: Supply missing member documentation Date: Thu, 8 Aug 2024 20:26:35 +0200 Message-ID: <20240808182636.3657537-6-armbru@redhat.com> In-Reply-To: <20240808182636.3657537-1-armbru@redhat.com> References: <20240808182636.3657537-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 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.141, 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_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: 1723141705293116600 Content-Type: text/plain; charset="utf-8" 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=C3=A9 --- 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 cc218f64b8..1570d6bcc6 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -65,7 +65,6 @@ 'MemoryDeviceInfoKind', 'NetClientDriver', 'ObjectType', - 'PciMemoryRegion', 'QCryptodevBackendServiceType', 'QKeyCode', 'RbdAuthMode', --=20 2.45.0 From nobody Sun Nov 24 11:27:51 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=1723141699; cv=none; d=zohomail.com; s=zohoarc; b=P9UqUolCVZXHnQ1p5J0zYeKduylbA5ZJ6nph7pjAkGU/xgsEaZ7GIMxG4QVg3nCQeggYjW+F5m7aQiOqkYUmjS6XIE3JLoMf530BwV+b5FYpmrDLXmO8LAFGCsmRVdBTbRYFK8BRtM10sJngVA9oD8AYZujhVMx6FyxZcy0PV2o= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723141699; 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=nSD5jyNB3zyE54bl3N6ltnUURcW/x5f1+28ktU5XQPg=; b=NtY4u28QeA0qzRH0ogQeTMSl0mmv2N5KTexJy7tJRB8N8+jy4Mfh9glaoxxQSRqJAq+Q9ELWihe5/ZmMmJ+ff8n20yEk3xRoV0HVAztWPa+pwyJZSDnjc8c96vDz53ZKS/n7y/NxNqu+wXmGBCo96D6yP8plq2x6s3jhTqbPMaE= 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 1723141699733677.8423561997646; Thu, 8 Aug 2024 11:28:19 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sc7qi-0007IX-EG; Thu, 08 Aug 2024 14:26:56 -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 1sc7qe-000757-Sr for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:52 -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 1sc7qZ-0000zy-6s for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:50 -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-324-_qpX1jBLMmOSebrQiN1ljQ-1; Thu, 08 Aug 2024 14:26:44 -0400 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (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 3BB8319560A2; Thu, 8 Aug 2024 18:26:42 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.193.245]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id F06E21955E99; Thu, 8 Aug 2024 18:26:41 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 35C5D21EC36C; Thu, 8 Aug 2024 20:26:36 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1723141605; 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=nSD5jyNB3zyE54bl3N6ltnUURcW/x5f1+28ktU5XQPg=; b=BI+4NenWuvk+K+QUcPY8HRGsBXydjmX1W0zGxIQCIgixUZcuMTKFl+f/gbJT1bfjl84yIG qYiexj1wmXXkElfZ5b3+pZF15sdiPaMs0385xhsW6CIIlUMJ6G/wJ/MPVsAUFUs4AD+BTR Jee4J+bqxfDMgNbPvpPI4H4L/cQAjgI= X-MC-Unique: _qpX1jBLMmOSebrQiN1ljQ-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, marcandre.lureau@redhat.com, pbonzini@redhat.com, berrange@redhat.com, mst@redhat.com, marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com Subject: [PATCH 6/6] qapi/rocker: Supply missing member documentation Date: Thu, 8 Aug 2024 20:26:36 +0200 Message-ID: <20240808182636.3657537-7-armbru@redhat.com> In-Reply-To: <20240808182636.3657537-1-armbru@redhat.com> References: <20240808182636.3657537-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 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.141, 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: 1723141701067116600 Content-Type: text/plain; charset="utf-8" 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=C3=A9 --- 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 1570d6bcc6..ae9eaa2657 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 6950ca9602..f1a87243fa 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 --=20 2.45.0