From patchwork Sat Mar 22 01:08:53 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Snow X-Patchwork-Id: 14026122 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 CF8BDC36002 for ; Sat, 22 Mar 2025 01:11:04 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tvnMf-0005EL-QX; Fri, 21 Mar 2025 21:09:29 -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 1tvnMe-0005Di-7z for qemu-devel@nongnu.org; Fri, 21 Mar 2025 21:09:28 -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 1tvnMc-0002x4-Mx for qemu-devel@nongnu.org; Fri, 21 Mar 2025 21:09:27 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1742605764; 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=xMFE+OKQXPk6+GcAKOzrqDTIPIMbEsdcGAmWO/K5+ok=; b=UVX1QbZcWy130QKlavlTFG7m2EvL9tf/QWP2erIXFgCje/JCrU/WKUZj+6vKoPxYa1cjtQ f/6rbLRSKejIkDjTjYC2f3zCdKaLyRo2IRWrkqFhQ8Y5zhQUbr6VM6TpPyvRapktGVp8qX bgdc857LvhIiERkDYXFddU/c3T0tdss= 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-63-ZEpSOToVPfqa-74BEAAyXA-1; Fri, 21 Mar 2025 21:09:20 -0400 X-MC-Unique: ZEpSOToVPfqa-74BEAAyXA-1 X-Mimecast-MFC-AGG-ID: ZEpSOToVPfqa-74BEAAyXA_1742605758 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 461B71945103; Sat, 22 Mar 2025 01:09:12 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.64.66]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 740A819373C4; Sat, 22 Mar 2025 01:08:59 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Markus Armbruster , =?utf-8?q?Marc-Andr=C3=A9_Lureau?= , Hanna Reitz , Peter Xu , "Gonglei (Arei)" , =?utf-8?q?Philippe_Mathieu-Daud?= =?utf-8?q?=C3=A9?= , Paolo Bonzini , =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Ani Sinha , Michael Tokarev , Lukas Straub , Fabiano Rosas , Eduardo Habkost , Stefan Berger , qemu-trivial@nongnu.org, Jason Wang , Marcel Apfelbaum , Vladimir Sementsov-Ogievskiy , Peter Maydell , Laurent Vivier , Yanan Wang , John Snow , Zhao Liu , Stefan Hajnoczi , Kevin Wolf , "Michael S. Tsirkin" , qemu-block@nongnu.org, Zhenwei Pi , Mads Ynddal , Gerd Hoffmann , Michael Roth , Eric Blake , Jiri Pirko Subject: [PATCH 0/4] qapi: add auto-generated return docs Date: Fri, 21 Mar 2025 21:08:53 -0400 Message-ID: <20250322010857.309490-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Received-SPF: pass client-ip=170.10.129.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -23 X-Spam_score: -2.4 X-Spam_bar: -- X-Spam_report: (-2.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.332, 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_H5=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 Basically RFC quality, I'm sure there's going to be a ton of back and forth on the doc phrasing changes. Ah well. John Snow (4): docs/qapi-domain: add return-nodesc docs, qapi: generate undocumented return sections qapi: remove trivial "Returns:" sections qapi: rephrase return docs to avoid type name docs/devel/qapi-domain.rst | 30 ++++++++++++++++++++++++++++++ docs/sphinx/qapi_domain.py | 8 ++++++++ docs/sphinx/qapidoc.py | 14 ++++++++------ qapi/audio.json | 2 -- qapi/block-core.json | 14 +++----------- qapi/block-export.json | 2 +- qapi/block.json | 2 +- qapi/char.json | 8 -------- qapi/control.json | 5 ++--- qapi/cryptodev.json | 2 -- qapi/dump.json | 5 ++--- qapi/introspect.json | 6 +++--- qapi/job.json | 2 +- qapi/machine-target.json | 9 +++------ qapi/machine.json | 22 ---------------------- qapi/migration.json | 12 ------------ qapi/misc-target.json | 14 +------------- qapi/misc.json | 12 ++---------- qapi/net.json | 2 +- qapi/pci.json | 2 +- qapi/qdev.json | 3 +-- qapi/qom.json | 8 +++----- qapi/rocker.json | 4 ---- qapi/run-state.json | 2 -- qapi/stats.json | 2 +- qapi/tpm.json | 4 ---- qapi/trace.json | 2 +- qapi/ui.json | 10 +--------- qapi/virtio.json | 8 +++----- qapi/yank.json | 1 - scripts/qapi/parser.py | 11 +++++++++++ scripts/qapi/schema.py | 3 +++ 32 files changed, 91 insertions(+), 140 deletions(-)