Merge branch 'maint-1.6.0' into maint-1.6.1
[git/gitweb.git] / builtin-log.c
blob60f8dd86048fd3a4ec51d7296b85984a0cefd602
1 /*
2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
5 * 2006 Junio Hamano
6 */
7 #include "cache.h"
8 #include "color.h"
9 #include "commit.h"
10 #include "diff.h"
11 #include "revision.h"
12 #include "log-tree.h"
13 #include "builtin.h"
14 #include "tag.h"
15 #include "reflog-walk.h"
16 #include "patch-ids.h"
17 #include "run-command.h"
18 #include "shortlog.h"
20 /* Set a default date-time format for git log ("log.date" config variable) */
21 static const char *default_date_mode = NULL;
23 static int default_show_root = 1;
24 static const char *fmt_patch_subject_prefix = "PATCH";
25 static const char *fmt_pretty;
27 static void cmd_log_init(int argc, const char **argv, const char *prefix,
28 struct rev_info *rev)
30 int i;
32 rev->abbrev = DEFAULT_ABBREV;
33 rev->commit_format = CMIT_FMT_DEFAULT;
34 if (fmt_pretty)
35 get_commit_format(fmt_pretty, rev);
36 rev->verbose_header = 1;
37 DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
38 rev->show_root_diff = default_show_root;
39 rev->subject_prefix = fmt_patch_subject_prefix;
40 DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
42 if (default_date_mode)
43 rev->date_mode = parse_date_format(default_date_mode);
45 argc = setup_revisions(argc, argv, rev, "HEAD");
47 if (rev->diffopt.pickaxe || rev->diffopt.filter)
48 rev->always_show_header = 0;
49 if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
50 rev->always_show_header = 0;
51 if (rev->diffopt.nr_paths != 1)
52 usage("git logs can only follow renames on one pathname at a time");
54 for (i = 1; i < argc; i++) {
55 const char *arg = argv[i];
56 if (!strcmp(arg, "--decorate")) {
57 load_ref_decorations();
58 rev->show_decorations = 1;
59 } else if (!strcmp(arg, "--source")) {
60 rev->show_source = 1;
61 } else
62 die("unrecognized argument: %s", arg);
67 * This gives a rough estimate for how many commits we
68 * will print out in the list.
70 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
72 int n = 0;
74 while (list) {
75 struct commit *commit = list->item;
76 unsigned int flags = commit->object.flags;
77 list = list->next;
78 if (!(flags & (TREESAME | UNINTERESTING)))
79 n++;
81 return n;
84 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
86 if (rev->shown_one) {
87 rev->shown_one = 0;
88 if (rev->commit_format != CMIT_FMT_ONELINE)
89 putchar(rev->diffopt.line_termination);
91 printf("Final output: %d %s\n", nr, stage);
94 struct itimerval early_output_timer;
96 static void log_show_early(struct rev_info *revs, struct commit_list *list)
98 int i = revs->early_output;
99 int show_header = 1;
101 sort_in_topological_order(&list, revs->lifo);
102 while (list && i) {
103 struct commit *commit = list->item;
104 switch (simplify_commit(revs, commit)) {
105 case commit_show:
106 if (show_header) {
107 int n = estimate_commit_count(revs, list);
108 show_early_header(revs, "incomplete", n);
109 show_header = 0;
111 log_tree_commit(revs, commit);
112 i--;
113 break;
114 case commit_ignore:
115 break;
116 case commit_error:
117 return;
119 list = list->next;
122 /* Did we already get enough commits for the early output? */
123 if (!i)
124 return;
127 * ..if no, then repeat it twice a second until we
128 * do.
130 * NOTE! We don't use "it_interval", because if the
131 * reader isn't listening, we want our output to be
132 * throttled by the writing, and not have the timer
133 * trigger every second even if we're blocked on a
134 * reader!
136 early_output_timer.it_value.tv_sec = 0;
137 early_output_timer.it_value.tv_usec = 500000;
138 setitimer(ITIMER_REAL, &early_output_timer, NULL);
141 static void early_output(int signal)
143 show_early_output = log_show_early;
146 static void setup_early_output(struct rev_info *rev)
148 struct sigaction sa;
151 * Set up the signal handler, minimally intrusively:
152 * we only set a single volatile integer word (not
153 * using sigatomic_t - trying to avoid unnecessary
154 * system dependencies and headers), and using
155 * SA_RESTART.
157 memset(&sa, 0, sizeof(sa));
158 sa.sa_handler = early_output;
159 sigemptyset(&sa.sa_mask);
160 sa.sa_flags = SA_RESTART;
161 sigaction(SIGALRM, &sa, NULL);
164 * If we can get the whole output in less than a
165 * tenth of a second, don't even bother doing the
166 * early-output thing..
168 * This is a one-time-only trigger.
170 early_output_timer.it_value.tv_sec = 0;
171 early_output_timer.it_value.tv_usec = 100000;
172 setitimer(ITIMER_REAL, &early_output_timer, NULL);
175 static void finish_early_output(struct rev_info *rev)
177 int n = estimate_commit_count(rev, rev->commits);
178 signal(SIGALRM, SIG_IGN);
179 show_early_header(rev, "done", n);
182 static int cmd_log_walk(struct rev_info *rev)
184 struct commit *commit;
186 if (rev->early_output)
187 setup_early_output(rev);
189 if (prepare_revision_walk(rev))
190 die("revision walk setup failed");
192 if (rev->early_output)
193 finish_early_output(rev);
196 * For --check and --exit-code, the exit code is based on CHECK_FAILED
197 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
198 * retain that state information if replacing rev->diffopt in this loop
200 while ((commit = get_revision(rev)) != NULL) {
201 log_tree_commit(rev, commit);
202 if (!rev->reflog_info) {
203 /* we allow cycles in reflog ancestry */
204 free(commit->buffer);
205 commit->buffer = NULL;
207 free_commit_list(commit->parents);
208 commit->parents = NULL;
210 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
211 DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
212 return 02;
214 return diff_result_code(&rev->diffopt, 0);
217 static int git_log_config(const char *var, const char *value, void *cb)
219 if (!strcmp(var, "format.pretty"))
220 return git_config_string(&fmt_pretty, var, value);
221 if (!strcmp(var, "format.subjectprefix"))
222 return git_config_string(&fmt_patch_subject_prefix, var, value);
223 if (!strcmp(var, "log.date"))
224 return git_config_string(&default_date_mode, var, value);
225 if (!strcmp(var, "log.showroot")) {
226 default_show_root = git_config_bool(var, value);
227 return 0;
229 return git_diff_ui_config(var, value, cb);
232 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
234 struct rev_info rev;
236 git_config(git_log_config, NULL);
238 if (diff_use_color_default == -1)
239 diff_use_color_default = git_use_color_default;
241 init_revisions(&rev, prefix);
242 rev.diff = 1;
243 rev.simplify_history = 0;
244 cmd_log_init(argc, argv, prefix, &rev);
245 if (!rev.diffopt.output_format)
246 rev.diffopt.output_format = DIFF_FORMAT_RAW;
247 return cmd_log_walk(&rev);
250 static void show_tagger(char *buf, int len, struct rev_info *rev)
252 char *email_end, *p;
253 unsigned long date;
254 int tz;
256 email_end = memchr(buf, '>', len);
257 if (!email_end)
258 return;
259 p = ++email_end;
260 while (isspace(*p))
261 p++;
262 date = strtoul(p, &p, 10);
263 while (isspace(*p))
264 p++;
265 tz = (int)strtol(p, NULL, 10);
266 printf("Tagger: %.*s\nDate: %s\n", (int)(email_end - buf), buf,
267 show_date(date, tz, rev->date_mode));
270 static int show_object(const unsigned char *sha1, int show_tag_object,
271 struct rev_info *rev)
273 unsigned long size;
274 enum object_type type;
275 char *buf = read_sha1_file(sha1, &type, &size);
276 int offset = 0;
278 if (!buf)
279 return error("Could not read object %s", sha1_to_hex(sha1));
281 if (show_tag_object)
282 while (offset < size && buf[offset] != '\n') {
283 int new_offset = offset + 1;
284 while (new_offset < size && buf[new_offset++] != '\n')
285 ; /* do nothing */
286 if (!prefixcmp(buf + offset, "tagger "))
287 show_tagger(buf + offset + 7,
288 new_offset - offset - 7, rev);
289 offset = new_offset;
292 if (offset < size)
293 fwrite(buf + offset, size - offset, 1, stdout);
294 free(buf);
295 return 0;
298 static int show_tree_object(const unsigned char *sha1,
299 const char *base, int baselen,
300 const char *pathname, unsigned mode, int stage, void *context)
302 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
303 return 0;
306 int cmd_show(int argc, const char **argv, const char *prefix)
308 struct rev_info rev;
309 struct object_array_entry *objects;
310 int i, count, ret = 0;
312 git_config(git_log_config, NULL);
314 if (diff_use_color_default == -1)
315 diff_use_color_default = git_use_color_default;
317 init_revisions(&rev, prefix);
318 rev.diff = 1;
319 rev.combine_merges = 1;
320 rev.dense_combined_merges = 1;
321 rev.always_show_header = 1;
322 rev.ignore_merges = 0;
323 rev.no_walk = 1;
324 cmd_log_init(argc, argv, prefix, &rev);
326 count = rev.pending.nr;
327 objects = rev.pending.objects;
328 for (i = 0; i < count && !ret; i++) {
329 struct object *o = objects[i].item;
330 const char *name = objects[i].name;
331 switch (o->type) {
332 case OBJ_BLOB:
333 ret = show_object(o->sha1, 0, NULL);
334 break;
335 case OBJ_TAG: {
336 struct tag *t = (struct tag *)o;
338 printf("%stag %s%s\n",
339 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
340 t->tag,
341 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
342 ret = show_object(o->sha1, 1, &rev);
343 if (ret)
344 break;
345 o = parse_object(t->tagged->sha1);
346 if (!o)
347 ret = error("Could not read object %s",
348 sha1_to_hex(t->tagged->sha1));
349 objects[i].item = o;
350 i--;
351 break;
353 case OBJ_TREE:
354 printf("%stree %s%s\n\n",
355 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
356 name,
357 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
358 read_tree_recursive((struct tree *)o, "", 0, 0, NULL,
359 show_tree_object, NULL);
360 break;
361 case OBJ_COMMIT:
362 rev.pending.nr = rev.pending.alloc = 0;
363 rev.pending.objects = NULL;
364 add_object_array(o, name, &rev.pending);
365 ret = cmd_log_walk(&rev);
366 break;
367 default:
368 ret = error("Unknown type: %d", o->type);
371 free(objects);
372 return ret;
376 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
378 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
380 struct rev_info rev;
382 git_config(git_log_config, NULL);
384 if (diff_use_color_default == -1)
385 diff_use_color_default = git_use_color_default;
387 init_revisions(&rev, prefix);
388 init_reflog_walk(&rev.reflog_info);
389 rev.abbrev_commit = 1;
390 rev.verbose_header = 1;
391 cmd_log_init(argc, argv, prefix, &rev);
394 * This means that we override whatever commit format the user gave
395 * on the cmd line. Sad, but cmd_log_init() currently doesn't
396 * allow us to set a different default.
398 rev.commit_format = CMIT_FMT_ONELINE;
399 rev.use_terminator = 1;
400 rev.always_show_header = 1;
403 * We get called through "git reflog", so unlike the other log
404 * routines, we need to set up our pager manually..
406 setup_pager();
408 return cmd_log_walk(&rev);
411 int cmd_log(int argc, const char **argv, const char *prefix)
413 struct rev_info rev;
415 git_config(git_log_config, NULL);
417 if (diff_use_color_default == -1)
418 diff_use_color_default = git_use_color_default;
420 init_revisions(&rev, prefix);
421 rev.always_show_header = 1;
422 cmd_log_init(argc, argv, prefix, &rev);
423 return cmd_log_walk(&rev);
426 /* format-patch */
427 #define FORMAT_PATCH_NAME_MAX 64
429 static int istitlechar(char c)
431 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
432 (c >= '0' && c <= '9') || c == '.' || c == '_';
435 static const char *fmt_patch_suffix = ".patch";
436 static int numbered = 0;
437 static int auto_number = 1;
439 static char **extra_hdr;
440 static int extra_hdr_nr;
441 static int extra_hdr_alloc;
443 static char **extra_to;
444 static int extra_to_nr;
445 static int extra_to_alloc;
447 static char **extra_cc;
448 static int extra_cc_nr;
449 static int extra_cc_alloc;
451 static void add_header(const char *value)
453 int len = strlen(value);
454 while (len && value[len - 1] == '\n')
455 len--;
456 if (!strncasecmp(value, "to: ", 4)) {
457 ALLOC_GROW(extra_to, extra_to_nr + 1, extra_to_alloc);
458 extra_to[extra_to_nr++] = xstrndup(value + 4, len - 4);
459 return;
461 if (!strncasecmp(value, "cc: ", 4)) {
462 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
463 extra_cc[extra_cc_nr++] = xstrndup(value + 4, len - 4);
464 return;
466 ALLOC_GROW(extra_hdr, extra_hdr_nr + 1, extra_hdr_alloc);
467 extra_hdr[extra_hdr_nr++] = xstrndup(value, len);
470 static int git_format_config(const char *var, const char *value, void *cb)
472 if (!strcmp(var, "format.headers")) {
473 if (!value)
474 die("format.headers without value");
475 add_header(value);
476 return 0;
478 if (!strcmp(var, "format.suffix"))
479 return git_config_string(&fmt_patch_suffix, var, value);
480 if (!strcmp(var, "format.cc")) {
481 if (!value)
482 return config_error_nonbool(var);
483 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
484 extra_cc[extra_cc_nr++] = xstrdup(value);
485 return 0;
487 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff")) {
488 return 0;
490 if (!strcmp(var, "format.numbered")) {
491 if (value && !strcasecmp(value, "auto")) {
492 auto_number = 1;
493 return 0;
495 numbered = git_config_bool(var, value);
496 auto_number = auto_number && numbered;
497 return 0;
500 return git_log_config(var, value, cb);
504 static const char *get_oneline_for_filename(struct commit *commit,
505 int keep_subject)
507 static char filename[PATH_MAX];
508 char *sol;
509 int len = 0;
510 int suffix_len = strlen(fmt_patch_suffix) + 1;
512 sol = strstr(commit->buffer, "\n\n");
513 if (!sol)
514 filename[0] = '\0';
515 else {
516 int j, space = 0;
518 sol += 2;
519 /* strip [PATCH] or [PATCH blabla] */
520 if (!keep_subject && !prefixcmp(sol, "[PATCH")) {
521 char *eos = strchr(sol + 6, ']');
522 if (eos) {
523 while (isspace(*eos))
524 eos++;
525 sol = eos;
529 for (j = 0;
530 j < FORMAT_PATCH_NAME_MAX - suffix_len - 5 &&
531 len < sizeof(filename) - suffix_len &&
532 sol[j] && sol[j] != '\n';
533 j++) {
534 if (istitlechar(sol[j])) {
535 if (space) {
536 filename[len++] = '-';
537 space = 0;
539 filename[len++] = sol[j];
540 if (sol[j] == '.')
541 while (sol[j + 1] == '.')
542 j++;
543 } else
544 space = 1;
546 while (filename[len - 1] == '.'
547 || filename[len - 1] == '-')
548 len--;
549 filename[len] = '\0';
551 return filename;
554 static FILE *realstdout = NULL;
555 static const char *output_directory = NULL;
556 static int outdir_offset;
558 static int reopen_stdout(const char *oneline, int nr, int total)
560 char filename[PATH_MAX];
561 int len = 0;
562 int suffix_len = strlen(fmt_patch_suffix) + 1;
564 if (output_directory) {
565 len = snprintf(filename, sizeof(filename), "%s",
566 output_directory);
567 if (len >=
568 sizeof(filename) - FORMAT_PATCH_NAME_MAX - suffix_len)
569 return error("name of output directory is too long");
570 if (filename[len - 1] != '/')
571 filename[len++] = '/';
574 if (!oneline)
575 len += sprintf(filename + len, "%d", nr);
576 else {
577 len += sprintf(filename + len, "%04d-", nr);
578 len += snprintf(filename + len, sizeof(filename) - len - 1
579 - suffix_len, "%s", oneline);
580 strcpy(filename + len, fmt_patch_suffix);
583 fprintf(realstdout, "%s\n", filename + outdir_offset);
584 if (freopen(filename, "w", stdout) == NULL)
585 return error("Cannot open patch file %s",filename);
587 return 0;
590 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids, const char *prefix)
592 struct rev_info check_rev;
593 struct commit *commit;
594 struct object *o1, *o2;
595 unsigned flags1, flags2;
597 if (rev->pending.nr != 2)
598 die("Need exactly one range.");
600 o1 = rev->pending.objects[0].item;
601 flags1 = o1->flags;
602 o2 = rev->pending.objects[1].item;
603 flags2 = o2->flags;
605 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
606 die("Not a range.");
608 init_patch_ids(ids);
610 /* given a range a..b get all patch ids for b..a */
611 init_revisions(&check_rev, prefix);
612 o1->flags ^= UNINTERESTING;
613 o2->flags ^= UNINTERESTING;
614 add_pending_object(&check_rev, o1, "o1");
615 add_pending_object(&check_rev, o2, "o2");
616 if (prepare_revision_walk(&check_rev))
617 die("revision walk setup failed");
619 while ((commit = get_revision(&check_rev)) != NULL) {
620 /* ignore merges */
621 if (commit->parents && commit->parents->next)
622 continue;
624 add_commit_patch_id(commit, ids);
627 /* reset for next revision walk */
628 clear_commit_marks((struct commit *)o1,
629 SEEN | UNINTERESTING | SHOWN | ADDED);
630 clear_commit_marks((struct commit *)o2,
631 SEEN | UNINTERESTING | SHOWN | ADDED);
632 o1->flags = flags1;
633 o2->flags = flags2;
636 static void gen_message_id(struct rev_info *info, char *base)
638 const char *committer = git_committer_info(IDENT_WARN_ON_NO_NAME);
639 const char *email_start = strrchr(committer, '<');
640 const char *email_end = strrchr(committer, '>');
641 struct strbuf buf = STRBUF_INIT;
642 if (!email_start || !email_end || email_start > email_end - 1)
643 die("Could not extract email from committer identity.");
644 strbuf_addf(&buf, "%s.%lu.git.%.*s", base,
645 (unsigned long) time(NULL),
646 (int)(email_end - email_start - 1), email_start + 1);
647 info->message_id = strbuf_detach(&buf, NULL);
650 static void make_cover_letter(struct rev_info *rev, int use_stdout,
651 int numbered, int numbered_files,
652 struct commit *origin,
653 int nr, struct commit **list, struct commit *head)
655 const char *committer;
656 char *head_sha1;
657 const char *subject_start = NULL;
658 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
659 const char *msg;
660 const char *extra_headers = rev->extra_headers;
661 struct shortlog log;
662 struct strbuf sb = STRBUF_INIT;
663 int i;
664 const char *encoding = "utf-8";
665 struct diff_options opts;
666 int need_8bit_cte = 0;
668 if (rev->commit_format != CMIT_FMT_EMAIL)
669 die("Cover letter needs email format");
671 if (!use_stdout && reopen_stdout(numbered_files ?
672 NULL : "cover-letter", 0, rev->total))
673 return;
675 head_sha1 = sha1_to_hex(head->object.sha1);
677 log_write_email_headers(rev, head_sha1, &subject_start, &extra_headers,
678 &need_8bit_cte);
680 committer = git_committer_info(0);
682 msg = body;
683 pp_user_info(NULL, CMIT_FMT_EMAIL, &sb, committer, DATE_RFC2822,
684 encoding);
685 pp_title_line(CMIT_FMT_EMAIL, &msg, &sb, subject_start, extra_headers,
686 encoding, need_8bit_cte);
687 pp_remainder(CMIT_FMT_EMAIL, &msg, &sb, 0);
688 printf("%s\n", sb.buf);
690 strbuf_release(&sb);
692 shortlog_init(&log);
693 log.wrap_lines = 1;
694 log.wrap = 72;
695 log.in1 = 2;
696 log.in2 = 4;
697 for (i = 0; i < nr; i++)
698 shortlog_add_commit(&log, list[i]);
700 shortlog_output(&log);
703 * We can only do diffstat with a unique reference point
705 if (!origin)
706 return;
708 memcpy(&opts, &rev->diffopt, sizeof(opts));
709 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
711 diff_setup_done(&opts);
713 diff_tree_sha1(origin->tree->object.sha1,
714 head->tree->object.sha1,
715 "", &opts);
716 diffcore_std(&opts);
717 diff_flush(&opts);
719 printf("\n");
722 static const char *clean_message_id(const char *msg_id)
724 char ch;
725 const char *a, *z, *m;
727 m = msg_id;
728 while ((ch = *m) && (isspace(ch) || (ch == '<')))
729 m++;
730 a = m;
731 z = NULL;
732 while ((ch = *m)) {
733 if (!isspace(ch) && (ch != '>'))
734 z = m;
735 m++;
737 if (!z)
738 die("insane in-reply-to: %s", msg_id);
739 if (++z == m)
740 return a;
741 return xmemdupz(a, z - a);
744 static const char *set_outdir(const char *prefix, const char *output_directory)
746 if (output_directory && is_absolute_path(output_directory))
747 return output_directory;
749 if (!prefix || !*prefix) {
750 if (output_directory)
751 return output_directory;
752 /* The user did not explicitly ask for "./" */
753 outdir_offset = 2;
754 return "./";
757 outdir_offset = strlen(prefix);
758 if (!output_directory)
759 return prefix;
761 return xstrdup(prefix_filename(prefix, outdir_offset,
762 output_directory));
765 int cmd_format_patch(int argc, const char **argv, const char *prefix)
767 struct commit *commit;
768 struct commit **list = NULL;
769 struct rev_info rev;
770 int nr = 0, total, i, j;
771 int use_stdout = 0;
772 int start_number = -1;
773 int keep_subject = 0;
774 int numbered_files = 0; /* _just_ numbers */
775 int subject_prefix = 0;
776 int ignore_if_in_upstream = 0;
777 int thread = 0;
778 int cover_letter = 0;
779 int boundary_count = 0;
780 int no_binary_diff = 0;
781 struct commit *origin = NULL, *head = NULL;
782 const char *in_reply_to = NULL;
783 struct patch_ids ids;
784 char *add_signoff = NULL;
785 struct strbuf buf = STRBUF_INIT;
787 git_config(git_format_config, NULL);
788 init_revisions(&rev, prefix);
789 rev.commit_format = CMIT_FMT_EMAIL;
790 rev.verbose_header = 1;
791 rev.diff = 1;
792 rev.combine_merges = 0;
793 rev.ignore_merges = 1;
794 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
796 rev.subject_prefix = fmt_patch_subject_prefix;
799 * Parse the arguments before setup_revisions(), or something
800 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
801 * possibly a valid SHA1.
803 for (i = 1, j = 1; i < argc; i++) {
804 if (!strcmp(argv[i], "--stdout"))
805 use_stdout = 1;
806 else if (!strcmp(argv[i], "-n") ||
807 !strcmp(argv[i], "--numbered"))
808 numbered = 1;
809 else if (!strcmp(argv[i], "-N") ||
810 !strcmp(argv[i], "--no-numbered")) {
811 numbered = 0;
812 auto_number = 0;
814 else if (!prefixcmp(argv[i], "--start-number="))
815 start_number = strtol(argv[i] + 15, NULL, 10);
816 else if (!strcmp(argv[i], "--numbered-files"))
817 numbered_files = 1;
818 else if (!strcmp(argv[i], "--start-number")) {
819 i++;
820 if (i == argc)
821 die("Need a number for --start-number");
822 start_number = strtol(argv[i], NULL, 10);
824 else if (!prefixcmp(argv[i], "--cc=")) {
825 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
826 extra_cc[extra_cc_nr++] = xstrdup(argv[i] + 5);
828 else if (!strcmp(argv[i], "-k") ||
829 !strcmp(argv[i], "--keep-subject")) {
830 keep_subject = 1;
831 rev.total = -1;
833 else if (!strcmp(argv[i], "--output-directory") ||
834 !strcmp(argv[i], "-o")) {
835 i++;
836 if (argc <= i)
837 die("Which directory?");
838 if (output_directory)
839 die("Two output directories?");
840 output_directory = argv[i];
842 else if (!strcmp(argv[i], "--signoff") ||
843 !strcmp(argv[i], "-s")) {
844 const char *committer;
845 const char *endpos;
846 committer = git_committer_info(IDENT_ERROR_ON_NO_NAME);
847 endpos = strchr(committer, '>');
848 if (!endpos)
849 die("bogus committer info %s\n", committer);
850 add_signoff = xmemdupz(committer, endpos - committer + 1);
852 else if (!strcmp(argv[i], "--attach")) {
853 rev.mime_boundary = git_version_string;
854 rev.no_inline = 1;
856 else if (!prefixcmp(argv[i], "--attach=")) {
857 rev.mime_boundary = argv[i] + 9;
858 rev.no_inline = 1;
860 else if (!strcmp(argv[i], "--inline")) {
861 rev.mime_boundary = git_version_string;
862 rev.no_inline = 0;
864 else if (!prefixcmp(argv[i], "--inline=")) {
865 rev.mime_boundary = argv[i] + 9;
866 rev.no_inline = 0;
868 else if (!strcmp(argv[i], "--ignore-if-in-upstream"))
869 ignore_if_in_upstream = 1;
870 else if (!strcmp(argv[i], "--thread"))
871 thread = 1;
872 else if (!prefixcmp(argv[i], "--in-reply-to="))
873 in_reply_to = argv[i] + 14;
874 else if (!strcmp(argv[i], "--in-reply-to")) {
875 i++;
876 if (i == argc)
877 die("Need a Message-Id for --in-reply-to");
878 in_reply_to = argv[i];
879 } else if (!prefixcmp(argv[i], "--subject-prefix=")) {
880 subject_prefix = 1;
881 rev.subject_prefix = argv[i] + 17;
882 } else if (!prefixcmp(argv[i], "--suffix="))
883 fmt_patch_suffix = argv[i] + 9;
884 else if (!strcmp(argv[i], "--cover-letter"))
885 cover_letter = 1;
886 else if (!strcmp(argv[i], "--no-binary"))
887 no_binary_diff = 1;
888 else
889 argv[j++] = argv[i];
891 argc = j;
893 for (i = 0; i < extra_hdr_nr; i++) {
894 strbuf_addstr(&buf, extra_hdr[i]);
895 strbuf_addch(&buf, '\n');
898 if (extra_to_nr)
899 strbuf_addstr(&buf, "To: ");
900 for (i = 0; i < extra_to_nr; i++) {
901 if (i)
902 strbuf_addstr(&buf, " ");
903 strbuf_addstr(&buf, extra_to[i]);
904 if (i + 1 < extra_to_nr)
905 strbuf_addch(&buf, ',');
906 strbuf_addch(&buf, '\n');
909 if (extra_cc_nr)
910 strbuf_addstr(&buf, "Cc: ");
911 for (i = 0; i < extra_cc_nr; i++) {
912 if (i)
913 strbuf_addstr(&buf, " ");
914 strbuf_addstr(&buf, extra_cc[i]);
915 if (i + 1 < extra_cc_nr)
916 strbuf_addch(&buf, ',');
917 strbuf_addch(&buf, '\n');
920 rev.extra_headers = strbuf_detach(&buf, 0);
922 if (start_number < 0)
923 start_number = 1;
924 if (numbered && keep_subject)
925 die ("-n and -k are mutually exclusive.");
926 if (keep_subject && subject_prefix)
927 die ("--subject-prefix and -k are mutually exclusive.");
928 if (numbered_files && use_stdout)
929 die ("--numbered-files and --stdout are mutually exclusive.");
931 argc = setup_revisions(argc, argv, &rev, "HEAD");
932 if (argc > 1)
933 die ("unrecognized argument: %s", argv[1]);
935 if (!rev.diffopt.output_format
936 || rev.diffopt.output_format == DIFF_FORMAT_PATCH)
937 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY | DIFF_FORMAT_PATCH;
939 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
940 DIFF_OPT_SET(&rev.diffopt, BINARY);
942 if (!use_stdout)
943 output_directory = set_outdir(prefix, output_directory);
945 if (output_directory) {
946 if (use_stdout)
947 die("standard output, or directory, which one?");
948 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
949 die("Could not create directory %s",
950 output_directory);
953 if (rev.pending.nr == 1) {
954 if (rev.max_count < 0 && !rev.show_root_diff) {
956 * This is traditional behaviour of "git format-patch
957 * origin" that prepares what the origin side still
958 * does not have.
960 rev.pending.objects[0].item->flags |= UNINTERESTING;
961 add_head_to_pending(&rev);
964 * Otherwise, it is "format-patch -22 HEAD", and/or
965 * "format-patch --root HEAD". The user wants
966 * get_revision() to do the usual traversal.
971 * We cannot move this anywhere earlier because we do want to
972 * know if --root was given explicitly from the comand line.
974 rev.show_root_diff = 1;
976 if (cover_letter) {
977 /* remember the range */
978 int i;
979 for (i = 0; i < rev.pending.nr; i++) {
980 struct object *o = rev.pending.objects[i].item;
981 if (!(o->flags & UNINTERESTING))
982 head = (struct commit *)o;
984 /* We can't generate a cover letter without any patches */
985 if (!head)
986 return 0;
989 if (ignore_if_in_upstream)
990 get_patch_ids(&rev, &ids, prefix);
992 if (!use_stdout)
993 realstdout = xfdopen(xdup(1), "w");
995 if (prepare_revision_walk(&rev))
996 die("revision walk setup failed");
997 rev.boundary = 1;
998 while ((commit = get_revision(&rev)) != NULL) {
999 if (commit->object.flags & BOUNDARY) {
1000 boundary_count++;
1001 origin = (boundary_count == 1) ? commit : NULL;
1002 continue;
1005 /* ignore merges */
1006 if (commit->parents && commit->parents->next)
1007 continue;
1009 if (ignore_if_in_upstream &&
1010 has_commit_patch_id(commit, &ids))
1011 continue;
1013 nr++;
1014 list = xrealloc(list, nr * sizeof(list[0]));
1015 list[nr - 1] = commit;
1017 total = nr;
1018 if (!keep_subject && auto_number && total > 1)
1019 numbered = 1;
1020 if (numbered)
1021 rev.total = total + start_number - 1;
1022 if (in_reply_to)
1023 rev.ref_message_id = clean_message_id(in_reply_to);
1024 if (cover_letter) {
1025 if (thread)
1026 gen_message_id(&rev, "cover");
1027 make_cover_letter(&rev, use_stdout, numbered, numbered_files,
1028 origin, nr, list, head);
1029 total++;
1030 start_number--;
1032 rev.add_signoff = add_signoff;
1033 while (0 <= --nr) {
1034 int shown;
1035 commit = list[nr];
1036 rev.nr = total - nr + (start_number - 1);
1037 /* Make the second and subsequent mails replies to the first */
1038 if (thread) {
1039 /* Have we already had a message ID? */
1040 if (rev.message_id) {
1042 * If we've got the ID to be a reply
1043 * to, discard the current ID;
1044 * otherwise, make everything a reply
1045 * to that.
1047 if (rev.ref_message_id)
1048 free(rev.message_id);
1049 else
1050 rev.ref_message_id = rev.message_id;
1052 gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1054 if (!use_stdout && reopen_stdout(numbered_files ? NULL :
1055 get_oneline_for_filename(commit, keep_subject),
1056 rev.nr, rev.total))
1057 die("Failed to create output files");
1058 shown = log_tree_commit(&rev, commit);
1059 free(commit->buffer);
1060 commit->buffer = NULL;
1062 /* We put one extra blank line between formatted
1063 * patches and this flag is used by log-tree code
1064 * to see if it needs to emit a LF before showing
1065 * the log; when using one file per patch, we do
1066 * not want the extra blank line.
1068 if (!use_stdout)
1069 rev.shown_one = 0;
1070 if (shown) {
1071 if (rev.mime_boundary)
1072 printf("\n--%s%s--\n\n\n",
1073 mime_boundary_leader,
1074 rev.mime_boundary);
1075 else
1076 printf("-- \n%s\n\n", git_version_string);
1078 if (!use_stdout)
1079 fclose(stdout);
1081 free(list);
1082 if (ignore_if_in_upstream)
1083 free_patch_ids(&ids);
1084 return 0;
1087 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1089 unsigned char sha1[20];
1090 if (get_sha1(arg, sha1) == 0) {
1091 struct commit *commit = lookup_commit_reference(sha1);
1092 if (commit) {
1093 commit->object.flags |= flags;
1094 add_pending_object(revs, &commit->object, arg);
1095 return 0;
1098 return -1;
1101 static const char cherry_usage[] =
1102 "git cherry [-v] <upstream> [<head>] [<limit>]";
1103 int cmd_cherry(int argc, const char **argv, const char *prefix)
1105 struct rev_info revs;
1106 struct patch_ids ids;
1107 struct commit *commit;
1108 struct commit_list *list = NULL;
1109 const char *upstream;
1110 const char *head = "HEAD";
1111 const char *limit = NULL;
1112 int verbose = 0;
1114 if (argc > 1 && !strcmp(argv[1], "-v")) {
1115 verbose = 1;
1116 argc--;
1117 argv++;
1120 switch (argc) {
1121 case 4:
1122 limit = argv[3];
1123 /* FALLTHROUGH */
1124 case 3:
1125 head = argv[2];
1126 /* FALLTHROUGH */
1127 case 2:
1128 upstream = argv[1];
1129 break;
1130 default:
1131 usage(cherry_usage);
1134 init_revisions(&revs, prefix);
1135 revs.diff = 1;
1136 revs.combine_merges = 0;
1137 revs.ignore_merges = 1;
1138 DIFF_OPT_SET(&revs.diffopt, RECURSIVE);
1140 if (add_pending_commit(head, &revs, 0))
1141 die("Unknown commit %s", head);
1142 if (add_pending_commit(upstream, &revs, UNINTERESTING))
1143 die("Unknown commit %s", upstream);
1145 /* Don't say anything if head and upstream are the same. */
1146 if (revs.pending.nr == 2) {
1147 struct object_array_entry *o = revs.pending.objects;
1148 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1149 return 0;
1152 get_patch_ids(&revs, &ids, prefix);
1154 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1155 die("Unknown commit %s", limit);
1157 /* reverse the list of commits */
1158 if (prepare_revision_walk(&revs))
1159 die("revision walk setup failed");
1160 while ((commit = get_revision(&revs)) != NULL) {
1161 /* ignore merges */
1162 if (commit->parents && commit->parents->next)
1163 continue;
1165 commit_list_insert(commit, &list);
1168 while (list) {
1169 char sign = '+';
1171 commit = list->item;
1172 if (has_commit_patch_id(commit, &ids))
1173 sign = '-';
1175 if (verbose) {
1176 struct strbuf buf = STRBUF_INIT;
1177 pretty_print_commit(CMIT_FMT_ONELINE, commit,
1178 &buf, 0, NULL, NULL, 0, 0);
1179 printf("%c %s %s\n", sign,
1180 sha1_to_hex(commit->object.sha1), buf.buf);
1181 strbuf_release(&buf);
1183 else {
1184 printf("%c %s\n", sign,
1185 sha1_to_hex(commit->object.sha1));
1188 list = list->next;
1191 free_patch_ids(&ids);
1192 return 0;