From nobody Wed Dec 4 08:07:36 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1731534904804159.11152642749414; Wed, 13 Nov 2024 13:55:04 -0800 (PST) Received: by lists.libvirt.org (Postfix, from userid 996) id B991A199D; Wed, 13 Nov 2024 16:55:03 -0500 (EST) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 595571981; Wed, 13 Nov 2024 16:54:49 -0500 (EST) Received: by lists.libvirt.org (Postfix, from userid 996) id C7F20171D; Wed, 13 Nov 2024 16:54:46 -0500 (EST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id AE6281454 for ; Wed, 13 Nov 2024 16:54:45 -0500 (EST) 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-576-uMVOQgRFOkCJXFbGxHIlKQ-1; Wed, 13 Nov 2024 16:54:44 -0500 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 43AA81956080 for ; Wed, 13 Nov 2024 21:54:43 +0000 (UTC) Received: from harajuku.usersys.redhat.com.homenet.telecomitalia.it (unknown [10.45.224.27]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 6ADED19560A3 for ; Wed, 13 Nov 2024 21:54:42 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_HELO_NONE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1731534885; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=6T79cnboB7nbcJ3rYSqACFXlXiUaYDw0u1K+zs6T+6Y=; b=RdwvqnFUDosINUVAE+GGpMwzP6l8CY41rGUy9goXFo2G/5sBY/QepGlzvz/YVj4ZC/pQpk rLNGLDjIU/yvZX1TTisNrNwmu0Xf9EbtU+D0RO923bg4ebUFiq2ZTBB629viwW1oyaYOjc +dXI5gEJWotRff1Si/AKIy0V9j+ES7g= X-MC-Unique: uMVOQgRFOkCJXFbGxHIlKQ-1 X-Mimecast-MFC-AGG-ID: uMVOQgRFOkCJXFbGxHIlKQ From: Andrea Bolognani To: devel@lists.libvirt.org Subject: [PATCH] syntax-check: Suggest ways to fix internal references Date: Wed, 13 Nov 2024 22:54:39 +0100 Message-ID: <20241113215439.380204-1-abologna@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: -_GDqFhZeCKiifaTaRrKIBkdD9sx5v02Bt5Z27TEE_E_1731534883 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: ZPQ5VPSEWF4LINIFIIGZHM4EZT2QT24S X-Message-ID-Hash: ZPQ5VPSEWF4LINIFIIGZHM4EZT2QT24S X-MailFrom: abologna@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1731534905141116600 Content-Type: text/plain; charset="utf-8"; x-default="true" The rule catches incorrect attempts to use internal references, but doesn't guide the developer hitting a failure towards the not exactly obvious acceptable alternatives. Signed-off-by: Andrea Bolognani Reviewed-by: Peter Krempa --- build-aux/syntax-check.mk | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build-aux/syntax-check.mk b/build-aux/syntax-check.mk index 6ed2a61192..2c9593c28f 100644 --- a/build-aux/syntax-check.mk +++ b/build-aux/syntax-check.mk @@ -1135,7 +1135,7 @@ sc_prohibit_backup_files: sc_avoid_remote_reference_to_local_file: @prohibit=3D'<#' \ in_vc_files=3D'\.rst$$' \ - halt=3D'use local reference within a file' \ + halt=3D'use `section`_ or `here `__ instead of `here <#section>= `__' \ $(_sc_search_regexp) =20 # This Perl code is slightly obfuscated. Not only is each "$" doubled --=20 2.47.0