From: Peter Krempa <pkrempa@redhat.com>
Date: Tue, 31 May 2022 07:50:58 +0000 (+0200)
Subject: syntax-check: Add check prohibiting remote reference to local file
X-Git-Tag: v8.5.0-rc1~234
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f50cfd9987c3a4712dcc3bbf44a067951cf18bf2;p=thirdparty%2Flibvirt.git

syntax-check: Add check prohibiting remote reference to local file

Within a file we should use the internal reference syntax.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
---

diff --git a/build-aux/syntax-check.mk b/build-aux/syntax-check.mk
index e8f9a91cee..649eb91acb 100644
--- a/build-aux/syntax-check.mk
+++ b/build-aux/syntax-check.mk
@@ -1087,6 +1087,13 @@ sc_prohibit_backup_files:
 	  { echo 'found version controlled backup file' 1>&2; \
 	    exit 1; } || :
 
+# prohibit remote references to local file in RST files
+sc_avoid_remote_reference_to_local_file:
+	@prohibit='<#' \
+	in_vc_files='\.rst$$' \
+	halt='use local reference within a file' \
+	  $(_sc_search_regexp)
+
 # This Perl code is slightly obfuscated.  Not only is each "$" doubled
 # because it's in a Makefile, but the $$c's are comments;  we cannot
 # use "#" due to the way the script ends up concatenated onto one line.