From: Junio C Hamano <gitster@pobox.com>
To: Stefan Beller <sbeller@google.com>
Cc: Josh Steadmon <steadmon@google.com>,
Jonathan Tan <jonathantanmy@google.com>,
git <git@vger.kernel.org>, Jonathan Nieder <jrnieder@gmail.com>
Subject: Re* [PATCH v3 1/1] protocol: advertise multiple supported versions
Date: Tue, 13 Nov 2018 12:24:39 +0900 [thread overview]
Message-ID: <xmqqy39xwtfs.fsf_-_@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <CAGZ79kaPjw3UbYY=XL0gyKp2VxghwaUOJJoDhiO5sQpT8OWerQ@mail.gmail.com> (Stefan Beller's message of "Mon, 12 Nov 2018 14:33:57 -0800")
Stefan Beller <sbeller@google.com> writes:
>> + if (have_advertised_versions_already)
>> + BUG(_("attempting to register an allowed protocol version after advertisement"));
>
> If this is a real BUG (due to wrong program flow) instead of bad user input,
> we would not want to burden the translators with this message.
>
> If it is a message that the user is intended to see upon bad input
> we'd rather go with die(_("translatable text here"));
Yeah, good suggestion.
Perhaps we should spell it out in docstrings for BUG/die with the
above rationale. A weatherbaloon patch follows.
git-compat-util.h | 22 +++++++++++++++++++++-
1 file changed, 21 insertions(+), 1 deletion(-)
diff --git a/git-compat-util.h b/git-compat-util.h
index 96a3f86d8e..a1cf68cbbc 100644
--- a/git-compat-util.h
+++ b/git-compat-util.h
@@ -420,7 +420,16 @@ static inline char *git_find_last_dir_sep(const char *path)
struct strbuf;
-/* General helper functions */
+/*
+ * General helper functions
+ *
+ * Note that these are to produce end-user facing messages, and most
+ * of them should be marked for translation (the exception is
+ * messages generated to be sent over the wire---as we currently do not
+ * have a mechanism to notice and honor locale settings used on the
+ * other end, leave them untranslated. We should *not* send messages
+ * that are localized for our end).
+ */
extern void vreportf(const char *prefix, const char *err, va_list params);
extern NORETURN void usage(const char *err);
extern NORETURN void usagef(const char *err, ...) __attribute__((format (printf, 1, 2)));
@@ -1142,6 +1151,17 @@ 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;
+/*
+ * BUG(fmt, ...) is to be used when the problem of reaching that point
+ * in code can only be caused by a program error. To abort with a
+ * message to report impossible-to-continue condition due to external
+ * factors like end-user input, environment settings, data it was fed
+ * over the wire, use die(_(fmt),...).
+ *
+ * Note that the message from BUG() should not be marked for
+ * translation while the message from die() is in general end-user
+ * facing and should be marked for translation.
+ */
#ifdef HAVE_VARIADIC_MACROS
__attribute__((format (printf, 3, 4))) NORETURN
void BUG_fl(const char *file, int line, const char *fmt, ...);
next prev parent reply other threads:[~2018-11-13 3:24 UTC|newest]
Thread overview: 52+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-02 21:59 [PATCH 0/1] Limit client version advertisements Josh Steadmon
2018-10-02 21:59 ` [PATCH 1/1] protocol: limit max protocol version per service Josh Steadmon
2018-10-02 22:28 ` Stefan Beller
2018-10-03 21:33 ` Josh Steadmon
2018-10-03 22:47 ` Stefan Beller
2018-10-05 0:18 ` Josh Steadmon
2018-10-05 19:25 ` Stefan Beller
2018-10-10 23:53 ` Josh Steadmon
2018-10-12 23:30 ` Jonathan Nieder
2018-10-12 23:32 ` Jonathan Nieder
2018-10-12 23:45 ` Josh Steadmon
2018-10-12 23:53 ` Jonathan Nieder
2018-10-13 7:58 ` Junio C Hamano
2018-10-12 1:02 ` [PATCH v2 0/1] Advertise multiple supported proto versions steadmon
2018-10-12 1:02 ` [PATCH v2 1/1] protocol: advertise multiple supported versions steadmon
2018-10-12 22:30 ` Stefan Beller
2018-10-22 22:55 ` Josh Steadmon
2018-10-23 0:37 ` Stefan Beller
2018-11-12 21:49 ` [PATCH v3 0/1] Advertise multiple supported proto versions steadmon
2018-11-12 21:49 ` [PATCH v3 1/1] protocol: advertise multiple supported versions steadmon
2018-11-12 22:33 ` Stefan Beller
2018-11-13 3:24 ` Junio C Hamano [this message]
2018-11-13 19:21 ` Re* " Stefan Beller
2018-11-14 2:31 ` Junio C Hamano
2018-11-13 4:01 ` Junio C Hamano
2018-11-13 22:53 ` Josh Steadmon
2018-11-14 2:38 ` Junio C Hamano
2018-11-14 19:57 ` Josh Steadmon
2018-11-16 2:45 ` Junio C Hamano
2018-11-16 19:59 ` Josh Steadmon
2018-11-13 13:35 ` Junio C Hamano
2018-11-13 18:28 ` SZEDER Gábor
2018-11-13 23:03 ` Josh Steadmon
2018-11-14 0:47 ` SZEDER Gábor
2018-11-14 2:44 ` Junio C Hamano
2018-11-14 11:01 ` SZEDER Gábor
2018-11-14 2:30 ` [PATCH v4 0/1] Advertise multiple supported proto versions Josh Steadmon
2018-11-14 2:30 ` [PATCH v4 1/1] protocol: advertise multiple supported versions Josh Steadmon
2018-11-14 10:22 ` [PATCH v4 0/1] Advertise multiple supported proto versions Junio C Hamano
2018-11-14 19:51 ` Josh Steadmon
2018-11-16 10:46 ` Junio C Hamano
2018-11-16 22:34 ` [PATCH v5 " Josh Steadmon
2018-11-16 22:34 ` [PATCH v5 1/1] protocol: advertise multiple supported versions Josh Steadmon
2018-12-14 20:20 ` Ævar Arnfjörð Bjarmason
2018-12-14 21:58 ` Josh Steadmon
2018-12-14 22:39 ` Ævar Arnfjörð Bjarmason
2018-12-18 23:05 ` Josh Steadmon
2018-12-20 21:58 ` [PATCH v6 0/1] Advertise multiple supported proto versions Josh Steadmon
2018-12-20 21:58 ` [PATCH v6 1/1] protocol: advertise multiple supported versions Josh Steadmon
2019-02-05 19:42 ` Jonathan Tan
2019-02-07 23:58 ` Josh Steadmon
2019-02-11 18:53 ` Jonathan Tan
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=xmqqy39xwtfs.fsf_-_@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=jonathantanmy@google.com \
--cc=jrnieder@gmail.com \
--cc=sbeller@google.com \
--cc=steadmon@google.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.
Code repositories for project(s) associated with this public 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).