git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: "Martin Ågren" <martin.agren@gmail.com>
To: Jeff King <peff@peff.net>
Cc: Git Mailing List <git@vger.kernel.org>, Taylor Blau <me@ttaylorr.com>
Subject: Re: [PATCH] list-objects-filter-options: fix function name in BUG
Date: Tue, 17 Nov 2020 19:02:19 +0100	[thread overview]
Message-ID: <CAN0heSoGnAKjTz2tiHpe2==Y-w7M03eiEpW2hU67FRbv=G+H8w@mail.gmail.com> (raw)
In-Reply-To: <20201117021318.GA30463@coredump.intra.peff.net>

On Tue, 17 Nov 2020 at 03:13, Jeff King <peff@peff.net> wrote:
>
> On Sat, Nov 14, 2020 at 09:43:26AM +0100, Martin Ågren wrote:
>
> > Fix the function name we give in the BUG message. It's "config", not
> > "choice".
>
> Yep, obviously an improvement.
>
> But as a general rule, I don't think we even need to include function
> names here. The message would look like:
>
>   BUG: list-objects-filter-options.c:20: list_object_filter_choice_name: invalid argument '3'
>
> which already tells us where the code is[1]. Perhaps:
>
>   BUG("invalid filter choice enum: %d", c);
>
> would be shorter but equally informative (I don't overly care here,
> since the idea is that nobody sees it, but just making a point about the
> future).

Having the function name or something else making the string unique
across the codebase could be useful if the compiler doesn't support
variadic macros -- we'll fall back to using a function instead of a
macro, and can't use __FILE__ and __LINE__. (You obviously know all of
this, having written d8193743e0 ("usage.c: add BUG() function",
2017-05-12).)

Now, this here BUG shouldn't be a "freak" bug which happens to trigger
under very special circumstances, and where it's not even clear which of
25 equal BUG messages it is that we're seeing. If you add a new enum
value and forget to add a case in this function, you should hit this BUG
quite quickly and very reliably.

All of that said, "don't overly care" also matches my feeling pretty
well.

Martin

  reply	other threads:[~2020-11-17 18:04 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-14  8:43 Martin Ågren
2020-11-17  2:13 ` Jeff King
2020-11-17 18:02   ` Martin Ågren [this message]
2020-11-17 22:54     ` Jeff King
2020-11-17 23:07       ` Eric Sunshine
2020-11-18  2:08         ` Jeff King
2020-11-18  2:24       ` Jonathan Nieder
2020-11-18  6:22       ` Martin Ågren

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: http://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to='CAN0heSoGnAKjTz2tiHpe2==Y-w7M03eiEpW2hU67FRbv=G+H8w@mail.gmail.com' \
    --to=martin.agren@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=me@ttaylorr.com \
    --cc=peff@peff.net \
    /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.
Code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

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).