gpg-interface: drop pointless config_error_nonbool() checks
[alt-git.git] / builtin / blame.c
blob2433b7da5cec6b8300b0316d8054af486a92ba7f
1 /*
2 * Blame
4 * Copyright (c) 2006, 2014 by its authors
5 * See COPYING for licensing conditions
6 */
8 #include "git-compat-util.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 "repository.h"
16 #include "commit.h"
17 #include "diff.h"
18 #include "revision.h"
19 #include "quote.h"
20 #include "string-list.h"
21 #include "mailmap.h"
22 #include "parse-options.h"
23 #include "prio-queue.h"
24 #include "utf8.h"
25 #include "userdiff.h"
26 #include "line-range.h"
27 #include "line-log.h"
28 #include "dir.h"
29 #include "progress.h"
30 #include "object-name.h"
31 #include "object-store-ll.h"
32 #include "pager.h"
33 #include "blame.h"
34 #include "refs.h"
35 #include "setup.h"
36 #include "tag.h"
37 #include "write-or-die.h"
39 static char blame_usage[] = N_("git blame [<options>] [<rev-opts>] [<rev>] [--] <file>");
40 static char annotate_usage[] = N_("git annotate [<options>] [<rev-opts>] [<rev>] [--] <file>");
42 static const char *blame_opt_usage[] = {
43 blame_usage,
44 "",
45 N_("<rev-opts> are documented in git-rev-list(1)"),
46 NULL
49 static const char *annotate_opt_usage[] = {
50 annotate_usage,
51 "",
52 N_("<rev-opts> are documented in git-rev-list(1)"),
53 NULL
56 static int longest_file;
57 static int longest_author;
58 static int max_orig_digits;
59 static int max_digits;
60 static int max_score_digits;
61 static int show_root;
62 static int reverse;
63 static int blank_boundary;
64 static int incremental;
65 static int xdl_opts;
66 static int abbrev = -1;
67 static int no_whole_file_rename;
68 static int show_progress;
69 static char repeated_meta_color[COLOR_MAXLEN];
70 static int coloring_mode;
71 static struct string_list ignore_revs_file_list = STRING_LIST_INIT_NODUP;
72 static int mark_unblamable_lines;
73 static int mark_ignored_lines;
75 static struct date_mode blame_date_mode = { DATE_ISO8601 };
76 static size_t blame_date_width;
78 static struct string_list mailmap = STRING_LIST_INIT_NODUP;
80 #ifndef DEBUG_BLAME
81 #define DEBUG_BLAME 0
82 #endif
84 static unsigned blame_move_score;
85 static unsigned blame_copy_score;
87 /* Remember to update object flag allocation in object.h */
88 #define METAINFO_SHOWN (1u<<12)
89 #define MORE_THAN_ONE_PATH (1u<<13)
91 struct progress_info {
92 struct progress *progress;
93 int blamed_lines;
96 static const char *nth_line_cb(void *data, long lno)
98 return blame_nth_line((struct blame_scoreboard *)data, lno);
102 * Information on commits, used for output.
104 struct commit_info {
105 struct strbuf author;
106 struct strbuf author_mail;
107 timestamp_t author_time;
108 struct strbuf author_tz;
110 /* filled only when asked for details */
111 struct strbuf committer;
112 struct strbuf committer_mail;
113 timestamp_t committer_time;
114 struct strbuf committer_tz;
116 struct strbuf summary;
119 #define COMMIT_INFO_INIT { \
120 .author = STRBUF_INIT, \
121 .author_mail = STRBUF_INIT, \
122 .author_tz = STRBUF_INIT, \
123 .committer = STRBUF_INIT, \
124 .committer_mail = STRBUF_INIT, \
125 .committer_tz = STRBUF_INIT, \
126 .summary = STRBUF_INIT, \
130 * Parse author/committer line in the commit object buffer
132 static void get_ac_line(const char *inbuf, const char *what,
133 struct strbuf *name, struct strbuf *mail,
134 timestamp_t *time, struct strbuf *tz)
136 struct ident_split ident;
137 size_t len, maillen, namelen;
138 char *tmp, *endp;
139 const char *namebuf, *mailbuf;
141 tmp = strstr(inbuf, what);
142 if (!tmp)
143 goto error_out;
144 tmp += strlen(what);
145 endp = strchr(tmp, '\n');
146 if (!endp)
147 len = strlen(tmp);
148 else
149 len = endp - tmp;
151 if (split_ident_line(&ident, tmp, len)) {
152 error_out:
153 /* Ugh */
154 tmp = "(unknown)";
155 strbuf_addstr(name, tmp);
156 strbuf_addstr(mail, tmp);
157 strbuf_addstr(tz, tmp);
158 *time = 0;
159 return;
162 namelen = ident.name_end - ident.name_begin;
163 namebuf = ident.name_begin;
165 maillen = ident.mail_end - ident.mail_begin;
166 mailbuf = ident.mail_begin;
168 if (ident.date_begin && ident.date_end)
169 *time = strtoul(ident.date_begin, NULL, 10);
170 else
171 *time = 0;
173 if (ident.tz_begin && ident.tz_end)
174 strbuf_add(tz, ident.tz_begin, ident.tz_end - ident.tz_begin);
175 else
176 strbuf_addstr(tz, "(unknown)");
179 * Now, convert both name and e-mail using mailmap
181 map_user(&mailmap, &mailbuf, &maillen,
182 &namebuf, &namelen);
184 strbuf_addf(mail, "<%.*s>", (int)maillen, mailbuf);
185 strbuf_add(name, namebuf, namelen);
188 static void commit_info_destroy(struct commit_info *ci)
191 strbuf_release(&ci->author);
192 strbuf_release(&ci->author_mail);
193 strbuf_release(&ci->author_tz);
194 strbuf_release(&ci->committer);
195 strbuf_release(&ci->committer_mail);
196 strbuf_release(&ci->committer_tz);
197 strbuf_release(&ci->summary);
200 static void get_commit_info(struct commit *commit,
201 struct commit_info *ret,
202 int detailed)
204 int len;
205 const char *subject, *encoding;
206 const char *message;
208 encoding = get_log_output_encoding();
209 message = repo_logmsg_reencode(the_repository, commit, NULL, encoding);
210 get_ac_line(message, "\nauthor ",
211 &ret->author, &ret->author_mail,
212 &ret->author_time, &ret->author_tz);
214 if (!detailed) {
215 repo_unuse_commit_buffer(the_repository, commit, message);
216 return;
219 get_ac_line(message, "\ncommitter ",
220 &ret->committer, &ret->committer_mail,
221 &ret->committer_time, &ret->committer_tz);
223 len = find_commit_subject(message, &subject);
224 if (len)
225 strbuf_add(&ret->summary, subject, len);
226 else
227 strbuf_addf(&ret->summary, "(%s)", oid_to_hex(&commit->object.oid));
229 repo_unuse_commit_buffer(the_repository, commit, message);
233 * Write out any suspect information which depends on the path. This must be
234 * handled separately from emit_one_suspect_detail(), because a given commit
235 * may have changes in multiple paths. So this needs to appear each time
236 * we mention a new group.
238 * To allow LF and other nonportable characters in pathnames,
239 * they are c-style quoted as needed.
241 static void write_filename_info(struct blame_origin *suspect)
243 if (suspect->previous) {
244 struct blame_origin *prev = suspect->previous;
245 printf("previous %s ", oid_to_hex(&prev->commit->object.oid));
246 write_name_quoted(prev->path, stdout, '\n');
248 printf("filename ");
249 write_name_quoted(suspect->path, stdout, '\n');
253 * Porcelain/Incremental format wants to show a lot of details per
254 * commit. Instead of repeating this every line, emit it only once,
255 * the first time each commit appears in the output (unless the
256 * user has specifically asked for us to repeat).
258 static int emit_one_suspect_detail(struct blame_origin *suspect, int repeat)
260 struct commit_info ci = COMMIT_INFO_INIT;
262 if (!repeat && (suspect->commit->object.flags & METAINFO_SHOWN))
263 return 0;
265 suspect->commit->object.flags |= METAINFO_SHOWN;
266 get_commit_info(suspect->commit, &ci, 1);
267 printf("author %s\n", ci.author.buf);
268 printf("author-mail %s\n", ci.author_mail.buf);
269 printf("author-time %"PRItime"\n", ci.author_time);
270 printf("author-tz %s\n", ci.author_tz.buf);
271 printf("committer %s\n", ci.committer.buf);
272 printf("committer-mail %s\n", ci.committer_mail.buf);
273 printf("committer-time %"PRItime"\n", ci.committer_time);
274 printf("committer-tz %s\n", ci.committer_tz.buf);
275 printf("summary %s\n", ci.summary.buf);
276 if (suspect->commit->object.flags & UNINTERESTING)
277 printf("boundary\n");
279 commit_info_destroy(&ci);
281 return 1;
285 * The blame_entry is found to be guilty for the range.
286 * Show it in incremental output.
288 static void found_guilty_entry(struct blame_entry *ent, void *data)
290 struct progress_info *pi = (struct progress_info *)data;
292 if (incremental) {
293 struct blame_origin *suspect = ent->suspect;
295 printf("%s %d %d %d\n",
296 oid_to_hex(&suspect->commit->object.oid),
297 ent->s_lno + 1, ent->lno + 1, ent->num_lines);
298 emit_one_suspect_detail(suspect, 0);
299 write_filename_info(suspect);
300 maybe_flush_or_die(stdout, "stdout");
302 pi->blamed_lines += ent->num_lines;
303 display_progress(pi->progress, pi->blamed_lines);
306 static const char *format_time(timestamp_t time, const char *tz_str,
307 int show_raw_time)
309 static struct strbuf time_buf = STRBUF_INIT;
311 strbuf_reset(&time_buf);
312 if (show_raw_time) {
313 strbuf_addf(&time_buf, "%"PRItime" %s", time, tz_str);
315 else {
316 const char *time_str;
317 size_t time_width;
318 int tz;
319 tz = atoi(tz_str);
320 time_str = show_date(time, tz, &blame_date_mode);
321 strbuf_addstr(&time_buf, time_str);
323 * Add space paddings to time_buf to display a fixed width
324 * string, and use time_width for display width calibration.
326 for (time_width = utf8_strwidth(time_str);
327 time_width < blame_date_width;
328 time_width++)
329 strbuf_addch(&time_buf, ' ');
331 return time_buf.buf;
334 #define OUTPUT_ANNOTATE_COMPAT (1U<<0)
335 #define OUTPUT_LONG_OBJECT_NAME (1U<<1)
336 #define OUTPUT_RAW_TIMESTAMP (1U<<2)
337 #define OUTPUT_PORCELAIN (1U<<3)
338 #define OUTPUT_SHOW_NAME (1U<<4)
339 #define OUTPUT_SHOW_NUMBER (1U<<5)
340 #define OUTPUT_SHOW_SCORE (1U<<6)
341 #define OUTPUT_NO_AUTHOR (1U<<7)
342 #define OUTPUT_SHOW_EMAIL (1U<<8)
343 #define OUTPUT_LINE_PORCELAIN (1U<<9)
344 #define OUTPUT_COLOR_LINE (1U<<10)
345 #define OUTPUT_SHOW_AGE_WITH_COLOR (1U<<11)
347 static void emit_porcelain_details(struct blame_origin *suspect, int repeat)
349 if (emit_one_suspect_detail(suspect, repeat) ||
350 (suspect->commit->object.flags & MORE_THAN_ONE_PATH))
351 write_filename_info(suspect);
354 static void emit_porcelain(struct blame_scoreboard *sb, struct blame_entry *ent,
355 int opt)
357 int repeat = opt & OUTPUT_LINE_PORCELAIN;
358 int cnt;
359 const char *cp;
360 struct blame_origin *suspect = ent->suspect;
361 char hex[GIT_MAX_HEXSZ + 1];
363 oid_to_hex_r(hex, &suspect->commit->object.oid);
364 printf("%s %d %d %d\n",
365 hex,
366 ent->s_lno + 1,
367 ent->lno + 1,
368 ent->num_lines);
369 emit_porcelain_details(suspect, repeat);
371 cp = blame_nth_line(sb, ent->lno);
372 for (cnt = 0; cnt < ent->num_lines; cnt++) {
373 char ch;
374 if (cnt) {
375 printf("%s %d %d\n", hex,
376 ent->s_lno + 1 + cnt,
377 ent->lno + 1 + cnt);
378 if (repeat)
379 emit_porcelain_details(suspect, 1);
381 putchar('\t');
382 do {
383 ch = *cp++;
384 putchar(ch);
385 } while (ch != '\n' &&
386 cp < sb->final_buf + sb->final_buf_size);
389 if (sb->final_buf_size && cp[-1] != '\n')
390 putchar('\n');
393 static struct color_field {
394 timestamp_t hop;
395 char col[COLOR_MAXLEN];
396 } *colorfield;
397 static int colorfield_nr, colorfield_alloc;
399 static void parse_color_fields(const char *s)
401 struct string_list l = STRING_LIST_INIT_DUP;
402 struct string_list_item *item;
403 enum { EXPECT_DATE, EXPECT_COLOR } next = EXPECT_COLOR;
405 colorfield_nr = 0;
407 /* Ideally this would be stripped and split at the same time? */
408 string_list_split(&l, s, ',', -1);
409 ALLOC_GROW(colorfield, colorfield_nr + 1, colorfield_alloc);
411 for_each_string_list_item(item, &l) {
412 switch (next) {
413 case EXPECT_DATE:
414 colorfield[colorfield_nr].hop = approxidate(item->string);
415 next = EXPECT_COLOR;
416 colorfield_nr++;
417 ALLOC_GROW(colorfield, colorfield_nr + 1, colorfield_alloc);
418 break;
419 case EXPECT_COLOR:
420 if (color_parse(item->string, colorfield[colorfield_nr].col))
421 die(_("expecting a color: %s"), item->string);
422 next = EXPECT_DATE;
423 break;
427 if (next == EXPECT_COLOR)
428 die(_("must end with a color"));
430 colorfield[colorfield_nr].hop = TIME_MAX;
431 string_list_clear(&l, 0);
434 static void setup_default_color_by_age(void)
436 parse_color_fields("blue,12 month ago,white,1 month ago,red");
439 static void determine_line_heat(struct commit_info *ci, const char **dest_color)
441 int i = 0;
443 while (i < colorfield_nr && ci->author_time > colorfield[i].hop)
444 i++;
446 *dest_color = colorfield[i].col;
449 static void emit_other(struct blame_scoreboard *sb, struct blame_entry *ent, int opt)
451 int cnt;
452 const char *cp;
453 struct blame_origin *suspect = ent->suspect;
454 struct commit_info ci = COMMIT_INFO_INIT;
455 char hex[GIT_MAX_HEXSZ + 1];
456 int show_raw_time = !!(opt & OUTPUT_RAW_TIMESTAMP);
457 const char *default_color = NULL, *color = NULL, *reset = NULL;
459 get_commit_info(suspect->commit, &ci, 1);
460 oid_to_hex_r(hex, &suspect->commit->object.oid);
462 cp = blame_nth_line(sb, ent->lno);
464 if (opt & OUTPUT_SHOW_AGE_WITH_COLOR) {
465 determine_line_heat(&ci, &default_color);
466 color = default_color;
467 reset = GIT_COLOR_RESET;
470 for (cnt = 0; cnt < ent->num_lines; cnt++) {
471 char ch;
472 int length = (opt & OUTPUT_LONG_OBJECT_NAME) ? the_hash_algo->hexsz : abbrev;
474 if (opt & OUTPUT_COLOR_LINE) {
475 if (cnt > 0) {
476 color = repeated_meta_color;
477 reset = GIT_COLOR_RESET;
478 } else {
479 color = default_color ? default_color : NULL;
480 reset = default_color ? GIT_COLOR_RESET : NULL;
483 if (color)
484 fputs(color, stdout);
486 if (suspect->commit->object.flags & UNINTERESTING) {
487 if (blank_boundary)
488 memset(hex, ' ', length);
489 else if (!(opt & OUTPUT_ANNOTATE_COMPAT)) {
490 length--;
491 putchar('^');
495 if (mark_unblamable_lines && ent->unblamable) {
496 length--;
497 putchar('*');
499 if (mark_ignored_lines && ent->ignored) {
500 length--;
501 putchar('?');
503 printf("%.*s", length, hex);
504 if (opt & OUTPUT_ANNOTATE_COMPAT) {
505 const char *name;
506 if (opt & OUTPUT_SHOW_EMAIL)
507 name = ci.author_mail.buf;
508 else
509 name = ci.author.buf;
510 printf("\t(%10s\t%10s\t%d)", name,
511 format_time(ci.author_time, ci.author_tz.buf,
512 show_raw_time),
513 ent->lno + 1 + cnt);
514 } else {
515 if (opt & OUTPUT_SHOW_SCORE)
516 printf(" %*d %02d",
517 max_score_digits, ent->score,
518 ent->suspect->refcnt);
519 if (opt & OUTPUT_SHOW_NAME)
520 printf(" %-*.*s", longest_file, longest_file,
521 suspect->path);
522 if (opt & OUTPUT_SHOW_NUMBER)
523 printf(" %*d", max_orig_digits,
524 ent->s_lno + 1 + cnt);
526 if (!(opt & OUTPUT_NO_AUTHOR)) {
527 const char *name;
528 int pad;
529 if (opt & OUTPUT_SHOW_EMAIL)
530 name = ci.author_mail.buf;
531 else
532 name = ci.author.buf;
533 pad = longest_author - utf8_strwidth(name);
534 printf(" (%s%*s %10s",
535 name, pad, "",
536 format_time(ci.author_time,
537 ci.author_tz.buf,
538 show_raw_time));
540 printf(" %*d) ",
541 max_digits, ent->lno + 1 + cnt);
543 if (reset)
544 fputs(reset, stdout);
545 do {
546 ch = *cp++;
547 putchar(ch);
548 } while (ch != '\n' &&
549 cp < sb->final_buf + sb->final_buf_size);
552 if (sb->final_buf_size && cp[-1] != '\n')
553 putchar('\n');
555 commit_info_destroy(&ci);
558 static void output(struct blame_scoreboard *sb, int option)
560 struct blame_entry *ent;
562 if (option & OUTPUT_PORCELAIN) {
563 for (ent = sb->ent; ent; ent = ent->next) {
564 int count = 0;
565 struct blame_origin *suspect;
566 struct commit *commit = ent->suspect->commit;
567 if (commit->object.flags & MORE_THAN_ONE_PATH)
568 continue;
569 for (suspect = get_blame_suspects(commit); suspect; suspect = suspect->next) {
570 if (suspect->guilty && count++) {
571 commit->object.flags |= MORE_THAN_ONE_PATH;
572 break;
578 for (ent = sb->ent; ent; ent = ent->next) {
579 if (option & OUTPUT_PORCELAIN)
580 emit_porcelain(sb, ent, option);
581 else {
582 emit_other(sb, ent, option);
588 * Add phony grafts for use with -S; this is primarily to
589 * support git's cvsserver that wants to give a linear history
590 * to its clients.
592 static int read_ancestry(const char *graft_file)
594 FILE *fp = fopen_or_warn(graft_file, "r");
595 struct strbuf buf = STRBUF_INIT;
596 if (!fp)
597 return -1;
598 while (!strbuf_getwholeline(&buf, fp, '\n')) {
599 /* The format is just "Commit Parent1 Parent2 ...\n" */
600 struct commit_graft *graft = read_graft_line(&buf);
601 if (graft)
602 register_commit_graft(the_repository, graft, 0);
604 fclose(fp);
605 strbuf_release(&buf);
606 return 0;
609 static int update_auto_abbrev(int auto_abbrev, struct blame_origin *suspect)
611 const char *uniq = repo_find_unique_abbrev(the_repository,
612 &suspect->commit->object.oid,
613 auto_abbrev);
614 int len = strlen(uniq);
615 if (auto_abbrev < len)
616 return len;
617 return auto_abbrev;
621 * How many columns do we need to show line numbers, authors,
622 * and filenames?
624 static void find_alignment(struct blame_scoreboard *sb, int *option)
626 int longest_src_lines = 0;
627 int longest_dst_lines = 0;
628 unsigned largest_score = 0;
629 struct blame_entry *e;
630 int compute_auto_abbrev = (abbrev < 0);
631 int auto_abbrev = DEFAULT_ABBREV;
633 for (e = sb->ent; e; e = e->next) {
634 struct blame_origin *suspect = e->suspect;
635 int num;
637 if (compute_auto_abbrev)
638 auto_abbrev = update_auto_abbrev(auto_abbrev, suspect);
639 if (strcmp(suspect->path, sb->path))
640 *option |= OUTPUT_SHOW_NAME;
641 num = strlen(suspect->path);
642 if (longest_file < num)
643 longest_file = num;
644 if (!(suspect->commit->object.flags & METAINFO_SHOWN)) {
645 struct commit_info ci = COMMIT_INFO_INIT;
646 suspect->commit->object.flags |= METAINFO_SHOWN;
647 get_commit_info(suspect->commit, &ci, 1);
648 if (*option & OUTPUT_SHOW_EMAIL)
649 num = utf8_strwidth(ci.author_mail.buf);
650 else
651 num = utf8_strwidth(ci.author.buf);
652 if (longest_author < num)
653 longest_author = num;
654 commit_info_destroy(&ci);
656 num = e->s_lno + e->num_lines;
657 if (longest_src_lines < num)
658 longest_src_lines = num;
659 num = e->lno + e->num_lines;
660 if (longest_dst_lines < num)
661 longest_dst_lines = num;
662 if (largest_score < blame_entry_score(sb, e))
663 largest_score = blame_entry_score(sb, e);
665 max_orig_digits = decimal_width(longest_src_lines);
666 max_digits = decimal_width(longest_dst_lines);
667 max_score_digits = decimal_width(largest_score);
669 if (compute_auto_abbrev)
670 /* one more abbrev length is needed for the boundary commit */
671 abbrev = auto_abbrev + 1;
674 static void sanity_check_on_fail(struct blame_scoreboard *sb, int baa)
676 int opt = OUTPUT_SHOW_SCORE | OUTPUT_SHOW_NUMBER | OUTPUT_SHOW_NAME;
677 find_alignment(sb, &opt);
678 output(sb, opt);
679 die("Baa %d!", baa);
682 static unsigned parse_score(const char *arg)
684 char *end;
685 unsigned long score = strtoul(arg, &end, 10);
686 if (*end)
687 return 0;
688 return score;
691 static const char *add_prefix(const char *prefix, const char *path)
693 return prefix_path(prefix, prefix ? strlen(prefix) : 0, path);
696 static int git_blame_config(const char *var, const char *value,
697 const struct config_context *ctx, void *cb)
699 if (!strcmp(var, "blame.showroot")) {
700 show_root = git_config_bool(var, value);
701 return 0;
703 if (!strcmp(var, "blame.blankboundary")) {
704 blank_boundary = git_config_bool(var, value);
705 return 0;
707 if (!strcmp(var, "blame.showemail")) {
708 int *output_option = cb;
709 if (git_config_bool(var, value))
710 *output_option |= OUTPUT_SHOW_EMAIL;
711 else
712 *output_option &= ~OUTPUT_SHOW_EMAIL;
713 return 0;
715 if (!strcmp(var, "blame.date")) {
716 if (!value)
717 return config_error_nonbool(var);
718 parse_date_format(value, &blame_date_mode);
719 return 0;
721 if (!strcmp(var, "blame.ignorerevsfile")) {
722 const char *str;
723 int ret;
725 ret = git_config_pathname(&str, var, value);
726 if (ret)
727 return ret;
728 string_list_insert(&ignore_revs_file_list, str);
729 return 0;
731 if (!strcmp(var, "blame.markunblamablelines")) {
732 mark_unblamable_lines = git_config_bool(var, value);
733 return 0;
735 if (!strcmp(var, "blame.markignoredlines")) {
736 mark_ignored_lines = git_config_bool(var, value);
737 return 0;
739 if (!strcmp(var, "color.blame.repeatedlines")) {
740 if (color_parse_mem(value, strlen(value), repeated_meta_color))
741 warning(_("invalid value for '%s': '%s'"),
742 "color.blame.repeatedLines", value);
743 return 0;
745 if (!strcmp(var, "color.blame.highlightrecent")) {
746 parse_color_fields(value);
747 return 0;
750 if (!strcmp(var, "blame.coloring")) {
751 if (!value)
752 return config_error_nonbool(var);
753 if (!strcmp(value, "repeatedLines")) {
754 coloring_mode |= OUTPUT_COLOR_LINE;
755 } else if (!strcmp(value, "highlightRecent")) {
756 coloring_mode |= OUTPUT_SHOW_AGE_WITH_COLOR;
757 } else if (!strcmp(value, "none")) {
758 coloring_mode &= ~(OUTPUT_COLOR_LINE |
759 OUTPUT_SHOW_AGE_WITH_COLOR);
760 } else {
761 warning(_("invalid value for '%s': '%s'"),
762 "blame.coloring", value);
763 return 0;
767 if (git_diff_heuristic_config(var, value, cb) < 0)
768 return -1;
769 if (userdiff_config(var, value) < 0)
770 return -1;
772 return git_default_config(var, value, ctx, cb);
775 static int blame_copy_callback(const struct option *option, const char *arg, int unset)
777 int *opt = option->value;
779 BUG_ON_OPT_NEG(unset);
782 * -C enables copy from removed files;
783 * -C -C enables copy from existing files, but only
784 * when blaming a new file;
785 * -C -C -C enables copy from existing files for
786 * everybody
788 if (*opt & PICKAXE_BLAME_COPY_HARDER)
789 *opt |= PICKAXE_BLAME_COPY_HARDEST;
790 if (*opt & PICKAXE_BLAME_COPY)
791 *opt |= PICKAXE_BLAME_COPY_HARDER;
792 *opt |= PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE;
794 if (arg)
795 blame_copy_score = parse_score(arg);
796 return 0;
799 static int blame_move_callback(const struct option *option, const char *arg, int unset)
801 int *opt = option->value;
803 BUG_ON_OPT_NEG(unset);
805 *opt |= PICKAXE_BLAME_MOVE;
807 if (arg)
808 blame_move_score = parse_score(arg);
809 return 0;
812 static int is_a_rev(const char *name)
814 struct object_id oid;
816 if (repo_get_oid(the_repository, name, &oid))
817 return 0;
818 return OBJ_NONE < oid_object_info(the_repository, &oid, NULL);
821 static int peel_to_commit_oid(struct object_id *oid_ret, void *cbdata)
823 struct repository *r = ((struct blame_scoreboard *)cbdata)->repo;
824 struct object_id oid;
826 oidcpy(&oid, oid_ret);
827 while (1) {
828 struct object *obj;
829 int kind = oid_object_info(r, &oid, NULL);
830 if (kind == OBJ_COMMIT) {
831 oidcpy(oid_ret, &oid);
832 return 0;
834 if (kind != OBJ_TAG)
835 return -1;
836 obj = deref_tag(r, parse_object(r, &oid), NULL, 0);
837 if (!obj)
838 return -1;
839 oidcpy(&oid, &obj->oid);
843 static void build_ignorelist(struct blame_scoreboard *sb,
844 struct string_list *ignore_revs_file_list,
845 struct string_list *ignore_rev_list)
847 struct string_list_item *i;
848 struct object_id oid;
850 oidset_init(&sb->ignore_list, 0);
851 for_each_string_list_item(i, ignore_revs_file_list) {
852 if (!strcmp(i->string, ""))
853 oidset_clear(&sb->ignore_list);
854 else
855 oidset_parse_file_carefully(&sb->ignore_list, i->string,
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, const char **argv, const char *prefix)
868 struct rev_info revs;
869 const char *path;
870 struct blame_scoreboard sb;
871 struct blame_origin *o;
872 struct blame_entry *ent = NULL;
873 long dashdash_pos, lno;
874 struct progress_info pi = { NULL, 0 };
876 struct string_list range_list = STRING_LIST_INIT_NODUP;
877 struct string_list ignore_rev_list = STRING_LIST_INIT_NODUP;
878 int output_option = 0, opt = 0;
879 int show_stats = 0;
880 const char *revs_file = NULL;
881 const char *contents_from = NULL;
882 const struct option options[] = {
883 OPT_BOOL(0, "incremental", &incremental, N_("show blame entries as we find them, incrementally")),
884 OPT_BOOL('b', NULL, &blank_boundary, N_("do not show object names of boundary commits (Default: off)")),
885 OPT_BOOL(0, "root", &show_root, N_("do not treat root commits as boundaries (Default: off)")),
886 OPT_BOOL(0, "show-stats", &show_stats, N_("show work cost statistics")),
887 OPT_BOOL(0, "progress", &show_progress, N_("force progress reporting")),
888 OPT_BIT(0, "score-debug", &output_option, N_("show output score for blame entries"), OUTPUT_SHOW_SCORE),
889 OPT_BIT('f', "show-name", &output_option, N_("show original filename (Default: auto)"), OUTPUT_SHOW_NAME),
890 OPT_BIT('n', "show-number", &output_option, N_("show original linenumber (Default: off)"), OUTPUT_SHOW_NUMBER),
891 OPT_BIT('p', "porcelain", &output_option, N_("show in a format designed for machine consumption"), OUTPUT_PORCELAIN),
892 OPT_BIT(0, "line-porcelain", &output_option, N_("show porcelain format with per-line commit information"), OUTPUT_PORCELAIN|OUTPUT_LINE_PORCELAIN),
893 OPT_BIT('c', NULL, &output_option, N_("use the same output mode as git-annotate (Default: off)"), OUTPUT_ANNOTATE_COMPAT),
894 OPT_BIT('t', NULL, &output_option, N_("show raw timestamp (Default: off)"), OUTPUT_RAW_TIMESTAMP),
895 OPT_BIT('l', NULL, &output_option, N_("show long commit SHA1 (Default: off)"), OUTPUT_LONG_OBJECT_NAME),
896 OPT_BIT('s', NULL, &output_option, N_("suppress author name and timestamp (Default: off)"), OUTPUT_NO_AUTHOR),
897 OPT_BIT('e', "show-email", &output_option, N_("show author email instead of name (Default: off)"), OUTPUT_SHOW_EMAIL),
898 OPT_BIT('w', NULL, &xdl_opts, N_("ignore whitespace differences"), XDF_IGNORE_WHITESPACE),
899 OPT_STRING_LIST(0, "ignore-rev", &ignore_rev_list, N_("rev"), N_("ignore <rev> when blaming")),
900 OPT_STRING_LIST(0, "ignore-revs-file", &ignore_revs_file_list, N_("file"), N_("ignore revisions from <file>")),
901 OPT_BIT(0, "color-lines", &output_option, N_("color redundant metadata from previous line differently"), OUTPUT_COLOR_LINE),
902 OPT_BIT(0, "color-by-age", &output_option, N_("color lines by age"), OUTPUT_SHOW_AGE_WITH_COLOR),
903 OPT_BIT(0, "minimal", &xdl_opts, N_("spend extra cycles to find better match"), XDF_NEED_MINIMAL),
904 OPT_STRING('S', NULL, &revs_file, N_("file"), N_("use revisions from <file> instead of calling git-rev-list")),
905 OPT_STRING(0, "contents", &contents_from, N_("file"), N_("use <file>'s contents as the final image")),
906 OPT_CALLBACK_F('C', NULL, &opt, N_("score"), N_("find line copies within and across files"), PARSE_OPT_OPTARG, blame_copy_callback),
907 OPT_CALLBACK_F('M', NULL, &opt, N_("score"), N_("find line movements within and across files"), PARSE_OPT_OPTARG, blame_move_callback),
908 OPT_STRING_LIST('L', NULL, &range_list, N_("range"),
909 N_("process only line range <start>,<end> or function :<funcname>")),
910 OPT__ABBREV(&abbrev),
911 OPT_END()
914 struct parse_opt_ctx_t ctx;
915 int cmd_is_annotate = !strcmp(argv[0], "annotate");
916 struct range_set ranges;
917 unsigned int range_i;
918 long anchor;
919 const int hexsz = the_hash_algo->hexsz;
920 long num_lines = 0;
921 const char *str_usage = cmd_is_annotate ? annotate_usage : blame_usage;
922 const char **opt_usage = cmd_is_annotate ? annotate_opt_usage : blame_opt_usage;
924 setup_default_color_by_age();
925 git_config(git_blame_config, &output_option);
926 repo_init_revisions(the_repository, &revs, NULL);
927 revs.date_mode = blame_date_mode;
928 revs.diffopt.flags.allow_textconv = 1;
929 revs.diffopt.flags.follow_renames = 1;
931 save_commit_buffer = 0;
932 dashdash_pos = 0;
933 show_progress = -1;
935 parse_options_start(&ctx, argc, argv, prefix, options,
936 PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_ARGV0);
937 for (;;) {
938 switch (parse_options_step(&ctx, options, opt_usage)) {
939 case PARSE_OPT_NON_OPTION:
940 case PARSE_OPT_UNKNOWN:
941 break;
942 case PARSE_OPT_HELP:
943 case PARSE_OPT_ERROR:
944 case PARSE_OPT_SUBCOMMAND:
945 exit(129);
946 case PARSE_OPT_COMPLETE:
947 exit(0);
948 case PARSE_OPT_DONE:
949 if (ctx.argv[0])
950 dashdash_pos = ctx.cpidx;
951 goto parse_done;
954 if (!strcmp(ctx.argv[0], "--reverse")) {
955 ctx.argv[0] = "--children";
956 reverse = 1;
958 parse_revision_opt(&revs, &ctx, options, opt_usage);
960 parse_done:
961 revision_opts_finish(&revs);
962 no_whole_file_rename = !revs.diffopt.flags.follow_renames;
963 xdl_opts |= revs.diffopt.xdl_opts & XDF_INDENT_HEURISTIC;
964 revs.diffopt.flags.follow_renames = 0;
965 argc = parse_options_end(&ctx);
967 prepare_repo_settings(the_repository);
968 the_repository->settings.command_requires_full_index = 0;
970 if (incremental || (output_option & OUTPUT_PORCELAIN)) {
971 if (show_progress > 0)
972 die(_("--progress can't be used with --incremental or porcelain formats"));
973 show_progress = 0;
974 } else if (show_progress < 0)
975 show_progress = isatty(2);
977 if (0 < abbrev && abbrev < hexsz)
978 /* one more abbrev length is needed for the boundary commit */
979 abbrev++;
980 else if (!abbrev)
981 abbrev = hexsz;
983 if (revs_file && read_ancestry(revs_file))
984 die_errno("reading graft file '%s' failed", revs_file);
986 if (cmd_is_annotate) {
987 output_option |= OUTPUT_ANNOTATE_COMPAT;
988 blame_date_mode.type = DATE_ISO8601;
989 } else {
990 blame_date_mode = revs.date_mode;
993 /* The maximum width used to show the dates */
994 switch (blame_date_mode.type) {
995 case DATE_RFC2822:
996 blame_date_width = sizeof("Thu, 19 Oct 2006 16:00:04 -0700");
997 break;
998 case DATE_ISO8601_STRICT:
999 blame_date_width = sizeof("2006-10-19T16:00:04-07:00");
1000 break;
1001 case DATE_ISO8601:
1002 blame_date_width = sizeof("2006-10-19 16:00:04 -0700");
1003 break;
1004 case DATE_RAW:
1005 blame_date_width = sizeof("1161298804 -0700");
1006 break;
1007 case DATE_UNIX:
1008 blame_date_width = sizeof("1161298804");
1009 break;
1010 case DATE_SHORT:
1011 blame_date_width = sizeof("2006-10-19");
1012 break;
1013 case DATE_RELATIVE:
1015 * TRANSLATORS: This string is used to tell us the
1016 * maximum display width for a relative timestamp in
1017 * "git blame" output. For C locale, "4 years, 11
1018 * months ago", which takes 22 places, is the longest
1019 * among various forms of relative timestamps, but
1020 * your language may need more or fewer display
1021 * columns.
1023 blame_date_width = utf8_strwidth(_("4 years, 11 months ago")) + 1; /* add the null */
1024 break;
1025 case DATE_HUMAN:
1026 /* If the year is shown, no time is shown */
1027 blame_date_width = sizeof("Thu Oct 19 16:00");
1028 break;
1029 case DATE_NORMAL:
1030 blame_date_width = sizeof("Thu Oct 19 16:00:04 2006 -0700");
1031 break;
1032 case DATE_STRFTIME:
1033 blame_date_width = strlen(show_date(0, 0, &blame_date_mode)) + 1; /* add the null */
1034 break;
1036 blame_date_width -= 1; /* strip the null */
1038 if (revs.diffopt.flags.find_copies_harder)
1039 opt |= (PICKAXE_BLAME_COPY | PICKAXE_BLAME_MOVE |
1040 PICKAXE_BLAME_COPY_HARDER);
1043 * We have collected options unknown to us in argv[1..unk]
1044 * which are to be passed to revision machinery if we are
1045 * going to do the "bottom" processing.
1047 * The remaining are:
1049 * (1) if dashdash_pos != 0, it is either
1050 * "blame [revisions] -- <path>" or
1051 * "blame -- <path> <rev>"
1053 * (2) otherwise, it is one of the two:
1054 * "blame [revisions] <path>"
1055 * "blame <path> <rev>"
1057 * Note that we must strip out <path> from the arguments: we do not
1058 * want the path pruning but we may want "bottom" processing.
1060 if (dashdash_pos) {
1061 switch (argc - dashdash_pos - 1) {
1062 case 2: /* (1b) */
1063 if (argc != 4)
1064 usage_with_options(opt_usage, options);
1065 /* reorder for the new way: <rev> -- <path> */
1066 argv[1] = argv[3];
1067 argv[3] = argv[2];
1068 argv[2] = "--";
1069 /* FALLTHROUGH */
1070 case 1: /* (1a) */
1071 path = add_prefix(prefix, argv[--argc]);
1072 argv[argc] = NULL;
1073 break;
1074 default:
1075 usage_with_options(opt_usage, options);
1077 } else {
1078 if (argc < 2)
1079 usage_with_options(opt_usage, options);
1080 if (argc == 3 && is_a_rev(argv[argc - 1])) { /* (2b) */
1081 path = add_prefix(prefix, argv[1]);
1082 argv[1] = argv[2];
1083 } else { /* (2a) */
1084 if (argc == 2 && is_a_rev(argv[1]) && !get_git_work_tree())
1085 die("missing <path> to blame");
1086 path = add_prefix(prefix, argv[argc - 1]);
1088 argv[argc - 1] = "--";
1091 revs.disable_stdin = 1;
1092 setup_revisions(argc, argv, &revs, NULL);
1093 if (!revs.pending.nr && is_bare_repository()) {
1094 struct commit *head_commit;
1095 struct object_id head_oid;
1097 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
1098 &head_oid, NULL) ||
1099 !(head_commit = lookup_commit_reference_gently(revs.repo,
1100 &head_oid, 1)))
1101 die("no such ref: HEAD");
1103 add_pending_object(&revs, &head_commit->object, "HEAD");
1106 init_scoreboard(&sb);
1107 sb.revs = &revs;
1108 sb.contents_from = contents_from;
1109 sb.reverse = reverse;
1110 sb.repo = the_repository;
1111 sb.path = path;
1112 build_ignorelist(&sb, &ignore_revs_file_list, &ignore_rev_list);
1113 string_list_clear(&ignore_revs_file_list, 0);
1114 string_list_clear(&ignore_rev_list, 0);
1115 setup_scoreboard(&sb, &o);
1118 * Changed-path Bloom filters are disabled when looking
1119 * for copies.
1121 if (!(opt & PICKAXE_BLAME_COPY))
1122 setup_blame_bloom_data(&sb);
1124 lno = sb.num_lines;
1126 if (lno && !range_list.nr)
1127 string_list_append(&range_list, "1");
1129 anchor = 1;
1130 range_set_init(&ranges, range_list.nr);
1131 for (range_i = 0; range_i < range_list.nr; ++range_i) {
1132 long bottom, top;
1133 if (parse_range_arg(range_list.items[range_i].string,
1134 nth_line_cb, &sb, lno, anchor,
1135 &bottom, &top, sb.path,
1136 the_repository->index))
1137 usage(str_usage);
1138 if ((!lno && (top || bottom)) || lno < bottom)
1139 die(Q_("file %s has only %lu line",
1140 "file %s has only %lu lines",
1141 lno), sb.path, lno);
1142 if (bottom < 1)
1143 bottom = 1;
1144 if (top < 1 || lno < top)
1145 top = lno;
1146 bottom--;
1147 range_set_append_unsafe(&ranges, bottom, top);
1148 anchor = top + 1;
1150 sort_and_merge_range_set(&ranges);
1152 for (range_i = ranges.nr; range_i > 0; --range_i) {
1153 const struct range *r = &ranges.ranges[range_i - 1];
1154 ent = blame_entry_prepend(ent, r->start, r->end, o);
1155 num_lines += (r->end - r->start);
1157 if (!num_lines)
1158 num_lines = sb.num_lines;
1160 o->suspects = ent;
1161 prio_queue_put(&sb.commits, o->commit);
1163 blame_origin_decref(o);
1165 range_set_release(&ranges);
1166 string_list_clear(&range_list, 0);
1168 sb.ent = NULL;
1170 if (blame_move_score)
1171 sb.move_score = blame_move_score;
1172 if (blame_copy_score)
1173 sb.copy_score = blame_copy_score;
1175 sb.debug = DEBUG_BLAME;
1176 sb.on_sanity_fail = &sanity_check_on_fail;
1178 sb.show_root = show_root;
1179 sb.xdl_opts = xdl_opts;
1180 sb.no_whole_file_rename = no_whole_file_rename;
1182 read_mailmap(&mailmap);
1184 sb.found_guilty_entry = &found_guilty_entry;
1185 sb.found_guilty_entry_data = &pi;
1186 if (show_progress)
1187 pi.progress = start_delayed_progress(_("Blaming lines"), num_lines);
1189 assign_blame(&sb, opt);
1191 stop_progress(&pi.progress);
1193 if (!incremental)
1194 setup_pager();
1195 else
1196 goto cleanup;
1198 blame_sort_final(&sb);
1200 blame_coalesce(&sb);
1202 if (!(output_option & (OUTPUT_COLOR_LINE | OUTPUT_SHOW_AGE_WITH_COLOR)))
1203 output_option |= coloring_mode;
1205 if (!(output_option & OUTPUT_PORCELAIN)) {
1206 find_alignment(&sb, &output_option);
1207 if (!*repeated_meta_color &&
1208 (output_option & OUTPUT_COLOR_LINE))
1209 xsnprintf(repeated_meta_color,
1210 sizeof(repeated_meta_color),
1211 "%s", GIT_COLOR_CYAN);
1213 if (output_option & OUTPUT_ANNOTATE_COMPAT)
1214 output_option &= ~(OUTPUT_COLOR_LINE | OUTPUT_SHOW_AGE_WITH_COLOR);
1216 output(&sb, output_option);
1217 free((void *)sb.final_buf);
1218 for (ent = sb.ent; ent; ) {
1219 struct blame_entry *e = ent->next;
1220 free(ent);
1221 ent = e;
1224 if (show_stats) {
1225 printf("num read blob: %d\n", sb.num_read_blob);
1226 printf("num get patch: %d\n", sb.num_get_patch);
1227 printf("num commits: %d\n", sb.num_commits);
1230 cleanup:
1231 cleanup_scoreboard(&sb);
1232 release_revisions(&revs);
1233 return 0;