MinGW: fix warning about implicit declaration of _getch()
[git/spearce.git] / builtin-log.c
blob0d34050556855d6bab8b4c4121e833cc326324df
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 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\n", 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 printf("%stag %s%s\n",
333 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
334 t->tag,
335 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
336 ret = show_object(o->sha1, 1, &rev);
337 if (ret)
338 break;
339 o = parse_object(t->tagged->sha1);
340 if (!o)
341 ret = error("Could not read object %s",
342 sha1_to_hex(t->tagged->sha1));
343 objects[i].item = o;
344 i--;
345 break;
347 case OBJ_TREE:
348 printf("%stree %s%s\n\n",
349 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
350 name,
351 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
352 read_tree_recursive((struct tree *)o, "", 0, 0, NULL,
353 show_tree_object, NULL);
354 break;
355 case OBJ_COMMIT:
356 rev.pending.nr = rev.pending.alloc = 0;
357 rev.pending.objects = NULL;
358 add_object_array(o, name, &rev.pending);
359 ret = cmd_log_walk(&rev);
360 break;
361 default:
362 ret = error("Unknown type: %d", o->type);
365 free(objects);
366 return ret;
370 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
372 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
374 struct rev_info rev;
376 git_config(git_log_config, NULL);
378 if (diff_use_color_default == -1)
379 diff_use_color_default = git_use_color_default;
381 init_revisions(&rev, prefix);
382 init_reflog_walk(&rev.reflog_info);
383 rev.abbrev_commit = 1;
384 rev.verbose_header = 1;
385 cmd_log_init(argc, argv, prefix, &rev);
388 * This means that we override whatever commit format the user gave
389 * on the cmd line. Sad, but cmd_log_init() currently doesn't
390 * allow us to set a different default.
392 rev.commit_format = CMIT_FMT_ONELINE;
393 rev.use_terminator = 1;
394 rev.always_show_header = 1;
397 * We get called through "git reflog", so unlike the other log
398 * routines, we need to set up our pager manually..
400 setup_pager();
402 return cmd_log_walk(&rev);
405 int cmd_log(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 rev.always_show_header = 1;
416 cmd_log_init(argc, argv, prefix, &rev);
417 return cmd_log_walk(&rev);
420 /* format-patch */
422 static const char *fmt_patch_suffix = ".patch";
423 static int numbered = 0;
424 static int auto_number = 1;
426 static char *default_attach = NULL;
428 static char **extra_hdr;
429 static int extra_hdr_nr;
430 static int extra_hdr_alloc;
432 static char **extra_to;
433 static int extra_to_nr;
434 static int extra_to_alloc;
436 static char **extra_cc;
437 static int extra_cc_nr;
438 static int extra_cc_alloc;
440 static void add_header(const char *value)
442 int len = strlen(value);
443 while (len && value[len - 1] == '\n')
444 len--;
445 if (!strncasecmp(value, "to: ", 4)) {
446 ALLOC_GROW(extra_to, extra_to_nr + 1, extra_to_alloc);
447 extra_to[extra_to_nr++] = xstrndup(value + 4, len - 4);
448 return;
450 if (!strncasecmp(value, "cc: ", 4)) {
451 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
452 extra_cc[extra_cc_nr++] = xstrndup(value + 4, len - 4);
453 return;
455 ALLOC_GROW(extra_hdr, extra_hdr_nr + 1, extra_hdr_alloc);
456 extra_hdr[extra_hdr_nr++] = xstrndup(value, len);
459 #define THREAD_SHALLOW 1
460 #define THREAD_DEEP 2
461 static int thread = 0;
462 static int do_signoff = 0;
464 static int git_format_config(const char *var, const char *value, void *cb)
466 if (!strcmp(var, "format.headers")) {
467 if (!value)
468 die("format.headers without value");
469 add_header(value);
470 return 0;
472 if (!strcmp(var, "format.suffix"))
473 return git_config_string(&fmt_patch_suffix, var, value);
474 if (!strcmp(var, "format.cc")) {
475 if (!value)
476 return config_error_nonbool(var);
477 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
478 extra_cc[extra_cc_nr++] = xstrdup(value);
479 return 0;
481 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff")) {
482 return 0;
484 if (!strcmp(var, "format.numbered")) {
485 if (value && !strcasecmp(value, "auto")) {
486 auto_number = 1;
487 return 0;
489 numbered = git_config_bool(var, value);
490 auto_number = auto_number && numbered;
491 return 0;
493 if (!strcmp(var, "format.attach")) {
494 if (value && *value)
495 default_attach = xstrdup(value);
496 else
497 default_attach = xstrdup(git_version_string);
498 return 0;
500 if (!strcmp(var, "format.thread")) {
501 if (value && !strcasecmp(value, "deep")) {
502 thread = THREAD_DEEP;
503 return 0;
505 if (value && !strcasecmp(value, "shallow")) {
506 thread = THREAD_SHALLOW;
507 return 0;
509 thread = git_config_bool(var, value) && THREAD_SHALLOW;
510 return 0;
512 if (!strcmp(var, "format.signoff")) {
513 do_signoff = git_config_bool(var, value);
514 return 0;
517 return git_log_config(var, value, cb);
520 static FILE *realstdout = NULL;
521 static const char *output_directory = NULL;
522 static int outdir_offset;
524 static int reopen_stdout(struct commit *commit, struct rev_info *rev)
526 struct strbuf filename = STRBUF_INIT;
527 int suffix_len = strlen(fmt_patch_suffix) + 1;
529 if (output_directory) {
530 strbuf_addstr(&filename, output_directory);
531 if (filename.len >=
532 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
533 return error("name of output directory is too long");
534 if (filename.buf[filename.len - 1] != '/')
535 strbuf_addch(&filename, '/');
538 get_patch_filename(commit, rev->nr, fmt_patch_suffix, &filename);
540 if (!DIFF_OPT_TST(&rev->diffopt, QUIET))
541 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
543 if (freopen(filename.buf, "w", stdout) == NULL)
544 return error("Cannot open patch file %s", filename.buf);
546 strbuf_release(&filename);
547 return 0;
550 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids, const char *prefix)
552 struct rev_info check_rev;
553 struct commit *commit;
554 struct object *o1, *o2;
555 unsigned flags1, flags2;
557 if (rev->pending.nr != 2)
558 die("Need exactly one range.");
560 o1 = rev->pending.objects[0].item;
561 flags1 = o1->flags;
562 o2 = rev->pending.objects[1].item;
563 flags2 = o2->flags;
565 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
566 die("Not a range.");
568 init_patch_ids(ids);
570 /* given a range a..b get all patch ids for b..a */
571 init_revisions(&check_rev, prefix);
572 o1->flags ^= UNINTERESTING;
573 o2->flags ^= UNINTERESTING;
574 add_pending_object(&check_rev, o1, "o1");
575 add_pending_object(&check_rev, o2, "o2");
576 if (prepare_revision_walk(&check_rev))
577 die("revision walk setup failed");
579 while ((commit = get_revision(&check_rev)) != NULL) {
580 /* ignore merges */
581 if (commit->parents && commit->parents->next)
582 continue;
584 add_commit_patch_id(commit, ids);
587 /* reset for next revision walk */
588 clear_commit_marks((struct commit *)o1,
589 SEEN | UNINTERESTING | SHOWN | ADDED);
590 clear_commit_marks((struct commit *)o2,
591 SEEN | UNINTERESTING | SHOWN | ADDED);
592 o1->flags = flags1;
593 o2->flags = flags2;
596 static void gen_message_id(struct rev_info *info, char *base)
598 const char *committer = git_committer_info(IDENT_WARN_ON_NO_NAME);
599 const char *email_start = strrchr(committer, '<');
600 const char *email_end = strrchr(committer, '>');
601 struct strbuf buf = STRBUF_INIT;
602 if (!email_start || !email_end || email_start > email_end - 1)
603 die("Could not extract email from committer identity.");
604 strbuf_addf(&buf, "%s.%lu.git.%.*s", base,
605 (unsigned long) time(NULL),
606 (int)(email_end - email_start - 1), email_start + 1);
607 info->message_id = strbuf_detach(&buf, NULL);
610 static void make_cover_letter(struct rev_info *rev, int use_stdout,
611 int numbered, int numbered_files,
612 struct commit *origin,
613 int nr, struct commit **list, struct commit *head)
615 const char *committer;
616 const char *subject_start = NULL;
617 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
618 const char *msg;
619 const char *extra_headers = rev->extra_headers;
620 struct shortlog log;
621 struct strbuf sb = STRBUF_INIT;
622 int i;
623 const char *encoding = "UTF-8";
624 struct diff_options opts;
625 int need_8bit_cte = 0;
626 struct commit *commit = NULL;
628 if (rev->commit_format != CMIT_FMT_EMAIL)
629 die("Cover letter needs email format");
631 committer = git_committer_info(0);
633 if (!numbered_files) {
635 * We fake a commit for the cover letter so we get the filename
636 * desired.
638 commit = xcalloc(1, sizeof(*commit));
639 commit->buffer = xmalloc(400);
640 snprintf(commit->buffer, 400,
641 "tree 0000000000000000000000000000000000000000\n"
642 "parent %s\n"
643 "author %s\n"
644 "committer %s\n\n"
645 "cover letter\n",
646 sha1_to_hex(head->object.sha1), committer, committer);
649 if (!use_stdout && reopen_stdout(commit, rev))
650 return;
652 if (commit) {
654 free(commit->buffer);
655 free(commit);
658 log_write_email_headers(rev, head, &subject_start, &extra_headers,
659 &need_8bit_cte);
661 msg = body;
662 pp_user_info(NULL, CMIT_FMT_EMAIL, &sb, committer, DATE_RFC2822,
663 encoding);
664 pp_title_line(CMIT_FMT_EMAIL, &msg, &sb, subject_start, extra_headers,
665 encoding, need_8bit_cte);
666 pp_remainder(CMIT_FMT_EMAIL, &msg, &sb, 0);
667 printf("%s\n", sb.buf);
669 strbuf_release(&sb);
671 shortlog_init(&log);
672 log.wrap_lines = 1;
673 log.wrap = 72;
674 log.in1 = 2;
675 log.in2 = 4;
676 for (i = 0; i < nr; i++)
677 shortlog_add_commit(&log, list[i]);
679 shortlog_output(&log);
682 * We can only do diffstat with a unique reference point
684 if (!origin)
685 return;
687 memcpy(&opts, &rev->diffopt, sizeof(opts));
688 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
690 diff_setup_done(&opts);
692 diff_tree_sha1(origin->tree->object.sha1,
693 head->tree->object.sha1,
694 "", &opts);
695 diffcore_std(&opts);
696 diff_flush(&opts);
698 printf("\n");
701 static const char *clean_message_id(const char *msg_id)
703 char ch;
704 const char *a, *z, *m;
706 m = msg_id;
707 while ((ch = *m) && (isspace(ch) || (ch == '<')))
708 m++;
709 a = m;
710 z = NULL;
711 while ((ch = *m)) {
712 if (!isspace(ch) && (ch != '>'))
713 z = m;
714 m++;
716 if (!z)
717 die("insane in-reply-to: %s", msg_id);
718 if (++z == m)
719 return a;
720 return xmemdupz(a, z - a);
723 static const char *set_outdir(const char *prefix, const char *output_directory)
725 if (output_directory && is_absolute_path(output_directory))
726 return output_directory;
728 if (!prefix || !*prefix) {
729 if (output_directory)
730 return output_directory;
731 /* The user did not explicitly ask for "./" */
732 outdir_offset = 2;
733 return "./";
736 outdir_offset = strlen(prefix);
737 if (!output_directory)
738 return prefix;
740 return xstrdup(prefix_filename(prefix, outdir_offset,
741 output_directory));
744 static const char * const builtin_format_patch_usage[] = {
745 "git format-patch [options] [<since> | <revision range>]",
746 NULL
749 static int keep_subject = 0;
751 static int keep_callback(const struct option *opt, const char *arg, int unset)
753 ((struct rev_info *)opt->value)->total = -1;
754 keep_subject = 1;
755 return 0;
758 static int subject_prefix = 0;
760 static int subject_prefix_callback(const struct option *opt, const char *arg,
761 int unset)
763 subject_prefix = 1;
764 ((struct rev_info *)opt->value)->subject_prefix = arg;
765 return 0;
768 static int numbered_cmdline_opt = 0;
770 static int numbered_callback(const struct option *opt, const char *arg,
771 int unset)
773 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
774 if (unset)
775 auto_number = 0;
776 return 0;
779 static int no_numbered_callback(const struct option *opt, const char *arg,
780 int unset)
782 return numbered_callback(opt, arg, 1);
785 static int output_directory_callback(const struct option *opt, const char *arg,
786 int unset)
788 const char **dir = (const char **)opt->value;
789 if (*dir)
790 die("Two output directories?");
791 *dir = arg;
792 return 0;
795 static int thread_callback(const struct option *opt, const char *arg, int unset)
797 int *thread = (int *)opt->value;
798 if (unset)
799 *thread = 0;
800 else if (!arg || !strcmp(arg, "shallow"))
801 *thread = THREAD_SHALLOW;
802 else if (!strcmp(arg, "deep"))
803 *thread = THREAD_DEEP;
804 else
805 return 1;
806 return 0;
809 static int attach_callback(const struct option *opt, const char *arg, int unset)
811 struct rev_info *rev = (struct rev_info *)opt->value;
812 if (unset)
813 rev->mime_boundary = NULL;
814 else if (arg)
815 rev->mime_boundary = arg;
816 else
817 rev->mime_boundary = git_version_string;
818 rev->no_inline = unset ? 0 : 1;
819 return 0;
822 static int inline_callback(const struct option *opt, const char *arg, int unset)
824 struct rev_info *rev = (struct rev_info *)opt->value;
825 if (unset)
826 rev->mime_boundary = NULL;
827 else if (arg)
828 rev->mime_boundary = arg;
829 else
830 rev->mime_boundary = git_version_string;
831 rev->no_inline = 0;
832 return 0;
835 static int header_callback(const struct option *opt, const char *arg, int unset)
837 add_header(arg);
838 return 0;
841 static int cc_callback(const struct option *opt, const char *arg, int unset)
843 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
844 extra_cc[extra_cc_nr++] = xstrdup(arg);
845 return 0;
848 int cmd_format_patch(int argc, const char **argv, const char *prefix)
850 struct commit *commit;
851 struct commit **list = NULL;
852 struct rev_info rev;
853 int nr = 0, total, i;
854 int use_stdout = 0;
855 int start_number = -1;
856 int numbered_files = 0; /* _just_ numbers */
857 int ignore_if_in_upstream = 0;
858 int cover_letter = 0;
859 int boundary_count = 0;
860 int no_binary_diff = 0;
861 struct commit *origin = NULL, *head = NULL;
862 const char *in_reply_to = NULL;
863 struct patch_ids ids;
864 char *add_signoff = NULL;
865 struct strbuf buf = STRBUF_INIT;
866 const struct option builtin_format_patch_options[] = {
867 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
868 "use [PATCH n/m] even with a single patch",
869 PARSE_OPT_NOARG, numbered_callback },
870 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
871 "use [PATCH] even with multiple patches",
872 PARSE_OPT_NOARG, no_numbered_callback },
873 OPT_BOOLEAN('s', "signoff", &do_signoff, "add Signed-off-by:"),
874 OPT_BOOLEAN(0, "stdout", &use_stdout,
875 "print patches to standard out"),
876 OPT_BOOLEAN(0, "cover-letter", &cover_letter,
877 "generate a cover letter"),
878 OPT_BOOLEAN(0, "numbered-files", &numbered_files,
879 "use simple number sequence for output file names"),
880 OPT_STRING(0, "suffix", &fmt_patch_suffix, "sfx",
881 "use <sfx> instead of '.patch'"),
882 OPT_INTEGER(0, "start-number", &start_number,
883 "start numbering patches at <n> instead of 1"),
884 { OPTION_CALLBACK, 0, "subject-prefix", &rev, "prefix",
885 "Use [<prefix>] instead of [PATCH]",
886 PARSE_OPT_NONEG, subject_prefix_callback },
887 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
888 "dir", "store resulting files in <dir>",
889 PARSE_OPT_NONEG, output_directory_callback },
890 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
891 "don't strip/add [PATCH]",
892 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
893 OPT_BOOLEAN(0, "no-binary", &no_binary_diff,
894 "don't output binary diffs"),
895 OPT_BOOLEAN(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
896 "don't include a patch matching a commit upstream"),
897 OPT_GROUP("Messaging"),
898 { OPTION_CALLBACK, 0, "add-header", NULL, "header",
899 "add email header", PARSE_OPT_NONEG,
900 header_callback },
901 { OPTION_CALLBACK, 0, "cc", NULL, "email", "add Cc: header",
902 PARSE_OPT_NONEG, cc_callback },
903 OPT_STRING(0, "in-reply-to", &in_reply_to, "message-id",
904 "make first mail a reply to <message-id>"),
905 { OPTION_CALLBACK, 0, "attach", &rev, "boundary",
906 "attach the patch", PARSE_OPT_OPTARG,
907 attach_callback },
908 { OPTION_CALLBACK, 0, "inline", &rev, "boundary",
909 "inline the patch",
910 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
911 inline_callback },
912 { OPTION_CALLBACK, 0, "thread", &thread, "style",
913 "enable message threading, styles: shallow, deep",
914 PARSE_OPT_OPTARG, thread_callback },
915 OPT_END()
918 git_config(git_format_config, NULL);
919 init_revisions(&rev, prefix);
920 rev.commit_format = CMIT_FMT_EMAIL;
921 rev.verbose_header = 1;
922 rev.diff = 1;
923 rev.combine_merges = 0;
924 rev.ignore_merges = 1;
925 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
927 rev.subject_prefix = fmt_patch_subject_prefix;
929 if (default_attach) {
930 rev.mime_boundary = default_attach;
931 rev.no_inline = 1;
935 * Parse the arguments before setup_revisions(), or something
936 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
937 * possibly a valid SHA1.
939 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
940 builtin_format_patch_usage,
941 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN);
943 if (do_signoff) {
944 const char *committer;
945 const char *endpos;
946 committer = git_committer_info(IDENT_ERROR_ON_NO_NAME);
947 endpos = strchr(committer, '>');
948 if (!endpos)
949 die("bogus committer info %s", committer);
950 add_signoff = xmemdupz(committer, endpos - committer + 1);
953 for (i = 0; i < extra_hdr_nr; i++) {
954 strbuf_addstr(&buf, extra_hdr[i]);
955 strbuf_addch(&buf, '\n');
958 if (extra_to_nr)
959 strbuf_addstr(&buf, "To: ");
960 for (i = 0; i < extra_to_nr; i++) {
961 if (i)
962 strbuf_addstr(&buf, " ");
963 strbuf_addstr(&buf, extra_to[i]);
964 if (i + 1 < extra_to_nr)
965 strbuf_addch(&buf, ',');
966 strbuf_addch(&buf, '\n');
969 if (extra_cc_nr)
970 strbuf_addstr(&buf, "Cc: ");
971 for (i = 0; i < extra_cc_nr; i++) {
972 if (i)
973 strbuf_addstr(&buf, " ");
974 strbuf_addstr(&buf, extra_cc[i]);
975 if (i + 1 < extra_cc_nr)
976 strbuf_addch(&buf, ',');
977 strbuf_addch(&buf, '\n');
980 rev.extra_headers = strbuf_detach(&buf, 0);
982 if (start_number < 0)
983 start_number = 1;
986 * If numbered is set solely due to format.numbered in config,
987 * and it would conflict with --keep-subject (-k) from the
988 * command line, reset "numbered".
990 if (numbered && keep_subject && !numbered_cmdline_opt)
991 numbered = 0;
993 if (numbered && keep_subject)
994 die ("-n and -k are mutually exclusive.");
995 if (keep_subject && subject_prefix)
996 die ("--subject-prefix and -k are mutually exclusive.");
998 argc = setup_revisions(argc, argv, &rev, "HEAD");
999 if (argc > 1)
1000 die ("unrecognized argument: %s", argv[1]);
1002 if (!rev.diffopt.output_format
1003 || rev.diffopt.output_format == DIFF_FORMAT_PATCH)
1004 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY | DIFF_FORMAT_PATCH;
1006 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
1007 DIFF_OPT_SET(&rev.diffopt, BINARY);
1009 if (!use_stdout)
1010 output_directory = set_outdir(prefix, output_directory);
1012 if (output_directory) {
1013 if (use_stdout)
1014 die("standard output, or directory, which one?");
1015 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1016 die("Could not create directory %s",
1017 output_directory);
1020 if (rev.pending.nr == 1) {
1021 if (rev.max_count < 0 && !rev.show_root_diff) {
1023 * This is traditional behaviour of "git format-patch
1024 * origin" that prepares what the origin side still
1025 * does not have.
1027 rev.pending.objects[0].item->flags |= UNINTERESTING;
1028 add_head_to_pending(&rev);
1031 * Otherwise, it is "format-patch -22 HEAD", and/or
1032 * "format-patch --root HEAD". The user wants
1033 * get_revision() to do the usual traversal.
1038 * We cannot move this anywhere earlier because we do want to
1039 * know if --root was given explicitly from the comand line.
1041 rev.show_root_diff = 1;
1043 if (cover_letter) {
1044 /* remember the range */
1045 int i;
1046 for (i = 0; i < rev.pending.nr; i++) {
1047 struct object *o = rev.pending.objects[i].item;
1048 if (!(o->flags & UNINTERESTING))
1049 head = (struct commit *)o;
1051 /* We can't generate a cover letter without any patches */
1052 if (!head)
1053 return 0;
1056 if (ignore_if_in_upstream)
1057 get_patch_ids(&rev, &ids, prefix);
1059 if (!use_stdout)
1060 realstdout = xfdopen(xdup(1), "w");
1062 if (prepare_revision_walk(&rev))
1063 die("revision walk setup failed");
1064 rev.boundary = 1;
1065 while ((commit = get_revision(&rev)) != NULL) {
1066 if (commit->object.flags & BOUNDARY) {
1067 boundary_count++;
1068 origin = (boundary_count == 1) ? commit : NULL;
1069 continue;
1072 /* ignore merges */
1073 if (commit->parents && commit->parents->next)
1074 continue;
1076 if (ignore_if_in_upstream &&
1077 has_commit_patch_id(commit, &ids))
1078 continue;
1080 nr++;
1081 list = xrealloc(list, nr * sizeof(list[0]));
1082 list[nr - 1] = commit;
1084 total = nr;
1085 if (!keep_subject && auto_number && total > 1)
1086 numbered = 1;
1087 if (numbered)
1088 rev.total = total + start_number - 1;
1089 if (in_reply_to || thread || cover_letter)
1090 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1091 if (in_reply_to) {
1092 const char *msgid = clean_message_id(in_reply_to);
1093 string_list_append(msgid, rev.ref_message_ids);
1095 rev.numbered_files = numbered_files;
1096 rev.patch_suffix = fmt_patch_suffix;
1097 if (cover_letter) {
1098 if (thread)
1099 gen_message_id(&rev, "cover");
1100 make_cover_letter(&rev, use_stdout, numbered, numbered_files,
1101 origin, nr, list, head);
1102 total++;
1103 start_number--;
1105 rev.add_signoff = add_signoff;
1106 while (0 <= --nr) {
1107 int shown;
1108 commit = list[nr];
1109 rev.nr = total - nr + (start_number - 1);
1110 /* Make the second and subsequent mails replies to the first */
1111 if (thread) {
1112 /* Have we already had a message ID? */
1113 if (rev.message_id) {
1115 * For deep threading: make every mail
1116 * a reply to the previous one, no
1117 * matter what other options are set.
1119 * For shallow threading:
1121 * Without --cover-letter and
1122 * --in-reply-to, make every mail a
1123 * reply to the one before.
1125 * With --in-reply-to but no
1126 * --cover-letter, make every mail a
1127 * reply to the <reply-to>.
1129 * With --cover-letter, make every
1130 * mail but the cover letter a reply
1131 * to the cover letter. The cover
1132 * letter is a reply to the
1133 * --in-reply-to, if specified.
1135 if (thread == THREAD_SHALLOW
1136 && rev.ref_message_ids->nr > 0
1137 && (!cover_letter || rev.nr > 1))
1138 free(rev.message_id);
1139 else
1140 string_list_append(rev.message_id,
1141 rev.ref_message_ids);
1143 gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1146 if (!use_stdout && reopen_stdout(numbered_files ? NULL : commit,
1147 &rev))
1148 die("Failed to create output files");
1149 shown = log_tree_commit(&rev, commit);
1150 free(commit->buffer);
1151 commit->buffer = NULL;
1153 /* We put one extra blank line between formatted
1154 * patches and this flag is used by log-tree code
1155 * to see if it needs to emit a LF before showing
1156 * the log; when using one file per patch, we do
1157 * not want the extra blank line.
1159 if (!use_stdout)
1160 rev.shown_one = 0;
1161 if (shown) {
1162 if (rev.mime_boundary)
1163 printf("\n--%s%s--\n\n\n",
1164 mime_boundary_leader,
1165 rev.mime_boundary);
1166 else
1167 printf("-- \n%s\n\n", git_version_string);
1169 if (!use_stdout)
1170 fclose(stdout);
1172 free(list);
1173 if (ignore_if_in_upstream)
1174 free_patch_ids(&ids);
1175 return 0;
1178 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1180 unsigned char sha1[20];
1181 if (get_sha1(arg, sha1) == 0) {
1182 struct commit *commit = lookup_commit_reference(sha1);
1183 if (commit) {
1184 commit->object.flags |= flags;
1185 add_pending_object(revs, &commit->object, arg);
1186 return 0;
1189 return -1;
1192 static const char cherry_usage[] =
1193 "git cherry [-v] [<upstream> [<head> [<limit>]]]";
1194 int cmd_cherry(int argc, const char **argv, const char *prefix)
1196 struct rev_info revs;
1197 struct patch_ids ids;
1198 struct commit *commit;
1199 struct commit_list *list = NULL;
1200 struct branch *current_branch;
1201 const char *upstream;
1202 const char *head = "HEAD";
1203 const char *limit = NULL;
1204 int verbose = 0;
1206 if (argc > 1 && !strcmp(argv[1], "-v")) {
1207 verbose = 1;
1208 argc--;
1209 argv++;
1212 switch (argc) {
1213 case 4:
1214 limit = argv[3];
1215 /* FALLTHROUGH */
1216 case 3:
1217 head = argv[2];
1218 /* FALLTHROUGH */
1219 case 2:
1220 upstream = argv[1];
1221 break;
1222 default:
1223 current_branch = branch_get(NULL);
1224 if (!current_branch || !current_branch->merge
1225 || !current_branch->merge[0]
1226 || !current_branch->merge[0]->dst) {
1227 fprintf(stderr, "Could not find a tracked"
1228 " remote branch, please"
1229 " specify <upstream> manually.\n");
1230 usage(cherry_usage);
1233 upstream = current_branch->merge[0]->dst;
1236 init_revisions(&revs, prefix);
1237 revs.diff = 1;
1238 revs.combine_merges = 0;
1239 revs.ignore_merges = 1;
1240 DIFF_OPT_SET(&revs.diffopt, RECURSIVE);
1242 if (add_pending_commit(head, &revs, 0))
1243 die("Unknown commit %s", head);
1244 if (add_pending_commit(upstream, &revs, UNINTERESTING))
1245 die("Unknown commit %s", upstream);
1247 /* Don't say anything if head and upstream are the same. */
1248 if (revs.pending.nr == 2) {
1249 struct object_array_entry *o = revs.pending.objects;
1250 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1251 return 0;
1254 get_patch_ids(&revs, &ids, prefix);
1256 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1257 die("Unknown commit %s", limit);
1259 /* reverse the list of commits */
1260 if (prepare_revision_walk(&revs))
1261 die("revision walk setup failed");
1262 while ((commit = get_revision(&revs)) != NULL) {
1263 /* ignore merges */
1264 if (commit->parents && commit->parents->next)
1265 continue;
1267 commit_list_insert(commit, &list);
1270 while (list) {
1271 char sign = '+';
1273 commit = list->item;
1274 if (has_commit_patch_id(commit, &ids))
1275 sign = '-';
1277 if (verbose) {
1278 struct strbuf buf = STRBUF_INIT;
1279 pretty_print_commit(CMIT_FMT_ONELINE, commit,
1280 &buf, 0, NULL, NULL, 0, 0);
1281 printf("%c %s %s\n", sign,
1282 sha1_to_hex(commit->object.sha1), buf.buf);
1283 strbuf_release(&buf);
1285 else {
1286 printf("%c %s\n", sign,
1287 sha1_to_hex(commit->object.sha1));
1290 list = list->next;
1293 free_patch_ids(&ids);
1294 return 0;