From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>, "Jeff King" <peff@peff.net>,
"Bagas Sanjaya" <bagasdotme@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH v3 0/3] i18n: improve translatability of ambiguous object output
Date: Fri, 8 Oct 2021 21:34:45 +0200 [thread overview]
Message-ID: <cover-v3-0.3-00000000000-20211008T193041Z-avarab@gmail.com> (raw)
In-Reply-To: <cover-v2-0.2-00000000000-20211004T142523Z-avarab@gmail.com>
Since v2 the "commit", "tag" etc. types in object.c are no longer
marked for translation.
There's a new 1/3 where we lead with an assert() and commit message
showing that the existing "unknown type" code is gone, which makes
what comes after simpler.
In 2/3 we no longer have to deal with special-cases related to corrupt
or otherwise bad objects, which makes for less work for translators.
In 3/3 I added the tag date to ambiguous tag objects, which is now
consistent with how commit objects are shown.
Ævar Arnfjörð Bjarmason (3):
object-name: remove unreachable "unknown type" handling
object-name: make ambiguous object output translatable
object-name: show date for ambiguous tag objects
object-name.c | 68 +++++++++++++++++++++++++++++++++++++++++++++------
1 file changed, 61 insertions(+), 7 deletions(-)
Range-diff against v2:
1: 55bde16aa23 < -: ----------- object.[ch]: mark object type names for translation
-: ----------- > 1: fb29e10ee35 object-name: remove unreachable "unknown type" handling
2: c0e873543f5 ! 2: 587a5717e47 object-name: make ambiguous object output translatable
@@ Commit message
object-name: make ambiguous object output translatable
Change the output of show_ambiguous_object() added in [1] and last
- tweaked in [2] to be more friendly to translators. By being able to
- customize the sprintf formats we're even ready for RTL languages.
-
- The "unknown type" message here is unreachable, and has been since
- [1], i.e. that code has never worked. If we craft an object of a bogus
- type with a conflicting prefix we'll just die:
-
- $ git rev-parse 8315
- error: short object ID 8315 is ambiguous
- hint: The candidates are:
- fatal: invalid object type
-
- But let's continue to pretend that this works, we can eventually use
- the API improvements in my ab/fsck-unexpected-type (once it lands) to
- inspect these objects and emit the actual type here, or at least not
- die as we emit "unknown type".
+ tweaked in [2] and the preceding commit to be more friendly to
+ translators. By being able to customize the "<SP><SP>%s\n" format
+ we're even ready for RTL languages, who'd presumably like to change
+ that to "%s<SP><SP>\n".
1. 1ffa26c461 (get_short_sha1: list ambiguous objects on error,
2016-09-26)
@@ Commit message
## object-name.c ##
@@ object-name.c: static int show_ambiguous_object(const struct object_id *oid, void *data)
- {
const struct disambiguate_state *ds = data;
struct strbuf desc = STRBUF_INIT;
-+ struct strbuf ci_ad = STRBUF_INIT;
-+ struct strbuf ci_s = STRBUF_INIT;
int type;
-+ const char *tag_desc = NULL;
-+ const char *abbrev;
++ const char *hash;
if (ds->fn && !ds->fn(ds->repo, oid, ds->cb_data))
return 0;
@@ object-name.c: static int show_ambiguous_object(const struct object_id *oid, void *data)
+ type = oid_object_info(ds->repo, oid, NULL);
+ assert(type == OBJ_TREE || type == OBJ_COMMIT ||
+ type == OBJ_BLOB || type == OBJ_TAG);
++ hash = repo_find_unique_abbrev(ds->repo, oid, DEFAULT_ABBREV);
++
+ if (type == OBJ_COMMIT) {
++ struct strbuf ad = STRBUF_INIT;
++ struct strbuf s = STRBUF_INIT;
+ struct commit *commit = lookup_commit(ds->repo, oid);
++
if (commit) {
struct pretty_print_context pp = {0};
pp.date_mode.type = DATE_SHORT;
- format_commit_message(commit, " %ad - %s", &desc, &pp);
-+ format_commit_message(commit, "%ad", &ci_ad, &pp);
-+ format_commit_message(commit, "%s", &ci_s, &pp);
++ format_commit_message(commit, "%ad", &ad, &pp);
++ format_commit_message(commit, "%s", &s, &pp);
}
- } else if (type == OBJ_TAG) {
- struct tag *tag = lookup_tag(ds->repo, oid);
- if (!parse_tag(tag) && tag->tag)
-- strbuf_addf(&desc, " %s", tag->tag);
-+ tag_desc = tag->tag;
- }
-
-- advise(" %s %s%s",
-- repo_find_unique_abbrev(ds->repo, oid, DEFAULT_ABBREV),
-- type_name(type) ? type_name(type) : "unknown type",
-- desc.buf);
-+ abbrev = repo_find_unique_abbrev(ds->repo, oid, DEFAULT_ABBREV);
-+ if (type == OBJ_COMMIT) {
++
+ /*
+ * TRANSLATORS: This is a line of ambiguous commit
+ * object output. E.g.:
+ *
+ * "deadbeef commit 2021-01-01 - Some Commit Message"
-+ *
-+ * The second argument is the "commit" string from
-+ * object.c, it should (hopefully) already be
-+ * translated.
+ */
-+ strbuf_addf(&desc, _("%s %s %s - %s"), abbrev, ci_ad.buf,
-+ _(type_name(type)), ci_s.buf);
-+ } else if (tag_desc) {
++ strbuf_addf(&desc, _("%s commit %s - %s"), hash, ad.buf, s.buf);
++
++ strbuf_release(&ad);
++ strbuf_release(&s);
+ } else if (type == OBJ_TAG) {
+ struct tag *tag = lookup_tag(ds->repo, oid);
++ const char *tag_tag = "";
++
+ if (!parse_tag(tag) && tag->tag)
+- strbuf_addf(&desc, " %s", tag->tag);
++ tag_tag = tag->tag;
++
+ /*
+ * TRANSLATORS: This is a line of
+ * ambiguous tag object output. E.g.:
@@ object-name.c: static int show_ambiguous_object(const struct object_id *oid, voi
+ * object.c, it should (hopefully) already be
+ * translated.
+ */
-+ strbuf_addf(&desc, _("%s %s %s"), abbrev, _(type_name(type)),
-+ tag_desc);
-+ } else {
-+ const char *tname = type_name(type) ? _(type_name(type)) :
-+ _(unknown_type);
++ strbuf_addf(&desc, _("%s tag %s"), hash, tag_tag);
++ } else if (type == OBJ_TREE) {
+ /*
+ * TRANSLATORS: This is a line of ambiguous <type>
-+ * object output. Where <type> is one of the object
-+ * types of "tree", "blob", "tag" ("commit" is handled
-+ * above).
-+ *
-+ * "deadbeef tree"
-+ * "deadbeef blob"
-+ * "deadbeef tag"
-+ * "deadbeef unknown type"
-+ *
-+ * Note that annotated tags use a separate format
-+ * outlined above.
-+ *
-+ * The second argument is the "tree", "blob" or "tag"
-+ * string from object.c, or the "unknown type" string
-+ * in the case of an unknown type. All of them should
-+ * (hopefully) already be translated.
++ * object output. E.g. "deadbeef tree".
+ */
-+ strbuf_addf(&desc, _("%s %s"), abbrev, tname);
-+ }
-+
++ strbuf_addf(&desc, _("%s tree"), hash);
++ } else if (type == OBJ_BLOB) {
++ /*
++ * TRANSLATORS: This is a line of ambiguous <type>
++ * object output. E.g. "deadbeef blob".
++ */
++ strbuf_addf(&desc, _("%s blob"), hash);
++ } else {
++ BUG("unreachable");
+ }
+
+- advise(" %s %s%s",
+- repo_find_unique_abbrev(ds->repo, oid, DEFAULT_ABBREV),
+- type_name(type), desc.buf);
+ /*
+ * TRANSLATORS: This is line item of ambiguous object output,
+ * translated above.
+ */
-+ advise(_(" %s\n"), desc.buf);
++ advise(_(" %s"), desc.buf);
strbuf_release(&desc);
-+ strbuf_release(&ci_ad);
-+ strbuf_release(&ci_s);
return 0;
- }
-
-: ----------- > 3: 8bde4e174b7 object-name: show date for ambiguous tag objects
--
2.33.0.1492.g76eb1af92bc
next prev parent reply other threads:[~2021-10-08 19:35 UTC|newest]
Thread overview: 90+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-04 1:42 [PATCH 0/2] i18n: improve translatability of ambiguous object output Ævar Arnfjörð Bjarmason
2021-10-04 1:42 ` [PATCH 1/2] object-name tests: tighten up advise() output test Ævar Arnfjörð Bjarmason
2021-10-04 2:52 ` Eric Sunshine
2021-10-04 7:05 ` Jeff King
2021-10-04 1:42 ` [PATCH 2/2] object-name: make ambiguous object output translatable Ævar Arnfjörð Bjarmason
2021-10-04 7:35 ` Jeff King
2021-10-04 8:26 ` Ævar Arnfjörð Bjarmason
2021-10-04 9:29 ` Jeff King
2021-10-04 11:16 ` Ævar Arnfjörð Bjarmason
2021-10-04 12:07 ` Jeff King
2021-10-04 14:27 ` [PATCH v2 0/2] i18n: improve translatability of ambiguous object output Ævar Arnfjörð Bjarmason
2021-10-04 14:27 ` [PATCH v2 1/2] object.[ch]: mark object type names for translation Ævar Arnfjörð Bjarmason
2021-10-04 18:54 ` Eric Sunshine
2021-10-05 9:37 ` Bagas Sanjaya
2021-10-05 15:52 ` Ævar Arnfjörð Bjarmason
2021-10-06 19:05 ` Jeff King
2021-10-06 19:46 ` Junio C Hamano
2021-10-06 20:38 ` Jeff King
2021-10-07 18:06 ` Junio C Hamano
2021-10-04 14:27 ` [PATCH v2 2/2] object-name: make ambiguous object output translatable Ævar Arnfjörð Bjarmason
2021-10-06 19:11 ` Jeff King
2021-10-08 19:34 ` Ævar Arnfjörð Bjarmason [this message]
2021-10-08 19:34 ` [PATCH v3 1/3] object-name: remove unreachable "unknown type" handling Ævar Arnfjörð Bjarmason
2021-10-08 19:34 ` [PATCH v3 2/3] object-name: make ambiguous object output translatable Ævar Arnfjörð Bjarmason
2021-10-08 19:34 ` [PATCH v3 3/3] object-name: show date for ambiguous tag objects Ævar Arnfjörð Bjarmason
2021-11-22 17:53 ` [PATCH v2 0/3] object-name: make ambiguous object output translatable + show tag date Ævar Arnfjörð Bjarmason
2021-11-22 17:53 ` [PATCH v4 1/3] object-name: remove unreachable "unknown type" handling Ævar Arnfjörð Bjarmason
2021-11-22 22:37 ` Jeff King
2021-11-22 17:53 ` [PATCH v4 2/3] object-name: make ambiguous object output translatable Ævar Arnfjörð Bjarmason
2021-11-22 17:53 ` [PATCH v4 3/3] object-name: show date for ambiguous tag objects Ævar Arnfjörð Bjarmason
2021-11-25 22:03 ` [PATCH v5 0/6] object-name: make ambiguous object output translatable + show tag date Ævar Arnfjörð Bjarmason
2021-11-25 22:03 ` [PATCH v5 1/6] object-name tests: add tests for ambiguous object blind spots Ævar Arnfjörð Bjarmason
2021-12-23 21:51 ` Josh Steadmon
2021-11-25 22:03 ` [PATCH v5 2/6] object-name: explicitly handle OBJ_BAD in show_ambiguous_object() Ævar Arnfjörð Bjarmason
2021-12-23 21:51 ` Josh Steadmon
2021-12-23 22:42 ` Junio C Hamano
2021-11-25 22:03 ` [PATCH v5 3/6] object-name: make ambiguous object output translatable Ævar Arnfjörð Bjarmason
2021-12-23 21:54 ` [PATCH] fixup! " Josh Steadmon
2021-12-23 22:48 ` Junio C Hamano
2021-11-25 22:03 ` [PATCH v5 4/6] object-name: show date for ambiguous tag objects Ævar Arnfjörð Bjarmason
2021-11-25 22:03 ` [PATCH v5 5/6] object-name: iterate ambiguous objects before showing header Ævar Arnfjörð Bjarmason
2021-11-25 22:03 ` [PATCH v5 6/6] object-name: re-use "struct strbuf" in show_ambiguous_object() Ævar Arnfjörð Bjarmason
2021-12-28 14:34 ` [PATCH v6 0/6] object-name: make ambiguous object output translatable + show tag date Ævar Arnfjörð Bjarmason
2021-12-28 14:34 ` [PATCH v6 1/6] object-name tests: add tests for ambiguous object blind spots Ævar Arnfjörð Bjarmason
2021-12-30 23:36 ` Junio C Hamano
2021-12-28 14:34 ` [PATCH v6 2/6] object-name: explicitly handle OBJ_BAD in show_ambiguous_object() Ævar Arnfjörð Bjarmason
2021-12-28 14:34 ` [PATCH v6 3/6] object-name: make ambiguous object output translatable Ævar Arnfjörð Bjarmason
2021-12-30 23:46 ` Junio C Hamano
2021-12-28 14:35 ` [PATCH v6 4/6] object-name: show date for ambiguous tag objects Ævar Arnfjörð Bjarmason
2021-12-30 21:43 ` Junio C Hamano
2021-12-28 14:35 ` [PATCH v6 5/6] object-name: iterate ambiguous objects before showing header Ævar Arnfjörð Bjarmason
2021-12-28 14:35 ` [PATCH v6 6/6] object-name: re-use "struct strbuf" in show_ambiguous_object() Ævar Arnfjörð Bjarmason
2021-12-28 15:18 ` [PATCH v8 0/7] progress: test fixes / cleanup Ævar Arnfjörð Bjarmason
2021-12-28 15:18 ` [PATCH v8 1/7] leak tests: fix a memory leak in "test-progress" helper Ævar Arnfjörð Bjarmason
2021-12-28 15:18 ` [PATCH v8 2/7] progress.c test helper: add missing braces Ævar Arnfjörð Bjarmason
2021-12-28 15:18 ` [PATCH v8 3/7] progress.c tests: make start/stop commands on stdin Ævar Arnfjörð Bjarmason
2021-12-28 16:25 ` Johannes Altmanninger
2021-12-28 15:19 ` [PATCH v8 4/7] progress.c tests: test some invalid usage Ævar Arnfjörð Bjarmason
2021-12-28 16:33 ` Johannes Altmanninger
2021-12-28 15:19 ` [PATCH v8 5/7] progress.c: add temporary variable from progress struct Ævar Arnfjörð Bjarmason
2021-12-28 16:05 ` René Scharfe
2021-12-28 16:13 ` Johannes Altmanninger
2021-12-28 15:19 ` [PATCH v8 6/7] pack-bitmap-write.c: don't return without stop_progress() Ævar Arnfjörð Bjarmason
2021-12-28 15:19 ` [PATCH v8 7/7] *.c: use isatty(0|2), not isatty(STDIN_FILENO|STDERR_FILENO) Ævar Arnfjörð Bjarmason
2021-12-28 16:47 ` René Scharfe
2021-12-28 23:56 ` Ævar Arnfjörð Bjarmason
2022-01-08 0:45 ` [PATCH v8 0/7] progress: test fixes / cleanup Junio C Hamano
2022-01-12 12:39 ` [PATCH v7 0/6] object-name: make ambiguous object output translatable + show tag date Ævar Arnfjörð Bjarmason
2022-01-12 12:39 ` [PATCH v7 1/6] object-name tests: add tests for ambiguous object blind spots Ævar Arnfjörð Bjarmason
2022-01-13 22:39 ` Junio C Hamano
2022-01-14 12:07 ` Ævar Arnfjörð Bjarmason
2022-01-14 18:45 ` Junio C Hamano
2022-01-12 12:39 ` [PATCH v7 2/6] object-name: explicitly handle OBJ_BAD in show_ambiguous_object() Ævar Arnfjörð Bjarmason
2022-01-12 12:39 ` [PATCH v7 3/6] object-name: make ambiguous object output translatable Ævar Arnfjörð Bjarmason
2022-01-12 12:39 ` [PATCH v7 4/6] object-name: show date for ambiguous tag objects Ævar Arnfjörð Bjarmason
2022-01-13 22:46 ` Junio C Hamano
2022-01-14 12:05 ` Ævar Arnfjörð Bjarmason
2022-01-14 19:04 ` Junio C Hamano
2022-01-14 19:35 ` Ævar Arnfjörð Bjarmason
2022-01-12 12:39 ` [PATCH v7 5/6] object-name: iterate ambiguous objects before showing header Ævar Arnfjörð Bjarmason
2022-01-12 12:39 ` [PATCH v7 6/6] object-name: re-use "struct strbuf" in show_ambiguous_object() Ævar Arnfjörð Bjarmason
2022-01-27 5:26 ` [PATCH v8 0/7] object-name: make ambiguous object output translatable + show tag date Ævar Arnfjörð Bjarmason
2022-01-27 5:26 ` [PATCH v8 1/7] object-name tests: add tests for ambiguous object blind spots Ævar Arnfjörð Bjarmason
2022-01-27 5:26 ` [PATCH v8 2/7] object-name: explicitly handle OBJ_BAD in show_ambiguous_object() Ævar Arnfjörð Bjarmason
2022-01-27 5:26 ` [PATCH v8 3/7] object-name: explicitly handle bad tags " Ævar Arnfjörð Bjarmason
2022-01-27 5:26 ` [PATCH v8 4/7] object-name: make ambiguous object output translatable Ævar Arnfjörð Bjarmason
2022-01-27 5:26 ` [PATCH v8 5/7] object-name: show date for ambiguous tag objects Ævar Arnfjörð Bjarmason
2022-01-27 5:26 ` [PATCH v8 6/7] object-name: iterate ambiguous objects before showing header Ævar Arnfjörð Bjarmason
2022-01-27 5:26 ` [PATCH v8 7/7] object-name: re-use "struct strbuf" in show_ambiguous_object() Ævar Arnfjörð Bjarmason
2022-01-27 20:14 ` [PATCH v8 0/7] object-name: make ambiguous object output translatable + show tag date Junio C Hamano
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=cover-v3-0.3-00000000000-20211008T193041Z-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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 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).