Merge branch 'ea/blame-progress'
authorJunio C Hamano <gitster@pobox.com>
Tue, 12 Jan 2016 23:16:54 +0000 (15:16 -0800)
committerJunio C Hamano <gitster@pobox.com>
Tue, 12 Jan 2016 23:16:54 +0000 (15:16 -0800)
"git blame" learned to produce the progress eye-candy when it takes
too much time before emitting the first line of the result.

* ea/blame-progress:
blame: add support for --[no-]progress option

1  2 
Documentation/blame-options.txt
builtin/blame.c
index 760eab7428357ad4006437ae3032cee958dce803,cd415e6287d91c440b64574cbdf345e40d622662..02cb6845cd96194b655c9898189c4d5f24ca6a92
@@@ -63,12 -63,20 +63,19 @@@ include::line-range-format.txt[
        `-` to make the command read from the standard input).
  
  --date <format>::
 -      The value is one of the following alternatives:
 -      {relative,local,default,iso,rfc,short}. If --date is not
 +      Specifies the format used to output dates. If --date is not
        provided, the value of the blame.date config variable is
        used. If the blame.date config variable is also not set, the
 -      iso format is used. For more information, See the discussion
 +      iso format is used. For supported values, see the discussion
        of the --date option at linkgit:git-log[1].
  
+ --[no-]progress::
+       Progress status is reported on the standard error stream
+       by default when it is attached to a terminal. This flag
+       enables progress reporting even if not attached to a
+       terminal. Can't use `--progress` together with `--porcelain`
+       or `--incremental`.
  -M|<num>|::
        Detect moved or copied lines within a file. When a commit
        moves or copies a block of lines (e.g. the original file
diff --combined builtin/blame.c
index 1df13cf7f4b501ed82dcbffdf4620706591a245e,776bb10c727c043f42a7d939a22f740c05a13f79..d3fc82c852a7dfe26b7ca0556eb49fe2c2db37be
@@@ -28,6 -28,7 +28,7 @@@
  #include "line-range.h"
  #include "line-log.h"
  #include "dir.h"
+ #include "progress.h"
  
  static char blame_usage[] = N_("git blame [<options>] [<rev-opts>] [<rev>] [--] <file>");
  
@@@ -50,6 -51,7 +51,7 @@@ static int incremental
  static int xdl_opts;
  static int abbrev = -1;
  static int no_whole_file_rename;
+ static int show_progress;
  
  static struct date_mode blame_date_mode = { DATE_ISO8601 };
  static size_t blame_date_width;
@@@ -127,6 -129,11 +129,11 @@@ struct origin 
        char path[FLEX_ARRAY];
  };
  
