From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1uUsfp-0000Se-5Z for mharc-qemu-trivial@gnu.org; Thu, 26 Jun 2025 15:54: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 1uUsfm-0000Rq-2M for qemu-trivial@nongnu.org; Thu, 26 Jun 2025 15:54:15 -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 1uUsfb-0004yG-6V for qemu-trivial@nongnu.org; Thu, 26 Jun 2025 15:54:13 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1750967637; 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=2Acdmgqx3JlB6C7vyrkWlKGIncyEECmo5kGK6ydG8qI=; b=Wq+pZkkbpS8XAl4Lidd80WYbYzRxG2S4q6G4eTqqtw+FNSMs+vG5eoZi2k6pO0eSJMgc65 4lxfbR95CvI70aE6xm5OsB8r/b0dIW9TOKNkPQO9nVKI3vk6ks4czg493Qio56z35ek18F 9lGxcWvnYYiKvpekMP57H4fgEpc3K98= 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-138-1_WkTurZMNCTVtJCfzQMVQ-1; Thu, 26 Jun 2025 15:53:55 -0400 X-MC-Unique: 1_WkTurZMNCTVtJCfzQMVQ-1 X-Mimecast-MFC-AGG-ID: 1_WkTurZMNCTVtJCfzQMVQ_1750967633 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-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 2967B1944A83; Thu, 26 Jun 2025 19:53:49 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.65.58]) by mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 0458C30002C0; Thu, 26 Jun 2025 19:53:38 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Jason Wang , Eduardo Habkost , Peter Maydell , Jiri Pirko , Vladimir Sementsov-Ogievskiy , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Michael Tokarev , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , qemu-trivial@nongnu.org, "Gonglei (Arei)" , Laurent Vivier , Peter Xu , Marcel Apfelbaum , Zhao Liu , Fabiano Rosas , Yanan Wang , Gerd Hoffmann , Paolo Bonzini , Markus Armbruster , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Michael Roth , Zhenwei Pi , Lukas Straub , John Snow , Hanna Reitz , Stefan Hajnoczi , Ani Sinha , Stefan Berger , "Michael S. Tsirkin" , Kevin Wolf , Eric Blake , qemu-block@nongnu.org, Mads Ynddal Subject: [PATCH v5 0/4] qapi: add auto-generated return docs Date: Thu, 26 Jun 2025 15:53:33 -0400 Message-ID: <20250626195337.2158250-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.4.1 on 10.30.177.4 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: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, 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: Thu, 26 Jun 2025 19:54:15 -0000 This series adds the ability for the new QAPIDoc system to generate=0D "Returns:" documentation based on the return type declared in the Schema=0D even when no explicit documentation is found in the QAPI source. As a=0D result and as an immediate cleanup, trivial return statements are=0D removed and remaining Return documentation is revised to avoid=0D re-stating the return type, which is always generated automatically.=0D =0D v5: rebased, implemented Markus' preferred insertion algorithm=0D =0D v4: rebased on origin/master (2025-06-12)=0D =0D v3: rebased on top of python-qapi-linting (v4) pull request;=0D removed commits that are no longer needed.=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.json | 22 ----------------------=0D qapi/migration.json | 12 ------------=0D qapi/misc-i386.json | 12 +-----------=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 | 34 ++++++++++++++++++++++++++++++++++=0D scripts/qapi/schema.py | 3 +++=0D 31 files changed, 111 insertions(+), 132 deletions(-)=0D =0D -- =0D 2.48.1=0D =0D