2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
14 #include "reflog-walk.h"
15 #include "patch-ids.h"
18 static int default_show_root = 1;
19 static const char *fmt_patch_subject_prefix = "PATCH";
21 static void add_name_decoration(const char *prefix, const char *name, struct object *obj)
23 int plen = strlen(prefix);
24 int nlen = strlen(name);
25 struct name_decoration *res = xmalloc(sizeof(struct name_decoration) + plen + nlen);
26 memcpy(res->name, prefix, plen);
27 memcpy(res->name + plen, name, nlen + 1);
28 res->next = add_decoration(&name_decoration, obj, res);
31 static int add_ref_decoration(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
33 struct object *obj = parse_object(sha1);
36 add_name_decoration("", refname, obj);
37 while (obj->type == OBJ_TAG) {
38 obj = ((struct tag *)obj)->tagged;
41 add_name_decoration("tag: ", refname, obj);
46 static void cmd_log_init(int argc, const char **argv, const char *prefix,
52 rev->abbrev = DEFAULT_ABBREV;
53 rev->commit_format = CMIT_FMT_DEFAULT;
54 rev->verbose_header = 1;
55 DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
56 rev->show_root_diff = default_show_root;
57 rev->subject_prefix = fmt_patch_subject_prefix;
58 argc = setup_revisions(argc, argv, rev, "HEAD");
59 if (rev->diffopt.pickaxe || rev->diffopt.filter)
60 rev->always_show_header = 0;
61 if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
62 rev->always_show_header = 0;
63 if (rev->diffopt.nr_paths != 1)
64 usage("git logs can only follow renames on one pathname at a time");
66 for (i = 1; i < argc; i++) {
67 const char *arg = argv[i];
68 if (!strcmp(arg, "--decorate")) {
70 for_each_ref(add_ref_decoration, NULL);
73 die("unrecognized argument: %s", arg);
78 * This gives a rough estimate for how many commits we
79 * will print out in the list.
81 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
86 struct commit *commit = list->item;
87 unsigned int flags = commit->object.flags;
89 if (!(flags & (TREESAME | UNINTERESTING)))
95 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
99 if (rev->commit_format != CMIT_FMT_ONELINE)
100 putchar(rev->diffopt.line_termination);
102 printf("Final output: %d %s\n", nr, stage);
105 struct itimerval early_output_timer;
107 static void log_show_early(struct rev_info *revs, struct commit_list *list)
109 int i = revs->early_output;
112 sort_in_topological_order(&list, revs->lifo);
114 struct commit *commit = list->item;
115 switch (simplify_commit(revs, commit)) {
118 int n = estimate_commit_count(revs, list);
119 show_early_header(revs, "incomplete", n);
122 log_tree_commit(revs, commit);
133 /* Did we already get enough commits for the early output? */
138 * ..if no, then repeat it twice a second until we
141 * NOTE! We don't use "it_interval", because if the
142 * reader isn't listening, we want our output to be
143 * throttled by the writing, and not have the timer
144 * trigger every second even if we're blocked on a
147 early_output_timer.it_value.tv_sec = 0;
148 early_output_timer.it_value.tv_usec = 500000;
149 setitimer(ITIMER_REAL, &early_output_timer, NULL);
152 static void early_output(int signal)
154 show_early_output = log_show_early;
157 static void setup_early_output(struct rev_info *rev)
162 * Set up the signal handler, minimally intrusively:
163 * we only set a single volatile integer word (not
164 * using sigatomic_t - trying to avoid unnecessary
165 * system dependencies and headers), and using
168 memset(&sa, 0, sizeof(sa));
169 sa.sa_handler = early_output;
170 sigemptyset(&sa.sa_mask);
171 sa.sa_flags = SA_RESTART;
172 sigaction(SIGALRM, &sa, NULL);
175 * If we can get the whole output in less than a
176 * tenth of a second, don't even bother doing the
177 * early-output thing..
179 * This is a one-time-only trigger.
181 early_output_timer.it_value.tv_sec = 0;
182 early_output_timer.it_value.tv_usec = 100000;
183 setitimer(ITIMER_REAL, &early_output_timer, NULL);
186 static void finish_early_output(struct rev_info *rev)
188 int n = estimate_commit_count(rev, rev->commits);
189 signal(SIGALRM, SIG_IGN);
190 show_early_header(rev, "done", n);
193 static int cmd_log_walk(struct rev_info *rev)
195 struct commit *commit;
197 if (rev->early_output)
198 setup_early_output(rev);
200 if (prepare_revision_walk(rev))
201 die("revision walk setup failed");
203 if (rev->early_output)
204 finish_early_output(rev);
206 while ((commit = get_revision(rev)) != NULL) {
207 log_tree_commit(rev, commit);
208 if (!rev->reflog_info) {
209 /* we allow cycles in reflog ancestry */
210 free(commit->buffer);
211 commit->buffer = NULL;
213 free_commit_list(commit->parents);
214 commit->parents = NULL;
219 static int git_log_config(const char *var, const char *value)
221 if (!strcmp(var, "format.subjectprefix")) {
223 config_error_nonbool(var);
224 fmt_patch_subject_prefix = xstrdup(value);
227 if (!strcmp(var, "log.showroot")) {
228 default_show_root = git_config_bool(var, value);
231 return git_diff_ui_config(var, value);
234 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
238 git_config(git_log_config);
239 init_revisions(&rev, prefix);
241 rev.simplify_history = 0;
242 cmd_log_init(argc, argv, prefix, &rev);
243 if (!rev.diffopt.output_format)
244 rev.diffopt.output_format = DIFF_FORMAT_RAW;
245 return cmd_log_walk(&rev);
248 static void show_tagger(char *buf, int len, struct rev_info *rev)
254 email_end = memchr(buf, '>', len);
260 date = strtoul(p, &p, 10);
263 tz = (int)strtol(p, NULL, 10);
264 printf("Tagger: %.*s\nDate: %s\n", (int)(email_end - buf), buf,
265 show_date(date, tz, rev->date_mode));
268 static int show_object(const unsigned char *sha1, int show_tag_object,
269 struct rev_info *rev)
272 enum object_type type;
273 char *buf = read_sha1_file(sha1, &type, &size);
277 return error("Could not read object %s", sha1_to_hex(sha1));
280 while (offset < size && buf[offset] != '\n') {
281 int new_offset = offset + 1;
282 while (new_offset < size && buf[new_offset++] != '\n')
284 if (!prefixcmp(buf + offset, "tagger "))
285 show_tagger(buf + offset + 7,
286 new_offset - offset - 7, rev);
291 fwrite(buf + offset, size - offset, 1, stdout);
296 static int show_tree_object(const unsigned char *sha1,
297 const char *base, int baselen,
298 const char *pathname, unsigned mode, int stage)
300 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
304 int cmd_show(int argc, const char **argv, const char *prefix)
307 struct object_array_entry *objects;
308 int i, count, ret = 0;
310 git_config(git_log_config);
311 init_revisions(&rev, prefix);
313 rev.combine_merges = 1;
314 rev.dense_combined_merges = 1;
315 rev.always_show_header = 1;
316 rev.ignore_merges = 0;
318 cmd_log_init(argc, argv, prefix, &rev);
320 count = rev.pending.nr;
321 objects = rev.pending.objects;
322 for (i = 0; i < count && !ret; i++) {
323 struct object *o = objects[i].item;
324 const char *name = objects[i].name;
327 ret = show_object(o->sha1, 0, NULL);
330 struct tag *t = (struct tag *)o;
332 printf("%stag %s%s\n",
333 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
335 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
336 ret = show_object(o->sha1, 1, &rev);
337 objects[i].item = (struct object *)t->tagged;
342 printf("%stree %s%s\n\n",
343 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
345 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
346 read_tree_recursive((struct tree *)o, "", 0, 0, NULL,
350 rev.pending.nr = rev.pending.alloc = 0;
351 rev.pending.objects = NULL;
352 add_object_array(o, name, &rev.pending);
353 ret = cmd_log_walk(&rev);
356 ret = error("Unknown type: %d", o->type);
364 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
366 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
370 git_config(git_log_config);
371 init_revisions(&rev, prefix);
372 init_reflog_walk(&rev.reflog_info);
373 rev.abbrev_commit = 1;
374 rev.verbose_header = 1;
375 cmd_log_init(argc, argv, prefix, &rev);
378 * This means that we override whatever commit format the user gave
379 * on the cmd line. Sad, but cmd_log_init() currently doesn't
380 * allow us to set a different default.
382 rev.commit_format = CMIT_FMT_ONELINE;
383 rev.always_show_header = 1;
386 * We get called through "git reflog", so unlike the other log
387 * routines, we need to set up our pager manually..
391 return cmd_log_walk(&rev);
394 int cmd_log(int argc, const char **argv, const char *prefix)
398 git_config(git_log_config);
399 init_revisions(&rev, prefix);
400 rev.always_show_header = 1;
401 cmd_log_init(argc, argv, prefix, &rev);
402 return cmd_log_walk(&rev);
406 #define FORMAT_PATCH_NAME_MAX 64
408 static int istitlechar(char c)
410 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
411 (c >= '0' && c <= '9') || c == '.' || c == '_';
414 static char *extra_headers = NULL;
415 static int extra_headers_size = 0;
416 static const char *fmt_patch_suffix = ".patch";
417 static int numbered = 0;
418 static int auto_number = 0;
420 static int git_format_config(const char *var, const char *value)
422 if (!strcmp(var, "format.headers")) {
426 die("format.headers without value");
428 extra_headers_size += len + 1;
429 extra_headers = xrealloc(extra_headers, extra_headers_size);
430 extra_headers[extra_headers_size - len - 1] = 0;
431 strcat(extra_headers, value);
434 if (!strcmp(var, "format.suffix")) {
436 return config_error_nonbool(var);
437 fmt_patch_suffix = xstrdup(value);
440 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff")) {
443 if (!strcmp(var, "format.numbered")) {
444 if (value && !strcasecmp(value, "auto")) {
448 numbered = git_config_bool(var, value);
452 return git_log_config(var, value);
456 static FILE *realstdout = NULL;
457 static const char *output_directory = NULL;
459 static int reopen_stdout(struct commit *commit, int nr, int keep_subject,
462 char filename[PATH_MAX];
465 int suffix_len = strlen(fmt_patch_suffix) + 1;
467 if (output_directory) {
468 if (strlen(output_directory) >=
469 sizeof(filename) - FORMAT_PATCH_NAME_MAX - suffix_len)
470 return error("name of output directory is too long");
471 strlcpy(filename, output_directory, sizeof(filename) - suffix_len);
472 len = strlen(filename);
473 if (filename[len - 1] != '/')
474 filename[len++] = '/';
477 if (numbered_files) {
478 sprintf(filename + len, "%d", nr);
479 len = strlen(filename);
482 sprintf(filename + len, "%04d", nr);
483 len = strlen(filename);
485 sol = strstr(commit->buffer, "\n\n");
490 /* strip [PATCH] or [PATCH blabla] */
491 if (!keep_subject && !prefixcmp(sol, "[PATCH")) {
492 char *eos = strchr(sol + 6, ']');
494 while (isspace(*eos))
501 j < FORMAT_PATCH_NAME_MAX - suffix_len - 5 &&
502 len < sizeof(filename) - suffix_len &&
503 sol[j] && sol[j] != '\n';
505 if (istitlechar(sol[j])) {
507 filename[len++] = '-';
510 filename[len++] = sol[j];
512 while (sol[j + 1] == '.')
517 while (filename[len - 1] == '.'
518 || filename[len - 1] == '-')
522 if (len + suffix_len >= sizeof(filename))
523 return error("Patch pathname too long");
524 strcpy(filename + len, fmt_patch_suffix);
527 fprintf(realstdout, "%s\n", filename);
528 if (freopen(filename, "w", stdout) == NULL)
529 return error("Cannot open patch file %s",filename);
534 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids, const char *prefix)
536 struct rev_info check_rev;
537 struct commit *commit;
538 struct object *o1, *o2;
539 unsigned flags1, flags2;
541 if (rev->pending.nr != 2)
542 die("Need exactly one range.");
544 o1 = rev->pending.objects[0].item;
546 o2 = rev->pending.objects[1].item;
549 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
554 /* given a range a..b get all patch ids for b..a */
555 init_revisions(&check_rev, prefix);
556 o1->flags ^= UNINTERESTING;
557 o2->flags ^= UNINTERESTING;
558 add_pending_object(&check_rev, o1, "o1");
559 add_pending_object(&check_rev, o2, "o2");
560 if (prepare_revision_walk(&check_rev))
561 die("revision walk setup failed");
563 while ((commit = get_revision(&check_rev)) != NULL) {
565 if (commit->parents && commit->parents->next)
568 add_commit_patch_id(commit, ids);
571 /* reset for next revision walk */
572 clear_commit_marks((struct commit *)o1,
573 SEEN | UNINTERESTING | SHOWN | ADDED);
574 clear_commit_marks((struct commit *)o2,
575 SEEN | UNINTERESTING | SHOWN | ADDED);
580 static void gen_message_id(char *dest, unsigned int length, char *base)
582 const char *committer = git_committer_info(IDENT_WARN_ON_NO_NAME);
583 const char *email_start = strrchr(committer, '<');
584 const char *email_end = strrchr(committer, '>');
585 if(!email_start || !email_end || email_start > email_end - 1)
586 die("Could not extract email from committer identity.");
587 snprintf(dest, length, "%s.%lu.git.%.*s", base,
588 (unsigned long) time(NULL),
589 (int)(email_end - email_start - 1), email_start + 1);
592 static const char *clean_message_id(const char *msg_id)
595 const char *a, *z, *m;
598 while ((ch = *m) && (isspace(ch) || (ch == '<')))
603 if (!isspace(ch) && (ch != '>'))
608 die("insane in-reply-to: %s", msg_id);
611 return xmemdupz(a, z - a);
614 int cmd_format_patch(int argc, const char **argv, const char *prefix)
616 struct commit *commit;
617 struct commit **list = NULL;
619 int nr = 0, total, i, j;
621 int start_number = -1;
622 int keep_subject = 0;
623 int numbered_files = 0; /* _just_ numbers */
624 int subject_prefix = 0;
625 int ignore_if_in_upstream = 0;
627 const char *in_reply_to = NULL;
628 struct patch_ids ids;
629 char *add_signoff = NULL;
630 char message_id[1024];
631 char ref_message_id[1024];
633 git_config(git_format_config);
634 init_revisions(&rev, prefix);
635 rev.commit_format = CMIT_FMT_EMAIL;
636 rev.verbose_header = 1;
638 rev.combine_merges = 0;
639 rev.ignore_merges = 1;
640 rev.diffopt.msg_sep = "";
641 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
643 rev.subject_prefix = fmt_patch_subject_prefix;
644 rev.extra_headers = extra_headers;
647 * Parse the arguments before setup_revisions(), or something
648 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
649 * possibly a valid SHA1.
651 for (i = 1, j = 1; i < argc; i++) {
652 if (!strcmp(argv[i], "--stdout"))
654 else if (!strcmp(argv[i], "-n") ||
655 !strcmp(argv[i], "--numbered"))
657 else if (!strcmp(argv[i], "-N") ||
658 !strcmp(argv[i], "--no-numbered")) {
662 else if (!prefixcmp(argv[i], "--start-number="))
663 start_number = strtol(argv[i] + 15, NULL, 10);
664 else if (!strcmp(argv[i], "--numbered-files"))
666 else if (!strcmp(argv[i], "--start-number")) {
669 die("Need a number for --start-number");
670 start_number = strtol(argv[i], NULL, 10);
672 else if (!strcmp(argv[i], "-k") ||
673 !strcmp(argv[i], "--keep-subject")) {
677 else if (!strcmp(argv[i], "--output-directory") ||
678 !strcmp(argv[i], "-o")) {
681 die("Which directory?");
682 if (output_directory)
683 die("Two output directories?");
684 output_directory = argv[i];
686 else if (!strcmp(argv[i], "--signoff") ||
687 !strcmp(argv[i], "-s")) {
688 const char *committer;
690 committer = git_committer_info(IDENT_ERROR_ON_NO_NAME);
691 endpos = strchr(committer, '>');
693 die("bogos committer info %s\n", committer);
694 add_signoff = xmemdupz(committer, endpos - committer + 1);
696 else if (!strcmp(argv[i], "--attach")) {
697 rev.mime_boundary = git_version_string;
700 else if (!prefixcmp(argv[i], "--attach=")) {
701 rev.mime_boundary = argv[i] + 9;
704 else if (!strcmp(argv[i], "--inline")) {
705 rev.mime_boundary = git_version_string;
708 else if (!prefixcmp(argv[i], "--inline=")) {
709 rev.mime_boundary = argv[i] + 9;
712 else if (!strcmp(argv[i], "--ignore-if-in-upstream"))
713 ignore_if_in_upstream = 1;
714 else if (!strcmp(argv[i], "--thread"))
716 else if (!prefixcmp(argv[i], "--in-reply-to="))
717 in_reply_to = argv[i] + 14;
718 else if (!strcmp(argv[i], "--in-reply-to")) {
721 die("Need a Message-Id for --in-reply-to");
722 in_reply_to = argv[i];
723 } else if (!prefixcmp(argv[i], "--subject-prefix=")) {
725 rev.subject_prefix = argv[i] + 17;
726 } else if (!prefixcmp(argv[i], "--suffix="))
727 fmt_patch_suffix = argv[i] + 9;
733 if (start_number < 0)
735 if (numbered && keep_subject)
736 die ("-n and -k are mutually exclusive.");
737 if (keep_subject && subject_prefix)
738 die ("--subject-prefix and -k are mutually exclusive.");
739 if (numbered_files && use_stdout)
740 die ("--numbered-files and --stdout are mutually exclusive.");
742 argc = setup_revisions(argc, argv, &rev, "HEAD");
744 die ("unrecognized argument: %s", argv[1]);
746 if (!rev.diffopt.output_format)
747 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY | DIFF_FORMAT_PATCH;
749 if (!DIFF_OPT_TST(&rev.diffopt, TEXT))
750 DIFF_OPT_SET(&rev.diffopt, BINARY);
752 if (!output_directory && !use_stdout)
753 output_directory = prefix;
755 if (output_directory) {
757 die("standard output, or directory, which one?");
758 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
759 die("Could not create directory %s",
763 if (rev.pending.nr == 1) {
764 if (rev.max_count < 0 && !rev.show_root_diff) {
766 * This is traditional behaviour of "git format-patch
767 * origin" that prepares what the origin side still
770 rev.pending.objects[0].item->flags |= UNINTERESTING;
771 add_head_to_pending(&rev);
774 * Otherwise, it is "format-patch -22 HEAD", and/or
775 * "format-patch --root HEAD". The user wants
776 * get_revision() to do the usual traversal.
780 if (ignore_if_in_upstream)
781 get_patch_ids(&rev, &ids, prefix);
784 realstdout = xfdopen(xdup(1), "w");
786 if (prepare_revision_walk(&rev))
787 die("revision walk setup failed");
788 while ((commit = get_revision(&rev)) != NULL) {
790 if (commit->parents && commit->parents->next)
793 if (ignore_if_in_upstream &&
794 has_commit_patch_id(commit, &ids))
798 list = xrealloc(list, nr * sizeof(list[0]));
799 list[nr - 1] = commit;
802 if (!keep_subject && auto_number && total > 1)
805 rev.total = total + start_number - 1;
806 rev.add_signoff = add_signoff;
808 rev.ref_message_id = clean_message_id(in_reply_to);
812 rev.nr = total - nr + (start_number - 1);
813 /* Make the second and subsequent mails replies to the first */
815 if (nr == (total - 2)) {
816 strncpy(ref_message_id, message_id,
817 sizeof(ref_message_id));
818 ref_message_id[sizeof(ref_message_id)-1]='\0';
819 rev.ref_message_id = ref_message_id;
821 gen_message_id(message_id, sizeof(message_id),
822 sha1_to_hex(commit->object.sha1));
823 rev.message_id = message_id;
826 if (reopen_stdout(commit, rev.nr, keep_subject,
828 die("Failed to create output files");
829 shown = log_tree_commit(&rev, commit);
830 free(commit->buffer);
831 commit->buffer = NULL;
833 /* We put one extra blank line between formatted
834 * patches and this flag is used by log-tree code
835 * to see if it needs to emit a LF before showing
836 * the log; when using one file per patch, we do
837 * not want the extra blank line.
842 if (rev.mime_boundary)
843 printf("\n--%s%s--\n\n\n",
844 mime_boundary_leader,
847 printf("-- \n%s\n\n", git_version_string);
853 if (ignore_if_in_upstream)
854 free_patch_ids(&ids);
858 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
860 unsigned char sha1[20];
861 if (get_sha1(arg, sha1) == 0) {
862 struct commit *commit = lookup_commit_reference(sha1);
864 commit->object.flags |= flags;
865 add_pending_object(revs, &commit->object, arg);
872 static const char cherry_usage[] =
873 "git-cherry [-v] <upstream> [<head>] [<limit>]";
874 int cmd_cherry(int argc, const char **argv, const char *prefix)
876 struct rev_info revs;
877 struct patch_ids ids;
878 struct commit *commit;
879 struct commit_list *list = NULL;
880 const char *upstream;
881 const char *head = "HEAD";
882 const char *limit = NULL;
885 if (argc > 1 && !strcmp(argv[1], "-v")) {
905 init_revisions(&revs, prefix);
907 revs.combine_merges = 0;
908 revs.ignore_merges = 1;
909 DIFF_OPT_SET(&revs.diffopt, RECURSIVE);
911 if (add_pending_commit(head, &revs, 0))
912 die("Unknown commit %s", head);
913 if (add_pending_commit(upstream, &revs, UNINTERESTING))
914 die("Unknown commit %s", upstream);
916 /* Don't say anything if head and upstream are the same. */
917 if (revs.pending.nr == 2) {
918 struct object_array_entry *o = revs.pending.objects;
919 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
923 get_patch_ids(&revs, &ids, prefix);
925 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
926 die("Unknown commit %s", limit);
928 /* reverse the list of commits */
929 if (prepare_revision_walk(&revs))
930 die("revision walk setup failed");
931 while ((commit = get_revision(&revs)) != NULL) {
933 if (commit->parents && commit->parents->next)
936 commit_list_insert(commit, &list);
943 if (has_commit_patch_id(commit, &ids))
948 strbuf_init(&buf, 0);
949 pretty_print_commit(CMIT_FMT_ONELINE, commit,
950 &buf, 0, NULL, NULL, 0, 0);
951 printf("%c %s %s\n", sign,
952 sha1_to_hex(commit->object.sha1), buf.buf);
953 strbuf_release(&buf);
956 printf("%c %s\n", sign,
957 sha1_to_hex(commit->object.sha1));
963 free_patch_ids(&ids);