Re: syntax-check rule to silence -Winclude-next-absolute-path warning

[Simon Josefsson via Gnulib discussion list <bug-gnulib@gnu.org>]

[-- Attachment #1: Type: text/plain, Size: 1199 bytes --]

Bruno Haible <bruno@clisp.org> writes:

> --- a/top/maint.mk
> +++ b/top/maint.mk
> @@ -503,6 +503,7 @@ sc_prohibit_have_config_h:
>  # Nearly all .c files must include <config.h>.  However, we also permit this
>  # via inclusion of a package-specific header, if cfg.mk specified one.
>  # config_h_header must be suitable for grep -E.
> +# Rationale: The Gnulib documentation, node 'Include <config.h>'.

Having a way to learn the rationale for a syntax-check is a really good
idea!  There are some checks that I struggle to understand the point of,
and one that I simply disagree with (sc_prohibit_strcmp).  Having a link
to discussion helps to determine how to deal with errors.

What do you think about:

   1) using a URL to the gnulib online manual instead?  For most users,
      that allows easier lookup, and for people who are really offline,
      the URL contains sufficient detail to find the relevant in the
      manual, and

   2) print the rationale link as part of the error message instead of a
      comment in the code

?

I think 'make syntax-check' is one of the powerful and under-appreciated
aspects of gnulib, so improving its usability can help make it more
used.

/Simon

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 255 bytes --]