bisect: use selected alternate terms in status output

Alternate bisect terms are helpful when the terms "good" and "bad" are
confusing such as when bisecting for the resolution of an issue (the
first good commit) rather than the introduction of a regression.

These terms must be used when marking a commit (e.g. `git bisect new`),
they will be used in reference names (e.g. refs/bisect/new) and they are
used in parts of git's log output such as "<sha> was both old and new"
in git bisect skip's output.

However, hardcoded "good"/"bad" terms are still used in a few status
messages and can cause confusion about the status of the bisect such as:

  $ git bisect old
  [sha] is the first bad commit

or about the required action such as:

  status: waiting for bad commit, 1 good commit known
  $ git bisect bad
  error: Invalid command: you're currently in a new/old bisect
  fatal: unknown command: 'bad'

This commit updates all remaining output messages which use hardcoded
"good" and "bad" terms to use the selected terms consistently across the
bisect output and adds tests.

Signed-off-by: Jonas Rebmann <kernel@schlaraffenlan.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/builtin/bisect.c b/builtin/bisect.c
index 4520e585d0677f1dee3da8c8b4511fff67060e4c..2b44911c0b835f6fcc8a5ee37bcac5e43a582bd8 100644 (file)
--- a/builtin/bisect.c
+++ b/builtin/bisect.c
@@ -465,13 +465,16 @@ static void bisect_print_status(const struct bisect_terms *terms)
                return;
 
        if (!state.nr_good && !state.nr_bad)
-               bisect_log_printf(_("status: waiting for both good and bad commits\n"));
+               bisect_log_printf(_("status: waiting for both '%s' and '%s' commits\n"),
+                                 terms->term_good, terms->term_bad);
        else if (state.nr_good)
-               bisect_log_printf(Q_("status: waiting for bad commit, %d good commit known\n",
-                                    "status: waiting for bad commit, %d good commits known\n",
-                                    state.nr_good), state.nr_good);
+               bisect_log_printf(Q_("status: waiting for '%s' commit, %d '%s' commit known\n",
+                                    "status: waiting for '%s' commit, %d '%s' commits known\n",
+                                    state.nr_good),
+                                 terms->term_bad, state.nr_good, terms->term_good);
        else
