The eleventh batch
[git/gitster.git] / builtin / blame.c
blobe407a22da3bacf6bd26a6738e0ab0292ffadc216
1 /*
2 * Blame
4 * Copyright (c) 2006, 2014 by its authors
5 * See COPYING for licensing conditions
6 */
7 #define USE_THE_REPOSITORY_VARIABLE
8 #include "builtin.h"
9 #include "config.h"
10 #include "color.h"
11 #include "builtin.h"
12 #include "environment.h"
13 #include "gettext.h"
14 #include "hex.h"
15 #include "commit.h"
16 #include "diff.h"
17 #include "revision.h"
18 #include "quote.h"
19 #include "string-list.h"
20 #include "mailmap.h"
21 #include "parse-options.h"
22 #include "prio-queue.h"
23 #include "utf8.h"
24 #include "userdiff.h"
25 #include "line-range.h"
26 #include "line-log.h"
27 #include "progress.h"
28 #include "object-name.h"
29 #include "object-store-ll.h"
30 #include "pager.h"
31 #include "blame.h"
32 #include "refs.h"
33 #include "setup.h"
34 #include "tag.h"
35 #include "write-or-die.h"
37 static char blame_usage[] = N_("git blame [<options>] [<rev-opts>] [<rev>] [--] <file>");
38 static char annotate_usage[] = N_("git annotate [<options>] [<rev-opts>] [<rev>] [--] <file>");
40 static const char *blame_opt_usage[] = {
41 blame_usage,
42 "",
43 N_("<rev-opts> are documented in git-rev-list(1)"),
44 NULL
47 static const char *annotate_opt_usage[] = {
48 annotate_usage,
49 "",
50 N_("<rev-opts> are documented in git-rev-list(1)"),
51 NULL
54 static int longest_file;
55 static int longest_author;
56 static int max_orig_digits;
57 static int max_digits;
58 static int max_score_digits;
59 static int show_root;
60 static int reverse;
61 static int blank_boundary;
62 static int incremental;
63 static int xdl_opts;
64 static int abbrev = -1;
65 static int no_whole_file_rename;
66 static int show_progress;
67 static char repeated_meta_color[COLOR_MAXLEN];
68 static int coloring_mode;
69 static struct string_list ignore_revs_file_list = STRING_LIST_INIT_DUP;
70 static int mark_unblamable_lines;
71 static int mark_ignored_lines;
73 static struct date_mode blame_date_mode = { DATE_ISO8601 };
74 static size_t blame_date_width;
76 static struct string_list mailmap = STRING_LIST_INIT_NODUP;
78 #ifndef DEBUG_BLAME
79 #define DEBUG_BLAME 0
80 #endif
82 static unsigned blame_move_score;
83 static unsigned blame_copy_score;
85 /* Remember to update object flag allocation in object.h */
86 #define METAINFO_SHOWN (1u<<12)
87 #define MORE_THAN_ONE_PATH (1u<<13)
89 struct progress_info {
90 struct progress *progress;
91 int blamed_lines;
94 static const char *nth_line_cb(void *data, long lno)
96 return blame_nth_line((struct blame_scoreboard *)data, lno);
100 * Information on commits, used for output.
102 struct commit_info {
103 struct strbuf author;
104 struct strbuf author_mail;
105 timestamp_t author_time;
106 struct strbuf author_tz;
108 /* filled only when asked for details */
109 struct strbuf committer;
110 struct strbuf committer_mail;
111 timestamp_t committer_time;
112 struct strbuf committer_tz;
114 struct strbuf summary;
117 #define COMMIT_INFO_INIT { \
118 .author = STRBUF_INIT, \
119 .author_mail = STRBUF_INIT, \
120 .author_tz = STRBUF_INIT, \
121 .committer = STRBUF_INIT, \
122 .committer_mail = STRBUF_INIT, \
123 .committer_tz = STRBUF_INIT, \
124 .summary = STRBUF_INIT, \
128 * Parse author/committer line in the commit object buffer
130 static void get_ac_line(const char *inbuf, const char *what,
131 struct strbuf *name, struct strbuf *mail,
132 timestamp_t *time, struct strbuf *tz)
134 struct ident_split ident;
135 size_t len, maillen, namelen;
136 const char *tmp, *endp;
137 const char *namebuf, *mailbuf;
139 tmp = strstr(inbuf, what);
140 if (!tmp)
141 goto error_out;
142 tmp += strlen(what);
143 endp = strchr(tmp, '\n');
144 if (!endp)
145 len = strlen(tmp);
146 else
147 len = endp - tmp;
149 if (split_ident_line(&ident, tmp, len)) {
150 error_out:
151 /* Ugh */
152 tmp = "(unknown)";
153 strbuf_addstr(name, tmp);
154 strbuf_addstr(mail, tmp);
155 strbuf_addstr(tz, tmp);
156 *time = 0;
157 return;
160 namelen = ident.name_end - ident.name_begin;
161 namebuf = ident.name_begin;
163 maillen = ident.mail_end - ident.mail_begin;
164 mailbuf = ident.mail_begin;
166 if (ident.date_begin && ident.date_end)
167 *time = strtoul(ident.date_begin, NULL, 10);
168 else
169 *time = 0;
171 if (ident.tz_begin && ident.tz_end)
172 strbuf_add(tz, ident.tz_begin, ident.tz_end - ident.tz_begin);
173 else
174 strbuf_addstr(tz, "(unknown)");
177 * Now, convert both name and e-mail using mailmap
179 map_user(&mailmap, &mailbuf, &maillen,
180 &namebuf, &namelen);
182 strbuf_addf(mail, "<%.*s>", (int)maillen, mailbuf);
183 strbuf_add(name, namebuf, namelen);
186 static void commit_info_destroy(struct commit_info *ci)
189 strbuf_release(&ci->author);
190 strbuf_release(&ci->author_mail);
191 strbuf_release(&ci->author_tz);
192 strbuf_release(&ci->committer);
193 strbuf_release(&ci->committer_mail);
194 strbuf_release(&ci->committer_tz);
195 strbuf_release(&ci->summary);
198 static void get_commit_info(struct commit *commit,
199 struct commit_info *ret,
200 int detailed)
202 int len;
203 const char *subject, *encoding;
204 const char *message;
206 encoding = get_log_output_encoding();
207 message = repo_logmsg_reencode(the_repository, commit, NULL, encoding);
208 get_ac_line(message, "\nauthor ",
209 &ret->author, &ret->author_mail,
210 &ret->author_time, &ret->author_tz);
212 if (!detailed) {
213 repo_unuse_commit_buffer(the_repository, commit, message);
214 return;
217 get_ac_line(message, "\ncommitter ",
218 &ret->committer, &ret->committer_mail,
219 &ret->committer_time, &ret->committer_tz);
221 len = find_commit_subject(message, &subject);
222 if (len)
223 strbuf_add(&ret->summary, subject, len);
224 else
225 strbuf_addf(&ret->summary, "(%s)", oid_to_hex(&commit->object.oid));
227 repo_unuse_commit_buffer(the_repository, commit, message);
231 * Write out any suspect information which depends on the path. This must be
232 * handled separately from emit_one_suspect_detail(), because a given commit
233 * may have changes in multiple paths. So this needs to appear each time
234 * we mention a new group.
236 * To allow LF and other nonportable characters in pathnames,
237 * they are c-style quoted as needed.
239 static void write_filename_info(struct blame_origin *suspect)
241 if (suspect->previous) {
242 struct blame_origin *prev = suspect->previous;
243 printf("previous %s ", oid_to_hex(&prev->commit->object.oid));
244 write_name_quoted(prev->path, stdout, '\n');
246 printf("filename ");
247 write_name_quoted(suspect->path, stdout, '\n');
251 * Porcelain/Incremental format wants to show a lot of details per
252 * commit. Instead of repeating this every line, emit it only once,
253 * the first time each commit appears in the output (unless the
254 * user has specifically asked for us to repeat).
256 static int emit_one_suspect_detail(struct blame_origin *suspect, int repeat)
258 struct commit_info ci = COMMIT_INFO_INIT;
260 if (!repeat && (suspect->commit->object.flags & METAINFO_SHOWN))
261 return 0;
263 suspect->commit->object.flags |= METAINFO_SHOWN;
264 get_commit_info(suspect->commit, &ci, 1);
265 printf("author %s\n", ci.author.buf);
266 printf("author-mail %s\n", ci.author_mail.buf);
267 printf("author-time %"PRItime"\n", ci.author_time);
268 printf("author-tz %s\n", ci.author_tz.buf);
269 printf("committer %s\n", ci.committer.buf);
270 printf("committer-mail %s\n", ci.committer_mail.buf);
271 printf("committer-time %"PRItime"\n", ci.committer_time);
272 printf("committer-tz %s\n", ci.committer_tz.buf);
273 printf("summary %s\n", ci.summary.buf);
274 if (suspect->commit->object.flags & UNINTERESTING)
275 printf("boundary\n");
277 commit_info_destroy(&ci);
279 return 1;
283 * The blame_entry is found to be guilty for the range.
284 * Show it in incremental output.
286 static void found_guilty_entry(struct blame_entry *ent, void *data)
288 struct progress_info *pi = (struct progress_info *)data;
290 if (incremental) {
291 struct blame_origin *suspect = ent->suspect;
293 printf("%s %d %d %d\n",
294 oid_to_hex(&suspect->commit->object.oid),
295 ent->s_lno + 1, ent->lno + 1, ent->num_lines);
296 emit_one_suspect_detail(suspect, 0);
297 write_filename_info(suspect);
298 maybe_flush_or_die(stdout, "stdout");
300 pi->blamed_lines += ent->num_lines;
301 display_progress(pi->progress, pi->blamed_lines);
304 static const char *format_time(timestamp_t time, const char *tz_str,
305 int show_raw_time)
307 static struct strbuf time_buf = STRBUF_INIT;
309 strbuf_reset(&time_buf);
310 if (show_raw_time) {
311 strbuf_addf(&time_buf, "%"PRItime" %s", time, tz_str);
313 else {
314 const char *time_str;
315 size_t time_width;
316 int tz;
317 tz = atoi(tz_str);
318 time_str = show_date(time, tz, blame_date_mode);
319 strbuf_addstr(&time_buf, time_str);
321 * Add space paddings to time_buf to display a fixed width
322 * string, and use time_width for display width calibration.
324 for (time_width = utf8_strwidth(time_str);
325 time_width < blame_date_width;
326 time_width++)
327 strbuf_addch(&time_buf, ' ');
329 return time_buf.buf;
332 #define OUTPUT_ANNOTATE_COMPAT (1U<<0)
333 #define OUTPUT_LONG_OBJECT_NAME (1U<<1)
334 #define OUTPUT_RAW_TIMESTAMP (1U<<2)
335 #define OUTPUT_PORCELAIN (1U<<3)
336 #define OUTPUT_SHOW_NAME (1U<<4)
337 #define OUTPUT_SHOW_NUMBER (1U<<5)
338 #define OUTPUT_SHOW_SCORE (1U<<6)
339 #define OUTPUT_NO_AUTHOR (1U<<7)
340 #define OUTPUT_SHOW_EMAIL (1U<<8)
341 #define OUTPUT_LINE_PORCELAIN (1U<<9)
342 #define OUTPUT_COLOR_LINE (1U<<10)
343 #define OUTPUT_SHOW_AGE_WITH_COLOR (1U<<11)
345 static void emit_porcelain_details(struct blame_origin *suspect, int repeat)
347 if (emit_one_suspect_detail(suspect, repeat) ||
348 (suspect->commit->object.flags & MORE_THAN_ONE_PATH))
349 write_filename_info(suspect);
352 static void emit_porcelain(struct blame_scoreboard *sb, struct blame_entry *ent,
353 int opt)
355 int repeat = opt & OUTPUT_LINE_PORCELAIN;
356 int cnt;
357 const char *cp;
358 struct blame_origin *suspect = ent->suspect;
359 char hex[GIT_MAX_HEXSZ + 1];
361 oid_to_hex_r(hex, &suspect->commit->object.oid);
362 printf("%s %d %d %d\n",
363 hex,
364 ent->s_lno + 1,
365 ent->lno + 1,
366 ent->num_lines);
367 emit_porcelain_details(suspect, repeat);
369 cp = blame_nth_line(sb, ent->lno);
370 for (cnt = 0; cnt < ent->num_lines; cnt++) {
371 char ch;
372 if (cnt) {
373 printf("%s %d %d\n", hex,
374 ent->s_lno + 1 + cnt,
375 ent->lno + 1 + cnt);
376 if (repeat)
377 emit_porcelain_details(suspect, 1);
379 putchar('\t');
380 do {
381 ch = *cp++;
382 putchar(ch);
383 } while (ch != '\n' &&
384 cp < sb->final_buf + sb->final_buf_size);
387 if (sb->final_buf_size && cp[-1] != '\n')
388 putchar('\n');
391 static struct color_field {
392 timestamp_t hop;
393 char col[COLOR_MAXLEN];
394 } *colorfield;
395 static int colorfield_nr, colorfield_alloc;
397 static void parse_color_fields(const char *s)
399 struct string_list l = STRING_LIST_INIT_DUP;
400 struct string_list_item *item;
401 enum { EXPECT_DATE, EXPECT_COLOR } next = EXPECT_COLOR;
403 colorfield_nr = 0;
405 /* Ideally this would be stripped and split at the same time? */
406 string_list_split(&l, s, ',', -1);
407 ALLOC_GROW(colorfield, colorfield_nr + 1, colorfield_alloc);
409 for_each_string_list_item(item, &l) {
410 switch (next) {
411 case EXPECT_DATE:
412 colorfield[colorfield_nr].hop = approxidate(item->string);
413 next = EXPECT_COLOR;
414 colorfield_nr++;
415 ALLOC_GROW(colorfield, colorfield_nr + 1, colorfield_alloc);
416 break;
417 case EXPECT_COLOR:
418 if (color_parse(item->string, colorfield[colorfield_nr].col))
419 die(_("expecting a color: %s"), item->string);
420 next = EXPECT_DATE;
421 break;
425 if (next == EXPECT_COLOR)
426 die(_("must end with a color"));
428 colorfield[colorfield_nr].hop = TIME_MAX;
429 string_list_clear(&l, 0);
432 static void setup_default_color_by_age(void)
434 parse_color_fields("blue,12 month ago,white,1 month ago,red");
437 static void determine_line_heat(struct commit_info *ci, const char **dest_color)
439 int i = 0;
441 while (i < colorfield_nr && ci->author_time > colorfield[i].hop)
442 i++;
444 *dest_color = colorfield[i].col;
447 static void emit_other(struct blame_scoreboard *sb, struct blame_entry *ent, int opt)
449 int cnt;
450 const char *cp;
451 struct blame_origin *suspect = ent->suspect;
452 struct commit_info ci = COMMIT_INFO_INIT;
453 char hex[GIT_MAX_HEXSZ + 1];
454 int show_raw_time = !!(opt & OUTPUT_RAW_TIMESTAMP);
455 const char *default_color = NULL, *color = NULL, *reset = NULL;
457 get_commit_info(suspect->commit, &ci, 1);
458 oid_to_hex_r(hex, &suspect->commit->object.oid);
460 cp = blame_nth_line(sb, ent->lno);
462 if (opt & OUTPUT_SHOW_AGE_WITH_COLOR) {
463 determine_line_heat(&ci, &default_color);
464 color = default_color;
465 reset = GIT_COLOR_RESET;
468 for (cnt = 0; cnt < ent->num_lines; cnt++) {
469 char ch;
470 int length = (opt & OUTPUT_LONG_OBJECT_NAME) ? the_hash_algo->hexsz : abbrev;
472 if (opt & OUTPUT_COLOR_LINE) {
473 if (cnt > 0) {
474 color = repeated_meta_color;
475 reset = GIT_COLOR_RESET;
476 } else {
477 color = default_color ? default_color : NULL;
478 reset = default_color ? GIT_COLOR_RESET : NULL;
481 if (color)
482 fputs(color, stdout);
484 if (suspect->commit->object.flags & UNINTERESTING) {
485 if (blank_boundary)
486 memset(hex, ' ', length);
487 else if (!(opt & OUTPUT_ANNOTATE_COMPAT)) {
488 length--;
489 putchar('^');
493 if (mark_unblamable_lines && ent->unblamable) {
494 length--;
495 putchar('*');
497 if (mark_ignored_lines && ent->ignored) {
498 length--;
499 putchar('?');
501 printf("%.*s", length, hex);
502 if (opt & OUTPUT_ANNOTATE_COMPAT) {
503 const char *name;
504 if (opt & OUTPUT_SHOW_EMAIL)
505 name = ci.author_mail.buf;
506 else
507 name = ci.author.buf;
508 printf("\t(%10s\t%10s\t%d)", name,
509 format_time(ci.author_time, ci.author_tz.buf,
510 show_raw_time),
511 ent->lno + 1 + cnt);
512 } else {
513 if (opt & OUTPUT_SHOW_SCORE)
514 printf(" %*d %02d",
515 max_score_digits, ent->score,
516 ent->suspect->refcnt);
517 if (opt & OUTPUT_SHOW_NAME)
518 printf(" %-*.*s", longest_file, longest_file,
519 suspect->path);
520 if (opt & OUTPUT_SHOW_NUMBER)
521 printf(" %*d", max_orig_digits,
522 ent->s_lno + 1 + cnt);
524 if (!(opt & OUTPUT_NO_AUTHOR)) {
525 const char *name;
526 int pad;
527 if (opt & OUTPUT_SHOW_EMAIL)
528 name = ci.author_mail.buf;
529 else
530 name = ci.author.buf;
531 pad = longest_author - utf8_strwidth(name);
532 printf(" (%s%*s %10s",
533 name, pad, "",
534 format_time(ci.author_time,
535 ci.author_tz.buf,
536 show_raw_time));
538 printf(" %*d) ",
539 max_digits, ent->lno + 1 + cnt);
541 if (reset)
542 fputs(reset, stdout);
543 do {
544 ch = *cp++;
545 putchar(ch);
546 } while (ch != '\n' &&
547 cp < sb->final_buf + sb->final_buf_size);
550 if (sb->final_buf_size && cp[-1] != '\n')
551 putchar('\n');
553 commit_info_destroy(&ci);
556 static void output(struct blame_scoreboard *sb, int option)
558 struct blame_entry *ent;
560 if (option & OUTPUT_PORCELAIN) {
561 for (ent = sb->ent; ent; ent = ent->next) {
562 int count = 0;
563 struct blame_origin *suspect;
564 struct commit *commit = ent->suspect->commit;
565 if (commit->object.flags & MORE_THAN_ONE_PATH)
566 continue;
567 for (suspect = get_blame_suspects(commit); suspect; suspect = suspect->next) {
568 if (suspect->guilty && count++) {
569 commit->object.flags |= MORE_THAN_ONE_PATH;
570 break;
576 for (ent = sb->ent; ent; ent = ent->next) {
577 if (option & OUTPUT_PORCELAIN)
578 emit_porcelain(sb, ent, option);
579 else {
580 emit_other(sb, ent, option);
586 * Add phony grafts for use with -S; this is primarily to
587 * support git's cvsserver that wants to give a linear history
588 * to its clients.
590 static int read_ancestry(const char *graft_file)
592 FILE *fp = fopen_or_warn(graft_file, "r");
593 struct strbuf buf = STRBUF_INIT;
594 if (!fp)
595 return -1;
596 while (!strbuf_getwholeline(&buf, fp, '\n')) {
597 /* The format is just "Commit Parent1 Parent2 ...\n" */
598 struct commit_graft *graft = read_graft_line(&buf);
599 if (graft)
600 register_commit_graft(the_repository, graft, 0);
602 fclose(fp);
603 strbuf_release(&buf);
604 return 0;
607 static int update_auto_abbrev(int auto_abbrev, struct blame_origin *suspect)
609 const char *uniq = repo_find_unique_abbrev(the_repository,
610 &suspect->commit->object.oid,
611 auto_abbrev);
612 int len = strlen(uniq);
613 if (auto_abbrev < len)
614 return len;
615 return auto_abbrev;
619 * How many columns do we need to show line numbers, authors,
620 * and filenames?
622 static void find_alignment(struct blame_scoreboard *sb, int *option)
624 int longest_src_lines = 0;
625 int longest_dst_lines = 0;
626 unsigned largest_score = 0;
627 struct blame_entry *e;
628 int compute_auto_abbrev = (abbrev < 0);
629 int auto_abbrev = DEFAULT_ABBREV;
631 for (e = sb->ent; e; e = e->next) {
632 struct blame_origin *suspect = e->suspect;
633 int num;
635 if (compute_auto_abbrev)
636 auto_abbrev = update_auto_abbrev(auto_abbrev, suspect);
637 if (strcmp(suspect->path, sb->path))
638 *option |= OUTPUT_SHOW_NAME;
639 num = strlen(suspect->path);
640 if (longest_file < num)
641 longest_file = num;
642 if (!(suspect->commit->object.flags & METAINFO_SHOWN)) {
643 struct commit_info ci = COMMIT_INFO_INIT;
644 suspect->commit->object.flags |= METAINFO_SHOWN;
645 get_commit_info(suspect->commit, &ci, 1);
646 if (*option & OUTPUT_SHOW_EMAIL)
647 num = utf8_strwidth(ci.author_mail.buf);
648 else
649 num = utf8_strwidth(ci.author.buf);
650 if (longest_author < num)
651 longest_author = num;
652 commit_info_destroy(&ci);
654 num = e->s_lno + e->num_lines;
655 if (longest_src_lines < num)
656 longest_src_lines = num;
657 num = e->lno + e->num_lines;
658 if (longest_dst_lines < num)
659 longest_dst_lines = num;
660 if (largest_score < blame_entry_score(sb, e))
661 largest_score = blame_entry_score(sb, e);
663 max_orig_digits = decimal_width(longest_src_lines);
664 max_digits = decimal_width(longest_dst_lines);
665 max_score_digits = decimal_width(largest_score);
667 if (compute_auto_abbrev)
668 /* one more abbrev length is needed for the boundary commit */
669 abbrev = auto_abbrev + 1;
672 static void sanity_check_on_fail(struct blame_scoreboard *sb, int baa)
674 int opt = OUTPUT_SHOW_SCORE | OUTPUT_SHOW_NUMBER | OUTPUT_SHOW_NAME;
675 find_alignment(sb, &opt);
676 output(sb, opt);
677 die("Baa %d!", baa);
680 static unsigned parse_score(const char *arg)
682 char *end;
683 unsigned long score = strtoul(arg, &end, 10);
684 if (*end)
685 return 0;
686 return score;
689 static char *add_prefix(const char *prefix, const char *path)
691 return prefix_path(prefix, prefix ? strlen(prefix) : 0, path);
694 static int git_blame_config(const char *var, const char *value,
695 const struct config_context *ctx, void *cb)
697 if (!strcmp(var, "blame.showroot")) {
698 show_root = git_config_bool(var, value);
699 return 0;
701 if (!strcmp(var, "blame.blankboundary")) {
702 blank_boundary = git_config_bool(var, value);
703 return 0;
705 if (!strcmp(var, "blame.showemail")) {
706 int *output_option = cb;
707 if (git_config_bool(var, value))
708 *output_option |= OUTPUT_SHOW_EMAIL;
709 else
710 *output_option &= ~OUTPUT_SHOW_EMAIL;
711 return 0;
713 if (!strcmp(var, "blame.date")) {
714 if (!value)
715 return config_error_nonbool(var);
716 parse_date_format(value, &blame_date_mode);
717 return 0;
719 if (!strcmp(var, "blame.ignorerevsfile")) {
720 char *str;
721 int ret;
723 ret = git_config_pathname(&str, var, value);
724 if (ret)
725 return ret;
726 string_list_insert(&ignore_revs_file_list, str);
727 free(str);
728 return 0;
730 if (!strcmp(var, "blame.markunblamablelines")) {
731 mark_unblamable_lines = git_config_bool(var, value);
732 return 0;
734 if (!strcmp(var, "blame.markignoredlines")) {
735 mark_ignored_lines = git_config_bool(var, value);
736 return 0;
738 if (!strcmp(var, "color.blame.repeatedlines")) {
739 if (color_parse_mem(value, strlen(value), repeated_meta_color))
740 warning(_("invalid value for '%s': '%s'"),
741 "color.blame.repeatedLines", value);
742 return 0;
744 if (!strcmp(var, "color.blame.highlightrecent")) {
745 parse_color_fields(value);
746 return 0;
749 if (!strcmp(var, "blame.coloring")) {
750 if (!value)
751 return config_error_nonbool(var);
752 if (!strcmp(value, "repeatedLines")) {
753 coloring_mode |= OUTPUT_COLOR_LINE;
754 } else if (!strcmp(value, "highlightRecent")) {
755 coloring_mode |= OUTPUT_SHOW_AGE_WITH_COLOR;
756 } else if (!strcmp(value, "none")) {
757 coloring_mode &= ~(OUTPUT_COLOR_LINE |
758 OUTPUT_SHOW_AGE_WITH_COLOR);
759 } else {
760 warning(_("invalid value for '%s': '%s'"),
761 "blame.coloring", value);
762 return 0;
766 if (git_diff_heuristic_config(var, value, cb) < 0)
767 return -1;
768 if (userdiff_config(var, value) < 0)
769 return -1;
771 return git_default_config(var, value, ctx, cb);
774 static int blame_copy_callback(const struct option *option, const char *arg, int unset)
776 int *opt = option->value;
778 BUG_ON_OPT_NEG(unset);
781 * -C enables copy from removed files;
782 * -C -C enables copy from existing files, but only
783 * when blaming a new file;
784 * -C -C -C enables copy from existing files for
785 * everybody
787 if (*opt & PICKAXE_BLAME_COPY_HARDER)
788 *opt |= PICKAXE_BLAME_COPY_HARDEST;
789 if (*opt & PICKAXE_BLAME_COPY)
790 *opt |= PICKAXE_BLAME_COPY_HARDER;
791 *opt |= PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE;
793 if (arg)
794 blame_copy_score = parse_score(arg);
795 return 0;
798 static int blame_move_callback(const struct option *option, const char *arg, int unset)
800 int *opt = option->value;
802 BUG_ON_OPT_NEG(unset);
804 *opt |= PICKAXE_BLAME_MOVE;
806 if (arg)
807 blame_move_score = parse_score(arg);
808 return 0;
811 static int is_a_rev(const char *name)
813 struct object_id oid;
815 if (repo_get_oid(the_repository, name, &oid))
816 return 0;
817 return OBJ_NONE < oid_object_info(the_repository, &oid, NULL);
820 static int peel_to_commit_oid(struct object_id *oid_ret, void *cbdata)
822 struct repository *r = ((struct blame_scoreboard *)cbdata)->repo;
823 struct object_id oid;
825 oidcpy(&oid, oid_ret);
826 while (1) {
827 struct object *obj;
828 int kind = oid_object_info(r, &oid, NULL);
829 if (kind == OBJ_COMMIT) {
830 oidcpy(oid_ret, &oid);
831 return 0;
833 if (kind != OBJ_TAG)
834 return -1;
835 obj = deref_tag(r, parse_object(r, &oid), NULL, 0);
836 if (!obj)
837 return -1;
838 oidcpy(&oid, &obj->oid);
842 static void build_ignorelist(struct blame_scoreboard *sb,
843 struct string_list *ignore_revs_file_list,
844 struct string_list *ignore_rev_list)
846 struct string_list_item *i;
847 struct object_id oid;
849 oidset_init(&sb->ignore_list, 0);
850 for_each_string_list_item(i, ignore_revs_file_list) {
851 if (!strcmp(i->string, ""))
852 oidset_clear(&sb->ignore_list);
853 else
854 oidset_parse_file_carefully(&sb->ignore_list, i->string,
855 the_repository->hash_algo,
856 peel_to_commit_oid, sb);
858 for_each_string_list_item(i, ignore_rev_list) {
859 if (repo_get_oid_committish(the_repository, i->string, &oid) ||
860 peel_to_commit_oid(&oid, sb))
861 die(_("cannot find revision %s to ignore"), i->string);
862 oidset_insert(&sb->ignore_list, &oid);
866 int cmd_blame(int argc,
867 const char **argv,
868 const char *prefix,
869 struct repository *repo UNUSED)
871 struct rev_info revs;
872 char *path = NULL;
873 struct blame_scoreboard sb;
874 struct blame_origin *o;
875 struct blame_entry *ent = NULL;
876 long dashdash_pos, lno;
877 struct progress_info pi = { NULL, 0 };
879 struct string_list range_list = STRING_LIST_INIT_NODUP;
880 struct string_list ignore_rev_list = STRING_LIST_INIT_NODUP;
881 int output_option = 0, opt = 0;
882 int show_stats = 0;
883 const char *revs_file = NULL;
884 const char *contents_from = NULL;
885 const struct option options[] = {
886 OPT_BOOL(0, "incremental", &incremental, N_("show blame entries as we find them, incrementally")),
887 OPT_BOOL('b', NULL, &blank_boundary, N_("do not show object names of boundary commits (Default: off)")),
888 OPT_BOOL(0, "root", &show_root, N_("do not treat root commits as boundaries (Default: off)")),
889 OPT_BOOL(0, "show-stats", &show_stats, N_("show work cost statistics")),
890 OPT_BOOL(0, "progress", &show_progress, N_("force progress reporting")),
891 OPT_BIT(0, "score-debug", &output_option, N_("show output score for blame entries"), OUTPUT_SHOW_SCORE),
892 OPT_BIT('f', "show-name", &output_option, N_("show original filename (Default: auto)"), OUTPUT_SHOW_NAME),
893 OPT_BIT('n', "show-number", &output_option, N_("show original linenumber (Default: off)"), OUTPUT_SHOW_NUMBER),
894 OPT_BIT('p', "porcelain", &output_option, N_("show in a format designed for machine consumption"), OUTPUT_PORCELAIN),
895 OPT_BIT(0, "line-porcelain", &output_option, N_("show porcelain format with per-line commit information"), OUTPUT_PORCELAIN|OUTPUT_LINE_PORCELAIN),
896 OPT_BIT('c', NULL, &output_option, N_("use the same output mode as git-annotate (Default: off)"), OUTPUT_ANNOTATE_COMPAT),
897 OPT_BIT('t', NULL, &output_option, N_("show raw timestamp (Default: off)"), OUTPUT_RAW_TIMESTAMP),
898 OPT_BIT('l', NULL, &output_option, N_("show long commit SHA1 (Default: off)"), OUTPUT_LONG_OBJECT_NAME),
899 OPT_BIT('s', NULL, &output_option, N_("suppress author name and timestamp (Default: off)"), OUTPUT_NO_AUTHOR),
900 OPT_BIT('e', "show-email", &output_option, N_("show author email instead of name (Default: off)"), OUTPUT_SHOW_EMAIL),
901 OPT_BIT('w', NULL, &xdl_opts, N_("ignore whitespace differences"), XDF_IGNORE_WHITESPACE),
902 OPT_STRING_LIST(0, "ignore-rev", &ignore_rev_list, N_("rev"), N_("ignore <rev> when blaming")),
903 OPT_STRING_LIST(0, "ignore-revs-file", &ignore_revs_file_list, N_("file"), N_("ignore revisions from <file>")),
904 OPT_BIT(0, "color-lines", &output_option, N_("color redundant metadata from previous line differently"), OUTPUT_COLOR_LINE),
905 OPT_BIT(0, "color-by-age", &output_option, N_("color lines by age"), OUTPUT_SHOW_AGE_WITH_COLOR),
906 OPT_BIT(0, "minimal", &xdl_opts, N_("spend extra cycles to find better match"), XDF_NEED_MINIMAL),
907 OPT_STRING('S', NULL, &revs_file, N_("file"), N_("use revisions from <file> instead of calling git-rev-list")),
908 OPT_STRING(0, "contents", &contents_from, N_("file"), N_("use <file>'s contents as the final image")),
909 OPT_CALLBACK_F('C', NULL, &opt, N_("score"), N_("find line copies within and across files"), PARSE_OPT_OPTARG, blame_copy_callback),
910 OPT_CALLBACK_F('M', NULL, &opt, N_("score"), N_("find line movements within and across files"), PARSE_OPT_OPTARG, blame_move_callback),
911 OPT_STRING_LIST('L', NULL, &range_list, N_("range"),
912 N_("process only line range <start>,<end> or function :<funcname>")),
913 OPT__ABBREV(&abbrev),
914 OPT_END()
917 struct parse_opt_ctx_t ctx;
918 int cmd_is_annotate = !strcmp(argv[0], "annotate");
919 struct range_set ranges;
920 unsigned int range_i;
921 long anchor;
922 long num_lines = 0;
923 const char *str_usage = cmd_is_annotate ? annotate_usage : blame_usage;
924 const char **opt_usage = cmd_is_annotate ? annotate_opt_usage : blame_opt_usage;
926 setup_default_color_by_age();
927 git_config(git_blame_config, &output_option);
928 repo_init_revisions(the_repository, &revs, NULL);
929 revs.date_mode = blame_date_mode;
930 revs.diffopt.flags.allow_textconv = 1;
931 revs.diffopt.flags.follow_renames = 1;
933 save_commit_buffer = 0;
934 dashdash_pos = 0;
935 show_progress = -1;
937 parse_options_start(&ctx, argc, argv, prefix, options,
938 PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_ARGV0);
939 for (;;) {
940 switch (parse_options_step(&ctx, options, opt_usage)) {
941 case PARSE_OPT_NON_OPTION:
942 case PARSE_OPT_UNKNOWN:
943 break;
944 case PARSE_OPT_HELP:
945 case PARSE_OPT_ERROR:
946 case PARSE_OPT_SUBCOMMAND:
947 exit(129);
948 case PARSE_OPT_COMPLETE:
949 exit(0);
950 case PARSE_OPT_DONE:
951 if (ctx.argv[0])
952 dashdash_pos = ctx.cpidx;
953 goto parse_done;
956 if (!strcmp(ctx.argv[0], "--reverse")) {
957 ctx.argv[0] = "--children";
958 reverse = 1;
960 parse_revision_opt(&revs, &ctx, options, opt_usage);
962 parse_done:
963 revision_opts_finish(&revs);
964 no_whole_file_rename = !revs.diffopt.flags.follow_renames;
965 xdl_opts |= revs.diffopt.xdl_opts & XDF_INDENT_HEURISTIC;
966 revs.diffopt.flags.follow_renames = 0;
967 argc = parse_options_end(&ctx);
969 prepare_repo_settings(the_repository);
970 the_repository->settings.command_requires_full_index = 0;
972 if (incremental || (output_option & OUTPUT_PORCELAIN)) {
973 if (show_progress > 0)
974 die(_("--progress can't be used with --incremental or porcelain formats"));
975 show_progress = 0;
976 } else if (show_progress < 0)
977 show_progress = isatty(2);
979 if (0 < abbrev && abbrev < (int)the_hash_algo->hexsz)
980 /* one more abbrev length is needed for the boundary commit */
981 abbrev++;
982 else if (!abbrev)
983 abbrev = the_hash_algo->hexsz;
985 if (revs_file && read_ancestry(revs_file))
986 die_errno("reading graft file '%s' failed", revs_file);
988 if (cmd_is_annotate) {
989 output_option |= OUTPUT_ANNOTATE_COMPAT;
990 blame_date_mode.type = DATE_ISO8601;
991 } else {
992 blame_date_mode = revs.date_mode;
995 /* The maximum width used to show the dates */
996 switch (blame_date_mode.type) {
997 case DATE_RFC2822:
998 blame_date_width = sizeof("Thu, 19 Oct 2006 16:00:04 -0700");
999 break;
1000 case DATE_ISO8601_STRICT:
1001 blame_date_width = sizeof("2006-10-19T16:00:04-07:00");
1002 break;
1003 case DATE_ISO8601:
1004 blame_date_width = sizeof("2006-10-19 16:00:04 -0700");
1005 break;
1006 case DATE_RAW:
1007 blame_date_width = sizeof("1161298804 -0700");
1008 break;
1009 case DATE_UNIX:
1010 blame_date_width = sizeof("1161298804");
1011 break;
1012 case DATE_SHORT:
1013 blame_date_width = sizeof("2006-10-19");
1014 break;
1015 case DATE_RELATIVE:
1017 * TRANSLATORS: This string is used to tell us the
1018 * maximum display width for a relative timestamp in
1019 * "git blame" output. For C locale, "4 years, 11
1020 * months ago", which takes 22 places, is the longest
1021 * among various forms of relative timestamps, but
1022 * your language may need more or fewer display
1023 * columns.
1025 blame_date_width = utf8_strwidth(_("4 years, 11 months ago")) + 1; /* add the null */
1026 break;
1027 case DATE_HUMAN:
1028 /* If the year is shown, no time is shown */
1029 blame_date_width = sizeof("Thu Oct 19 16:00");
1030 break;
1031 case DATE_NORMAL:
1032 blame_date_width = sizeof("Thu Oct 19 16:00:04 2006 -0700");
1033 break;
1034 case DATE_STRFTIME:
1035 blame_date_width = strlen(show_date(0, 0, blame_date_mode)) + 1; /* add the null */
1036 break;
1038 blame_date_width -= 1; /* strip the null */
1040 if (revs.diffopt.flags.find_copies_harder)
1041 opt |= (PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE |
1042 PICKAXE_BLAME_COPY_HARDER);
1045 * We have collected options unknown to us in argv[1..unk]
1046 * which are to be passed to revision machinery if we are
1047 * going to do the "bottom" processing.
1049 * The remaining are:
1051 * (1) if dashdash_pos != 0, it is either
1052 * "blame [revisions] -- <path>" or
1053 * "blame -- <path> <rev>"
1055 * (2) otherwise, it is one of the two:
1056 * "blame [revisions] <path>"
1057 * "blame <path> <rev>"
1059 * Note that we must strip out <path> from the arguments: we do not
1060 * want the path pruning but we may want "bottom" processing.
1062 if (dashdash_pos) {
1063 switch (argc - dashdash_pos - 1) {
1064 case 2: /* (1b) */
1065 if (argc != 4)
1066 usage_with_options(opt_usage, options);
1067 /* reorder for the new way: <rev> -- <path> */
1068 argv[1] = argv[3];
1069 argv[3] = argv[2];
1070 argv[2] = "--";
1071 /* FALLTHROUGH */
1072 case 1: /* (1a) */
1073 path = add_prefix(prefix, argv[--argc]);
1074 argv[argc] = NULL;
1075 break;
1076 default:
1077 usage_with_options(opt_usage, options);
1079 } else {
1080 if (argc < 2)
1081 usage_with_options(opt_usage, options);
1082 if (argc == 3 && is_a_rev(argv[argc - 1])) { /* (2b) */
1083 path = add_prefix(prefix, argv[1]);
1084 argv[1] = argv[2];
1085 } else { /* (2a) */
1086 if (argc == 2 && is_a_rev(argv[1]) && !repo_get_work_tree(the_repository))
1087 die("missing <path> to blame");
1088 path = add_prefix(prefix, argv[argc - 1]);
1090 argv[argc - 1] = "--";
1093 revs.disable_stdin = 1;
1094 setup_revisions(argc, argv, &revs, NULL);
1095 if (!revs.pending.nr && is_bare_repository()) {
1096 struct commit *head_commit;
1097 struct object_id head_oid;
1099 if (!refs_resolve_ref_unsafe(get_main_ref_store(the_repository), "HEAD", RESOLVE_REF_READING,
1100 &head_oid, NULL) ||
1101 !(head_commit = lookup_commit_reference_gently(revs.repo,
1102 &head_oid, 1)))
1103 die("no such ref: HEAD");
1105 add_pending_object(&revs, &head_commit->object, "HEAD");
1108 init_scoreboard(&sb);
1109 sb.revs = &revs;
1110 sb.contents_from = contents_from;
1111 sb.reverse = reverse;
1112 sb.repo = the_repository;
1113 sb.path = path;
1114 build_ignorelist(&sb, &ignore_revs_file_list, &ignore_rev_list);
1115 string_list_clear(&ignore_revs_file_list, 0);
1116 string_list_clear(&ignore_rev_list, 0);
1117 setup_scoreboard(&sb, &o);
1120 * Changed-path Bloom filters are disabled when looking
1121 * for copies.
1123 if (!(opt & PICKAXE_BLAME_COPY))
1124 setup_blame_bloom_data(&sb);
1126 lno = sb.num_lines;
1128 if (lno && !range_list.nr)
1129 string_list_append(&range_list, "1");
1131 anchor = 1;
1132 range_set_init(&ranges, range_list.nr);
1133 for (range_i = 0; range_i < range_list.nr; ++range_i) {
1134 long bottom, top;
1135 if (parse_range_arg(range_list.items[range_i].string,
1136 nth_line_cb, &sb, lno, anchor,
1137 &bottom, &top, sb.path,
1138 the_repository->index))
1139 usage(str_usage);
1140 if ((!lno && (top || bottom)) || lno < bottom)
1141 die(Q_("file %s has only %lu line",
1142 "file %s has only %lu lines",
1143 lno), sb.path, lno);
1144 if (bottom < 1)
1145 bottom = 1;
1146 if (top < 1 || lno < top)
1147 top = lno;
1148 bottom--;
1149 range_set_append_unsafe(&ranges, bottom, top);
1150 anchor = top + 1;
1152 sort_and_merge_range_set(&ranges);
1154 for (range_i = ranges.nr; range_i > 0; --range_i) {
1155 const struct range *r = &ranges.ranges[range_i - 1];
1156 ent = blame_entry_prepend(ent, r->start, r->end, o);
1157 num_lines += (r->end - r->start);
1159 if (!num_lines)
1160 num_lines = sb.num_lines;
1162 o->suspects = ent;
1163 prio_queue_put(&sb.commits, o->commit);
1165 blame_origin_decref(o);
1167 range_set_release(&ranges);
1168 string_list_clear(&range_list, 0);
1170 sb.ent = NULL;
1172 if (blame_move_score)
1173 sb.move_score = blame_move_score;
1174 if (blame_copy_score)
1175 sb.copy_score = blame_copy_score;
1177 sb.debug = DEBUG_BLAME;
1178 sb.on_sanity_fail = &sanity_check_on_fail;
1180 sb.show_root = show_root;
1181 sb.xdl_opts = xdl_opts;
1182 sb.no_whole_file_rename = no_whole_file_rename;
1184 read_mailmap(&mailmap);
1186 sb.found_guilty_entry = &found_guilty_entry;
1187 sb.found_guilty_entry_data = &pi;
1188 if (show_progress)
1189 pi.progress = start_delayed_progress(_("Blaming lines"), num_lines);
1191 assign_blame(&sb, opt);
1193 stop_progress(&pi.progress);
1195 if (!incremental)
1196 setup_pager();
1197 else
1198 goto cleanup;
1200 blame_sort_final(&sb);
1202 blame_coalesce(&sb);
1204 if (!(output_option & (OUTPUT_COLOR_LINE | OUTPUT_SHOW_AGE_WITH_COLOR)))
1205 output_option |= coloring_mode;
1207 if (!(output_option & OUTPUT_PORCELAIN)) {
1208 find_alignment(&sb, &output_option);
1209 if (!*repeated_meta_color &&
1210 (output_option & OUTPUT_COLOR_LINE))
1211 xsnprintf(repeated_meta_color,
1212 sizeof(repeated_meta_color),
1213 "%s", GIT_COLOR_CYAN);
1215 if (output_option & OUTPUT_ANNOTATE_COMPAT)
1216 output_option &= ~(OUTPUT_COLOR_LINE | OUTPUT_SHOW_AGE_WITH_COLOR);
1218 output(&sb, output_option);
1219 free((void *)sb.final_buf);
1220 for (ent = sb.ent; ent; ) {
1221 struct blame_entry *e = ent->next;
1222 free(ent);
1223 ent = e;
1226 if (show_stats) {
1227 printf("num read blob: %d\n", sb.num_read_blob);
1228 printf("num get patch: %d\n", sb.num_get_patch);
1229 printf("num commits: %d\n", sb.num_commits);
1232 cleanup:
1233 free(path);
1234 cleanup_scoreboard(&sb);
1235 release_revisions(&revs);
1236 return 0;