Thread-safe xmalloc and xrealloc needs a recursive mutex
[git/dscho.git] / builtin-log.c
blobe0d5caa61bac72cb40272ab26aa9b2202d5bb3e8
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"
19 #include "remote.h"
20 #include "string-list.h"
21 #include "parse-options.h"
23 /* Set a default date-time format for git log ("log.date" config variable) */
24 static const char *default_date_mode = NULL;
26 static int default_show_root = 1;
27 static const char *fmt_patch_subject_prefix = "PATCH";
28 static const char *fmt_pretty;
30 static const char * const builtin_log_usage =
31 "git log [<options>] [<since>..<until>] [[--] <path>...]\n"
32 " or: git show [options] <object>...";
34 static void cmd_log_init(int argc, const char **argv, const char *prefix,
35 struct rev_info *rev)
37 int i;
38 int decoration_style = 0;
40 rev->abbrev = DEFAULT_ABBREV;
41 rev->commit_format = CMIT_FMT_DEFAULT;
42 if (fmt_pretty)
43 get_commit_format(fmt_pretty, rev);
44 rev->verbose_header = 1;
45 DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
46 rev->show_root_diff = default_show_root;
47 rev->subject_prefix = fmt_patch_subject_prefix;
48 DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
50 if (default_date_mode)
51 rev->date_mode = parse_date_format(default_date_mode);
54 * Check for -h before setup_revisions(), or "git log -h" will
55 * fail when run without a git directory.
57 if (argc == 2 && !strcmp(argv[1], "-h"))
58 usage(builtin_log_usage);
59 argc = setup_revisions(argc, argv, rev, "HEAD");
61 if (!rev->show_notes_given && !rev->pretty_given)
62 rev->show_notes = 1;
64 if (rev->diffopt.pickaxe || rev->diffopt.filter)
65 rev->always_show_header = 0;
66 if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
67 rev->always_show_header = 0;
68 if (rev->diffopt.nr_paths != 1)
69 usage("git logs can only follow renames on one pathname at a time");
71 for (i = 1; i < argc; i++) {
72 const char *arg = argv[i];
73 if (!strcmp(arg, "--decorate")) {
74 decoration_style = DECORATE_SHORT_REFS;
75 } else if (!prefixcmp(arg, "--decorate=")) {
76 const char *v = skip_prefix(arg, "--decorate=");
77 if (!strcmp(v, "full"))
78 decoration_style = DECORATE_FULL_REFS;
79 else if (!strcmp(v, "short"))
80 decoration_style = DECORATE_SHORT_REFS;
81 else
82 die("invalid --decorate option: %s", arg);
83 } else if (!strcmp(arg, "--source")) {
84 rev->show_source = 1;
85 } else if (!strcmp(arg, "-h")) {
86 usage(builtin_log_usage);
87 } else
88 die("unrecognized argument: %s", arg);
90 if (decoration_style) {
91 rev->show_decorations = 1;
92 load_ref_decorations(decoration_style);
97 * This gives a rough estimate for how many commits we
98 * will print out in the list.
100 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
102 int n = 0;
104 while (list) {
105 struct commit *commit = list->item;
106 unsigned int flags = commit->object.flags;
107 list = list->next;
108 if (!(flags & (TREESAME | UNINTERESTING)))
109 n++;
111 return n;
114 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
116 if (rev->shown_one) {
117 rev->shown_one = 0;
118 if (rev->commit_format != CMIT_FMT_ONELINE)
119 putchar(rev->diffopt.line_termination);
121 printf("Final output: %d %s\n", nr, stage);
124 static struct itimerval early_output_timer;
126 static void log_show_early(struct rev_info *revs, struct commit_list *list)
128 int i = revs->early_output;
129 int show_header = 1;
131 sort_in_topological_order(&list, revs->lifo);
132 while (list && i) {
133 struct commit *commit = list->item;
134 switch (simplify_commit(revs, commit)) {
135 case commit_show:
136 if (show_header) {
137 int n = estimate_commit_count(revs, list);
138 show_early_header(revs, "incomplete", n);
139 show_header = 0;
141 log_tree_commit(revs, commit);
142 i--;
143 break;
144 case commit_ignore:
145 break;
146 case commit_error:
147 return;
149 list = list->next;
152 /* Did we already get enough commits for the early output? */
153 if (!i)
154 return;
157 * ..if no, then repeat it twice a second until we
158 * do.
160 * NOTE! We don't use "it_interval", because if the
161 * reader isn't listening, we want our output to be
162 * throttled by the writing, and not have the timer
163 * trigger every second even if we're blocked on a
164 * reader!
166 early_output_timer.it_value.tv_sec = 0;
167 early_output_timer.it_value.tv_usec = 500000;
168 setitimer(ITIMER_REAL, &early_output_timer, NULL);
171 static void early_output(int signal)
173 show_early_output = log_show_early;
176 static void setup_early_output(struct rev_info *rev)
178 struct sigaction sa;
181 * Set up the signal handler, minimally intrusively:
182 * we only set a single volatile integer word (not
183 * using sigatomic_t - trying to avoid unnecessary
184 * system dependencies and headers), and using
185 * SA_RESTART.
187 memset(&sa, 0, sizeof(sa));
188 sa.sa_handler = early_output;
189 sigemptyset(&sa.sa_mask);
190 sa.sa_flags = SA_RESTART;
191 sigaction(SIGALRM, &sa, NULL);
194 * If we can get the whole output in less than a
195 * tenth of a second, don't even bother doing the
196 * early-output thing..
198 * This is a one-time-only trigger.
200 early_output_timer.it_value.tv_sec = 0;
201 early_output_timer.it_value.tv_usec = 100000;
202 setitimer(ITIMER_REAL, &early_output_timer, NULL);
205 static void finish_early_output(struct rev_info *rev)
207 int n = estimate_commit_count(rev, rev->commits);
208 signal(SIGALRM, SIG_IGN);
209 show_early_header(rev, "done", n);
212 static int cmd_log_walk(struct rev_info *rev)
214 struct commit *commit;
216 if (rev->early_output)
217 setup_early_output(rev);
219 if (prepare_revision_walk(rev))
220 die("revision walk setup failed");
222 if (rev->early_output)
223 finish_early_output(rev);
226 * For --check and --exit-code, the exit code is based on CHECK_FAILED
227 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
228 * retain that state information if replacing rev->diffopt in this loop
230 while ((commit = get_revision(rev)) != NULL) {
231 log_tree_commit(rev, commit);
232 if (!rev->reflog_info) {
233 /* we allow cycles in reflog ancestry */
234 free(commit->buffer);
235 commit->buffer = NULL;
237 free_commit_list(commit->parents);
238 commit->parents = NULL;
240 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
241 DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
242 return 02;
244 return diff_result_code(&rev->diffopt, 0);
247 static int git_log_config(const char *var, const char *value, void *cb)
249 if (!strcmp(var, "format.pretty"))
250 return git_config_string(&fmt_pretty, var, value);
251 if (!strcmp(var, "format.subjectprefix"))
252 return git_config_string(&fmt_patch_subject_prefix, var, value);
253 if (!strcmp(var, "log.date"))
254 return git_config_string(&default_date_mode, var, value);
255 if (!strcmp(var, "log.showroot")) {
256 default_show_root = git_config_bool(var, value);
257 return 0;
259 return git_diff_ui_config(var, value, cb);
262 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
264 struct rev_info rev;
266 git_config(git_log_config, NULL);
268 if (diff_use_color_default == -1)
269 diff_use_color_default = git_use_color_default;
271 init_revisions(&rev, prefix);
272 rev.diff = 1;
273 rev.simplify_history = 0;
274 cmd_log_init(argc, argv, prefix, &rev);
275 if (!rev.diffopt.output_format)
276 rev.diffopt.output_format = DIFF_FORMAT_RAW;
277 return cmd_log_walk(&rev);
280 static void show_tagger(char *buf, int len, struct rev_info *rev)
282 struct strbuf out = STRBUF_INIT;
284 pp_user_info("Tagger", rev->commit_format, &out, buf, rev->date_mode,
285 git_log_output_encoding ?
286 git_log_output_encoding: git_commit_encoding);
287 printf("%s", out.buf);
288 strbuf_release(&out);
291 static int show_object(const unsigned char *sha1, int show_tag_object,
292 struct rev_info *rev)
294 unsigned long size;
295 enum object_type type;
296 char *buf = read_sha1_file(sha1, &type, &size);
297 int offset = 0;
299 if (!buf)
300 return error("Could not read object %s", sha1_to_hex(sha1));
302 if (show_tag_object)
303 while (offset < size && buf[offset] != '\n') {
304 int new_offset = offset + 1;
305 while (new_offset < size && buf[new_offset++] != '\n')
306 ; /* do nothing */
307 if (!prefixcmp(buf + offset, "tagger "))
308 show_tagger(buf + offset + 7,
309 new_offset - offset - 7, rev);
310 offset = new_offset;
313 if (offset < size)
314 fwrite(buf + offset, size - offset, 1, stdout);
315 free(buf);
316 return 0;
319 static int show_tree_object(const unsigned char *sha1,
320 const char *base, int baselen,
321 const char *pathname, unsigned mode, int stage, void *context)
323 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
324 return 0;
327 int cmd_show(int argc, const char **argv, const char *prefix)
329 struct rev_info rev;
330 struct object_array_entry *objects;
331 int i, count, ret = 0;
333 git_config(git_log_config, NULL);
335 if (diff_use_color_default == -1)
336 diff_use_color_default = git_use_color_default;
338 init_revisions(&rev, prefix);
339 rev.diff = 1;
340 rev.combine_merges = 1;
341 rev.dense_combined_merges = 1;
342 rev.always_show_header = 1;
343 rev.ignore_merges = 0;
344 rev.no_walk = 1;
345 cmd_log_init(argc, argv, prefix, &rev);
347 count = rev.pending.nr;
348 objects = rev.pending.objects;
349 for (i = 0; i < count && !ret; i++) {
350 struct object *o = objects[i].item;
351 const char *name = objects[i].name;
352 switch (o->type) {
353 case OBJ_BLOB:
354 ret = show_object(o->sha1, 0, NULL);
355 break;
356 case OBJ_TAG: {
357 struct tag *t = (struct tag *)o;
359 if (rev.shown_one)
360 putchar('\n');
361 printf("%stag %s%s\n",
362 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
363 t->tag,
364 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
365 ret = show_object(o->sha1, 1, &rev);
366 rev.shown_one = 1;
367 if (ret)
368 break;
369 o = parse_object(t->tagged->sha1);
370 if (!o)
371 ret = error("Could not read object %s",
372 sha1_to_hex(t->tagged->sha1));
373 objects[i].item = o;
374 i--;
375 break;
377 case OBJ_TREE:
378 if (rev.shown_one)
379 putchar('\n');
380 printf("%stree %s%s\n\n",
381 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
382 name,
383 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
384 read_tree_recursive((struct tree *)o, "", 0, 0, NULL,
385 show_tree_object, NULL);
386 rev.shown_one = 1;
387 break;
388 case OBJ_COMMIT:
389 rev.pending.nr = rev.pending.alloc = 0;
390 rev.pending.objects = NULL;
391 add_object_array(o, name, &rev.pending);
392 ret = cmd_log_walk(&rev);
393 break;
394 default:
395 ret = error("Unknown type: %d", o->type);
398 free(objects);
399 return ret;
403 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
405 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
407 struct rev_info rev;
409 git_config(git_log_config, NULL);
411 if (diff_use_color_default == -1)
412 diff_use_color_default = git_use_color_default;
414 init_revisions(&rev, prefix);
415 init_reflog_walk(&rev.reflog_info);
416 rev.abbrev_commit = 1;
417 rev.verbose_header = 1;
418 cmd_log_init(argc, argv, prefix, &rev);
421 * This means that we override whatever commit format the user gave
422 * on the cmd line. Sad, but cmd_log_init() currently doesn't
423 * allow us to set a different default.
425 rev.commit_format = CMIT_FMT_ONELINE;
426 rev.use_terminator = 1;
427 rev.always_show_header = 1;
430 * We get called through "git reflog", so unlike the other log
431 * routines, we need to set up our pager manually..
433 setup_pager();
435 return cmd_log_walk(&rev);
438 int cmd_log(int argc, const char **argv, const char *prefix)
440 struct rev_info rev;
442 git_config(git_log_config, NULL);
444 if (diff_use_color_default == -1)
445 diff_use_color_default = git_use_color_default;
447 init_revisions(&rev, prefix);
448 rev.always_show_header = 1;
449 cmd_log_init(argc, argv, prefix, &rev);
450 return cmd_log_walk(&rev);
453 /* format-patch */
455 static const char *fmt_patch_suffix = ".patch";
456 static int numbered = 0;
457 static int auto_number = 1;
459 static char *default_attach = NULL;
461 static char **extra_hdr;
462 static int extra_hdr_nr;
463 static int extra_hdr_alloc;
465 static char **extra_to;
466 static int extra_to_nr;
467 static int extra_to_alloc;
469 static char **extra_cc;
470 static int extra_cc_nr;
471 static int extra_cc_alloc;
473 static void add_header(const char *value)
475 int len = strlen(value);
476 while (len && value[len - 1] == '\n')
477 len--;
478 if (!strncasecmp(value, "to: ", 4)) {
479 ALLOC_GROW(extra_to, extra_to_nr + 1, extra_to_alloc);
480 extra_to[extra_to_nr++] = xstrndup(value + 4, len - 4);
481 return;
483 if (!strncasecmp(value, "cc: ", 4)) {
484 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
485 extra_cc[extra_cc_nr++] = xstrndup(value + 4, len - 4);
486 return;
488 ALLOC_GROW(extra_hdr, extra_hdr_nr + 1, extra_hdr_alloc);
489 extra_hdr[extra_hdr_nr++] = xstrndup(value, len);
492 #define THREAD_SHALLOW 1
493 #define THREAD_DEEP 2
494 static int thread = 0;
495 static int do_signoff = 0;
497 static int git_format_config(const char *var, const char *value, void *cb)
499 if (!strcmp(var, "format.headers")) {
500 if (!value)
501 die("format.headers without value");
502 add_header(value);
503 return 0;
505 if (!strcmp(var, "format.suffix"))
506 return git_config_string(&fmt_patch_suffix, var, value);
507 if (!strcmp(var, "format.cc")) {
508 if (!value)
509 return config_error_nonbool(var);
510 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
511 extra_cc[extra_cc_nr++] = xstrdup(value);
512 return 0;
514 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff")) {
515 return 0;
517 if (!strcmp(var, "format.numbered")) {
518 if (value && !strcasecmp(value, "auto")) {
519 auto_number = 1;
520 return 0;
522 numbered = git_config_bool(var, value);
523 auto_number = auto_number && numbered;
524 return 0;
526 if (!strcmp(var, "format.attach")) {
527 if (value && *value)
528 default_attach = xstrdup(value);
529 else
530 default_attach = xstrdup(git_version_string);
531 return 0;
533 if (!strcmp(var, "format.thread")) {
534 if (value && !strcasecmp(value, "deep")) {
535 thread = THREAD_DEEP;
536 return 0;
538 if (value && !strcasecmp(value, "shallow")) {
539 thread = THREAD_SHALLOW;
540 return 0;
542 thread = git_config_bool(var, value) && THREAD_SHALLOW;
543 return 0;
545 if (!strcmp(var, "format.signoff")) {
546 do_signoff = git_config_bool(var, value);
547 return 0;
550 return git_log_config(var, value, cb);
553 static FILE *realstdout = NULL;
554 static const char *output_directory = NULL;
555 static int outdir_offset;
557 static int reopen_stdout(struct commit *commit, struct rev_info *rev)
559 struct strbuf filename = STRBUF_INIT;
560 int suffix_len = strlen(fmt_patch_suffix) + 1;
562 if (output_directory) {
563 strbuf_addstr(&filename, output_directory);
564 if (filename.len >=
565 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
566 return error("name of output directory is too long");
567 if (filename.buf[filename.len - 1] != '/')
568 strbuf_addch(&filename, '/');
571 get_patch_filename(commit, rev->nr, fmt_patch_suffix, &filename);
573 if (!DIFF_OPT_TST(&rev->diffopt, QUICK))
574 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
576 if (freopen(filename.buf, "w", stdout) == NULL)
577 return error("Cannot open patch file %s", filename.buf);
579 strbuf_release(&filename);
580 return 0;
583 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids, const char *prefix)
585 struct rev_info check_rev;
586 struct commit *commit;
587 struct object *o1, *o2;
588 unsigned flags1, flags2;
590 if (rev->pending.nr != 2)
591 die("Need exactly one range.");
593 o1 = rev->pending.objects[0].item;
594 flags1 = o1->flags;
595 o2 = rev->pending.objects[1].item;
596 flags2 = o2->flags;
598 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
599 die("Not a range.");
601 init_patch_ids(ids);
603 /* given a range a..b get all patch ids for b..a */
604 init_revisions(&check_rev, prefix);
605 o1->flags ^= UNINTERESTING;
606 o2->flags ^= UNINTERESTING;
607 add_pending_object(&check_rev, o1, "o1");
608 add_pending_object(&check_rev, o2, "o2");
609 if (prepare_revision_walk(&check_rev))
610 die("revision walk setup failed");
612 while ((commit = get_revision(&check_rev)) != NULL) {
613 /* ignore merges */
614 if (commit->parents && commit->parents->next)
615 continue;
617 add_commit_patch_id(commit, ids);
620 /* reset for next revision walk */
621 clear_commit_marks((struct commit *)o1,
622 SEEN | UNINTERESTING | SHOWN | ADDED);
623 clear_commit_marks((struct commit *)o2,
624 SEEN | UNINTERESTING | SHOWN | ADDED);
625 o1->flags = flags1;
626 o2->flags = flags2;
629 static void gen_message_id(struct rev_info *info, char *base)
631 const char *committer = git_committer_info(IDENT_WARN_ON_NO_NAME);
632 const char *email_start = strrchr(committer, '<');
633 const char *email_end = strrchr(committer, '>');
634 struct strbuf buf = STRBUF_INIT;
635 if (!email_start || !email_end || email_start > email_end - 1)
636 die("Could not extract email from committer identity.");
637 strbuf_addf(&buf, "%s.%lu.git.%.*s", base,
638 (unsigned long) time(NULL),
639 (int)(email_end - email_start - 1), email_start + 1);
640 info->message_id = strbuf_detach(&buf, NULL);
643 static void make_cover_letter(struct rev_info *rev, int use_stdout,
644 int numbered, int numbered_files,
645 struct commit *origin,
646 int nr, struct commit **list, struct commit *head)
648 const char *committer;
649 const char *subject_start = NULL;
650 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
651 const char *msg;
652 const char *extra_headers = rev->extra_headers;
653 struct shortlog log;
654 struct strbuf sb = STRBUF_INIT;
655 int i;
656 const char *encoding = "UTF-8";
657 struct diff_options opts;
658 int need_8bit_cte = 0;
659 struct commit *commit = NULL;
661 if (rev->commit_format != CMIT_FMT_EMAIL)
662 die("Cover letter needs email format");
664 committer = git_committer_info(0);
666 if (!numbered_files) {
668 * We fake a commit for the cover letter so we get the filename
669 * desired.
671 commit = xcalloc(1, sizeof(*commit));
672 commit->buffer = xmalloc(400);
673 snprintf(commit->buffer, 400,
674 "tree 0000000000000000000000000000000000000000\n"
675 "parent %s\n"
676 "author %s\n"
677 "committer %s\n\n"
678 "cover letter\n",
679 sha1_to_hex(head->object.sha1), committer, committer);
682 if (!use_stdout && reopen_stdout(commit, rev))
683 return;
685 if (commit) {
687 free(commit->buffer);
688 free(commit);
691 log_write_email_headers(rev, head, &subject_start, &extra_headers,
692 &need_8bit_cte);
694 for (i = 0; !need_8bit_cte && i < nr; i++)
695 if (has_non_ascii(list[i]->buffer))
696 need_8bit_cte = 1;
698 msg = body;
699 pp_user_info(NULL, CMIT_FMT_EMAIL, &sb, committer, DATE_RFC2822,
700 encoding);
701 pp_title_line(CMIT_FMT_EMAIL, &msg, &sb, subject_start, extra_headers,
702 encoding, need_8bit_cte);
703 pp_remainder(CMIT_FMT_EMAIL, &msg, &sb, 0);
704 printf("%s\n", sb.buf);
706 strbuf_release(&sb);
708 shortlog_init(&log);
709 log.wrap_lines = 1;
710 log.wrap = 72;
711 log.in1 = 2;
712 log.in2 = 4;
713 for (i = 0; i < nr; i++)
714 shortlog_add_commit(&log, list[i]);
716 shortlog_output(&log);
719 * We can only do diffstat with a unique reference point
721 if (!origin)
722 return;
724 memcpy(&opts, &rev->diffopt, sizeof(opts));
725 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
727 diff_setup_done(&opts);
729 diff_tree_sha1(origin->tree->object.sha1,
730 head->tree->object.sha1,
731 "", &opts);
732 diffcore_std(&opts);
733 diff_flush(&opts);
735 printf("\n");
738 static const char *clean_message_id(const char *msg_id)
740 char ch;
741 const char *a, *z, *m;
743 m = msg_id;
744 while ((ch = *m) && (isspace(ch) || (ch == '<')))
745 m++;
746 a = m;
747 z = NULL;
748 while ((ch = *m)) {
749 if (!isspace(ch) && (ch != '>'))
750 z = m;
751 m++;
753 if (!z)
754 die("insane in-reply-to: %s", msg_id);
755 if (++z == m)
756 return a;
757 return xmemdupz(a, z - a);
760 static const char *set_outdir(const char *prefix, const char *output_directory)
762 if (output_directory && is_absolute_path(output_directory))
763 return output_directory;
765 if (!prefix || !*prefix) {
766 if (output_directory)
767 return output_directory;
768 /* The user did not explicitly ask for "./" */
769 outdir_offset = 2;
770 return "./";
773 outdir_offset = strlen(prefix);
774 if (!output_directory)
775 return prefix;
777 return xstrdup(prefix_filename(prefix, outdir_offset,
778 output_directory));
781 static const char * const builtin_format_patch_usage[] = {
782 "git format-patch [options] [<since> | <revision range>]",
783 NULL
786 static int keep_subject = 0;
788 static int keep_callback(const struct option *opt, const char *arg, int unset)
790 ((struct rev_info *)opt->value)->total = -1;
791 keep_subject = 1;
792 return 0;
795 static int subject_prefix = 0;
797 static int subject_prefix_callback(const struct option *opt, const char *arg,
798 int unset)
800 subject_prefix = 1;
801 ((struct rev_info *)opt->value)->subject_prefix = arg;
802 return 0;
805 static int numbered_cmdline_opt = 0;
807 static int numbered_callback(const struct option *opt, const char *arg,
808 int unset)
810 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
811 if (unset)
812 auto_number = 0;
813 return 0;
816 static int no_numbered_callback(const struct option *opt, const char *arg,
817 int unset)
819 return numbered_callback(opt, arg, 1);
822 static int output_directory_callback(const struct option *opt, const char *arg,
823 int unset)
825 const char **dir = (const char **)opt->value;
826 if (*dir)
827 die("Two output directories?");
828 *dir = arg;
829 return 0;
832 static int thread_callback(const struct option *opt, const char *arg, int unset)
834 int *thread = (int *)opt->value;
835 if (unset)
836 *thread = 0;
837 else if (!arg || !strcmp(arg, "shallow"))
838 *thread = THREAD_SHALLOW;
839 else if (!strcmp(arg, "deep"))
840 *thread = THREAD_DEEP;
841 else
842 return 1;
843 return 0;
846 static int attach_callback(const struct option *opt, const char *arg, int unset)
848 struct rev_info *rev = (struct rev_info *)opt->value;
849 if (unset)
850 rev->mime_boundary = NULL;
851 else if (arg)
852 rev->mime_boundary = arg;
853 else
854 rev->mime_boundary = git_version_string;
855 rev->no_inline = unset ? 0 : 1;
856 return 0;
859 static int inline_callback(const struct option *opt, const char *arg, int unset)
861 struct rev_info *rev = (struct rev_info *)opt->value;
862 if (unset)
863 rev->mime_boundary = NULL;
864 else if (arg)
865 rev->mime_boundary = arg;
866 else
867 rev->mime_boundary = git_version_string;
868 rev->no_inline = 0;
869 return 0;
872 static int header_callback(const struct option *opt, const char *arg, int unset)
874 add_header(arg);
875 return 0;
878 static int cc_callback(const struct option *opt, const char *arg, int unset)
880 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
881 extra_cc[extra_cc_nr++] = xstrdup(arg);
882 return 0;
885 int cmd_format_patch(int argc, const char **argv, const char *prefix)
887 struct commit *commit;
888 struct commit **list = NULL;
889 struct rev_info rev;
890 int nr = 0, total, i;
891 int use_stdout = 0;
892 int start_number = -1;
893 int numbered_files = 0; /* _just_ numbers */
894 int ignore_if_in_upstream = 0;
895 int cover_letter = 0;
896 int boundary_count = 0;
897 int no_binary_diff = 0;
898 struct commit *origin = NULL, *head = NULL;
899 const char *in_reply_to = NULL;
900 struct patch_ids ids;
901 char *add_signoff = NULL;
902 struct strbuf buf = STRBUF_INIT;
903 int use_patch_format = 0;
904 const struct option builtin_format_patch_options[] = {
905 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
906 "use [PATCH n/m] even with a single patch",
907 PARSE_OPT_NOARG, numbered_callback },
908 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
909 "use [PATCH] even with multiple patches",
910 PARSE_OPT_NOARG, no_numbered_callback },
911 OPT_BOOLEAN('s', "signoff", &do_signoff, "add Signed-off-by:"),
912 OPT_BOOLEAN(0, "stdout", &use_stdout,
913 "print patches to standard out"),
914 OPT_BOOLEAN(0, "cover-letter", &cover_letter,
915 "generate a cover letter"),
916 OPT_BOOLEAN(0, "numbered-files", &numbered_files,
917 "use simple number sequence for output file names"),
918 OPT_STRING(0, "suffix", &fmt_patch_suffix, "sfx",
919 "use <sfx> instead of '.patch'"),
920 OPT_INTEGER(0, "start-number", &start_number,
921 "start numbering patches at <n> instead of 1"),
922 { OPTION_CALLBACK, 0, "subject-prefix", &rev, "prefix",
923 "Use [<prefix>] instead of [PATCH]",
924 PARSE_OPT_NONEG, subject_prefix_callback },
925 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
926 "dir", "store resulting files in <dir>",
927 PARSE_OPT_NONEG, output_directory_callback },
928 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
929 "don't strip/add [PATCH]",
930 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
931 OPT_BOOLEAN(0, "no-binary", &no_binary_diff,
932 "don't output binary diffs"),
933 OPT_BOOLEAN(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
934 "don't include a patch matching a commit upstream"),
935 { OPTION_BOOLEAN, 'p', "no-stat", &use_patch_format, NULL,
936 "show patch format instead of default (patch + stat)",
937 PARSE_OPT_NONEG | PARSE_OPT_NOARG },
938 OPT_GROUP("Messaging"),
939 { OPTION_CALLBACK, 0, "add-header", NULL, "header",
940 "add email header", PARSE_OPT_NONEG,
941 header_callback },
942 { OPTION_CALLBACK, 0, "cc", NULL, "email", "add Cc: header",
943 PARSE_OPT_NONEG, cc_callback },
944 OPT_STRING(0, "in-reply-to", &in_reply_to, "message-id",
945 "make first mail a reply to <message-id>"),
946 { OPTION_CALLBACK, 0, "attach", &rev, "boundary",
947 "attach the patch", PARSE_OPT_OPTARG,
948 attach_callback },
949 { OPTION_CALLBACK, 0, "inline", &rev, "boundary",
950 "inline the patch",
951 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
952 inline_callback },
953 { OPTION_CALLBACK, 0, "thread", &thread, "style",
954 "enable message threading, styles: shallow, deep",
955 PARSE_OPT_OPTARG, thread_callback },
956 OPT_END()
959 git_config(git_format_config, NULL);
960 init_revisions(&rev, prefix);
961 rev.commit_format = CMIT_FMT_EMAIL;
962 rev.verbose_header = 1;
963 rev.diff = 1;
964 rev.combine_merges = 0;
965 rev.ignore_merges = 1;
966 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
968 rev.subject_prefix = fmt_patch_subject_prefix;
970 if (default_attach) {
971 rev.mime_boundary = default_attach;
972 rev.no_inline = 1;
976 * Parse the arguments before setup_revisions(), or something
977 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
978 * possibly a valid SHA1.
980 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
981 builtin_format_patch_usage,
982 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
983 PARSE_OPT_KEEP_DASHDASH);
985 if (do_signoff) {
986 const char *committer;
987 const char *endpos;
988 committer = git_committer_info(IDENT_ERROR_ON_NO_NAME);
989 endpos = strchr(committer, '>');
990 if (!endpos)
991 die("bogus committer info %s", committer);
992 add_signoff = xmemdupz(committer, endpos - committer + 1);
995 for (i = 0; i < extra_hdr_nr; i++) {
996 strbuf_addstr(&buf, extra_hdr[i]);
997 strbuf_addch(&buf, '\n');
1000 if (extra_to_nr)
1001 strbuf_addstr(&buf, "To: ");
1002 for (i = 0; i < extra_to_nr; i++) {
1003 if (i)
1004 strbuf_addstr(&buf, " ");
1005 strbuf_addstr(&buf, extra_to[i]);
1006 if (i + 1 < extra_to_nr)
1007 strbuf_addch(&buf, ',');
1008 strbuf_addch(&buf, '\n');
1011 if (extra_cc_nr)
1012 strbuf_addstr(&buf, "Cc: ");
1013 for (i = 0; i < extra_cc_nr; i++) {
1014 if (i)
1015 strbuf_addstr(&buf, " ");
1016 strbuf_addstr(&buf, extra_cc[i]);
1017 if (i + 1 < extra_cc_nr)
1018 strbuf_addch(&buf, ',');
1019 strbuf_addch(&buf, '\n');
1022 rev.extra_headers = strbuf_detach(&buf, NULL);
1024 if (start_number < 0)
1025 start_number = 1;
1028 * If numbered is set solely due to format.numbered in config,
1029 * and it would conflict with --keep-subject (-k) from the
1030 * command line, reset "numbered".
1032 if (numbered && keep_subject && !numbered_cmdline_opt)
1033 numbered = 0;
1035 if (numbered && keep_subject)
1036 die ("-n and -k are mutually exclusive.");
1037 if (keep_subject && subject_prefix)
1038 die ("--subject-prefix and -k are mutually exclusive.");
1040 argc = setup_revisions(argc, argv, &rev, "HEAD");
1041 if (argc > 1)
1042 die ("unrecognized argument: %s", argv[1]);
1044 if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1045 die("--name-only does not make sense");
1046 if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1047 die("--name-status does not make sense");
1048 if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1049 die("--check does not make sense");
1051 if (!use_patch_format &&
1052 (!rev.diffopt.output_format ||
1053 rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1054 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1056 /* Always generate a patch */
1057 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1059 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
1060 DIFF_OPT_SET(&rev.diffopt, BINARY);
1062 if (!use_stdout)
1063 output_directory = set_outdir(prefix, output_directory);
1065 if (output_directory) {
1066 if (use_stdout)
1067 die("standard output, or directory, which one?");
1068 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1069 die_errno("Could not create directory '%s'",
1070 output_directory);
1073 if (rev.pending.nr == 1) {
1074 if (rev.max_count < 0 && !rev.show_root_diff) {
1076 * This is traditional behaviour of "git format-patch
1077 * origin" that prepares what the origin side still
1078 * does not have.
1080 rev.pending.objects[0].item->flags |= UNINTERESTING;
1081 add_head_to_pending(&rev);
1084 * Otherwise, it is "format-patch -22 HEAD", and/or
1085 * "format-patch --root HEAD". The user wants
1086 * get_revision() to do the usual traversal.
1091 * We cannot move this anywhere earlier because we do want to
1092 * know if --root was given explicitly from the command line.
1094 rev.show_root_diff = 1;
1096 if (cover_letter) {
1097 /* remember the range */
1098 int i;
1099 for (i = 0; i < rev.pending.nr; i++) {
1100 struct object *o = rev.pending.objects[i].item;
1101 if (!(o->flags & UNINTERESTING))
1102 head = (struct commit *)o;
1104 /* We can't generate a cover letter without any patches */
1105 if (!head)
1106 return 0;
1109 if (ignore_if_in_upstream)
1110 get_patch_ids(&rev, &ids, prefix);
1112 if (!use_stdout)
1113 realstdout = xfdopen(xdup(1), "w");
1115 if (prepare_revision_walk(&rev))
1116 die("revision walk setup failed");
1117 rev.boundary = 1;
1118 while ((commit = get_revision(&rev)) != NULL) {
1119 if (commit->object.flags & BOUNDARY) {
1120 boundary_count++;
1121 origin = (boundary_count == 1) ? commit : NULL;
1122 continue;
1125 /* ignore merges */
1126 if (commit->parents && commit->parents->next)
1127 continue;
1129 if (ignore_if_in_upstream &&
1130 has_commit_patch_id(commit, &ids))
1131 continue;
1133 nr++;
1134 list = xrealloc(list, nr * sizeof(list[0]));
1135 list[nr - 1] = commit;
1137 total = nr;
1138 if (!keep_subject && auto_number && total > 1)
1139 numbered = 1;
1140 if (numbered)
1141 rev.total = total + start_number - 1;
1142 if (in_reply_to || thread || cover_letter)
1143 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1144 if (in_reply_to) {
1145 const char *msgid = clean_message_id(in_reply_to);
1146 string_list_append(msgid, rev.ref_message_ids);
1148 rev.numbered_files = numbered_files;
1149 rev.patch_suffix = fmt_patch_suffix;
1150 if (cover_letter) {
1151 if (thread)
1152 gen_message_id(&rev, "cover");
1153 make_cover_letter(&rev, use_stdout, numbered, numbered_files,
1154 origin, nr, list, head);
1155 total++;
1156 start_number--;
1158 rev.add_signoff = add_signoff;
1159 while (0 <= --nr) {
1160 int shown;
1161 commit = list[nr];
1162 rev.nr = total - nr + (start_number - 1);
1163 /* Make the second and subsequent mails replies to the first */
1164 if (thread) {
1165 /* Have we already had a message ID? */
1166 if (rev.message_id) {
1168 * For deep threading: make every mail
1169 * a reply to the previous one, no
1170 * matter what other options are set.
1172 * For shallow threading:
1174 * Without --cover-letter and
1175 * --in-reply-to, make every mail a
1176 * reply to the one before.
1178 * With --in-reply-to but no
1179 * --cover-letter, make every mail a
1180 * reply to the <reply-to>.
1182 * With --cover-letter, make every
1183 * mail but the cover letter a reply
1184 * to the cover letter. The cover
1185 * letter is a reply to the
1186 * --in-reply-to, if specified.
1188 if (thread == THREAD_SHALLOW
1189 && rev.ref_message_ids->nr > 0
1190 && (!cover_letter || rev.nr > 1))
1191 free(rev.message_id);
1192 else
1193 string_list_append(rev.message_id,
1194 rev.ref_message_ids);
1196 gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1199 if (!use_stdout && reopen_stdout(numbered_files ? NULL : commit,
1200 &rev))
1201 die("Failed to create output files");
1202 shown = log_tree_commit(&rev, commit);
1203 free(commit->buffer);
1204 commit->buffer = NULL;
1206 /* We put one extra blank line between formatted
1207 * patches and this flag is used by log-tree code
1208 * to see if it needs to emit a LF before showing
1209 * the log; when using one file per patch, we do
1210 * not want the extra blank line.
1212 if (!use_stdout)
1213 rev.shown_one = 0;
1214 if (shown) {
1215 if (rev.mime_boundary)
1216 printf("\n--%s%s--\n\n\n",
1217 mime_boundary_leader,
1218 rev.mime_boundary);
1219 else
1220 printf("-- \n%s\n\n", git_version_string);
1222 if (!use_stdout)
1223 fclose(stdout);
1225 free(list);
1226 if (ignore_if_in_upstream)
1227 free_patch_ids(&ids);
1228 return 0;
1231 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1233 unsigned char sha1[20];
1234 if (get_sha1(arg, sha1) == 0) {
1235 struct commit *commit = lookup_commit_reference(sha1);
1236 if (commit) {
1237 commit->object.flags |= flags;
1238 add_pending_object(revs, &commit->object, arg);
1239 return 0;
1242 return -1;
1245 static const char cherry_usage[] =
1246 "git cherry [-v] [<upstream> [<head> [<limit>]]]";
1247 int cmd_cherry(int argc, const char **argv, const char *prefix)
1249 struct rev_info revs;
1250 struct patch_ids ids;
1251 struct commit *commit;
1252 struct commit_list *list = NULL;
1253 struct branch *current_branch;
1254 const char *upstream;
1255 const char *head = "HEAD";
1256 const char *limit = NULL;
1257 int verbose = 0;
1259 if (argc > 1 && !strcmp(argv[1], "-v")) {
1260 verbose = 1;
1261 argc--;
1262 argv++;
1265 if (argc > 1 && !strcmp(argv[1], "-h"))
1266 usage(cherry_usage);
1268 switch (argc) {
1269 case 4:
1270 limit = argv[3];
1271 /* FALLTHROUGH */
1272 case 3:
1273 head = argv[2];
1274 /* FALLTHROUGH */
1275 case 2:
1276 upstream = argv[1];
1277 break;
1278 default:
1279 current_branch = branch_get(NULL);
1280 if (!current_branch || !current_branch->merge
1281 || !current_branch->merge[0]
1282 || !current_branch->merge[0]->dst) {
1283 fprintf(stderr, "Could not find a tracked"
1284 " remote branch, please"
1285 " specify <upstream> manually.\n");
1286 usage(cherry_usage);
1289 upstream = current_branch->merge[0]->dst;
1292 init_revisions(&revs, prefix);
1293 revs.diff = 1;
1294 revs.combine_merges = 0;
1295 revs.ignore_merges = 1;
1296 DIFF_OPT_SET(&revs.diffopt, RECURSIVE);
1298 if (add_pending_commit(head, &revs, 0))
1299 die("Unknown commit %s", head);
1300 if (add_pending_commit(upstream, &revs, UNINTERESTING))
1301 die("Unknown commit %s", upstream);
1303 /* Don't say anything if head and upstream are the same. */
1304 if (revs.pending.nr == 2) {
1305 struct object_array_entry *o = revs.pending.objects;
1306 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1307 return 0;
1310 get_patch_ids(&revs, &ids, prefix);
1312 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1313 die("Unknown commit %s", limit);
1315 /* reverse the list of commits */
1316 if (prepare_revision_walk(&revs))
1317 die("revision walk setup failed");
1318 while ((commit = get_revision(&revs)) != NULL) {
1319 /* ignore merges */
1320 if (commit->parents && commit->parents->next)
1321 continue;
1323 commit_list_insert(commit, &list);
1326 while (list) {
1327 char sign = '+';
1329 commit = list->item;
1330 if (has_commit_patch_id(commit, &ids))
1331 sign = '-';
1333 if (verbose) {
1334 struct strbuf buf = STRBUF_INIT;
1335 struct pretty_print_context ctx = {0};
1336 pretty_print_commit(CMIT_FMT_ONELINE, commit,
1337 &buf, &ctx);
1338 printf("%c %s %s\n", sign,
1339 sha1_to_hex(commit->object.sha1), buf.buf);
1340 strbuf_release(&buf);
1342 else {
1343 printf("%c %s\n", sign,
1344 sha1_to_hex(commit->object.sha1));
1347 list = list->next;
1350 free_patch_ids(&ids);
1351 return 0;