Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1uIX53-0000bI-0l for mharc-qemu-trivial@gnu.org; Fri, 23 May 2025 14:25:17 -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 1uIX4z-0000Y5-6t for qemu-trivial@nongnu.org; Fri, 23 May 2025 14:25:14 -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 1uIX4x-00036j-Ng for qemu-trivial@nongnu.org; Fri, 23 May 2025 14:25:12 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1748024711; 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=MowPuyafokaa+aumB5Q/UtEV3bsIZFGBtc/UrpEe/8c=; b=UBGQj4QmdHAG/XCpF3QZ4MSjRlTLEPeF/+lS8/UpmNEHrE1MRyTljdZpau4fB6nzQCloaV niaN6aXRwCvRcmeXCfQRIzpF63GN19JWrTbxK7Z6RHf1FZhVlZ4F8qTnCcKb2PaD2BxMMG I4yU29n5m9MbSB3Fvd7UqstRFyLGNnQ= 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-354-MqYExDCqNLu2jwXVtATxbw-1; Fri, 23 May 2025 14:25:06 -0400 X-MC-Unique: MqYExDCqNLu2jwXVtATxbw-1 X-Mimecast-MFC-AGG-ID: MqYExDCqNLu2jwXVtATxbw_1748024704 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-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 5995E195608C; Fri, 23 May 2025 18:25:02 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.64.78]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 01B0F1944A89; Fri, 23 May 2025 18:24:50 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Kevin Wolf , Peter Maydell , Yanan Wang , Jiri Pirko , Marcel Apfelbaum , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Lukas Straub , Peter Xu , Michael Roth , Jason Wang , Stefan Hajnoczi , Eric Blake , qemu-trivial@nongnu.org, Gerd Hoffmann , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Michael Tokarev , qemu-block@nongnu.org, Mads Ynddal , "Michael S. Tsirkin" , Stefan Berger , Paolo Bonzini , John Snow , Eduardo Habkost , Fabiano Rosas , Zhao Liu , Zhenwei Pi , Ani Sinha , Markus Armbruster , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Hanna Reitz , Vladimir Sementsov-Ogievskiy , "Gonglei (Arei)" , Laurent Vivier Subject: [PATCH v3 0/4] qapi: add auto-generated return docs Date: Fri, 23 May 2025 14:24:38 -0400 Message-ID: <20250523182442.54469-1-jsnow@redhat.com> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Received-SPF: pass client-ip=170.10.133.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.287, 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=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-trivial@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 23 May 2025 18:25:15 -0000 v3: rebased on top of python-qapi-linting (v4) pull request;=0D removed commits that are no longer needed.=0D Markus: I forget where we left off... shall we refresh?=0D =0D v2: fix multi-return-sections bug :(=0D =0D John Snow (4):=0D docs/qapi-domain: add return-nodesc=0D docs, qapi: generate undocumented return sections=0D qapi: remove trivial "Returns:" sections=0D qapi: rephrase return docs to avoid type name=0D =0D docs/devel/qapi-domain.rst | 30 ++++++++++++++++++++++++++++++=0D docs/sphinx/qapi_domain.py | 8 ++++++++=0D docs/sphinx/qapidoc.py | 14 ++++++++------=0D qapi/audio.json | 2 --=0D qapi/block-core.json | 14 +++-----------=0D qapi/block-export.json | 2 +-=0D qapi/block.json | 2 +-=0D qapi/char.json | 8 --------=0D qapi/control.json | 5 ++---=0D qapi/cryptodev.json | 2 --=0D qapi/dump.json | 5 ++---=0D qapi/introspect.json | 6 +++---=0D qapi/job.json | 2 +-=0D qapi/machine-target.json | 9 +++------=0D qapi/machine.json | 22 ----------------------=0D qapi/migration.json | 12 ------------=0D qapi/misc-target.json | 14 +-------------=0D qapi/misc.json | 12 ++----------=0D qapi/net.json | 2 +-=0D qapi/pci.json | 2 +-=0D qapi/qdev.json | 3 +--=0D qapi/qom.json | 8 +++-----=0D qapi/rocker.json | 4 ----=0D qapi/run-state.json | 2 --=0D qapi/stats.json | 2 +-=0D qapi/tpm.json | 4 ----=0D qapi/trace.json | 2 +-=0D qapi/ui.json | 10 +---------=0D qapi/virtio.json | 8 +++-----=0D qapi/yank.json | 1 -=0D scripts/qapi/parser.py | 15 +++++++++++++++=0D scripts/qapi/schema.py | 3 +++=0D 32 files changed, 95 insertions(+), 140 deletions(-)=0D =0D -- =0D 2.48.1=0D =0D