Git development
 help / color / mirror / Atom feed
From: "Philip Oakley" <philipoakley@iee.org>
To: "Junio C Hamano" <gitster@pobox.com>,
	"Eric Sunshine" <sunshine@sunshineco.com>
Cc: "David Turner" <dturner@twopensource.com>,
	"Git List" <git@vger.kernel.org>,
	"David Turner" <dturner@twitter.com>
Subject: Re: [PATCH 2/3] sha1_name: get_sha1_with_context learns to follow symlinks
Date: Fri, 8 May 2015 21:38:06 +0100	[thread overview]
Message-ID: <BB246DF6A6DA4735B0B627F5555CB803@PhilipOakley> (raw)
In-Reply-To: CAPc5daXmJSfdB_eyQ5ppVp2NhYGZvPChGAyn4p2hEde=4x9EEQ@mail.gmail.com

From: "Junio C Hamano" <gitster@pobox.com>
> On Fri, May 8, 2015 at 12:45 PM, Eric Sunshine 
> <sunshine@sunshineco.com> wrote:
>>> +       if (flags & GET_SHA1_FOLLOW_SYMLINKS && flags & 
>>> GET_SHA1_ONLY_TO_DIE)
>>> +               die(_("internal error: bad flags for 
>>> get_sha1_with_context"));
>>
>> There may not be much value in marking an "internal error" string for
>> translation.
>
> The whole point of this kind of messages is so that the end users,
> when they see it trigger, can notify us and then to allow us to
> identify which die() triggered.  It is not just "may not be much
> value in", but is actively unproductive to make it translatable,
> even if we ignore the cost to i18n/l10n teams to translate such
> messages.
>
> By the way, we would want to standardise the string before the
> colon, so that we can tell users "If you see an error message that
> begins with 'internal error:', please report that to us---it is a
> programming error".  I think the majority of existing code uses the
> string "BUG:" for that, and I do not mind using 'internal error:'
> for that purpose instead, but the important thing is to use just one
> single string thoughout the codebase, so that the "please report
> when you see this" message we give the users can be simple.
>
I would see "BUG:" as being internationally recognised, while "internal 
error:" would need to be translated, and perhaps be written "internal 
error, report this to git@vger.kernel.org:" to ensure that the reader 
knows immediately what to do.
--
Philip 

  parent reply	other threads:[~2015-05-08 20:47 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-08 18:13 [PATCH 1/3] tree-walk: learn get_tree_enty_follow_symlinks dturner
2015-05-08 18:13 ` [PATCH 2/3] sha1_name: get_sha1_with_context learns to follow symlinks dturner
2015-05-08 19:45   ` Eric Sunshine
2015-05-08 20:17     ` Junio C Hamano
2015-05-08 20:25       ` Junio C Hamano
2015-05-08 20:39         ` Jeff King
2015-05-08 21:22           ` Junio C Hamano
2015-05-08 20:27       ` David Turner
2015-05-08 20:38       ` Philip Oakley [this message]
2015-05-08 21:31   ` Junio C Hamano
2015-05-08 18:13 ` [PATCH 3/3] cat-file: add --follow-symlinks to --batch dturner
2015-05-08 19:51   ` Eric Sunshine
2015-05-08 19:26 ` [PATCH 1/3] tree-walk: learn get_tree_enty_follow_symlinks Junio C Hamano
2015-05-08 20:02   ` David Turner
2015-05-08 19:43 ` Eric Sunshine
  -- strict thread matches above, loose matches on Subject: below --
2015-05-13 18:21 [PATCH v8 0/3] git cat-file --follow-symlinks David Turner
2015-05-13 18:21 ` [PATCH 2/3] sha1_name: get_sha1_with_context learns to follow symlinks David Turner
2015-05-13 18:23 [PATCH v9 0/3] David Turner
2015-05-13 18:23 ` [PATCH 2/3] sha1_name: get_sha1_with_context learns to follow symlinks David Turner
2015-05-14 20:17 [PATCH v10 0/3] David Turner
2015-05-14 20:17 ` [PATCH 2/3] sha1_name: get_sha1_with_context learns to follow symlinks David Turner
2015-05-14 20:38 [PATCH v11 0/3] cat-file --follow-symlinks David Turner
2015-05-14 20:38 ` [PATCH 2/3] sha1_name: get_sha1_with_context learns to follow symlinks David Turner
2015-05-14 21:58 [PATCH v12 0/3] git cat-file --follow-symlinks David Turner
2015-05-14 21:58 ` [PATCH 2/3] sha1_name: get_sha1_with_context learns to follow symlinks David Turner

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

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

  git send-email \
    --in-reply-to=BB246DF6A6DA4735B0B627F5555CB803@PhilipOakley \
    --to=philipoakley@iee.org \
    --cc=dturner@twitter.com \
    --cc=dturner@twopensource.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=sunshine@sunshineco.com \
    /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