Merge branch 'jk/bisect-show-tree' into maint
authorJunio C Hamano <gitster@pobox.com>
Mon, 11 Jul 2016 17:44:11 +0000 (10:44 -0700)
committerJunio C Hamano <gitster@pobox.com>
Mon, 11 Jul 2016 17:44:11 +0000 (10:44 -0700)
"git bisect" makes an internal call to "git diff-tree" when
bisection finds the culprit, but this call did not initialize the
data structure to pass to the diff-tree API correctly.

* jk/bisect-show-tree:
bisect: always call setup_revisions after init_revisions

1  2 
bisect.c
diff --combined bisect.c
index 6d93edbcb97382269bd310d38cacd95ce3619091,07bf842acf97108dde5b143044b03c665a438f06..dc13319c20b255d2a3d76f237746ba5dc953680a
+++ b/bisect.c
  static struct sha1_array good_revs;
  static struct sha1_array skipped_revs;
  
 -static unsigned char *current_bad_sha1;
 +static struct object_id *current_bad_oid;
  
  static const char *argv_checkout[] = {"checkout", "-q", NULL, "--", NULL};
  static const char *argv_show_branch[] = {"show-branch", NULL, NULL};
 -static const char *argv_update_ref[] = {"update-ref", "--no-deref", "BISECT_HEAD", NULL, NULL};
 +
 +static const char *term_bad;
 +static const char *term_good;
  
  /* Remember to update object flag allocation in object.h */
  #define COUNTED               (1u<<16)
@@@ -193,7 -191,7 +193,7 @@@ static int compare_commit_dist(const vo
        b = (struct commit_dist *)b_;
        if (a->distance != b->distance)
                return b->distance - a->distance; /* desc sort */
 -      return hashcmp(a->commit->object.sha1, b->commit->object.sha1);
 +      return oidcmp(&a->commit->object.oid, &b->commit->object.oid);
  }
  
  static struct commit_list *best_bisection_sorted(struct commit_list *list, int nr)
