block-sha1: improve code on large-register-set machines
[git/spearce.git] / builtin-log.c
blob30358166e64c5745e979e6231a5de5e0e5111119
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 void cmd_log_init(int argc, const char **argv, const char *prefix,
31 struct rev_info *rev)
33 int i;
35 rev->abbrev = DEFAULT_ABBREV;
36 rev->commit_format = CMIT_FMT_DEFAULT;
37 if (fmt_pretty)
38 get_commit_format(fmt_pretty, rev);
39 rev->verbose_header = 1;
40 DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
41 rev->show_root_diff = default_show_root;
42 rev->subject_prefix = fmt_patch_subject_prefix;
43 DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
45 if (default_date_mode)
46 rev->date_mode = parse_date_format(default_date_mode);
48 argc = setup_revisions(argc, argv, rev, "HEAD");
50 if (rev->diffopt.pickaxe || rev->diffopt.filter)
51 rev->always_show_header = 0;
52 if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
53 rev->always_show_header = 0;
54 if (rev->diffopt.nr_paths != 1)
55 usage("git logs can only follow renames on one pathname at a time");
57 for (i = 1; i < argc; i++) {
58 const char *arg = argv[i];
59 if (!strcmp(arg, "--decorate")) {
60 load_ref_decorations();
61 rev->show_decorations = 1;
62 } else if (!strcmp(arg, "--source")) {
63 rev->show_source = 1;
64 } else
65 die("unrecognized argument: %s", arg);
70 * This gives a rough estimate for how many commits we
71 * will print out in the list.
73 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
75 int n = 0;
77 while (list) {
78 struct commit *commit = list->item;
79 unsigned int flags = commit->object.flags;
80 list = list->next;
81 if (!(flags & (TREESAME | UNINTERESTING)))
82 n++;
84 return n;
87 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
89 if (rev->shown_one) {
90 rev->shown_one = 0;
91 if (rev->commit_format != CMIT_FMT_ONELINE)
92 putchar(rev->diffopt.line_termination);
94 printf("Final output: %d %s\n", nr, stage);
97 static struct itimerval early_output_timer;
99 static void log_show_early(struct rev_info *revs, struct commit_list *list)
101 int i = revs->early_output;
102 int show_header = 1;
104 sort_in_topological_order(&list, revs->lifo);
105 while (list && i) {
106 struct commit *commit = list->item;
107 switch (simplify_commit(revs, commit)) {
108 case commit_show:
109 if (show_header) {
110 int n = estimate_commit_count(revs, list);
111 show_early_header(revs, "incomplete", n);
112 show_header = 0;
114 log_tree_commit(revs, commit);
115 i--;
116 break;
117 case commit_ignore:
118 break;
119 case commit_error:
120 return;
122 list = list->next;
125 /* Did we already get enough commits for the early output? */
126 if (!i)
127 return;
130 * ..if no, then repeat it twice a second until we
131 * do.
133 * NOTE! We don't use "it_interval", because if the
134 * reader isn't listening, we want our output to be
135 * throttled by the writing, and not have the timer
136 * trigger every second even if we're blocked on a
137 * reader!
139 early_output_timer.it_value.tv_sec = 0;
140 early_output_timer.it_value.tv_usec = 500000;
141 setitimer(ITIMER_REAL, &early_output_timer, NULL);
144 static void early_output(int signal)
146 show_early_output = log_show_early;
149 static void setup_early_output(struct rev_info *rev)
151 struct sigaction sa;
154 * Set up the signal handler, minimally intrusively:
155 * we only set a single volatile integer word (not
156 * using sigatomic_t - trying to avoid unnecessary
157 * system dependencies and headers), and using
158 * SA_RESTART.
160 memset(&sa, 0, sizeof(sa));
161 sa.sa_handler = early_output;
162 sigemptyset(&sa.sa_mask);
163 sa.sa_flags = SA_RESTART;
164 sigaction(SIGALRM, &sa, NULL);
167 * If we can get the whole output in less than a
168 * tenth of a second, don't even bother doing the
169 * early-output thing..
171 * This is a one-time-only trigger.
173 early_output_timer.it_value.tv_sec = 0;
174 early_output_timer.it_value.tv_usec = 100000;
175 setitimer(ITIMER_REAL, &early_output_timer, NULL);
178 static void finish_early_output(struct rev_info *rev)
180 int n = estimate_commit_count(rev, rev->commits);
181 signal(SIGALRM, SIG_IGN);
182 show_early_header(rev, "done", n);
185 static int cmd_log_walk(struct rev_info *rev)
187 struct commit *commit;
189 if (rev->early_output)
190 setup_early_output(rev);
192 if (prepare_revision_walk(rev))
193 die("revision walk setup failed");
195 if (rev->early_output)
196 finish_early_output(rev);
199 * For --check and --exit-code, the exit code is based on CHECK_FAILED
200 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
201 * retain that state information if replacing rev->diffopt in this loop
203 while ((commit = get_revision(rev)) != NULL) {
204 log_tree_commit(rev, commit);
205 if (!rev->reflog_info) {
206 /* we allow cycles in reflog ancestry */
207 free(commit->buffer);
208 commit->buffer = NULL;
210 free_commit_list(commit->parents);
211 commit->parents = NULL;
213 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
214 DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
215 return 02;
217 return diff_result_code(&rev->diffopt, 0);
220 static int git_log_config(const char *var, const char *value, void *cb)
222 if (!strcmp(var, "format.pretty"))
223 return git_config_string(&fmt_pretty, var, value);
224 if (!strcmp(var, "format.subjectprefix"))
225 return git_config_string(&fmt_patch_subject_prefix, var, value);
226 if (!strcmp(var, "log.date"))
227 return git_config_string(&default_date_mode, var, value);
228 if (!strcmp(var, "log.showroot")) {
229 default_show_root = git_config_bool(var, value);
230 return 0;
232 return git_diff_ui_config(var, value, cb);
235 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
237 struct rev_info rev;
239 git_config(git_log_config, NULL);
241 if (diff_use_color_default == -1)
242 diff_use_color_default = git_use_color_default;
244 init_revisions(&rev, prefix);
245 rev.diff = 1;
246 rev.simplify_history = 0;
247 cmd_log_init(argc, argv, prefix, &rev);
248 if (!rev.diffopt.output_format)
249 rev.diffopt.output_format = DIFF_FORMAT_RAW;
250 return cmd_log_walk(&rev);
253 static void show_tagger(char *buf, int len, struct rev_info *rev)
255 struct strbuf out = STRBUF_INIT;
257 pp_user_info("Tagger", rev->commit_format, &out, buf, rev->date_mode,
258 git_log_output_encoding ?
259 git_log_output_encoding: git_commit_encoding);
260 printf("%s", out.buf);
261 strbuf_release(&out);
264 static int show_object(const unsigned char *sha1, int show_tag_object,
265 struct rev_info *rev)
267 unsigned long size;
268 enum object_type type;
269 char *buf = read_sha1_file(sha1, &type, &size);
270 int offset = 0;
272 if (!buf)
273 return error("Could not read object %s", sha1_to_hex(sha1));
275 if (show_tag_object)
276 while (offset < size && buf[offset] != '\n') {
277 int new_offset = offset + 1;
278 while (new_offset < size && buf[new_offset++] != '\n')
279 ; /* do nothing */
280 if (!prefixcmp(buf + offset, "tagger "))
281 show_tagger(buf + offset + 7,
282 new_offset - offset - 7, rev);
283 offset = new_offset;
286 if (offset < size)
287 fwrite(buf + offset, size - offset, 1, stdout);
288 free(buf);
289 return 0;
292 static int show_tree_object(const unsigned char *sha1,
293 const char *base, int baselen,
294 const char *pathname, unsigned mode, int stage, void *context)
296 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
297 return 0;
300 int cmd_show(int argc, const char **argv, const char *prefix)
302 struct rev_info rev;
303 struct object_array_entry *objects;
304 int i, count, ret = 0;
306 git_config(git_log_config, NULL);
308 if (diff_use_color_default == -1)
309 diff_use_color_default = git_use_color_default;
311 init_revisions(&rev, prefix);
312 rev.diff = 1;
313 rev.combine_merges = 1;
314 rev.dense_combined_merges = 1;
315 rev.always_show_header = 1;
316 rev.ignore_merges = 0;
317 rev.no_walk = 1;
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;
325 switch (o->type) {
326 case OBJ_BLOB:
327 ret = show_object(o->sha1, 0, NULL);
328 break;
329 case OBJ_TAG: {
330 struct tag *t = (struct tag *)o;
332 if (rev.shown_one)
333 putchar('\n');
334 printf("%stag %s%s\n",
335 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
336 t->tag,
337 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
338 ret = show_object(o->sha1, 1, &rev);
339 rev.shown_one = 1;
340 if (ret)
341 break;
342 o = parse_object(t->tagged->sha1);
343 if (!o)
344 ret = error("Could not read object %s",
345 sha1_to_hex(t->tagged->sha1));
346 objects[i].item = o;
347 i--;
348 break;
350 case OBJ_TREE:
351 if (rev.shown_one)
352 putchar('\n');
353 printf("%stree %s%s\n\n",
354 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
355 name,
356 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
357 read_tree_recursive((struct tree *)o, "", 0, 0, NULL,
358 show_tree_object, NULL);
359 rev.shown_one = 1;
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 */
428 static const char *fmt_patch_suffix = ".patch";
429 static int numbered = 0;
430 static int auto_number = 1;
432 static char *default_attach = NULL;
434 static char **extra_hdr;
435 static int extra_hdr_nr;
436 static int extra_hdr_alloc;
438 static char **extra_to;
439 static int extra_to_nr;
440 static int extra_to_alloc;
442 static char **extra_cc;
443 static int extra_cc_nr;
444 static int extra_cc_alloc;
446 static void add_header(const char *value)
448 int len = strlen(value);
449 while (len && value[len - 1] == '\n')
450 len--;
451 if (!strncasecmp(value, "to: ", 4)) {
452 ALLOC_GROW(extra_to, extra_to_nr + 1, extra_to_alloc);
453 extra_to[extra_to_nr++] = xstrndup(value + 4, len - 4);
454 return;
456 if (!strncasecmp(value, "cc: ", 4)) {
457 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
458 extra_cc[extra_cc_nr++] = xstrndup(value + 4, len - 4);
459 return;
461 ALLOC_GROW(extra_hdr, extra_hdr_nr + 1, extra_hdr_alloc);
462 extra_hdr[extra_hdr_nr++] = xstrndup(value, len);
465 #define THREAD_SHALLOW 1
466 #define THREAD_DEEP 2
467 static int thread = 0;
468 static int do_signoff = 0;
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;
499 if (!strcmp(var, "format.attach")) {
500 if (value && *value)
501 default_attach = xstrdup(value);
502 else
503 default_attach = xstrdup(git_version_string);
504 return 0;
506 if (!strcmp(var, "format.thread")) {
507 if (value && !strcasecmp(value, "deep")) {
508 thread = THREAD_DEEP;
509 return 0;
511 if (value && !strcasecmp(value, "shallow")) {
512 thread = THREAD_SHALLOW;
513 return 0;
515 thread = git_config_bool(var, value) && THREAD_SHALLOW;
516 return 0;
518 if (!strcmp(var, "format.signoff")) {
519 do_signoff = git_config_bool(var, value);
520 return 0;
523 return git_log_config(var, value, cb);
526 static FILE *realstdout = NULL;
527 static const char *output_directory = NULL;
528 static int outdir_offset;
530 static int reopen_stdout(struct commit *commit, struct rev_info *rev)
532 struct strbuf filename = STRBUF_INIT;
533 int suffix_len = strlen(fmt_patch_suffix) + 1;
535 if (output_directory) {
536 strbuf_addstr(&filename, output_directory);
537 if (filename.len >=
538 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
539 return error("name of output directory is too long");
540 if (filename.buf[filename.len - 1] != '/')
541 strbuf_addch(&filename, '/');
544 get_patch_filename(commit, rev->nr, fmt_patch_suffix, &filename);
546 if (!DIFF_OPT_TST(&rev->diffopt, QUIET))
547 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
549 if (freopen(filename.buf, "w", stdout) == NULL)
550 return error("Cannot open patch file %s", filename.buf);
552 strbuf_release(&filename);
553 return 0;
556 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids, const char *prefix)
558 struct rev_info check_rev;
559 struct commit *commit;
560 struct object *o1, *o2;
561 unsigned flags1, flags2;
563 if (rev->pending.nr != 2)
564 die("Need exactly one range.");
566 o1 = rev->pending.objects[0].item;
567 flags1 = o1->flags;
568 o2 = rev->pending.objects[1].item;
569 flags2 = o2->flags;
571 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
572 die("Not a range.");
574 init_patch_ids(ids);
576 /* given a range a..b get all patch ids for b..a */
577 init_revisions(&check_rev, prefix);
578 o1->flags ^= UNINTERESTING;
579 o2->flags ^= UNINTERESTING;
580 add_pending_object(&check_rev, o1, "o1");
581 add_pending_object(&check_rev, o2, "o2");
582 if (prepare_revision_walk(&check_rev))
583 die("revision walk setup failed");
585 while ((commit = get_revision(&check_rev)) != NULL) {
586 /* ignore merges */
587 if (commit->parents && commit->parents->next)
588 continue;
590 add_commit_patch_id(commit, ids);
593 /* reset for next revision walk */
594 clear_commit_marks((struct commit *)o1,
595 SEEN | UNINTERESTING | SHOWN | ADDED);
596 clear_commit_marks((struct commit *)o2,
597 SEEN | UNINTERESTING | SHOWN | ADDED);
598 o1->flags = flags1;
599 o2->flags = flags2;
602 static void gen_message_id(struct rev_info *info, char *base)
604 const char *committer = git_committer_info(IDENT_WARN_ON_NO_NAME);
605 const char *email_start = strrchr(committer, '<');
606 const char *email_end = strrchr(committer, '>');
607 struct strbuf buf = STRBUF_INIT;
608 if (!email_start || !email_end || email_start > email_end - 1)
609 die("Could not extract email from committer identity.");
610 strbuf_addf(&buf, "%s.%lu.git.%.*s", base,
611 (unsigned long) time(NULL),
612 (int)(email_end - email_start - 1), email_start + 1);
613 info->message_id = strbuf_detach(&buf, NULL);
616 static void make_cover_letter(struct rev_info *rev, int use_stdout,
617 int numbered, int numbered_files,
618 struct commit *origin,
619 int nr, struct commit **list, struct commit *head)
621 const char *committer;
622 const char *subject_start = NULL;
623 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
624 const char *msg;
625 const char *extra_headers = rev->extra_headers;
626 struct shortlog log;
627 struct strbuf sb = STRBUF_INIT;
628 int i;
629 const char *encoding = "UTF-8";
630 struct diff_options opts;
631 int need_8bit_cte = 0;
632 struct commit *commit = NULL;
634 if (rev->commit_format != CMIT_FMT_EMAIL)
635 die("Cover letter needs email format");
637 committer = git_committer_info(0);
639 if (!numbered_files) {
641 * We fake a commit for the cover letter so we get the filename
642 * desired.
644 commit = xcalloc(1, sizeof(*commit));
645 commit->buffer = xmalloc(400);
646 snprintf(commit->buffer, 400,
647 "tree 0000000000000000000000000000000000000000\n"
648 "parent %s\n"
649 "author %s\n"
650 "committer %s\n\n"
651 "cover letter\n",
652 sha1_to_hex(head->object.sha1), committer, committer);
655 if (!use_stdout && reopen_stdout(commit, rev))
656 return;
658 if (commit) {
660 free(commit->buffer);
661 free(commit);
664 log_write_email_headers(rev, head, &subject_start, &extra_headers,
665 &need_8bit_cte);
667 msg = body;
668 pp_user_info(NULL, CMIT_FMT_EMAIL, &sb, committer, DATE_RFC2822,
669 encoding);
670 pp_title_line(CMIT_FMT_EMAIL, &msg, &sb, subject_start, extra_headers,
671 encoding, need_8bit_cte);
672 pp_remainder(CMIT_FMT_EMAIL, &msg, &sb, 0);
673 printf("%s\n", sb.buf);
675 strbuf_release(&sb);
677 shortlog_init(&log);
678 log.wrap_lines = 1;
679 log.wrap = 72;
680 log.in1 = 2;
681 log.in2 = 4;
682 for (i = 0; i < nr; i++)
683 shortlog_add_commit(&log, list[i]);
685 shortlog_output(&log);
688 * We can only do diffstat with a unique reference point
690 if (!origin)
691 return;
693 memcpy(&opts, &rev->diffopt, sizeof(opts));
694 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
696 diff_setup_done(&opts);
698 diff_tree_sha1(origin->tree->object.sha1,
699 head->tree->object.sha1,
700 "", &opts);
701 diffcore_std(&opts);
702 diff_flush(&opts);
704 printf("\n");
707 static const char *clean_message_id(const char *msg_id)
709 char ch;
710 const char *a, *z, *m;
712 m = msg_id;
713 while ((ch = *m) && (isspace(ch) || (ch == '<')))
714 m++;
715 a = m;
716 z = NULL;
717 while ((ch = *m)) {
718 if (!isspace(ch) && (ch != '>'))
719 z = m;
720 m++;
722 if (!z)
723 die("insane in-reply-to: %s", msg_id);
724 if (++z == m)
725 return a;
726 return xmemdupz(a, z - a);
729 static const char *set_outdir(const char *prefix, const char *output_directory)
731 if (output_directory && is_absolute_path(output_directory))
732 return output_directory;
734 if (!prefix || !*prefix) {
735 if (output_directory)
736 return output_directory;
737 /* The user did not explicitly ask for "./" */
738 outdir_offset = 2;
739 return "./";
742 outdir_offset = strlen(prefix);
743 if (!output_directory)
744 return prefix;
746 return xstrdup(prefix_filename(prefix, outdir_offset,
747 output_directory));
750 static const char * const builtin_format_patch_usage[] = {
751 "git format-patch [options] [<since> | <revision range>]",
752 NULL
755 static int keep_subject = 0;
757 static int keep_callback(const struct option *opt, const char *arg, int unset)
759 ((struct rev_info *)opt->value)->total = -1;
760 keep_subject = 1;
761 return 0;
764 static int subject_prefix = 0;
766 static int subject_prefix_callback(const struct option *opt, const char *arg,
767 int unset)
769 subject_prefix = 1;
770 ((struct rev_info *)opt->value)->subject_prefix = arg;
771 return 0;
774 static int numbered_cmdline_opt = 0;
776 static int numbered_callback(const struct option *opt, const char *arg,
777 int unset)
779 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
780 if (unset)
781 auto_number = 0;
782 return 0;
785 static int no_numbered_callback(const struct option *opt, const char *arg,
786 int unset)
788 return numbered_callback(opt, arg, 1);
791 static int output_directory_callback(const struct option *opt, const char *arg,
792 int unset)
794 const char **dir = (const char **)opt->value;
795 if (*dir)
796 die("Two output directories?");
797 *dir = arg;
798 return 0;
801 static int thread_callback(const struct option *opt, const char *arg, int unset)
803 int *thread = (int *)opt->value;
804 if (unset)
805 *thread = 0;
806 else if (!arg || !strcmp(arg, "shallow"))
807 *thread = THREAD_SHALLOW;
808 else if (!strcmp(arg, "deep"))
809 *thread = THREAD_DEEP;
810 else
811 return 1;
812 return 0;
815 static int attach_callback(const struct option *opt, const char *arg, int unset)
817 struct rev_info *rev = (struct rev_info *)opt->value;
818 if (unset)
819 rev->mime_boundary = NULL;
820 else if (arg)
821 rev->mime_boundary = arg;
822 else
823 rev->mime_boundary = git_version_string;
824 rev->no_inline = unset ? 0 : 1;
825 return 0;
828 static int inline_callback(const struct option *opt, const char *arg, int unset)
830 struct rev_info *rev = (struct rev_info *)opt->value;
831 if (unset)
832 rev->mime_boundary = NULL;
833 else if (arg)
834 rev->mime_boundary = arg;
835 else
836 rev->mime_boundary = git_version_string;
837 rev->no_inline = 0;
838 return 0;
841 static int header_callback(const struct option *opt, const char *arg, int unset)
843 add_header(arg);
844 return 0;
847 static int cc_callback(const struct option *opt, const char *arg, int unset)
849 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
850 extra_cc[extra_cc_nr++] = xstrdup(arg);
851 return 0;
854 int cmd_format_patch(int argc, const char **argv, const char *prefix)
856 struct commit *commit;
857 struct commit **list = NULL;
858 struct rev_info rev;
859 int nr = 0, total, i;
860 int use_stdout = 0;
861 int start_number = -1;
862 int numbered_files = 0; /* _just_ numbers */
863 int ignore_if_in_upstream = 0;
864 int cover_letter = 0;
865 int boundary_count = 0;
866 int no_binary_diff = 0;
867 struct commit *origin = NULL, *head = NULL;
868 const char *in_reply_to = NULL;
869 struct patch_ids ids;
870 char *add_signoff = NULL;
871 struct strbuf buf = STRBUF_INIT;
872 const struct option builtin_format_patch_options[] = {
873 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
874 "use [PATCH n/m] even with a single patch",
875 PARSE_OPT_NOARG, numbered_callback },
876 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
877 "use [PATCH] even with multiple patches",
878 PARSE_OPT_NOARG, no_numbered_callback },
879 OPT_BOOLEAN('s', "signoff", &do_signoff, "add Signed-off-by:"),
880 OPT_BOOLEAN(0, "stdout", &use_stdout,
881 "print patches to standard out"),
882 OPT_BOOLEAN(0, "cover-letter", &cover_letter,
883 "generate a cover letter"),
884 OPT_BOOLEAN(0, "numbered-files", &numbered_files,
885 "use simple number sequence for output file names"),
886 OPT_STRING(0, "suffix", &fmt_patch_suffix, "sfx",
887 "use <sfx> instead of '.patch'"),
888 OPT_INTEGER(0, "start-number", &start_number,
889 "start numbering patches at <n> instead of 1"),
890 { OPTION_CALLBACK, 0, "subject-prefix", &rev, "prefix",
891 "Use [<prefix>] instead of [PATCH]",
892 PARSE_OPT_NONEG, subject_prefix_callback },
893 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
894 "dir", "store resulting files in <dir>",
895 PARSE_OPT_NONEG, output_directory_callback },
896 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
897 "don't strip/add [PATCH]",
898 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
899 OPT_BOOLEAN(0, "no-binary", &no_binary_diff,
900 "don't output binary diffs"),
901 OPT_BOOLEAN(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
902 "don't include a patch matching a commit upstream"),
903 OPT_GROUP("Messaging"),
904 { OPTION_CALLBACK, 0, "add-header", NULL, "header",
905 "add email header", PARSE_OPT_NONEG,
906 header_callback },
907 { OPTION_CALLBACK, 0, "cc", NULL, "email", "add Cc: header",
908 PARSE_OPT_NONEG, cc_callback },
909 OPT_STRING(0, "in-reply-to", &in_reply_to, "message-id",
910 "make first mail a reply to <message-id>"),
911 { OPTION_CALLBACK, 0, "attach", &rev, "boundary",
912 "attach the patch", PARSE_OPT_OPTARG,
913 attach_callback },
914 { OPTION_CALLBACK, 0, "inline", &rev, "boundary",
915 "inline the patch",
916 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
917 inline_callback },
918 { OPTION_CALLBACK, 0, "thread", &thread, "style",
919 "enable message threading, styles: shallow, deep",
920 PARSE_OPT_OPTARG, thread_callback },
921 OPT_END()
924 git_config(git_format_config, NULL);
925 init_revisions(&rev, prefix);
926 rev.commit_format = CMIT_FMT_EMAIL;
927 rev.verbose_header = 1;
928 rev.diff = 1;
929 rev.combine_merges = 0;
930 rev.ignore_merges = 1;
931 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
933 rev.subject_prefix = fmt_patch_subject_prefix;
935 if (default_attach) {
936 rev.mime_boundary = default_attach;
937 rev.no_inline = 1;
941 * Parse the arguments before setup_revisions(), or something
942 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
943 * possibly a valid SHA1.
945 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
946 builtin_format_patch_usage,
947 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN);
949 if (do_signoff) {
950 const char *committer;
951 const char *endpos;
952 committer = git_committer_info(IDENT_ERROR_ON_NO_NAME);
953 endpos = strchr(committer, '>');
954 if (!endpos)
955 die("bogus committer info %s", committer);
956 add_signoff = xmemdupz(committer, endpos - committer + 1);
959 for (i = 0; i < extra_hdr_nr; i++) {
960 strbuf_addstr(&buf, extra_hdr[i]);
961 strbuf_addch(&buf, '\n');
964 if (extra_to_nr)
965 strbuf_addstr(&buf, "To: ");
966 for (i = 0; i < extra_to_nr; i++) {
967 if (i)
968 strbuf_addstr(&buf, " ");
969 strbuf_addstr(&buf, extra_to[i]);
970 if (i + 1 < extra_to_nr)
971 strbuf_addch(&buf, ',');
972 strbuf_addch(&buf, '\n');
975 if (extra_cc_nr)
976 strbuf_addstr(&buf, "Cc: ");
977 for (i = 0; i < extra_cc_nr; i++) {
978 if (i)
979 strbuf_addstr(&buf, " ");
980 strbuf_addstr(&buf, extra_cc[i]);
981 if (i + 1 < extra_cc_nr)
982 strbuf_addch(&buf, ',');
983 strbuf_addch(&buf, '\n');
986 rev.extra_headers = strbuf_detach(&buf, NULL);
988 if (start_number < 0)
989 start_number = 1;
992 * If numbered is set solely due to format.numbered in config,
993 * and it would conflict with --keep-subject (-k) from the
994 * command line, reset "numbered".
996 if (numbered && keep_subject && !numbered_cmdline_opt)
997 numbered = 0;
999 if (numbered && keep_subject)
1000 die ("-n and -k are mutually exclusive.");
1001 if (keep_subject && subject_prefix)
1002 die ("--subject-prefix and -k are mutually exclusive.");
1004 argc = setup_revisions(argc, argv, &rev, "HEAD");
1005 if (argc > 1)
1006 die ("unrecognized argument: %s", argv[1]);
1008 if (!rev.diffopt.output_format
1009 || rev.diffopt.output_format == DIFF_FORMAT_PATCH)
1010 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY | DIFF_FORMAT_PATCH;
1012 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
1013 DIFF_OPT_SET(&rev.diffopt, BINARY);
1015 if (!use_stdout)
1016 output_directory = set_outdir(prefix, output_directory);
1018 if (output_directory) {
1019 if (use_stdout)
1020 die("standard output, or directory, which one?");
1021 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1022 die_errno("Could not create directory '%s'",
1023 output_directory);
1026 if (rev.pending.nr == 1) {
1027 if (rev.max_count < 0 && !rev.show_root_diff) {
1029 * This is traditional behaviour of "git format-patch
1030 * origin" that prepares what the origin side still
1031 * does not have.
1033 rev.pending.objects[0].item->flags |= UNINTERESTING;
1034 add_head_to_pending(&rev);
1037 * Otherwise, it is "format-patch -22 HEAD", and/or
1038 * "format-patch --root HEAD". The user wants
1039 * get_revision() to do the usual traversal.
1044 * We cannot move this anywhere earlier because we do want to
1045 * know if --root was given explicitly from the comand line.
1047 rev.show_root_diff = 1;
1049 if (cover_letter) {
1050 /* remember the range */
1051 int i;
1052 for (i = 0; i < rev.pending.nr; i++) {
1053 struct object *o = rev.pending.objects[i].item;
1054 if (!(o->flags & UNINTERESTING))
1055 head = (struct commit *)o;
1057 /* We can't generate a cover letter without any patches */
1058 if (!head)
1059 return 0;
1062 if (ignore_if_in_upstream)
1063 get_patch_ids(&rev, &ids, prefix);
1065 if (!use_stdout)
1066 realstdout = xfdopen(xdup(1), "w");
1068 if (prepare_revision_walk(&rev))
1069 die("revision walk setup failed");
1070 rev.boundary = 1;
1071 while ((commit = get_revision(&rev)) != NULL) {
1072 if (commit->object.flags & BOUNDARY) {
1073 boundary_count++;
1074 origin = (boundary_count == 1) ? commit : NULL;
1075 continue;
1078 /* ignore merges */
1079 if (commit->parents && commit->parents->next)
1080 continue;
1082 if (ignore_if_in_upstream &&
1083 has_commit_patch_id(commit, &ids))
1084 continue;
1086 nr++;
1087 list = xrealloc(list, nr * sizeof(list[0]));
1088 list[nr - 1] = commit;
1090 total = nr;
1091 if (!keep_subject && auto_number && total > 1)
1092 numbered = 1;
1093 if (numbered)
1094 rev.total = total + start_number - 1;
1095 if (in_reply_to || thread || cover_letter)
1096 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1097 if (in_reply_to) {
1098 const char *msgid = clean_message_id(in_reply_to);
1099 string_list_append(msgid, rev.ref_message_ids);
1101 rev.numbered_files = numbered_files;
1102 rev.patch_suffix = fmt_patch_suffix;
1103 if (cover_letter) {
1104 if (thread)
1105 gen_message_id(&rev, "cover");
1106 make_cover_letter(&rev, use_stdout, numbered, numbered_files,
1107 origin, nr, list, head);
1108 total++;
1109 start_number--;
1111 rev.add_signoff = add_signoff;
1112 while (0 <= --nr) {
1113 int shown;
1114 commit = list[nr];
1115 rev.nr = total - nr + (start_number - 1);
1116 /* Make the second and subsequent mails replies to the first */
1117 if (thread) {
1118 /* Have we already had a message ID? */
1119 if (rev.message_id) {
1121 * For deep threading: make every mail
1122 * a reply to the previous one, no
1123 * matter what other options are set.
1125 * For shallow threading:
1127 * Without --cover-letter and
1128 * --in-reply-to, make every mail a
1129 * reply to the one before.
1131 * With --in-reply-to but no
1132 * --cover-letter, make every mail a
1133 * reply to the <reply-to>.
1135 * With --cover-letter, make every
1136 * mail but the cover letter a reply
1137 * to the cover letter. The cover
1138 * letter is a reply to the
1139 * --in-reply-to, if specified.
1141 if (thread == THREAD_SHALLOW
1142 && rev.ref_message_ids->nr > 0
1143 && (!cover_letter || rev.nr > 1))
1144 free(rev.message_id);
1145 else
1146 string_list_append(rev.message_id,
1147 rev.ref_message_ids);
1149 gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1152 if (!use_stdout && reopen_stdout(numbered_files ? NULL : commit,
1153 &rev))
1154 die("Failed to create output files");
1155 shown = log_tree_commit(&rev, commit);
1156 free(commit->buffer);
1157 commit->buffer = NULL;
1159 /* We put one extra blank line between formatted
1160 * patches and this flag is used by log-tree code
1161 * to see if it needs to emit a LF before showing
1162 * the log; when using one file per patch, we do
1163 * not want the extra blank line.
1165 if (!use_stdout)
1166 rev.shown_one = 0;
1167 if (shown) {
1168 if (rev.mime_boundary)
1169 printf("\n--%s%s--\n\n\n",
1170 mime_boundary_leader,
1171 rev.mime_boundary);
1172 else
1173 printf("-- \n%s\n\n", git_version_string);
1175 if (!use_stdout)
1176 fclose(stdout);
1178 free(list);
1179 if (ignore_if_in_upstream)
1180 free_patch_ids(&ids);
1181 return 0;
1184 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1186 unsigned char sha1[20];
1187 if (get_sha1(arg, sha1) == 0) {
1188 struct commit *commit = lookup_commit_reference(sha1);
1189 if (commit) {
1190 commit->object.flags |= flags;
1191 add_pending_object(revs, &commit->object, arg);
1192 return 0;
1195 return -1;
1198 static const char cherry_usage[] =
1199 "git cherry [-v] [<upstream> [<head> [<limit>]]]";
1200 int cmd_cherry(int argc, const char **argv, const char *prefix)
1202 struct rev_info revs;
1203 struct patch_ids ids;
1204 struct commit *commit;
1205 struct commit_list *list = NULL;
1206 struct branch *current_branch;
1207 const char *upstream;
1208 const char *head = "HEAD";
1209 const char *limit = NULL;
1210 int verbose = 0;
1212 if (argc > 1 && !strcmp(argv[1], "-v")) {
1213 verbose = 1;
1214 argc--;
1215 argv++;
1218 switch (argc) {
1219 case 4:
1220 limit = argv[3];
1221 /* FALLTHROUGH */
1222 case 3:
1223 head = argv[2];
1224 /* FALLTHROUGH */
1225 case 2:
1226 upstream = argv[1];
1227 break;
1228 default:
1229 current_branch = branch_get(NULL);
1230 if (!current_branch || !current_branch->merge
1231 || !current_branch->merge[0]
1232 || !current_branch->merge[0]->dst) {
1233 fprintf(stderr, "Could not find a tracked"
1234 " remote branch, please"
1235 " specify <upstream> manually.\n");
1236 usage(cherry_usage);
1239 upstream = current_branch->merge[0]->dst;
1242 init_revisions(&revs, prefix);
1243 revs.diff = 1;
1244 revs.combine_merges = 0;
1245 revs.ignore_merges = 1;
1246 DIFF_OPT_SET(&revs.diffopt, RECURSIVE);
1248 if (add_pending_commit(head, &revs, 0))
1249 die("Unknown commit %s", head);
1250 if (add_pending_commit(upstream, &revs, UNINTERESTING))
1251 die("Unknown commit %s", upstream);
1253 /* Don't say anything if head and upstream are the same. */
1254 if (revs.pending.nr == 2) {
1255 struct object_array_entry *o = revs.pending.objects;
1256 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1257 return 0;
1260 get_patch_ids(&revs, &ids, prefix);
1262 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1263 die("Unknown commit %s", limit);
1265 /* reverse the list of commits */
1266 if (prepare_revision_walk(&revs))
1267 die("revision walk setup failed");
1268 while ((commit = get_revision(&revs)) != NULL) {
1269 /* ignore merges */
1270 if (commit->parents && commit->parents->next)
1271 continue;
1273 commit_list_insert(commit, &list);
1276 while (list) {
1277 char sign = '+';
1279 commit = list->item;
1280 if (has_commit_patch_id(commit, &ids))
1281 sign = '-';
1283 if (verbose) {
1284 struct strbuf buf = STRBUF_INIT;
1285 pretty_print_commit(CMIT_FMT_ONELINE, commit,
1286 &buf, 0, NULL, NULL, 0, 0);
1287 printf("%c %s %s\n", sign,
1288 sha1_to_hex(commit->object.sha1), buf.buf);
1289 strbuf_release(&buf);
1291 else {
1292 printf("%c %s\n", sign,
1293 sha1_to_hex(commit->object.sha1));
1296 list = list->next;
1299 free_patch_ids(&ids);
1300 return 0;