From nobody Tue Jan 28 23:52:39 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1734052744; cv=none; d=zohomail.com; s=zohoarc; b=JDZFdiAacFHkMWcrsq2GE2fE5LPQFQxtBnehbHnMnxToAKnrPLqWfzGYvY368ElxK4ezQXSca1d/nskANMdwMs9rlNRcW/zGCB/NFJcXHuYoO4NZhp2Nwa5SfG05jmX82pW+AImXnf90y6fUfwqD4y6d8SW5rvX/jLFdpM1i2rY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1734052744; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=oIVykYglNzfjCvyW2Izk/HQ4KymL73UyLf8Jai2qlWs=; b=gi0weG1q2DensYtq5PEyWIqu74NODUYXBfzyMlJtYxDZa6gtlXFNT1LAEDDHYrl9k3srw2gw25LXDBF3D8PqEBn6yDgjzvndKugHBkwZUyN7mIaZ5APK/j2MZAjZb8MOJHK+qaXYQh59EBD+6Bl2ZetLcZxnf+/OX6U6+zzEYhU= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1734052743990663.170273458945; Thu, 12 Dec 2024 17:19:03 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLuH1-0000ZM-G3; Thu, 12 Dec 2024 20:15:19 -0500 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 1tLuGz-0000Ly-L5 for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:15:17 -0500 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 1tLuGt-0000uk-H5 for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:15:17 -0500 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-563-9HjEOfLnOqSLob7q2p_gfg-1; Thu, 12 Dec 2024 20:15:05 -0500 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (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 5E28119560BD; Fri, 13 Dec 2024 01:15:04 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.88.22]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id B6E851956086; Fri, 13 Dec 2024 01:14:59 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734052508; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=oIVykYglNzfjCvyW2Izk/HQ4KymL73UyLf8Jai2qlWs=; b=W/R60TUaWtGDqZCSAQv6dAhNFwG7u3e5kL86snI77Q9+B6TxVcytvudkuPA386c8s/P2Hl xQmSibsMe/ClOC4s6OwTtgx1S7ubDpqPjYP+vDWDTMxAWT4dpTz1FhXuPe+t1HrtP1iz0L 2ZBXv08BjlPm+0oh0ncgJam/5U7VO4o= X-MC-Unique: 9HjEOfLnOqSLob7q2p_gfg-1 X-Mimecast-MFC-AGG-ID: 9HjEOfLnOqSLob7q2p_gfg From: John Snow To: qemu-devel@nongnu.org Cc: Michael Roth , Markus Armbruster , Peter Maydell , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Victor Toso de Carvalho , Paolo Bonzini , John Snow Subject: [RFC PATCH v2 29/35] docs/qapi-domain: warn when QAPI domain xrefs fail to resolve Date: Thu, 12 Dec 2024 20:12:58 -0500 Message-ID: <20241213011307.2942030-30-jsnow@redhat.com> In-Reply-To: <20241213011307.2942030-1-jsnow@redhat.com> References: <20241213011307.2942030-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; 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: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.496, 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1734052745993116600 Content-Type: text/plain; charset="utf-8" Ignore the built-in JSON doc types, but warn about anything else. This is primarily here to assert that the cross-referencing system is complete and accurate, and that any cross-references the transmogrifier generates are correctly marked as visible and rendered/indexed by the qapi-domain. Signed-off-by: John Snow --- docs/sphinx/qapi-domain.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py index 907ba6d27d3..8dbf0ee5e70 100644 --- a/docs/sphinx/qapi-domain.py +++ b/docs/sphinx/qapi-domain.py @@ -1060,6 +1060,16 @@ def resolve_xref( multiple_matches =3D len(matches) > 1 =20 if not matches: + if target not in ( + "string", + "number", + "int", + "boolean", + "null", + "value", + "q_empty", + ): + print(f"!QXREF: {type=3D} {target=3D}") return None elif multiple_matches: logger.warning( --=20 2.47.0