blame: add support for --[no-]progress option

Teach the command to show progress output when it takes long time to
produce the first line of output; this option cannot be used with
"--incremental" or "--porcelain" options.

git-annotate inherits the option as well.

Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Edmundo Carmona Antoranz <eantoranz@gmail.com>
Reviewed-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt
index a09969ba086609af5d35bbb3c5f30dfea5db00b6..cd415e6287d91c440b64574cbdf345e40d622662 100644 (file)
--- a/Documentation/blame-options.txt
+++ b/Documentation/blame-options.txt
@@ -70,6 +70,13 @@ include::line-range-format.txt[]
        iso format is used. For more information, See the discussion
        of the --date option at linkgit:git-log[1].
 
        iso format is used. For more information, 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
 -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 --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt
index e6e947c808d5e419a9d974d63ab7b95195b667c8..ba5417567c4df286a95a99cf1ae3e02ee466458f 100644 (file)
--- a/Documentation/git-blame.txt
+++ b/Documentation/git-blame.txt
@@ -10,7 +10,8 @@ SYNOPSIS
 [verse]
 'git blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]
            [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>]
 [verse]
 'git blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]
            [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>]

-           [--abbrev=<n>] [<rev> | --contents <file> | --reverse <rev>] [--] <file>
+           [--progress] [--abbrev=<n>] [<rev> | --contents <file> | --reverse <rev>]
+           [--] <file>

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------

diff --git a/builtin/blame.c b/builtin/blame.c
index 6cac59c973bfcf1dc48e2a1af26375f914bb02c4..776bb10c727c043f42a7d939a22f740c05a13f79 100644 (file)
--- a/builtin/blame.c
+++ b/builtin/blame.c
@@ -28,6 +28,7 @@
 #include "line-range.h"
 #include "line-log.h"
 #include "dir.h"
 #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>");
 
 
 static char blame_usage[] = N_("git blame [<options>] [<rev-opts>] [<rev>] [--] <file>");
 


@@ -50,6 +51,7 @@ static int incremental;
 static int xdl_opts;
 static int abbrev = -1;
 static int no_whole_file_rename;
 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;
 
 static struct date_mode blame_date_mode = { DATE_ISO8601 };
 static size_t blame_date_width;


@@ -127,6 +129,11 @@ struct origin {
        char path[FLEX_ARRAY];
 };
 
        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)
 {
 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)
 {


@@ -1745,7 +1752,8 @@ static int emit_one_suspect_detail(struct origin *suspect, int repeat)
  * The blame_entry is found to be guilty for the range.
  * Show it in incremental output.
  */
  * 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;
 {
        if (incremental) {
                struct origin *suspect = ent->suspect;


@@ -1757,6 +1765,8 @@ static void found_guilty_entry(struct blame_entry *ent)
                write_filename_info(suspect->path);
                maybe_flush_or_die(stdout, "stdout");
        }
                write_filename_info(suspect->path);
                maybe_flush_or_die(stdout, "stdout");
        }

+       pi->blamed_lines += ent->num_lines;
+       display_progress(pi->progress, pi->blamed_lines);

 }
 
 /*
 }
 
 /*


@@ -1767,6 +1777,11 @@ static void assign_blame(struct scoreboard *sb, int opt)
 {
        struct rev_info *revs = sb->revs;
        struct commit *commit = prio_queue_get(&sb->commits);
 {
        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;
 
        while (commit) {
                struct blame_entry *ent;


@@ -1808,7 +1823,7 @@ static void assign_blame(struct scoreboard *sb, int opt)
                        suspect->guilty = 1;
                        for (;;) {
                                struct blame_entry *next = ent->next;
                        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 (next) {
                                        ent = next;
                                        continue;


@@ -1824,6 +1839,8 @@ static void assign_blame(struct scoreboard *sb, int opt)
                if (DEBUG) /* sanity */
                        sanity_check_refcnt(sb);
        }
                if (DEBUG) /* sanity */
                        sanity_check_refcnt(sb);
        }

+
+       stop_progress(&pi.progress);

 }
 
 static const char *format_time(unsigned long time, const char *tz_str,
 }
 
 static const char *format_time(unsigned long time, const char *tz_str,


@@ -2513,6 +2530,7 @@ int cmd_blame(int argc, const char **argv, const char *prefix)
                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('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),
                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),


@@ -2548,6 +2566,7 @@ int cmd_blame(int argc, const char **argv, const char *prefix)
 
        save_commit_buffer = 0;
        dashdash_pos = 0;
 
        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);
 
        parse_options_start(&ctx, argc, argv, prefix, options,
                            PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_ARGV0);


@@ -2572,6 +2591,13 @@ int cmd_blame(int argc, const char **argv, const char *prefix)
        DIFF_OPT_CLR(&revs.diffopt, FOLLOW_RENAMES);
        argc = parse_options_end(&ctx);
 
        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++;
        if (0 < abbrev)
                /* one more abbrev length is needed for the boundary commit */
                abbrev++;


@@ -2797,11 +2823,11 @@ int cmd_blame(int argc, const char **argv, const char *prefix)
 
        read_mailmap(&mailmap, NULL);
 
 
        read_mailmap(&mailmap, NULL);
 

+       assign_blame(&sb, opt);
+

        if (!incremental)
                setup_pager();
 
        if (!incremental)
                setup_pager();
 

-       assign_blame(&sb, opt);
-

        free(final_commit_name);
 
        if (incremental)
        free(final_commit_name);
 
        if (incremental)