list-objects-filter-options: fix function name in BUG
PATCH 1/1 list-objects-filter-options: fix function name in BUG
Fix the function name we give in the BUG message. It's "config", not "choice".
--- list-objects-filter-options.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
list-objects-filter-options.c +1 -1
@@ -35,7 +35,7 @@ const char *list_object_filter_config_name(enum list_objects_filter_choice c)/* not a real filter type; just the count of all filters */ break ; } -BUG ("list_object_filter_choice_name: invalid argument '%d'" , c); +BUG ("list_object_filter_config_name: invalid argument '%d'" , c); }/*
Signature · 1 line
2.29.2.454.gaff20da3a2
Quoted 2 lines · Martin Ågren
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).
-Peff
[1] Obviously it doesn't include the actual function name, though we could do so on many platforms by using __FUNCTION__. I tend to think it would make the messages overly long, but again, the hope is that nobody ever sees these.
Quoted 13 lines · Jeff King
Quoted 2 lines · Martin Ågren
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'
Quoted 7 lines
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
Quoted 13 lines · Martin Ågren
Quoted 5 lines
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'Quoted 7 lines
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).
Quoted 6 lines
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 writtend8193743e0("usage.c: addBUG()function", 2017-05-12).)
My feeling is that we shouldn't care too much about platforms without variadic macros. AFAIK they are an extreme minority at this point, if they exist at all. We are being nice by making Git compile at all on such platforms, but I don't want people doing normal development work (like writing trace or bug calls) to have to be thinking too much about it.
I actually wonder if it is time to drop HAVE_VARIADIC_MACROS completely. They are in C99, and we have been introducing many other C99-isms. It would be a minor cleanup to a few bits of code, which perhaps isn't worth the risk. But I also have a vague memory of not being able to implement some interfaces because we couldn't count on them.
Poking around, 3689539127 (add helpers for allocating flex-array structs, 2016-02-22) points out one such case. I think discussion of BUG_ON() got blocked by that, too. Looks like we also discussed them in the big "C99 weather balloon" thread:
https://lore.kernel.org/git/[email protected]/
Maybe it's time for something like this as a test:
git-compat-util.h +0 -5
@@ -1194,14 +1194,9 @@ static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,/* usage.c: only to be used for testing BUG() implementation (see test-tool) */ extern int BUG_exit_code; -#ifdef HAVE_VARIADIC_MACROS __attribute__((format (printf,3 ,4 )))NORETURN void BUG_fl(const char *file, int line, const char *fmt, ...);#define BUG (...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__) -#else -__attribute__((format (printf,1 ,2 )))NORETURN -void BUG(const char *fmt, ...); -#endif /* * Preserves errno, prints a message, but gives no warning for ENOENT.
usage.c +0 -10
@@ -273,23 +273,13 @@ static NORETURN void BUG_vfl(const char *file, int line, const char *fmt, va_lisabort (); } -#ifdef HAVE_VARIADIC_MACROS NORETURN void BUG_fl(const char *file, int line, const char *fmt, ...) {va_list ap;va_start (ap, fmt);BUG_vfl (file, line, fmt, ap);va_end (ap); } -#else -NORETURN void BUG(const char *fmt, ...) -{ -va_list ap; -va_start (ap, fmt); -BUG_vfl (NULL ,0 , fmt, ap); -va_end (ap); -} -#endif #ifdef SUPPRESS_ANNOTATED_LEAKS void unleak_memory (const void *ptr,size_t len)
Quoted 10 lines · Jeff King
I actually wonder if it is time to drop
HAVE_VARIADIC_MACROScompletely. They are in C99, and we have been introducing many other C99-isms. It would be a minor cleanup to a few bits of code, which perhaps isn't worth the risk. But I also have a vague memory of not being able to implement some interfaces because we couldn't count on them.Poking around, 3689539127 (add helpers for allocating flex-array structs, 2016-02-22) points out one such case. I think discussion of
BUG_ON()got blocked by that, too. Looks like we also discussed them in the big "C99 weather balloon" thread:
There was also an idea[1] to use variadic macros to prevent errno from being clobbered in a case like this:
die_errno(_("blah %s"), foobar());In which, if foobar() changes errno, then die_errno() reports the wrong value.
[1]: https://lore.kernel.org/git/CAPig+cQKMxwadf9aGyC5ESa-vxDy9PzrYo+m+JaVQ3S=12PyQQ@mail.gmail.com/
Quoted 12 lines · Eric Sunshine
Quoted 10 lines · Jeff King
I actually wonder if it is time to drop
HAVE_VARIADIC_MACROScompletely. They are in C99, and we have been introducing many other C99-isms. It would be a minor cleanup to a few bits of code, which perhaps isn't worth the risk. But I also have a vague memory of not being able to implement some interfaces because we couldn't count on them.Poking around, 3689539127 (add helpers for allocating flex-array structs, 2016-02-22) points out one such case. I think discussion of
BUG_ON()got blocked by that, too. Looks like we also discussed them in the big "C99 weather balloon" thread:
Quoted 8 lines
There was also an idea[1] to use variadic macros to prevent
errnofrom being clobbered in a case like this:die_errno(_("blah %s"), foobar());In which, if
foobar()changeserrno, thendie_errno()reports the wrong value.[1]: https://lore.kernel.org/git/CAPig+cQKMxwadf9aGyC5ESa-vxDy9PzrYo+m+JaVQ3S=12PyQQ@mail.gmail.com/
Thanks, that's another good example. This _could_ be done conditionally on HAVE_VARIADIC_MACROS, but it would mean on the non-variadic platform that they'd see the wrong errno. I'm willing to give them worse BUG() messages, but that may be going too far. :)
I still suspect there may be zero such platforms, which would mean nobody is affected. But if that is the case, then we should just say so and get rid of the HAVE_VARIADIC_MACROS flag entirely.
-Peff
Jonathan Nieder
Reviewed-byQuoted 6 lines · Jeff King
I actually wonder if it is time to drop
HAVE_VARIADIC_MACROScompletely. They are in C99, and we have been introducing many other C99-isms. It would be a minor cleanup to a few bits of code, which perhaps isn't worth the risk. But I also have a vague memory of not being able to implement some interfaces because we couldn't count on them.
Quoted 8 lines
Poking around, 3689539127 (add helpers for allocating flex-array structs, 2016-02-22) points out one such case. I think discussion of
BUG_ON()got blocked by that, too. Looks like we also discussed them in the big "C99 weather balloon" thread:https://lore.kernel.org/git/[email protected]/
Maybe it's time for something like this as a test:
Yes. For what it's worth,
Want to re-send with a signoff?
Thanks,
Jonathan
Quoted 47 lines
git-compat-util.h +0
-5@@ -1194,14 +1194,9 @@ static inline int regexec_buf(const regex_t *preg, const char *buf, size_t size,/* usage.c: only to be used for testing BUG() implementation (see test-tool) */ extern int BUG_exit_code; -#ifdef HAVE_VARIADIC_MACROS __attribute__((format (printf,3 ,4 )))NORETURN void BUG_fl(const char *file, int line, const char *fmt, ...);#define BUG (...) BUG_fl(__FILE__, __LINE__, __VA_ARGS__) -#else -__attribute__((format (printf,1 ,2 )))NORETURN -void BUG(const char *fmt, ...); -#endif /* * Preserves errno, prints a message, but gives no warning for ENOENT. usage.c +0
-10@@ -273,23 +273,13 @@ static NORETURN void BUG_vfl(const char *file, int line, const char *fmt, va_lisabort (); } -#ifdef HAVE_VARIADIC_MACROS NORETURN void BUG_fl(const char *file, int line, const char *fmt, ...) {va_list ap;va_start (ap, fmt);BUG_vfl (file, line, fmt, ap);va_end (ap); } -#else -NORETURN void BUG(const char *fmt, ...) -{ -va_list ap; -va_start (ap, fmt); -BUG_vfl (NULL ,0 , fmt, ap); -va_end (ap); -} -#endif #ifdef SUPPRESS_ANNOTATED_LEAKS void unleak_memory (const void *ptr,size_t len)
Quoted 7 lines · Jeff King
I actually wonder if it is time to drop
HAVE_VARIADIC_MACROScompletely. They are in C99, and we have been introducing many other C99-isms. It would be a minor cleanup to a few bits of code, which perhaps isn't worth the risk. But I also have a vague memory of not being able to implement some interfaces because we couldn't count on them.
Quoted 6 lines
Poking around, 3689539127 (add helpers for allocating flex-array structs, 2016-02-22) points out one such case. I think discussion of
BUG_ON()got blocked by that, too. Looks like we also discussed them in the big "C99 weather balloon" thread:
Ok, that all makes sense.
Quoted 1 line
Maybe it's time for something like this as a test:
I had a vague memory that for some weather balloons, we would add a comment like "please let us know if you trip on this; for your own sake, don't just patch it locally." But maybe that was just for, e.g., 01d3a526ad ("t0000: check whether the shell supports the "local" keyword", 2017-10-26), where we add a test, and a single failing test might otherwise be easy to ignore.
Which is different to what would happen if every file including git-compat-util.h and/or each invocation of BUG() would make the compiler complain.
All in all, this diff makes sense.
Martin