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 6ed2a61192e739d22b6ccfd89fb7d33c1af320a3..2c9593c28f302e3fba7d4e8635319e42d4c5e306 100644 (file)
--- 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