@@@ -402,24 -400,18 +402,24 @@@ struct commit_list *find_bisection(stru
        return best;
  }
  
 -static int register_ref(const char *refname, const unsigned char *sha1,
 +static int register_ref(const char *refname, const struct object_id *oid,
                        int flags, void *cb_data)
  {
 -      if (!strcmp(refname, "bad")) {
 -              current_bad_sha1 = xmalloc(20);
 -              hashcpy(current_bad_sha1, sha1);
 -      } else if (starts_with(refname, "good-")) {
 -              sha1_array_append(&good_revs, sha1);
 +      struct strbuf good_prefix = STRBUF_INIT;
 +      strbuf_addstr(&good_prefix, term_good);
 +      strbuf_addstr(&good_prefix, "-");
 +
 +      if (!strcmp(refname, term_bad)) {
 +              current_bad_oid = xmalloc(sizeof(*current_bad_oid));
 +              oidcpy(current_bad_oid, oid);
 +      } else if (starts_with(refname, good_prefix.buf)) {
 +              sha1_array_append(&good_revs, oid->hash);
        } else if (starts_with(refname, "skip-")) {
 -              sha1_array_append(&skipped_revs, sha1);
 +              sha1_array_append(&skipped_revs, oid->hash);
        }
  
 +      strbuf_release(&good_prefix);
 +
        return 0;
  }
  
@@@ -428,19 -420,16 +428,19 @@@ static int read_bisect_refs(void
        return for_each_ref_in("refs/bisect/", register_ref, NULL);
  }
  
 +static GIT_PATH_FUNC(git_path_bisect_names, "BISECT_NAMES")
 +static GIT_PATH_FUNC(git_path_bisect_expected_rev, "BISECT_EXPECTED_REV")
 +
  static void read_bisect_paths(struct argv_array *array)
  {
        struct strbuf str = STRBUF_INIT;
 -      const char *filename = git_path("BISECT_NAMES");
 +      const char *filename = git_path_bisect_names();
        FILE *fp = fopen(filename, "r");
  
        if (!fp)
                die_errno("Could not open file '%s'", filename);
  
 -      while (strbuf_getline(&str, fp, '\n') != EOF) {
 +      while (strbuf_getline_lf(&str, fp) != EOF) {
                strbuf_trim(&str);
                if (sq_dequote_to_argv_array(str.buf, array))
                        die("Badly quoted content in file '%s': %s",
@@@ -500,7 -489,7 +500,7 @@@ struct commit_list *filter_skipped(stru
                struct commit_list *next = list->next;
                list->next = NULL;
                if (0 <= sha1_array_lookup(&skipped_revs,
 -                                         list->item->object.sha1)) {
 +                                         list->item->object.oid.hash)) {
                        if (skipped_first && !*skipped_first)
                                *skipped_first = 1;
                        /* Move current to tried list */
@@@ -575,7 -564,7 +575,7 @@@ static struct commit_list *skip_away(st
  
        for (i = 0; cur; cur = cur->next, i++) {
                if (i == index) {
 -                      if (hashcmp(cur->item->object.sha1, current_bad_sha1))
 +                      if (oidcmp(&cur->item->object.oid, current_bad_oid))
                                return cur;
                        if (previous)
                                return previous;
@@@ -618,7 -607,7 +618,7 @@@ static void bisect_rev_setup(struct rev
  
        /* rev_argv.argv[0] will be ignored by setup_revisions */
        argv_array_push(&rev_argv, "bisect_rev_setup");
 -      argv_array_pushf(&rev_argv, bad_format, sha1_to_hex(current_bad_sha1));
 +      argv_array_pushf(&rev_argv, bad_format, oid_to_hex(current_bad_oid));
        for (i = 0; i < good_revs.nr; i++)
                argv_array_pushf(&rev_argv, good_format,
                                 sha1_to_hex(good_revs.sha1[i]));
@@@ -639,23 -628,23 +639,23 @@@ static void bisect_common(struct rev_in
  }
  
  static void exit_if_skipped_commits(struct commit_list *tried,
 -                                  const unsigned char *bad)
 +                                  const struct object_id *bad)
  {
        if (!tried)
                return;
  
        printf("There are only 'skip'ped commits left to test.\n"
 -             "The first bad commit could be any of:\n");
 +             "The first %s commit could be any of:\n", term_bad);
        print_commit_list(tried, "%s\n", "%s\n");
        if (bad)
 -              printf("%s\n", sha1_to_hex(bad));
 +              printf("%s\n", oid_to_hex(bad));
        printf("We cannot bisect more!\n");
        exit(2);
  }
  
 -static int is_expected_rev(const unsigned char *sha1)
 +static int is_expected_rev(const struct object_id *oid)
  {
 -      const char *filename = git_path("BISECT_EXPECTED_REV");
 +      const char *filename = git_path_bisect_expected_rev();
        struct stat st;
        struct strbuf str = STRBUF_INIT;
        FILE *fp;
        if (!fp)
                return 0;
  
 -      if (strbuf_getline(&str, fp, '\n') != EOF)
 -              res = !strcmp(str.buf, sha1_to_hex(sha1));
 +      if (strbuf_getline_lf(&str, fp) != EOF)
 +              res = !strcmp(str.buf, oid_to_hex(oid));
  
        strbuf_release(&str);
        fclose(fp);
        return res;
  }
  
 -static void mark_expected_rev(char *bisect_rev_hex)
 -{
 -      int len = strlen(bisect_rev_hex);
 -      const char *filename = git_path("BISECT_EXPECTED_REV");
 -      int fd = open(filename, O_CREAT | O_TRUNC | O_WRONLY, 0600);
 -
 -      if (fd < 0)
 -              die_errno("could not create file '%s'", filename);
 -
 -      bisect_rev_hex[len] = '\n';
 -      write_or_die(fd, bisect_rev_hex, len + 1);
 -      bisect_rev_hex[len] = '\0';
 -
 -      if (close(fd) < 0)
 -              die("closing file %s: %s", filename, strerror(errno));
 -}
 -
 -static int bisect_checkout(char *bisect_rev_hex, int no_checkout)
 +static int bisect_checkout(const unsigned char *bisect_rev, int no_checkout)
  {
 +      char bisect_rev_hex[GIT_SHA1_HEXSZ + 1];
  
 -      mark_expected_rev(bisect_rev_hex);
 +      memcpy(bisect_rev_hex, sha1_to_hex(bisect_rev), GIT_SHA1_HEXSZ + 1);
 +      update_ref(NULL, "BISECT_EXPECTED_REV", bisect_rev, NULL, 0, UPDATE_REFS_DIE_ON_ERR);
  
        argv_checkout[2] = bisect_rev_hex;
        if (no_checkout) {
 -              argv_update_ref[3] = bisect_rev_hex;
 -              if (run_command_v_opt(argv_update_ref, RUN_GIT_CMD))
 -                      die("update-ref --no-deref HEAD failed on %s",
 -                          bisect_rev_hex);
 +              update_ref(NULL, "BISECT_HEAD", bisect_rev, NULL, 0, UPDATE_REFS_DIE_ON_ERR);
        } else {
                int res;
                res = run_command_v_opt(argv_checkout, RUN_GIT_CMD);
@@@ -708,11 -715,11 +708,11 @@@ static struct commit *get_commit_refere
  
  static struct commit **get_bad_and_good_commits(int *rev_nr)
  {
 -      int len = 1 + good_revs.nr;
 -      struct commit **rev = xmalloc(len * sizeof(*rev));
 +      struct commit **rev;
        int i, n = 0;
  
 -      rev[n++] = get_commit_reference(current_bad_sha1);
 +      ALLOC_ARRAY(rev, 1 + good_revs.nr);
 +      rev[n++] = get_commit_reference(current_bad_oid->hash);
        for (i = 0; i < good_revs.nr; i++)
                rev[n++] = get_commit_reference(good_revs.sha1[i]);
        *rev_nr = n;
  
  static void handle_bad_merge_base(void)
  {
 -      if (is_expected_rev(current_bad_sha1)) {
 -              char *bad_hex = sha1_to_hex(current_bad_sha1);
 +      if (is_expected_rev(current_bad_oid)) {
 +              char *bad_hex = oid_to_hex(current_bad_oid);
                char *good_hex = join_sha1_array_hex(&good_revs, ' ');
 -
 -              fprintf(stderr, "The merge base %s is bad.\n"
 -                      "This means the bug has been fixed "
 -                      "between %s and [%s].\n",
 -                      bad_hex, bad_hex, good_hex);
 -
 +              if (!strcmp(term_bad, "bad") && !strcmp(term_good, "good")) {
 +                      fprintf(stderr, "The merge base %s is bad.\n"
 +                              "This means the bug has been fixed "
 +                              "between %s and [%s].\n",
 +                              bad_hex, bad_hex, good_hex);
 +              } else if (!strcmp(term_bad, "new") && !strcmp(term_good, "old")) {
 +                      fprintf(stderr, "The merge base %s is new.\n"
 +                              "The property has changed "
 +                              "between %s and [%s].\n",
 +                              bad_hex, bad_hex, good_hex);
 +              } else {
 +                      fprintf(stderr, "The merge base %s is %s.\n"
 +                              "This means the first '%s' commit is "
 +                              "between %s and [%s].\n",
 +                              bad_hex, term_bad, term_good, bad_hex, good_hex);
 +              }
                exit(3);
        }
  
 -      fprintf(stderr, "Some good revs are not ancestor of the bad rev.\n"
 +      fprintf(stderr, "Some %s revs are not ancestor of the %s rev.\n"
                "git bisect cannot work properly in this case.\n"
 -              "Maybe you mistake good and bad revs?\n");
 +              "Maybe you mistook %s and %s revs?\n",
 +              term_good, term_bad, term_good, term_bad);
        exit(1);
  }
  
  static void handle_skipped_merge_base(const unsigned char *mb)
  {
        char *mb_hex = sha1_to_hex(mb);
 -      char *bad_hex = sha1_to_hex(current_bad_sha1);
 +      char *bad_hex = sha1_to_hex(current_bad_oid->hash);
        char *good_hex = join_sha1_array_hex(&good_revs, ' ');
  
        warning("the merge base between %s and [%s] "
                "must be skipped.\n"
 -              "So we cannot be sure the first bad commit is "
 +              "So we cannot be sure the first %s commit is "
                "between %s and %s.\n"
                "We continue anyway.",
 -              bad_hex, good_hex, mb_hex, bad_hex);
 +              bad_hex, good_hex, term_bad, mb_hex, bad_hex);
        free(good_hex);
  }
  
  /*
 - * "check_merge_bases" checks that merge bases are not "bad".
 + * "check_merge_bases" checks that merge bases are not "bad" (or "new").
   *
 - * - If one is "bad", it means the user assumed something wrong
 + * - If one is "bad" (or "new"), it means the user assumed something wrong
   * and we must exit with a non 0 error code.
 - * - If one is "good", that's good, we have nothing to do.
 + * - If one is "good" (or "old"), that's good, we have nothing to do.
   * - If one is "skipped", we can't know but we should warn.
   * - If we don't know, we should check it out and ask the user to test.
   */
@@@ -784,8 -780,8 +784,8 @@@ static void check_merge_bases(int no_ch
        result = get_merge_bases_many(rev[0], rev_nr - 1, rev + 1);
  
        for (; result; result = result->next) {
 -              const unsigned char *mb = result->item->object.sha1;
 -              if (!hashcmp(mb, current_bad_sha1)) {
 +              const unsigned char *mb = result->item->object.oid.hash;
 +              if (!hashcmp(mb, current_bad_oid->hash)) {
                        handle_bad_merge_base();
                } else if (0 <= sha1_array_lookup(&good_revs, mb)) {
                        continue;
                        handle_skipped_merge_base(mb);
                } else {
                        printf("Bisecting: a merge base must be tested\n");
 -                      exit(bisect_checkout(sha1_to_hex(mb), no_checkout));
 +                      exit(bisect_checkout(mb, no_checkout));
                }
        }
  
@@@ -842,8 -838,8 +842,8 @@@ static void check_good_are_ancestors_of
        struct stat st;
        int fd;
  
 -      if (!current_bad_sha1)
 -              die("a bad revision is needed");
 +      if (!current_bad_oid)
 +              die("a %s revision is needed", term_bad);
  
        /* Check if file BISECT_ANCESTORS_OK exists. */
        if (!stat(filename, &st) && S_ISREG(st.st_mode))
        /* Create file BISECT_ANCESTORS_OK. */
        fd = open(filename, O_CREAT | O_TRUNC | O_WRONLY, 0600);
        if (fd < 0)
 -              warning("could not create file '%s': %s",
 -                      filename, strerror(errno));
 +              warning_errno("could not create file '%s'",
 +                            filename);
        else
                close(fd);
   done:
@@@ -890,38 -886,10 +890,39 @@@ static void show_diff_tree(const char *
        if (!opt.diffopt.output_format)
                opt.diffopt.output_format = DIFF_FORMAT_RAW;
  
+       setup_revisions(0, NULL, &opt, NULL);
        log_tree_commit(&opt, commit);
  }
  
 +/*
 + * The terms used for this bisect session are stored in BISECT_TERMS.
 + * We read them and store them to adapt the messages accordingly.
 + * Default is bad/good.
 + */
 +void read_bisect_terms(const char **read_bad, const char **read_good)
 +{
 +      struct strbuf str = STRBUF_INIT;
 +      const char *filename = git_path("BISECT_TERMS");
 +      FILE *fp = fopen(filename, "r");
 +
 +      if (!fp) {
 +              if (errno == ENOENT) {
 +                      *read_bad = "bad";
 +                      *read_good = "good";
 +                      return;
 +              } else {
 +                      die_errno("could not read file '%s'", filename);
 +              }
 +      } else {
 +              strbuf_getline_lf(&str, fp);
 +              *read_bad = strbuf_detach(&str, NULL);
 +              strbuf_getline_lf(&str, fp);
 +              *read_good = strbuf_detach(&str, NULL);
 +      }
 +      strbuf_release(&str);
 +      fclose(fp);
 +}
 +
  /*
   * We use the convention that exiting with an exit code 10 means that
   * the bisection process finished successfully.
@@@ -936,8 -904,8 +937,8 @@@ int bisect_next_all(const char *prefix
        struct commit_list *tried;
        int reaches = 0, all = 0, nr, steps;
        const unsigned char *bisect_rev;
 -      char bisect_rev_hex[41];
  
 +      read_bisect_terms(&term_bad, &term_good);
        if (read_bisect_refs())
                die("reading bisect refs failed");
  
                 */
                exit_if_skipped_commits(tried, NULL);
  
 -              printf("%s was both good and bad\n",
 -                     sha1_to_hex(current_bad_sha1));
 +              printf("%s was both %s and %s\n",
 +                     oid_to_hex(current_bad_oid),
 +                     term_good,
 +                     term_bad);
                exit(1);
        }
  
                exit(4);
        }
  
 -      bisect_rev = revs.commits->item->object.sha1;
 -      memcpy(bisect_rev_hex, sha1_to_hex(bisect_rev), 41);
 +      bisect_rev = revs.commits->item->object.oid.hash;
  
 -      if (!hashcmp(bisect_rev, current_bad_sha1)) {
 -              exit_if_skipped_commits(tried, current_bad_sha1);
 -              printf("%s is the first bad commit\n", bisect_rev_hex);
 +      if (!hashcmp(bisect_rev, current_bad_oid->hash)) {
 +              exit_if_skipped_commits(tried, current_bad_oid);
 +              printf("%s is the first %s commit\n", sha1_to_hex(bisect_rev),
 +                      term_bad);
                show_diff_tree(prefix, revs.commits->item);
                /* This means the bisection process succeeded. */
                exit(10);
               "(roughly %d step%s)\n", nr, (nr == 1 ? "" : "s"),
               steps, (steps == 1 ? "" : "s"));
  
 -      return bisect_checkout(bisect_rev_hex, no_checkout);
 +      return bisect_checkout(bisect_rev, no_checkout);
  }
  
  static inline int log2i(int n)