-               bisect_log_printf(_("status: waiting for good commit(s), bad commit known\n"));
+               bisect_log_printf(_("status: waiting for '%s' commit(s), '%s' commit known\n"),
+                                 terms->term_good, terms->term_bad);
 }
 
 static int bisect_next_check(const struct bisect_terms *terms,
@@ -1262,14 +1265,14 @@ static int bisect_run(struct bisect_terms *terms, int argc, const char **argv)
                        int rc = verify_good(terms, command.buf);
                        is_first_run = 0;
                        if (rc < 0 || 128 <= rc) {
-                               error(_("unable to verify %s on good"
-                                       " revision"), command.buf);
+                               error(_("unable to verify %s on %s revision"),
+                                     command.buf, terms->term_good);
                                res = BISECT_FAILED;
                                break;
                        }
                        if (rc == res) {
-                               error(_("bogus exit code %d for good revision"),
-                                     rc);
+                               error(_("bogus exit code %d for %s revision"),
+                                     rc, terms->term_good);
                                res = BISECT_FAILED;
                                break;
                        }
@@ -1314,7 +1317,7 @@ static int bisect_run(struct bisect_terms *terms, int argc, const char **argv)
                        puts(_("bisect run success"));
                        res = BISECT_OK;
                } else if (res == BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND) {
-                       puts(_("bisect found first bad commit"));
+                       printf(_("bisect found first %s commit\n"), terms->term_bad);
                        res = BISECT_OK;
                } else if (res) {
                        error(_("bisect run failed: 'git bisect %s'"

diff --git a/t/t6030-bisect-porcelain.sh b/t/t6030-bisect-porcelain.sh
index cdc02706404b34b17b29692d72d97fab7eba58b1..61593b7e5d7b69812a9ce7631c573fb2112053d9 100755 (executable)
--- a/t/t6030-bisect-porcelain.sh
+++ b/t/t6030-bisect-porcelain.sh
@@ -1077,12 +1077,14 @@ test_expect_success 'bisect terms shows good/bad after start' '
 
 test_expect_success 'bisect start with one term1 and term2' '
        git bisect reset &&
-       git bisect start --term-old term2 --term-new term1 &&
-       git bisect term2 $HASH1 &&
+       git bisect start --term-old term2 --term-new term1 >bisect_result &&
+       test_grep "status: waiting for both '\''term2'\'' and '\''term1'\'' commits" bisect_result &&
+       git bisect term2 $HASH1 >bisect_result &&
+       test_grep "status: waiting for '\''term1'\'' commit, 1 '\''term2'\'' commit known" bisect_result &&
        git bisect term1 $HASH4 &&
        git bisect term1 &&
        git bisect term1 >bisect_result &&
-       grep "$HASH2 is the first term1 commit" bisect_result &&
+       test_grep "$HASH2 is the first term1 commit" bisect_result &&
        git bisect log >log_to_replay.txt &&
        git bisect reset
 '
@@ -1103,6 +1105,16 @@ test_expect_success 'bisect replay with term1 and term2' '
        git bisect reset
 '
 
+test_expect_success 'bisect run term1 term2' '
+       git bisect reset &&
+       git bisect start --term-new term1 --term-old term2 $HASH4 $HASH1 &&
+       git bisect term1 &&
+       git bisect run false >bisect_result &&
+       test_grep "bisect found first term1 commit" bisect_result &&
+       git bisect log >log_to_replay.txt &&
+       git bisect reset
+'
+
 test_expect_success 'bisect start term1 term2' '
        git bisect reset &&
        git bisect start --term-new term1 --term-old term2 $HASH4 $HASH1 &&
@@ -1224,29 +1236,29 @@ test_expect_success 'bisect visualize with a filename with dash and space' '
 test_expect_success 'bisect state output with multiple good commits' '
        git bisect reset &&
        git bisect start >output &&
-       grep "waiting for both good and bad commits" output &&
+       grep "waiting for both '\''good'\'' and '\''bad'\'' commits" output &&
        git bisect log >output &&
-       grep "waiting for both good and bad commits" output &&
+       grep "waiting for both '\''good'\'' and '\''bad'\'' commits" output &&
        git bisect good "$HASH1" >output &&
-       grep "waiting for bad commit, 1 good commit known" output &&
+       grep "waiting for '\''bad'\'' commit, 1 '\''good'\'' commit known" output &&
        git bisect log >output &&
-       grep "waiting for bad commit, 1 good commit known" output &&
+       grep "waiting for '\''bad'\'' commit, 1 '\''good'\'' commit known" output &&
        git bisect good "$HASH2" >output &&
-       grep "waiting for bad commit, 2 good commits known" output &&
+       grep "waiting for '\''bad'\'' commit, 2 '\''good'\'' commits known" output &&
        git bisect log >output &&
-       grep "waiting for bad commit, 2 good commits known" output
+       grep "waiting for '\''bad'\'' commit, 2 '\''good'\'' commits known" output
 '
 
 test_expect_success 'bisect state output with bad commit' '
        git bisect reset &&
        git bisect start >output &&
-       grep "waiting for both good and bad commits" output &&
+       grep "waiting for both '\''good'\'' and '\''bad'\'' commits" output &&
        git bisect log >output &&
-       grep "waiting for both good and bad commits" output &&
+       grep "waiting for both '\''good'\'' and '\''bad'\'' commits" output &&
        git bisect bad "$HASH4" >output &&
-       grep -F "waiting for good commit(s), bad commit known" output &&
+       grep -F "waiting for '\''good'\'' commit(s), '\''bad'\'' commit known" output &&
        git bisect log >output &&
-       grep -F "waiting for good commit(s), bad commit known" output
+       grep -F "waiting for '\''good'\'' commit(s), '\''bad'\'' commit known" output
 '
 
 test_expect_success 'verify correct error message' '