From: Eric Sunshine <sunshine@sunshineco.com>
Date: Wed, 29 Jun 2016 18:12:11 GMT
Subject: Re: [PATCH 1/9] Report bugs consistently
Message-ID: <CAPig+cSHy=2VaNP5gpwqKN4vuCBrOUy39L0i9xcda8m3zx+GPA@mail.gmail.com>
In-Reply-To: <8615dc276828a3f99a27ff2eda9909548a7d435e.1467199553.git.johannes.schindelin@gmx.de>

On Wed, Jun 29, 2016 at 7:36 AM, Johannes Schindelin
<johannes.schindelin@gmx.de> wrote:
> The vast majority of error messages in Git's source code which report a
> bug use the convention to prefix the message with "BUG:".
> [...]
> Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
> ---
> diff --git a/merge-recursive.c b/merge-recursive.c
> @@ -1853,7 +1852,7 @@ int merge_trees(struct merge_options *o,
> -                               die(_("Unprocessed path??? %s"),
> +                               die(_("BUG: unprocessed path??? %s"),

This and others downcase the first word (which is consistent with
modern practice)...

> diff --git a/sha1_file.c b/sha1_file.c
> @@ -795,7 +795,7 @@ void close_all_packs(void)
> -                       die("BUG! Want to close pack marked 'do-not-close'");
> +                       die("BUG: Want to close pack marked 'do-not-close'");

...but this one neglects to.