From: Andrea Bolognani <abologna@redhat.com>
Date: Wed, 13 Nov 2024 21:51:35 +0000 (+0100)
Subject: syntax-check: Suggest ways to fix internal references
X-Git-Tag: v10.10.0-rc1~141
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fde04774dbfd76416838207569de783574e7d9b1;p=thirdparty%2Flibvirt.git

syntax-check: Suggest ways to fix internal references

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 <abologna@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
---

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='<#' \
 	in_vc_files='\.rst$$' \
-	halt='use local reference within a file' \
+	halt='use `section`_ or `here <section_>`__ instead of `here <#section>`__' \
 	  $(_sc_search_regexp)
 
 # This Perl code is slightly obfuscated.  Not only is each "$" doubled