bug-gnulib@gnu.org mirror (unofficial)
 help / color / mirror / Atom feed
From: Jim Meyering <jim@meyering.net>
To: Simon Josefsson <simon@josefsson.org>
Cc: Bruno Haible <bruno@clisp.org>,
	bug-gnulib@gnu.org,  Collin Funk <collin.funk1@gmail.com>
Subject: Re: syntax-check rule to silence -Winclude-next-absolute-path warning
Date: Mon, 19 Feb 2024 12:39:08 -0800	[thread overview]
Message-ID: <CA+8g5KHDn2GisqhB_wvZT5RmkWTUrhMo+8iJqDW0Bv5xBJD9WQ@mail.gmail.com> (raw)
In-Reply-To: <87y1bg4zc0.fsf@kaka.sjd.se>

On Mon, Feb 19, 2024 at 12:45 AM Simon Josefsson <simon@josefsson.org> wrote:
> 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.

Hi Simon, I like both ideas.


  reply	other threads:[~2024-02-19 20:39 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-17  8:36 [PATCH] math: Silence -Winclude-next-absolute-path warning Collin Funk
2024-02-17 10:51 ` Bruno Haible
2024-02-17 12:26   ` Collin Funk
2024-02-17 13:17     ` Bruno Haible
2024-02-18 12:19     ` Bruno Haible
2024-02-18 12:44       ` syntax-check rule to silence " Bruno Haible
2024-02-18 20:12         ` Collin Funk
2024-02-18 20:33           ` Bruno Haible
2024-02-19  5:02             ` Jim Meyering
2024-02-19 18:11               ` Collin Funk
2024-02-19 18:32                 ` Jim Meyering
2024-02-19  8:45             ` Simon Josefsson via Gnulib discussion list
2024-02-19 20:39               ` Jim Meyering [this message]
2024-02-20 15:17               ` Bruno Haible
2024-02-20 20:23         ` Collin Funk
2024-02-20 20:49           ` Bruno Haible
2024-02-19  6:31       ` [PATCH] math: Silence " Paul Eggert
2024-02-19 11:03         ` Bruno Haible
2024-02-19 20:41           ` Paul Eggert
2024-02-19 21:24             ` Bruno Haible
2024-02-19 21:45               ` Paul Eggert

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://lists.gnu.org/mailman/listinfo/bug-gnulib

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CA+8g5KHDn2GisqhB_wvZT5RmkWTUrhMo+8iJqDW0Bv5xBJD9WQ@mail.gmail.com \
    --to=jim@meyering.net \
    --cc=bruno@clisp.org \
    --cc=bug-gnulib@gnu.org \
    --cc=collin.funk1@gmail.com \
    --cc=simon@josefsson.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).