syntax-check: Suggest ways to fix internal references

[PATCH] syntax-check: Suggest ways to fix internal references

Andrea Bolognani posted 1 patch 1 year, 2 months ago

Download mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20241113215439.380204-1-abologna@redhat.com

build-aux/syntax-check.mk | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

Expand all Fold all

[PATCH] syntax-check: Suggest ways to fix internal references

Posted by Andrea Bolognani 1 year, 2 months ago

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>
---
 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='<#' \
 	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
-- 
2.47.0

Re: [PATCH] syntax-check: Suggest ways to fix internal references

Posted by Peter Krempa 1 year, 2 months ago

On Wed, Nov 13, 2024 at 22:54:39 +0100, Andrea Bolognani wrote:
> 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>
> ---
>  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='<#' \
>  	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

Reviewed-by: Peter Krempa <pkrempa@redhat.com>