From patchwork Thu Aug 8 18:26:30 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Markus Armbruster X-Patchwork-Id: 13758037 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 D5429C3DA4A for ; Thu, 8 Aug 2024 18:27:10 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sc7qZ-0006th-NV; Thu, 08 Aug 2024 14:26:47 -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 1sc7qX-0006tC-Ea for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:45 -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 1sc7qV-0000zc-0e for qemu-devel@nongnu.org; Thu, 08 Aug 2024 14:26:44 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1723141601; 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; bh=TjjLli6oi2nax6w3whWJq07SXfTeOO0VLZ0zlUlPf3c=; b=iHTnoiRjM1TFdVJa3iQbzQ/DMdPpwG9V9d4sIhPVoL0X1EpvqSo3GXKkVIaSTJpquFjKFf Tl7v07ifEhcJ3T8oBZPPAMfAwwrpIVZKNUPiCFsb7yCt37aN+SZ+pX9dNkCUqr2DCbSdid VJ0gydWYolSF21anz2w+GYJ6Kjx2ouM= 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-36-_kTruHLqN1ei2RmcMJnkoQ-1; Thu, 08 Aug 2024 14:26:40 -0400 X-MC-Unique: _kTruHLqN1ei2RmcMJnkoQ-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-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id CAD6819560BA; Thu, 8 Aug 2024 18:26:38 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.193.245]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 5987919560A3; Thu, 8 Aug 2024 18:26:38 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 24B4121E5E6E; Thu, 8 Aug 2024 20:26:36 +0200 (CEST) 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 0/6] qapi: Supply some of the missing member documentation Date: Thu, 8 Aug 2024 20:26:30 +0200 Message-ID: <20240808182636.3657537-1-armbru@redhat.com> MIME-Version: 1.0 Content-type: text/plain X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org This series gets a few of modules off the pragma documentation-exceptions list of shame that require minimal effort. Many undocumented members still remain: module type or command #missing ------------------------------------------------------------ audio AudiodevDriver 12 block-core BlkdebugEvent 43 BlockdevDriver 39 BlockdevQcow2EncryptionFormat 1 BlockdevVmdkAdapterType 4 DummyBlockCoreForceArrays 1 ImageInfoSpecificKind 2 IscsiHeaderDigest 4 IscsiTransport 2 RbdAuthMode 2 RbdImageEncryptionFormat 2 ThrottleGroupProperties 19 XDbgBlockGraph 2 blockdev-reopen 1 cryptodev QCryptodevBackendServiceType 5 cxl CxlCorErrorType 1 machine-common CpuS390Entitlement 4 machine-target CpuS390Polarization 2 machine CpuS390State 5 DummyForceArrays 1 MemoryDeviceInfoKind 1 SysEmuTarget 27 X86CPURegister32 8 net NetClientDriver 10 String 1 qom ObjectType 48 transaction AbortWrapper 1 BlockDirtyBitmapAddWrapper 1 BlockDirtyBitmapMergeWrapper 1 BlockDirtyBitmapWrapper 1 BlockdevBackupWrapper 1 BlockdevSnapshotInternalWrapper 1 BlockdevSnapshotSyncWrapper 1 BlockdevSnapshotWrapper 1 DriveBackupWrapper 1 ui DisplayProtocol 2 HotKeyMod 3 InputAxis 2 InputButton 7 KeyValueKind 2 QKeyCode 119 VncPrimaryAuth 9 VncVencryptSubAuth 9 virtio DummyVirtioForceArrays 1 yank YankInstanceType 3 qga GuestNVMeSmart 25 Note: DummyVirtioForceArrays is purely internal, and should be elided from the manual instead, but that's a different project. Markus Armbruster (6): qapi/char: Supply missing member documentation qapi/common: Supply missing member documentation qapi/crypto: Supply missing member documentation qapi/introspect: Supply missing member documentation qapi/pci: Supply missing member documentation qapi/rocker: Supply missing member documentation qapi/char.json | 44 ++++++++++++++++++++++++++++---------------- qapi/common.json | 14 +++++++++++++- qapi/crypto.json | 4 ++++ qapi/introspect.json | 16 ++++++++++++++++ qapi/pci.json | 2 ++ qapi/pragma.json | 9 +-------- qapi/rocker.json | 4 ++++ 7 files changed, 68 insertions(+), 25 deletions(-)