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 DD6ADC28B28 for ; Thu, 13 Mar 2025 06:48:02 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tscME-0003Ri-1K; Thu, 13 Mar 2025 02:47:54 -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 1tscM9-0003Px-Qo for qemu-devel@nongnu.org; Thu, 13 Mar 2025 02:47:49 -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 1tscM8-0004S0-3J for qemu-devel@nongnu.org; Thu, 13 Mar 2025 02:47:49 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741848465; 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: in-reply-to:in-reply-to:references:references; bh=1Tnktz1iVRtmu2EDZLTdo7spKQooIuMwe4EiiwygAUU=; b=VJniv6WiUyKY3nduql4Ehcv6dEiiu7zVTRoeBjSWisu5RUeEuqDz1XRHkjc0L+IPyLA/qn TzeOgXHbsIwU3E8KZffQkwV/zY/Eg8ziQkH6H3auhn5qemqv+naBZgGuLZxq/mEQicNsvl U9Nnohx3OvvO0p2qfyrKLHWlfQ+cU18= 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-679-FQXykbbgOkS5u0crNJcfOQ-1; Thu, 13 Mar 2025 02:47:41 -0400 X-MC-Unique: FQXykbbgOkS5u0crNJcfOQ-1 X-Mimecast-MFC-AGG-ID: FQXykbbgOkS5u0crNJcfOQ_1741848460 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 EB94B1956080; Thu, 13 Mar 2025 06:47:39 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.22.74.4]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 749AB1955BCB; Thu, 13 Mar 2025 06:47:39 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id C566A21E66C4; Thu, 13 Mar 2025 07:47:35 +0100 (CET) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Konstantin Kostiuk , Peter Maydell , Eric Blake , qemu-block@nongnu.org, Michael Roth , Kevin Wolf Subject: Re: [PATCH 07/11] docs/qapi_domain: add namespace support to cross-references In-Reply-To: <20250313044312.189276-8-jsnow@redhat.com> (John Snow's message of "Thu, 13 Mar 2025 00:43:08 -0400") References: <20250313044312.189276-1-jsnow@redhat.com> <20250313044312.189276-8-jsnow@redhat.com> Date: Thu, 13 Mar 2025 07:47:35 +0100 Message-ID: <8734fhe8ag.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@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_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_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 John Snow writes: > This patch does three things: > > 1. Record the current namespace context in pending_xrefs so it can be > used for link resolution later, > 2. Pass that recorded namespace context to find_obj() when resolving a > reference, and > 3. Wildly and completely rewrite find_obj(). > > cross-reference support is expanded to tolerate the presence or absence > of either namespace or module, and to cope with the presence or absence > of contextual information for either. > > References now work like this: > > 1. If the explicit reference target is recorded in the domain's object > registry, we link to that target and stop looking. We do this lookup > regardless of how fully qualified the target is, which allows direct > references to modules (which don't have a module component to their > names) or direct references to definitions that may or may not belong > to a namespace or module. > > 2. If contextual information is available from qapi:namespace or > qapi:module directives, try using those components to find a direct > match to the implied target name. > > 3. If both prior lookups fail, generate a series of regular expressions > looking for wildcard matches in order from most to least > specific. Any explicitly provided components (namespace, module) > *must* match exactly, but both contextual and entirely omitted > components are allowed to differ from the search result. Note that if > more than one result is found, Sphinx will emit a warning (a build > error for QEMU) and list all of the candidate references. > > The practical upshot is that in the large majority of cases, namespace > and module information is not required when creating simple `references` > to definitions from within the same context -- even when identical > definitions exist in other contexts. Can you illustrate this this examples? > Even when using simple `references` from elsewhere in the QEMU > documentation manual, explicit namespace info is not required if there > is only one definition by that name. Fails safely: if we add a second definition, doc generation errors out. Correct? > Disambiguation *will* be required from outside of the QAPI documentation > when referencing e.g. block-core definitions, which are shared between > QEMU QMP and the QEMU Storage Daemon. In that case, there are two > options: > > A: References can be made partially or fully explicit, > e.g. `QMP:block-dirty-bitmap-add` will link to the QEMU version of > the definition, while `QGA:block-dirty-bitmap-add` would link to the > QGA version. Do you mean "QSD:"? > B: If all of the references in a document are intended to go to the same > place, you can insert a "qapi:namespace:: QMP" directive to influence > the fuzzy-searching for later references. > > Signed-off-by: John Snow