+ struct progress_info {
+       struct progress *progress;
+       int blamed_lines;
+ };
  static int diff_hunks(mmfile_t *file_a, mmfile_t *file_b, long ctxlen,
                      xdl_emit_hunk_consume_func_t hunk_func, void *cb_data)
  {
@@@ -459,13 -466,12 +466,13 @@@ static void queue_blames(struct scorebo
  static struct origin *make_origin(struct commit *commit, const char *path)
  {
        struct origin *o;
 -      o = xcalloc(1, sizeof(*o) + strlen(path) + 1);
 +      size_t pathlen = strlen(path) + 1;
 +      o = xcalloc(1, sizeof(*o) + pathlen);
        o->commit = commit;
        o->refcnt = 1;
        o->next = commit->util;
        commit->util = o;
 -      strcpy(o->path, path);
 +      memcpy(o->path, path, pathlen); /* includes NUL */
        return o;
  }
  
@@@ -506,7 -512,7 +513,7 @@@ static int fill_blob_sha1_and_mode(stru
  {
        if (!is_null_sha1(origin->blob_sha1))
                return 0;
 -      if (get_tree_entry(origin->commit->object.sha1,
 +      if (get_tree_entry(origin->commit->object.oid.hash,
                           origin->path,
                           origin->blob_sha1, &origin->mode))
                goto error_out;
@@@ -557,11 -563,11 +564,11 @@@ static struct origin *find_origin(struc
                       PATHSPEC_LITERAL_PATH, "", paths);
        diff_setup_done(&diff_opts);
  
 -      if (is_null_sha1(origin->commit->object.sha1))
 -              do_diff_cache(parent->tree->object.sha1, &diff_opts);
 +      if (is_null_oid(&origin->commit->object.oid))
 +              do_diff_cache(parent->tree->object.oid.hash, &diff_opts);
        else
 -              diff_tree_sha1(parent->tree->object.sha1,
 -                             origin->commit->tree->object.sha1,
 +              diff_tree_sha1(parent->tree->object.oid.hash,
 +                             origin->commit->tree->object.oid.hash,
                               "", &diff_opts);
        diffcore_std(&diff_opts);
  
@@@ -627,11 -633,11 +634,11 @@@ static struct origin *find_rename(struc
        diff_opts.single_follow = origin->path;
        diff_setup_done(&diff_opts);
  
 -      if (is_null_sha1(origin->commit->object.sha1))
 -              do_diff_cache(parent->tree->object.sha1, &diff_opts);
 +      if (is_null_oid(&origin->commit->object.oid))
 +              do_diff_cache(parent->tree->object.oid.hash, &diff_opts);
        else
 -              diff_tree_sha1(parent->tree->object.sha1,
 -                             origin->commit->tree->object.sha1,
 +              diff_tree_sha1(parent->tree->object.oid.hash,
 +                             origin->commit->tree->object.oid.hash,
                               "", &diff_opts);
        diffcore_std(&diff_opts);
  
@@@ -977,8 -983,8 +984,8 @@@ static void pass_blame_to_parent(struc
  
        if (diff_hunks(&file_p, &file_o, 0, blame_chunk_cb, &d))
                die("unable to generate diff (%s -> %s)",
 -                  sha1_to_hex(parent->commit->object.sha1),
 -                  sha1_to_hex(target->commit->object.sha1));
 +                  oid_to_hex(&parent->commit->object.oid),
 +                  oid_to_hex(&target->commit->object.oid));
        /* The rest are the same as the parent */
        blame_chunk(&d.dstq, &d.srcq, INT_MAX, d.offset, INT_MAX, parent);
        *d.dstq = NULL;
@@@ -1126,7 -1132,7 +1133,7 @@@ static void find_copy_in_blob(struct sc
        memset(split, 0, sizeof(struct blame_entry [3]));
        if (diff_hunks(file_p, &file_o, 1, handle_split_cb, &d))
                die("unable to generate diff (%s)",
 -                  sha1_to_hex(parent->commit->object.sha1));
 +                  oid_to_hex(&parent->commit->object.oid));
        /* remainder, if any, all match the preimage */
        handle_split(sb, ent, d.tlno, d.plno, ent->num_lines, parent, split);
  }
@@@ -1275,11 -1281,11 +1282,11 @@@ static void find_copy_in_parent(struct 
                && (!porigin || strcmp(target->path, porigin->path))))
                DIFF_OPT_SET(&diff_opts, FIND_COPIES_HARDER);
  
 -      if (is_null_sha1(target->commit->object.sha1))
 -              do_diff_cache(parent->tree->object.sha1, &diff_opts);
 +      if (is_null_oid(&target->commit->object.oid))
 +              do_diff_cache(parent->tree->object.oid.hash, &diff_opts);
        else
 -              diff_tree_sha1(parent->tree->object.sha1,
 -                             target->commit->tree->object.sha1,
 +              diff_tree_sha1(parent->tree->object.oid.hash,
 +                             target->commit->tree->object.oid.hash,
                               "", &diff_opts);
  
        if (!DIFF_OPT_TST(&diff_opts, FIND_COPIES_HARDER))
@@@ -1690,7 -1696,7 +1697,7 @@@ static void get_commit_info(struct comm
        if (len)
                strbuf_add(&ret->summary, subject, len);
        else
 -              strbuf_addf(&ret->summary, "(%s)", sha1_to_hex(commit->object.sha1));
 +              strbuf_addf(&ret->summary, "(%s)", oid_to_hex(&commit->object.oid));
  
        unuse_commit_buffer(commit, message);
  }
@@@ -1733,7 -1739,7 +1740,7 @@@ static int emit_one_suspect_detail(stru
                printf("boundary\n");
        if (suspect->previous) {
                struct origin *prev = suspect->previous;
 -              printf("previous %s ", sha1_to_hex(prev->commit->object.sha1));
 +              printf("previous %s ", oid_to_hex(&prev->commit->object.oid));
                write_name_quoted(prev->path, stdout, '\n');
        }
  
   * The blame_entry is found to be guilty for the range.
   * Show it in incremental output.
   */
- static void found_guilty_entry(struct blame_entry *ent)
+ static void found_guilty_entry(struct blame_entry *ent,
+                          struct progress_info *pi)
  {
        if (incremental) {
                struct origin *suspect = ent->suspect;
  
                printf("%s %d %d %d\n",
 -                     sha1_to_hex(suspect->commit->object.sha1),
 +                     oid_to_hex(&suspect->commit->object.oid),
                       ent->s_lno + 1, ent->lno + 1, ent->num_lines);
                emit_one_suspect_detail(suspect, 0);
                write_filename_info(suspect->path);
                maybe_flush_or_die(stdout, "stdout");
        }
+       pi->blamed_lines += ent->num_lines;
+       display_progress(pi->progress, pi->blamed_lines);
  }
  
  /*
@@@ -1768,6 -1777,11 +1778,11 @@@ static void assign_blame(struct scorebo
  {
        struct rev_info *revs = sb->revs;
        struct commit *commit = prio_queue_get(&sb->commits);
+       struct progress_info pi = { NULL, 0 };
+       if (show_progress)
+               pi.progress = start_progress_delay(_("Blaming lines"),
+                                                  sb->num_lines, 50, 1);
  
        while (commit) {
                struct blame_entry *ent;
                        suspect->guilty = 1;
                        for (;;) {
                                struct blame_entry *next = ent->next;
-                               found_guilty_entry(ent);
+                               found_guilty_entry(ent, &pi);
                                if (next) {
                                        ent = next;
                                        continue;
                if (DEBUG) /* sanity */
                        sanity_check_refcnt(sb);
        }
+       stop_progress(&pi.progress);
  }
  
  static const char *format_time(unsigned long time, const char *tz_str,
@@@ -1880,9 -1896,9 +1897,9 @@@ static void emit_porcelain(struct score
        int cnt;
        const char *cp;
        struct origin *suspect = ent->suspect;
 -      char hex[41];
 +      char hex[GIT_SHA1_HEXSZ + 1];
  
 -      strcpy(hex, sha1_to_hex(suspect->commit->object.sha1));
 +      sha1_to_hex_r(hex, suspect->commit->object.oid.hash);
        printf("%s %d %d %d\n",
               hex,
               ent->s_lno + 1,
@@@ -1918,11 -1934,11 +1935,11 @@@ static void emit_other(struct scoreboar
        const char *cp;
        struct origin *suspect = ent->suspect;
        struct commit_info ci;
 -      char hex[41];
 +      char hex[GIT_SHA1_HEXSZ + 1];
        int show_raw_time = !!(opt & OUTPUT_RAW_TIMESTAMP);
  
        get_commit_info(suspect->commit, &ci, 1);
 -      strcpy(hex, sha1_to_hex(suspect->commit->object.sha1));
 +      sha1_to_hex_r(hex, suspect->commit->object.oid.hash);
  
        cp = nth_line(sb, ent->lno);
        for (cnt = 0; cnt < ent->num_lines; cnt++) {
@@@ -2077,7 -2093,7 +2094,7 @@@ static int read_ancestry(const char *gr
  
  static int update_auto_abbrev(int auto_abbrev, struct origin *suspect)
  {
 -      const char *uniq = find_unique_abbrev(suspect->commit->object.sha1,
 +      const char *uniq = find_unique_abbrev(suspect->commit->object.oid.hash,
                                              auto_abbrev);
        int len = strlen(uniq);
        if (auto_abbrev < len)
@@@ -2153,7 -2169,7 +2170,7 @@@ static void sanity_check_refcnt(struct 
                if (ent->suspect->refcnt <= 0) {
                        fprintf(stderr, "%s in %s has negative refcnt %d\n",
                                ent->suspect->path,
 -                              sha1_to_hex(ent->suspect->commit->object.sha1),
 +                              oid_to_hex(&ent->suspect->commit->object.oid),
                                ent->suspect->refcnt);
                        baa = 1;
                }
@@@ -2216,7 -2232,7 +2233,7 @@@ static void verify_working_tree_path(st
        struct commit_list *parents;
  
        for (parents = work_tree->parents; parents; parents = parents->next) {
 -              const unsigned char *commit_sha1 = parents->item->object.sha1;
 +              const unsigned char *commit_sha1 = parents->item->object.oid.hash;
                unsigned char blob_sha1[20];
                unsigned mode;
  
@@@ -2310,7 -2326,7 +2327,7 @@@ static struct commit *fake_working_tree
        strbuf_addstr(&msg, "tree 0000000000000000000000000000000000000000\n");
        for (parent = commit->parents; parent; parent = parent->next)
                strbuf_addf(&msg, "parent %s\n",
 -                          sha1_to_hex(parent->item->object.sha1));
 +                          oid_to_hex(&parent->item->object.oid));
        strbuf_addf(&msg,
                    "author %s\n"
                    "committer %s\n\n"
        return commit;
  }
  
 -static char *prepare_final(struct scoreboard *sb)
 +static struct commit *find_single_final(struct rev_info *revs,
 +                                      const char **name_p)
  {
        int i;
 -      const char *final_commit_name = NULL;
 -      struct rev_info *revs = sb->revs;
 +      struct commit *found = NULL;
 +      const char *name = NULL;
  
 -      /*
 -       * There must be one and only one positive commit in the
 -       * revs->pending array.
 -       */
        for (i = 0; i < revs->pending.nr; i++) {
                struct object *obj = revs->pending.objects[i].item;
                if (obj->flags & UNINTERESTING)
                        obj = deref_tag(obj, NULL, 0);
                if (obj->type != OBJ_COMMIT)
                        die("Non commit %s?", revs->pending.objects[i].name);
 -              if (sb->final)
 +              if (found)
                        die("More than one commit to dig from %s and %s?",
 -                          revs->pending.objects[i].name,
 -                          final_commit_name);
 -              sb->final = (struct commit *) obj;
 -              final_commit_name = revs->pending.objects[i].name;
 +                          revs->pending.objects[i].name, name);
 +              found = (struct commit *)obj;
 +              name = revs->pending.objects[i].name;
        }
 -      return xstrdup_or_null(final_commit_name);
 +      if (name_p)
 +              *name_p = name;
 +      return found;
 +}
 +
 +static char *prepare_final(struct scoreboard *sb)
 +{
 +      const char *name;
 +      sb->final = find_single_final(sb->revs, &name);
 +      return xstrdup_or_null(name);
  }
  
  static char *prepare_initial(struct scoreboard *sb)
@@@ -2508,7 -2519,6 +2525,7 @@@ int cmd_blame(int argc, const char **ar
        long dashdash_pos, lno;
        char *final_commit_name = NULL;
        enum object_type type;
 +      struct commit *final_commit = NULL;
  
        static struct string_list range_list;
        static int output_option = 0, opt = 0;
                OPT_BOOL('b', NULL, &blank_boundary, N_("Show blank SHA-1 for boundary commits (Default: off)")),
                OPT_BOOL(0, "root", &show_root, N_("Do not treat root commits as boundaries (Default: off)")),
                OPT_BOOL(0, "show-stats", &show_stats, N_("Show work cost statistics")),
+               OPT_BOOL(0, "progress", &show_progress, N_("Force progress reporting")),
                OPT_BIT(0, "score-debug", &output_option, N_("Show output score for blame entries"), OUTPUT_SHOW_SCORE),
                OPT_BIT('f', "show-name", &output_option, N_("Show original filename (Default: auto)"), OUTPUT_SHOW_NAME),
                OPT_BIT('n', "show-number", &output_option, N_("Show original linenumber (Default: off)"), OUTPUT_SHOW_NUMBER),
  
        save_commit_buffer = 0;
        dashdash_pos = 0;
+       show_progress = -1;
  
        parse_options_start(&ctx, argc, argv, prefix, options,
                            PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_ARGV0);
@@@ -2579,6 -2591,13 +2598,13 @@@ parse_done
        DIFF_OPT_CLR(&revs.diffopt, FOLLOW_RENAMES);
        argc = parse_options_end(&ctx);
  
+       if (incremental || (output_option & OUTPUT_PORCELAIN)) {
+               if (show_progress > 0)
+                       die("--progress can't be used with --incremental or porcelain formats");
+               show_progress = 0;
+       } else if (show_progress < 0)
+               show_progress = isatty(2);
        if (0 < abbrev)
                /* one more abbrev length is needed for the boundary commit */
                abbrev++;
                   fewer display columns. */
                blame_date_width = utf8_strwidth(_("4 years, 11 months ago")) + 1; /* add the null */
                break;
 -      case DATE_LOCAL:
        case DATE_NORMAL:
                blame_date_width = sizeof("Thu Oct 19 16:00:04 2006 -0700");
                break;
        }
        else if (contents_from)
                die("--contents and --reverse do not blend well.");
 -      else if (revs.first_parent_only)
 -              die("combining --first-parent and --reverse is not supported");
        else {
                final_commit_name = prepare_initial(&sb);
                sb.commits.compare = compare_commits_by_reverse_commit_date;
 +              if (revs.first_parent_only)
 +                      revs.children.name = NULL;
        }
  
        if (!sb.final) {
        else if (contents_from)
                die("Cannot use --contents with final commit object name");
  
 +      if (reverse && revs.first_parent_only) {
 +              final_commit = find_single_final(sb.revs, NULL);
 +              if (!final_commit)
 +                      die("--reverse and --first-parent together require specified latest commit");
 +      }
 +
        /*
         * If we have bottom, this will mark the ancestors of the
         * bottom commits we would reach while traversing as
        if (prepare_revision_walk(&revs))
                die(_("revision walk setup failed"));
  
 -      if (is_null_sha1(sb.final->object.sha1)) {
 +      if (reverse && revs.first_parent_only) {
 +              struct commit *c = final_commit;
 +
 +              sb.revs->children.name = "children";
 +              while (c->parents &&
 +                     oidcmp(&c->object.oid, &sb.final->object.oid)) {
 +                      struct commit_list *l = xcalloc(1, sizeof(*l));
 +
 +                      l->item = c;
 +                      if (add_decoration(&sb.revs->children,
 +                                         &c->parents->item->object, l))
 +                              die("BUG: not unique item in first-parent chain");
 +                      c = c->parents->item;
 +              }
 +
 +              if (oidcmp(&c->object.oid, &sb.final->object.oid))
 +                      die("--reverse --first-parent together require range along first-parent chain");
 +      }
 +
 +      if (is_null_oid(&sb.final->object.oid)) {
                o = sb.final->util;
                sb.final_buf = xmemdupz(o->file.ptr, o->file.size);
                sb.final_buf_size = o->file.size;
  
        read_mailmap(&mailmap, NULL);
  
+       assign_blame(&sb, opt);
        if (!incremental)
                setup_pager();
  
-       assign_blame(&sb, opt);
        free(final_commit_name);
  
        if (incremental)