From mboxrd@z Thu Jan 1 00:00:00 1970 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 D20B7C282D1 for ; Sun, 9 Mar 2025 08:36:09 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1trC8e-0000iR-BU; Sun, 09 Mar 2025 04:36:00 -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 1trC8c-0000dw-Od for qemu-devel@nongnu.org; Sun, 09 Mar 2025 04:35:58 -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 1trC8b-0001zh-05 for qemu-devel@nongnu.org; Sun, 09 Mar 2025 04:35:58 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741509356; 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=JxiusdFM4yuXUh+fVwTw71zchLQQeAz9jeF4iUcPmIc=; b=gs/uhjGMpTQrqNlctWe96Iar03s+FRTHBkSA9/qxXdON6ruuedLDtbhAk6lB63tY5p5pKQ 5vDiBH6J8mq4BXIZ4g8H4AtekJV6OjWsYJW4w3tFvjrdpLIAzCml4hGAiMM2Ft7Bka1ng5 0PBoXCxYnUxq3hGdYMrwWiVHb+sOQdY= Received: from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-522-bGGZcq1dOl-4BKrDsjrMbA-1; Sun, 09 Mar 2025 04:35:54 -0400 X-MC-Unique: bGGZcq1dOl-4BKrDsjrMbA-1 X-Mimecast-MFC-AGG-ID: bGGZcq1dOl-4BKrDsjrMbA_1741509353 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-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 68A2D180035E; Sun, 9 Mar 2025 08:35:53 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.64.4]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 4736419560AB; Sun, 9 Mar 2025 08:35:51 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Markus Armbruster , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Michael Roth , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Eric Blake , Thomas Huth , =?UTF-8?q?Alex=20Benn=C3=A9e?= , Peter Maydell , John Snow Subject: [PATCH v2 00/62] docs: Add new QAPI transmogrifier Date: Sun, 9 Mar 2025 04:34:47 -0400 Message-ID: <20250309083550.5155-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.40 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_H2=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 This series is a "minimum viable" version of the new QAPI documentation=0D system. It does the bare minimum under the new framework, saving nice=0D features for later.=0D =0D Patches 3-31 implement the qapi_domain extension.=0D Patches 32-59 implement the qapidoc "Transmogrifier".=0D =0D Known shortcomings in this series:=0D =0D - Some ifcond information is still not displayed.=0D - No QAPI namespace support ... yet. So we can't enable it for QMP, QGA=0D and QSD simultaneously just yet. It's nearly complete.=0D - Didn't finish addressing all of Markus' feedback, but needed to get=0D another spin out on the list ASAP.=0D =0D v2:=0D =0D - Did you know that my computer just shut off the moment I started=0D sending the patchset? Just a hard off. Wow!=0D - Refactored QAPIObject class so that QAPIModule uses more of=0D Sphinx's ObjectDescription class, which means less fooling around with=0D re-parsing Sphinx standard options.=0D - Removed test document, flipped switch on the real QMP manual.=0D - Undocumented members have been re-added. I think that's new for this vers= ion!=0D - Removed some inliner branch code that snuck into the "validate info=0D fields" patch.=0D - Lots of Markus' feedback, and misc changes.=0D =0D "v1":=0D =0D - @foo is processed into ``foo`=0D - "The members of ..." messages have been temporarily re-added until we=0D can smooth over the inliner.=0D - This series runs under Sphinx 3.4.3 to Sphinx 8.2.0 inclusive. It=0D truly is a Christmas miracle. (please clap)=0D - This series now fully type checks and lint checks under Sphinx 8.2.0,=0D but may not type check under earlier Sphinx versions. Achieving this=0D alone, nevermind in conjunction with the above, was a literal=0D herculean labor.=0D =0D John Snow (62):=0D do-not-merge=0D qapi: shush pylint up=0D docs/sphinx: create QAPI domain extension stub=0D docs/sphinx: add compat.py module and nested_parse helper=0D docs/qapi-domain: add QAPI domain object registry=0D docs/qapi-domain: add QAPI index=0D docs/qapi-domain: add resolve_any_xref()=0D docs/qapi-domain: add QAPI xref roles=0D docs/qapi-domain: add compatibility node classes=0D docs/qapi-domain: Add ObjectDescription abstract class=0D docs/qapi-domain: add qapi:module directive=0D docs/qapi-domain: add QAPIObject class=0D docs/qapi-domain: add qapi:command directive=0D docs/qapi-domain: add :since: directive option=0D docs/qapi-domain: add "Arguments:" field lists=0D docs/qapi-domain: add "Features:" field lists=0D docs/qapi-domain: add "Errors:" field lists=0D docs/qapi-domain: add "Return:" field lists=0D docs/qapi-domain: add qapi:enum directive=0D docs/qapi-domain: add qapi:alternate directive=0D docs/qapi-domain: add qapi:event directive=0D docs/qapi-domain: add qapi:object directive=0D docs/qapi-domain: add :deprecated: directive option=0D docs/qapi-domain: add :unstable: directive option=0D docs/qapi-domain: add :ifcond: directive option=0D docs/qapi-domain: add warnings for malformed field lists=0D docs/qapi-domain: add type cross-refs to field lists=0D docs/qapi-domain: add CSS styling=0D docs/qapi-domain: add XREF compatibility goop for Sphinx < 4.1=0D docs/qapi-domain: warn when QAPI domain xrefs fail to resolve=0D docs/qapi-domain: Fix error context reporting in Sphinx 5.x and 6.x=0D qapi/parser: adjust info location for doc body section=0D qapi: expand tags to all doc sections=0D qapi/schema: add __repr__ to QAPIDoc.Section=0D docs/qapidoc: add transmogrifier stub=0D docs/qapidoc: split old implementation into qapidoc_legacy.py=0D docs/qapidoc: Fix static typing on qapidoc.py=0D do-not-merge=0D docs/qapidoc: add transmogrifier class stub=0D docs/qapidoc: add visit_module() method=0D qapi/source: allow multi-line QAPISourceInfo advancing=0D docs/qapidoc: add visit_freeform() method=0D docs/qapidoc: add preamble() method=0D docs/qapidoc: add visit_paragraph() method=0D docs/qapidoc: add visit_errors() method=0D docs/qapidoc: add format_type() method=0D docs/qapidoc: add add_field() and generate_field() helper methods=0D docs/qapidoc: add visit_feature() method=0D docs/qapidoc: prepare to record entity being transmogrified=0D docs/qapidoc: add visit_returns() method=0D docs/qapidoc: add visit_member() method=0D docs/qapidoc: add visit_sections() method=0D docs/qapidoc: add visit_entity()=0D docs/qapidoc: implement transmogrify() method=0D docs/qapidoc: process @foo into ``foo``=0D docs/qapidoc: add intermediate output debugger=0D docs/qapidoc: Add "the members of" pointers=0D docs/qapidoc: generate entries for undocumented members=0D qapi/parser: add undocumented stub members to all_sections=0D docs: disambiguate cross-references=0D docs: enable qapidoc transmogrifier for QEMU QMP Reference=0D docs: add qapi-domain syntax documentation=0D =0D docs/conf.py | 18 +-=0D docs/devel/codebase.rst | 6 +-=0D docs/devel/index-build.rst | 1 +=0D docs/devel/qapi-domain.rst | 670 +++++++++++++++++=0D docs/glossary.rst | 10 +-=0D docs/interop/qemu-qmp-ref.rst | 1 +=0D docs/sphinx-static/theme_overrides.css | 98 ++-=0D docs/sphinx/compat.py | 230 ++++++=0D docs/sphinx/qapi_domain.py | 926 ++++++++++++++++++++++++=0D docs/sphinx/qapidoc.py | 948 ++++++++++++++-----------=0D docs/sphinx/qapidoc_legacy.py | 440 ++++++++++++=0D qapi/qapi-schema.json | 2 +=0D scripts/qapi-lint.sh | 57 ++=0D scripts/qapi/backend.py | 2 +=0D scripts/qapi/main.py | 8 +-=0D scripts/qapi/parser.py | 121 +++-=0D scripts/qapi/source.py | 4 +-=0D tests/qapi-schema/doc-good.out | 10 +-=0D tests/qapi-schema/test-qapi.py | 2 +-=0D 19 files changed, 3069 insertions(+), 485 deletions(-)=0D create mode 100644 docs/devel/qapi-domain.rst=0D create mode 100644 docs/sphinx/compat.py=0D create mode 100644 docs/sphinx/qapi_domain.py=0D create mode 100644 docs/sphinx/qapidoc_legacy.py=0D create mode 100755 scripts/qapi-lint.sh=0D =0D -- =0D 2.48.1=0D =0D