git.oblomov.eu Git - git/blob - builtin/bisect--helper.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "parse-options.h"
   4 #include "bisect.h"
   5 #include "refs.h"
   6 #include "dir.h"
   7 #include "strvec.h"
   8 #include "run-command.h"
   9 #include "prompt.h"
  10 #include "quote.h"
  11
  12 static GIT_PATH_FUNC(git_path_bisect_terms, "BISECT_TERMS")
  13 static GIT_PATH_FUNC(git_path_bisect_expected_rev, "BISECT_EXPECTED_REV")
  14 static GIT_PATH_FUNC(git_path_bisect_ancestors_ok, "BISECT_ANCESTORS_OK")
  15 static GIT_PATH_FUNC(git_path_bisect_start, "BISECT_START")
  16 static GIT_PATH_FUNC(git_path_bisect_log, "BISECT_LOG")
  17 static GIT_PATH_FUNC(git_path_head_name, "head-name")
  18 static GIT_PATH_FUNC(git_path_bisect_names, "BISECT_NAMES")
  19 static GIT_PATH_FUNC(git_path_bisect_first_parent, "BISECT_FIRST_PARENT")
  20
  21 static const char * const git_bisect_helper_usage[] = {
  22         N_("git bisect--helper --next-all"),
  23         N_("git bisect--helper --write-terms <bad_term> <good_term>"),
  24         N_("git bisect--helper --bisect-clean-state"),
  25         N_("git bisect--helper --bisect-reset [<commit>]"),
  26         N_("git bisect--helper --bisect-write [--no-log] <state> <revision> <good_term> <bad_term>"),
  27         N_("git bisect--helper --bisect-check-and-set-terms <command> <good_term> <bad_term>"),
  28         N_("git bisect--helper --bisect-next-check <good_term> <bad_term> [<term>]"),
  29         N_("git bisect--helper --bisect-terms [--term-good | --term-old | --term-bad | --term-new]"),
  30         N_("git bisect--helper --bisect-start [--term-{old,good}=<term> --term-{new,bad}=<term>]"
  31                                             " [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<paths>...]"),
  32         NULL
  33 };
  34
  35 struct bisect_terms {
  36         char *term_good;
  37         char *term_bad;
  38 };
  39
  40 static void free_terms(struct bisect_terms *terms)
  41 {
  42         FREE_AND_NULL(terms->term_good);
  43         FREE_AND_NULL(terms->term_bad);
  44 }
  45
  46 static void set_terms(struct bisect_terms *terms, const char *bad,
  47                       const char *good)
  48 {
  49         free((void *)terms->term_good);
  50         terms->term_good = xstrdup(good);
  51         free((void *)terms->term_bad);
  52         terms->term_bad = xstrdup(bad);
  53 }
  54
  55 static const char vocab_bad[] = "bad|new";
  56 static const char vocab_good[] = "good|old";
  57
  58 /*
  59  * Check whether the string `term` belongs to the set of strings
  60  * included in the variable arguments.
  61  */
  62 LAST_ARG_MUST_BE_NULL
  63 static int one_of(const char *term, ...)
  64 {
  65         int res = 0;
  66         va_list matches;
  67         const char *match;
  68
  69         va_start(matches, term);
  70         while (!res && (match = va_arg(matches, const char *)))
  71                 res = !strcmp(term, match);
  72         va_end(matches);
  73
  74         return res;
  75 }
  76
  77 static int check_term_format(const char *term, const char *orig_term)
  78 {
  79         int res;
  80         char *new_term = xstrfmt("refs/bisect/%s", term);
  81
  82         res = check_refname_format(new_term, 0);
  83         free(new_term);
  84
  85         if (res)
  86                 return error(_("'%s' is not a valid term"), term);
  87
  88         if (one_of(term, "help", "start", "skip", "next", "reset",
  89                         "visualize", "view", "replay", "log", "run", "terms", NULL))
  90                 return error(_("can't use the builtin command '%s' as a term"), term);
  91
  92         /*
  93          * In theory, nothing prevents swapping completely good and bad,
  94          * but this situation could be confusing and hasn't been tested
  95          * enough. Forbid it for now.
  96          */
  97
  98         if ((strcmp(orig_term, "bad") && one_of(term, "bad", "new", NULL)) ||
  99                  (strcmp(orig_term, "good") && one_of(term, "good", "old", NULL)))
 100                 return error(_("can't change the meaning of the term '%s'"), term);
 101
 102         return 0;
 103 }
 104
 105 static int write_terms(const char *bad, const char *good)
 106 {
 107         FILE *fp = NULL;
 108         int res;
 109
 110         if (!strcmp(bad, good))
 111                 return error(_("please use two different terms"));
 112
 113         if (check_term_format(bad, "bad") || check_term_format(good, "good"))
 114                 return -1;
 115
 116         fp = fopen(git_path_bisect_terms(), "w");
 117         if (!fp)
 118                 return error_errno(_("could not open the file BISECT_TERMS"));
 119
 120         res = fprintf(fp, "%s\n%s\n", bad, good);
 121         res |= fclose(fp);
 122         return (res < 0) ? -1 : 0;
 123 }
 124
 125 static int is_expected_rev(const char *expected_hex)
 126 {
 127         struct strbuf actual_hex = STRBUF_INIT;
 128         int res = 0;
 129         if (strbuf_read_file(&actual_hex, git_path_bisect_expected_rev(), 0) >= 40) {
 130                 strbuf_trim(&actual_hex);
 131                 res = !strcmp(actual_hex.buf, expected_hex);
 132         }
 133         strbuf_release(&actual_hex);
 134         return res;
 135 }
 136
 137 static void check_expected_revs(const char **revs, int rev_nr)
 138 {
 139         int i;
 140
 141         for (i = 0; i < rev_nr; i++) {
 142                 if (!is_expected_rev(revs[i])) {
 143                         unlink_or_warn(git_path_bisect_ancestors_ok());
 144                         unlink_or_warn(git_path_bisect_expected_rev());
 145                 }
 146         }
 147 }
 148
 149 static int bisect_reset(const char *commit)
 150 {
 151         struct strbuf branch = STRBUF_INIT;
 152
 153         if (!commit) {
 154                 if (strbuf_read_file(&branch, git_path_bisect_start(), 0) < 1) {
 155                         printf(_("We are not bisecting.\n"));
 156                         return 0;
 157                 }
 158                 strbuf_rtrim(&branch);
 159         } else {
 160                 struct object_id oid;
 161
 162                 if (get_oid_commit(commit, &oid))
 163                         return error(_("'%s' is not a valid commit"), commit);
 164                 strbuf_addstr(&branch, commit);
 165         }
 166
 167         if (!ref_exists("BISECT_HEAD")) {
 168                 struct strvec argv = STRVEC_INIT;
 169
 170                 strvec_pushl(&argv, "checkout", branch.buf, "--", NULL);
 171                 if (run_command_v_opt(argv.v, RUN_GIT_CMD)) {
 172                         error(_("could not check out original"
 173                                 " HEAD '%s'. Try 'git bisect"
 174                                 " reset <commit>'."), branch.buf);
 175                         strbuf_release(&branch);
 176                         strvec_clear(&argv);
 177                         return -1;
 178                 }
 179                 strvec_clear(&argv);
 180         }
 181
 182         strbuf_release(&branch);
 183         return bisect_clean_state();
 184 }
 185
 186 static void log_commit(FILE *fp, char *fmt, const char *state,
 187                        struct commit *commit)
 188 {
 189         struct pretty_print_context pp = {0};
 190         struct strbuf commit_msg = STRBUF_INIT;
 191         char *label = xstrfmt(fmt, state);
 192
 193         format_commit_message(commit, "%s", &commit_msg, &pp);
 194
 195         fprintf(fp, "# %s: [%s] %s\n", label, oid_to_hex(&commit->object.oid),
 196                 commit_msg.buf);
 197
 198         strbuf_release(&commit_msg);
 199         free(label);
 200 }
 201
 202 static int bisect_write(const char *state, const char *rev,
 203                         const struct bisect_terms *terms, int nolog)
 204 {
 205         struct strbuf tag = STRBUF_INIT;
 206         struct object_id oid;
 207         struct commit *commit;
 208         FILE *fp = NULL;
 209         int res = 0;
 210
 211         if (!strcmp(state, terms->term_bad)) {
 212                 strbuf_addf(&tag, "refs/bisect/%s", state);
 213         } else if (one_of(state, terms->term_good, "skip", NULL)) {
 214                 strbuf_addf(&tag, "refs/bisect/%s-%s", state, rev);
 215         } else {
 216                 res = error(_("Bad bisect_write argument: %s"), state);
 217                 goto finish;
 218         }
 219
 220         if (get_oid(rev, &oid)) {
 221                 res = error(_("couldn't get the oid of the rev '%s'"), rev);
 222                 goto finish;
 223         }
 224
 225         if (update_ref(NULL, tag.buf, &oid, NULL, 0,
 226                        UPDATE_REFS_MSG_ON_ERR)) {
 227                 res = -1;
 228                 goto finish;
 229         }
 230
 231         fp = fopen(git_path_bisect_log(), "a");
 232         if (!fp) {
 233                 res = error_errno(_("couldn't open the file '%s'"), git_path_bisect_log());
 234                 goto finish;
 235         }
 236
 237         commit = lookup_commit_reference(the_repository, &oid);
 238         log_commit(fp, "%s", state, commit);
 239
 240         if (!nolog)
 241                 fprintf(fp, "git bisect %s %s\n", state, rev);
 242
 243 finish:
 244         if (fp)
 245                 fclose(fp);
 246         strbuf_release(&tag);
 247         return res;
 248 }
 249
 250 static int check_and_set_terms(struct bisect_terms *terms, const char *cmd)
 251 {
 252         int has_term_file = !is_empty_or_missing_file(git_path_bisect_terms());
 253
 254         if (one_of(cmd, "skip", "start", "terms", NULL))
 255                 return 0;
 256
 257         if (has_term_file && strcmp(cmd, terms->term_bad) &&
 258             strcmp(cmd, terms->term_good))
 259                 return error(_("Invalid command: you're currently in a "
 260                                 "%s/%s bisect"), terms->term_bad,
 261                                 terms->term_good);
 262
 263         if (!has_term_file) {
 264                 if (one_of(cmd, "bad", "good", NULL)) {
 265                         set_terms(terms, "bad", "good");
 266                         return write_terms(terms->term_bad, terms->term_good);
 267                 }
 268                 if (one_of(cmd, "new", "old", NULL)) {
 269                         set_terms(terms, "new", "old");
 270                         return write_terms(terms->term_bad, terms->term_good);
 271                 }
 272         }
 273
 274         return 0;
 275 }
 276
 277 static int mark_good(const char *refname, const struct object_id *oid,
 278                      int flag, void *cb_data)
 279 {
 280         int *m_good = (int *)cb_data;
 281         *m_good = 0;
 282         return 1;
 283 }
 284
 285 static const char need_bad_and_good_revision_warning[] =
 286         N_("You need to give me at least one %s and %s revision.\n"
 287            "You can use \"git bisect %s\" and \"git bisect %s\" for that.");
 288
 289 static const char need_bisect_start_warning[] =
 290         N_("You need to start by \"git bisect start\".\n"
 291            "You then need to give me at least one %s and %s revision.\n"
 292            "You can use \"git bisect %s\" and \"git bisect %s\" for that.");
 293
 294 static int decide_next(const struct bisect_terms *terms,
 295                        const char *current_term, int missing_good,
 296                        int missing_bad)
 297 {
 298         if (!missing_good && !missing_bad)
 299                 return 0;
 300         if (!current_term)
 301                 return -1;
 302
 303         if (missing_good && !missing_bad &&
 304             !strcmp(current_term, terms->term_good)) {
 305                 char *yesno;
 306                 /*
 307                  * have bad (or new) but not good (or old). We could bisect
 308                  * although this is less optimum.
 309                  */
 310                 warning(_("bisecting only with a %s commit"), terms->term_bad);
 311                 if (!isatty(0))
 312                         return 0;
 313                 /*
 314                  * TRANSLATORS: Make sure to include [Y] and [n] in your
 315                  * translation. The program will only accept English input
 316                  * at this point.
 317                  */
 318                 yesno = git_prompt(_("Are you sure [Y/n]? "), PROMPT_ECHO);
 319                 if (starts_with(yesno, "N") || starts_with(yesno, "n"))
 320                         return -1;
 321                 return 0;
 322         }
 323
 324         if (!is_empty_or_missing_file(git_path_bisect_start()))
 325                 return error(_(need_bad_and_good_revision_warning),
 326                              vocab_bad, vocab_good, vocab_bad, vocab_good);
 327         else
 328                 return error(_(need_bisect_start_warning),
 329                              vocab_good, vocab_bad, vocab_good, vocab_bad);
 330 }
 331
 332 static int bisect_next_check(const struct bisect_terms *terms,
 333                              const char *current_term)
 334 {
 335         int missing_good = 1, missing_bad = 1;
 336         char *bad_ref = xstrfmt("refs/bisect/%s", terms->term_bad);
 337         char *good_glob = xstrfmt("%s-*", terms->term_good);
 338
 339         if (ref_exists(bad_ref))
 340                 missing_bad = 0;
 341
 342         for_each_glob_ref_in(mark_good, good_glob, "refs/bisect/",
 343                              (void *) &missing_good);
 344
 345         free(good_glob);
 346         free(bad_ref);
 347
 348         return decide_next(terms, current_term, missing_good, missing_bad);
 349 }
 350
 351 static int get_terms(struct bisect_terms *terms)
 352 {
 353         struct strbuf str = STRBUF_INIT;
 354         FILE *fp = NULL;
 355         int res = 0;
 356
 357         fp = fopen(git_path_bisect_terms(), "r");
 358         if (!fp) {
 359                 res = -1;
 360                 goto finish;
 361         }
 362
 363         free_terms(terms);
 364         strbuf_getline_lf(&str, fp);
 365         terms->term_bad = strbuf_detach(&str, NULL);
 366         strbuf_getline_lf(&str, fp);
 367         terms->term_good = strbuf_detach(&str, NULL);
 368
 369 finish:
 370         if (fp)
 371                 fclose(fp);
 372         strbuf_release(&str);
 373         return res;
 374 }
 375
 376 static int bisect_terms(struct bisect_terms *terms, const char *option)
 377 {
 378         if (get_terms(terms))
 379                 return error(_("no terms defined"));
 380
 381         if (option == NULL) {
 382                 printf(_("Your current terms are %s for the old state\n"
 383                          "and %s for the new state.\n"),
 384                        terms->term_good, terms->term_bad);
 385                 return 0;
 386         }
 387         if (one_of(option, "--term-good", "--term-old", NULL))
 388                 printf("%s\n", terms->term_good);
 389         else if (one_of(option, "--term-bad", "--term-new", NULL))
 390                 printf("%s\n", terms->term_bad);
 391         else
 392                 return error(_("invalid argument %s for 'git bisect terms'.\n"
 393                                "Supported options are: "
 394                                "--term-good|--term-old and "
 395                                "--term-bad|--term-new."), option);
 396
 397         return 0;
 398 }
 399
 400 static int bisect_append_log_quoted(const char **argv)
 401 {
 402         int res = 0;
 403         FILE *fp = fopen(git_path_bisect_log(), "a");
 404         struct strbuf orig_args = STRBUF_INIT;
 405
 406         if (!fp)
 407                 return -1;
 408
 409         if (fprintf(fp, "git bisect start") < 1) {
 410                 res = -1;
 411                 goto finish;
 412         }
 413
 414         sq_quote_argv(&orig_args, argv);
 415         if (fprintf(fp, "%s\n", orig_args.buf) < 1)
 416                 res = -1;
 417
 418 finish:
 419         fclose(fp);
 420         strbuf_release(&orig_args);
 421         return res;
 422 }
 423
 424 static int bisect_start(struct bisect_terms *terms, const char **argv, int argc)
 425 {
 426         int no_checkout = 0;
 427         int first_parent_only = 0;
 428         int i, has_double_dash = 0, must_write_terms = 0, bad_seen = 0;
 429         int flags, pathspec_pos, res = 0;
 430         struct string_list revs = STRING_LIST_INIT_DUP;
 431         struct string_list states = STRING_LIST_INIT_DUP;
 432         struct strbuf start_head = STRBUF_INIT;
 433         struct strbuf bisect_names = STRBUF_INIT;
 434         struct object_id head_oid;
 435         struct object_id oid;
 436         const char *head;
 437
 438         if (is_bare_repository())
 439                 no_checkout = 1;
 440
 441         /*
 442          * Check for one bad and then some good revisions
 443          */
 444         for (i = 0; i < argc; i++) {
 445                 if (!strcmp(argv[i], "--")) {
 446                         has_double_dash = 1;
 447                         break;
 448                 }
 449         }
 450
 451         for (i = 0; i < argc; i++) {
 452                 const char *arg = argv[i];
 453                 if (!strcmp(argv[i], "--")) {
 454                         break;
 455                 } else if (!strcmp(arg, "--no-checkout")) {
 456                         no_checkout = 1;
 457                 } else if (!strcmp(arg, "--first-parent")) {
 458                         first_parent_only = 1;
 459                 } else if (!strcmp(arg, "--term-good") ||
 460                          !strcmp(arg, "--term-old")) {
 461                         i++;
 462                         if (argc <= i)
 463                                 return error(_("'' is not a valid term"));
 464                         must_write_terms = 1;
 465                         free((void *) terms->term_good);
 466                         terms->term_good = xstrdup(argv[i]);
 467                 } else if (skip_prefix(arg, "--term-good=", &arg) ||
 468                            skip_prefix(arg, "--term-old=", &arg)) {
 469                         must_write_terms = 1;
 470                         free((void *) terms->term_good);
 471                         terms->term_good = xstrdup(arg);
 472                 } else if (!strcmp(arg, "--term-bad") ||
 473                          !strcmp(arg, "--term-new")) {
 474                         i++;
 475                         if (argc <= i)
 476                                 return error(_("'' is not a valid term"));
 477                         must_write_terms = 1;
 478                         free((void *) terms->term_bad);
 479                         terms->term_bad = xstrdup(argv[i]);
 480                 } else if (skip_prefix(arg, "--term-bad=", &arg) ||
 481                            skip_prefix(arg, "--term-new=", &arg)) {
 482                         must_write_terms = 1;
 483                         free((void *) terms->term_bad);
 484                         terms->term_bad = xstrdup(arg);
 485                 } else if (starts_with(arg, "--")) {
 486                         return error(_("unrecognized option: '%s'"), arg);
 487                 } else {
 488                         char *commit_id = xstrfmt("%s^{commit}", arg);
 489                         if (get_oid(commit_id, &oid) && has_double_dash)
 490                                 die(_("'%s' does not appear to be a valid "
 491                                       "revision"), arg);
 492
 493                         string_list_append(&revs, oid_to_hex(&oid));
 494                         free(commit_id);
 495                 }
 496         }
 497         pathspec_pos = i;
 498
 499         /*
 500          * The user ran "git bisect start <sha1> <sha1>", hence did not
 501          * explicitly specify the terms, but we are already starting to
 502          * set references named with the default terms, and won't be able
 503          * to change afterwards.
 504          */
 505         if (revs.nr)
 506                 must_write_terms = 1;
 507         for (i = 0; i < revs.nr; i++) {
 508                 if (bad_seen) {
 509                         string_list_append(&states, terms->term_good);
 510                 } else {
 511                         bad_seen = 1;
 512                         string_list_append(&states, terms->term_bad);
 513                 }
 514         }
 515
 516         /*
 517          * Verify HEAD
 518          */
 519         head = resolve_ref_unsafe("HEAD", 0, &head_oid, &flags);
 520         if (!head)
 521                 if (get_oid("HEAD", &head_oid))
 522                         return error(_("bad HEAD - I need a HEAD"));
 523
 524         /*
 525          * Check if we are bisecting
 526          */
 527         if (!is_empty_or_missing_file(git_path_bisect_start())) {
 528                 /* Reset to the rev from where we started */
 529                 strbuf_read_file(&start_head, git_path_bisect_start(), 0);
 530                 strbuf_trim(&start_head);
 531                 if (!no_checkout) {
 532                         struct strvec argv = STRVEC_INIT;
 533
 534                         strvec_pushl(&argv, "checkout", start_head.buf,
 535                                      "--", NULL);
 536                         if (run_command_v_opt(argv.v, RUN_GIT_CMD)) {
 537                                 res = error(_("checking out '%s' failed."
 538                                                  " Try 'git bisect start "
 539                                                  "<valid-branch>'."),
 540                                                start_head.buf);
 541                                 goto finish;
 542                         }
 543                 }
 544         } else {
 545                 /* Get the rev from where we start. */
 546                 if (!get_oid(head, &head_oid) &&
 547                     !starts_with(head, "refs/heads/")) {
 548                         strbuf_reset(&start_head);
 549                         strbuf_addstr(&start_head, oid_to_hex(&head_oid));
 550                 } else if (!get_oid(head, &head_oid) &&
 551                            skip_prefix(head, "refs/heads/", &head)) {
 552                         /*
 553                          * This error message should only be triggered by
 554                          * cogito usage, and cogito users should understand
 555                          * it relates to cg-seek.
 556                          */
 557                         if (!is_empty_or_missing_file(git_path_head_name()))
 558                                 return error(_("won't bisect on cg-seek'ed tree"));
 559                         strbuf_addstr(&start_head, head);
 560                 } else {
 561                         return error(_("bad HEAD - strange symbolic ref"));
 562                 }
 563         }
 564
 565         /*
 566          * Get rid of any old bisect state.
 567          */
 568         if (bisect_clean_state())
 569                 return -1;
 570
 571         /*
 572          * In case of mistaken revs or checkout error, or signals received,
 573          * "bisect_auto_next" below may exit or misbehave.
 574          * We have to trap this to be able to clean up using
 575          * "bisect_clean_state".
 576          */
 577
 578         /*
 579          * Write new start state
 580          */
 581         write_file(git_path_bisect_start(), "%s\n", start_head.buf);
 582
 583         if (first_parent_only)
 584                 write_file(git_path_bisect_first_parent(), "\n");
 585
 586         if (no_checkout) {
 587                 if (get_oid(start_head.buf, &oid) < 0) {
 588                         res = error(_("invalid ref: '%s'"), start_head.buf);
 589                         goto finish;
 590                 }
 591                 if (update_ref(NULL, "BISECT_HEAD", &oid, NULL, 0,
 592                                UPDATE_REFS_MSG_ON_ERR)) {
 593                         res = -1;
 594                         goto finish;
 595                 }
 596         }
 597
 598         if (pathspec_pos < argc - 1)
 599                 sq_quote_argv(&bisect_names, argv + pathspec_pos);
 600         write_file(git_path_bisect_names(), "%s\n", bisect_names.buf);
 601
 602         for (i = 0; i < states.nr; i++)
 603                 if (bisect_write(states.items[i].string,
 604                                  revs.items[i].string, terms, 1)) {
 605                         res = -1;
 606                         goto finish;
 607                 }
 608
 609         if (must_write_terms && write_terms(terms->term_bad,
 610                                             terms->term_good)) {
 611                 res = -1;
 612                 goto finish;
 613         }
 614
 615         res = bisect_append_log_quoted(argv);
 616         if (res)
 617                 res = -1;
 618
 619 finish:
 620         string_list_clear(&revs, 0);
 621         string_list_clear(&states, 0);
 622         strbuf_release(&start_head);
 623         strbuf_release(&bisect_names);
 624         return res;
 625 }
 626
 627 int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
 628 {
 629         enum {
 630                 NEXT_ALL = 1,
 631                 WRITE_TERMS,
 632                 BISECT_CLEAN_STATE,
 633                 CHECK_EXPECTED_REVS,
 634                 BISECT_RESET,
 635                 BISECT_WRITE,
 636                 CHECK_AND_SET_TERMS,
 637                 BISECT_NEXT_CHECK,
 638                 BISECT_TERMS,
 639                 BISECT_START
 640         } cmdmode = 0;
 641         int res = 0, nolog = 0;
 642         struct option options[] = {
 643                 OPT_CMDMODE(0, "next-all", &cmdmode,
 644                          N_("perform 'git bisect next'"), NEXT_ALL),
 645                 OPT_CMDMODE(0, "write-terms", &cmdmode,
 646                          N_("write the terms to .git/BISECT_TERMS"), WRITE_TERMS),
 647                 OPT_CMDMODE(0, "bisect-clean-state", &cmdmode,
 648                          N_("cleanup the bisection state"), BISECT_CLEAN_STATE),
 649                 OPT_CMDMODE(0, "check-expected-revs", &cmdmode,
 650                          N_("check for expected revs"), CHECK_EXPECTED_REVS),
 651                 OPT_CMDMODE(0, "bisect-reset", &cmdmode,
 652                          N_("reset the bisection state"), BISECT_RESET),
 653                 OPT_CMDMODE(0, "bisect-write", &cmdmode,
 654                          N_("write out the bisection state in BISECT_LOG"), BISECT_WRITE),
 655                 OPT_CMDMODE(0, "check-and-set-terms", &cmdmode,
 656                          N_("check and set terms in a bisection state"), CHECK_AND_SET_TERMS),
 657                 OPT_CMDMODE(0, "bisect-next-check", &cmdmode,
 658                          N_("check whether bad or good terms exist"), BISECT_NEXT_CHECK),
 659                 OPT_CMDMODE(0, "bisect-terms", &cmdmode,
 660                          N_("print out the bisect terms"), BISECT_TERMS),
 661                 OPT_CMDMODE(0, "bisect-start", &cmdmode,
 662                          N_("start the bisect session"), BISECT_START),
 663                 OPT_BOOL(0, "no-log", &nolog,
 664                          N_("no log for BISECT_WRITE")),
 665                 OPT_END()
 666         };
 667         struct bisect_terms terms = { .term_good = NULL, .term_bad = NULL };
 668
 669         argc = parse_options(argc, argv, prefix, options,
 670                              git_bisect_helper_usage,
 671                              PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_UNKNOWN);
 672
 673         if (!cmdmode)
 674                 usage_with_options(git_bisect_helper_usage, options);
 675
 676         switch (cmdmode) {
 677         case NEXT_ALL:
 678                 res = bisect_next_all(the_repository, prefix);
 679                 break;
 680         case WRITE_TERMS:
 681                 if (argc != 2)
 682                         return error(_("--write-terms requires two arguments"));
 683                 return write_terms(argv[0], argv[1]);
 684         case BISECT_CLEAN_STATE:
 685                 if (argc != 0)
 686                         return error(_("--bisect-clean-state requires no arguments"));
 687                 return bisect_clean_state();
 688         case CHECK_EXPECTED_REVS:
 689                 check_expected_revs(argv, argc);
 690                 return 0;
 691         case BISECT_RESET:
 692                 if (argc > 1)
 693                         return error(_("--bisect-reset requires either no argument or a commit"));
 694                 return !!bisect_reset(argc ? argv[0] : NULL);
 695         case BISECT_WRITE:
 696                 if (argc != 4 && argc != 5)
 697                         return error(_("--bisect-write requires either 4 or 5 arguments"));
 698                 set_terms(&terms, argv[3], argv[2]);
 699                 res = bisect_write(argv[0], argv[1], &terms, nolog);
 700                 break;
 701         case CHECK_AND_SET_TERMS:
 702                 if (argc != 3)
 703                         return error(_("--check-and-set-terms requires 3 arguments"));
 704                 set_terms(&terms, argv[2], argv[1]);
 705                 res = check_and_set_terms(&terms, argv[0]);
 706                 break;
 707         case BISECT_NEXT_CHECK:
 708                 if (argc != 2 && argc != 3)
 709                         return error(_("--bisect-next-check requires 2 or 3 arguments"));
 710                 set_terms(&terms, argv[1], argv[0]);
 711                 res = bisect_next_check(&terms, argc == 3 ? argv[2] : NULL);
 712                 break;
 713         case BISECT_TERMS:
 714                 if (argc > 1)
 715                         return error(_("--bisect-terms requires 0 or 1 argument"));
 716                 res = bisect_terms(&terms, argc == 1 ? argv[0] : NULL);
 717                 break;
 718         case BISECT_START:
 719                 set_terms(&terms, "bad", "good");
 720                 res = bisect_start(&terms, argv, argc);
 721                 break;
 722         default:
 723                 return error("BUG: unknown subcommand '%d'", cmdmode);
 724         }
 725         free_terms(&terms);
 726
 727         /*
 728          * Handle early success
 729          * From check_merge_bases > check_good_are_ancestors_of_bad > bisect_next_all
 730          */
 731         if (res == BISECT_INTERNAL_SUCCESS_MERGE_BASE)
 732                 res = BISECT_OK;
 733
 734         return abs(res);
 735 }