t7008: demonstrate behavior of grep with textconv
[git/mjg.git] / builtin / log.c
blob815c5b84eda26a960924e9090b21afbdd771d249
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"
22 #include "branch.h"
23 #include "streaming.h"
24 #include "version.h"
25 #include "mailmap.h"
26 #include "gpg-interface.h"
28 /* Set a default date-time format for git log ("log.date" config variable) */
29 static const char *default_date_mode = NULL;
31 static int default_abbrev_commit;
32 static int default_show_root = 1;
33 static int decoration_style;
34 static int decoration_given;
35 static int use_mailmap_config;
36 static const char *fmt_patch_subject_prefix = "PATCH";
37 static const char *fmt_pretty;
39 static const char * const builtin_log_usage[] = {
40 N_("git log [<options>] [<since>..<until>] [[--] <path>...]\n")
41 N_(" or: git show [options] <object>..."),
42 NULL
45 static int parse_decoration_style(const char *var, const char *value)
47 switch (git_config_maybe_bool(var, value)) {
48 case 1:
49 return DECORATE_SHORT_REFS;
50 case 0:
51 return 0;
52 default:
53 break;
55 if (!strcmp(value, "full"))
56 return DECORATE_FULL_REFS;
57 else if (!strcmp(value, "short"))
58 return DECORATE_SHORT_REFS;
59 return -1;
62 static int decorate_callback(const struct option *opt, const char *arg, int unset)
64 if (unset)
65 decoration_style = 0;
66 else if (arg)
67 decoration_style = parse_decoration_style("command line", arg);
68 else
69 decoration_style = DECORATE_SHORT_REFS;
71 if (decoration_style < 0)
72 die("invalid --decorate option: %s", arg);
74 decoration_given = 1;
76 return 0;
79 static void cmd_log_init_defaults(struct rev_info *rev)
81 if (fmt_pretty)
82 get_commit_format(fmt_pretty, rev);
83 rev->verbose_header = 1;
84 DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
85 rev->diffopt.stat_width = -1; /* use full terminal width */
86 rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
87 rev->abbrev_commit = default_abbrev_commit;
88 rev->show_root_diff = default_show_root;
89 rev->subject_prefix = fmt_patch_subject_prefix;
90 DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
92 if (default_date_mode)
93 rev->date_mode = parse_date_format(default_date_mode);
94 rev->diffopt.touched_flags = 0;
97 static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
98 struct rev_info *rev, struct setup_revision_opt *opt)
100 struct userformat_want w;
101 int quiet = 0, source = 0, mailmap = 0;
103 const struct option builtin_log_options[] = {
104 OPT_BOOL(0, "quiet", &quiet, N_("suppress diff output")),
105 OPT_BOOL(0, "source", &source, N_("show source")),
106 OPT_BOOL(0, "use-mailmap", &mailmap, N_("Use mail map file")),
107 { OPTION_CALLBACK, 0, "decorate", NULL, NULL, N_("decorate options"),
108 PARSE_OPT_OPTARG, decorate_callback},
109 OPT_END()
112 mailmap = use_mailmap_config;
113 argc = parse_options(argc, argv, prefix,
114 builtin_log_options, builtin_log_usage,
115 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
116 PARSE_OPT_KEEP_DASHDASH);
118 if (quiet)
119 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
120 argc = setup_revisions(argc, argv, rev, opt);
122 /* Any arguments at this point are not recognized */
123 if (argc > 1)
124 die("unrecognized argument: %s", argv[1]);
126 memset(&w, 0, sizeof(w));
127 userformat_find_requirements(NULL, &w);
129 if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
130 rev->show_notes = 1;
131 if (rev->show_notes)
132 init_display_notes(&rev->notes_opt);
134 if (rev->diffopt.pickaxe || rev->diffopt.filter)
135 rev->always_show_header = 0;
136 if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
137 rev->always_show_header = 0;
138 if (rev->diffopt.pathspec.nr != 1)
139 usage("git logs can only follow renames on one pathname at a time");
142 if (source)
143 rev->show_source = 1;
145 if (mailmap) {
146 rev->mailmap = xcalloc(1, sizeof(struct string_list));
147 read_mailmap(rev->mailmap, NULL);
150 if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
152 * "log --pretty=raw" is special; ignore UI oriented
153 * configuration variables such as decoration.
155 if (!decoration_given)
156 decoration_style = 0;
157 if (!rev->abbrev_commit_given)
158 rev->abbrev_commit = 0;
161 if (decoration_style) {
162 rev->show_decorations = 1;
163 load_ref_decorations(decoration_style);
165 setup_pager();
168 static void cmd_log_init(int argc, const char **argv, const char *prefix,
169 struct rev_info *rev, struct setup_revision_opt *opt)
171 cmd_log_init_defaults(rev);
172 cmd_log_init_finish(argc, argv, prefix, rev, opt);
176 * This gives a rough estimate for how many commits we
177 * will print out in the list.
179 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
181 int n = 0;
183 while (list) {
184 struct commit *commit = list->item;
185 unsigned int flags = commit->object.flags;
186 list = list->next;
187 if (!(flags & (TREESAME | UNINTERESTING)))
188 n++;
190 return n;
193 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
195 if (rev->shown_one) {
196 rev->shown_one = 0;
197 if (rev->commit_format != CMIT_FMT_ONELINE)
198 putchar(rev->diffopt.line_termination);
200 printf(_("Final output: %d %s\n"), nr, stage);
203 static struct itimerval early_output_timer;
205 static void log_show_early(struct rev_info *revs, struct commit_list *list)
207 int i = revs->early_output;
208 int show_header = 1;
210 sort_in_topological_order(&list, revs->lifo);
211 while (list && i) {
212 struct commit *commit = list->item;
213 switch (simplify_commit(revs, commit)) {
214 case commit_show:
215 if (show_header) {
216 int n = estimate_commit_count(revs, list);
217 show_early_header(revs, "incomplete", n);
218 show_header = 0;
220 log_tree_commit(revs, commit);
221 i--;
222 break;
223 case commit_ignore:
224 break;
225 case commit_error:
226 return;
228 list = list->next;
231 /* Did we already get enough commits for the early output? */
232 if (!i)
233 return;
236 * ..if no, then repeat it twice a second until we
237 * do.
239 * NOTE! We don't use "it_interval", because if the
240 * reader isn't listening, we want our output to be
241 * throttled by the writing, and not have the timer
242 * trigger every second even if we're blocked on a
243 * reader!
245 early_output_timer.it_value.tv_sec = 0;
246 early_output_timer.it_value.tv_usec = 500000;
247 setitimer(ITIMER_REAL, &early_output_timer, NULL);
250 static void early_output(int signal)
252 show_early_output = log_show_early;
255 static void setup_early_output(struct rev_info *rev)
257 struct sigaction sa;
260 * Set up the signal handler, minimally intrusively:
261 * we only set a single volatile integer word (not
262 * using sigatomic_t - trying to avoid unnecessary
263 * system dependencies and headers), and using
264 * SA_RESTART.
266 memset(&sa, 0, sizeof(sa));
267 sa.sa_handler = early_output;
268 sigemptyset(&sa.sa_mask);
269 sa.sa_flags = SA_RESTART;
270 sigaction(SIGALRM, &sa, NULL);
273 * If we can get the whole output in less than a
274 * tenth of a second, don't even bother doing the
275 * early-output thing..
277 * This is a one-time-only trigger.
279 early_output_timer.it_value.tv_sec = 0;
280 early_output_timer.it_value.tv_usec = 100000;
281 setitimer(ITIMER_REAL, &early_output_timer, NULL);
284 static void finish_early_output(struct rev_info *rev)
286 int n = estimate_commit_count(rev, rev->commits);
287 signal(SIGALRM, SIG_IGN);
288 show_early_header(rev, "done", n);
291 static int cmd_log_walk(struct rev_info *rev)
293 struct commit *commit;
294 int saved_nrl = 0;
295 int saved_dcctc = 0;
297 if (rev->early_output)
298 setup_early_output(rev);
300 if (prepare_revision_walk(rev))
301 die(_("revision walk setup failed"));
303 if (rev->early_output)
304 finish_early_output(rev);
307 * For --check and --exit-code, the exit code is based on CHECK_FAILED
308 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
309 * retain that state information if replacing rev->diffopt in this loop
311 while ((commit = get_revision(rev)) != NULL) {
312 if (!log_tree_commit(rev, commit) &&
313 rev->max_count >= 0)
315 * We decremented max_count in get_revision,
316 * but we didn't actually show the commit.
318 rev->max_count++;
319 if (!rev->reflog_info) {
320 /* we allow cycles in reflog ancestry */
321 free(commit->buffer);
322 commit->buffer = NULL;
324 free_commit_list(commit->parents);
325 commit->parents = NULL;
326 if (saved_nrl < rev->diffopt.needed_rename_limit)
327 saved_nrl = rev->diffopt.needed_rename_limit;
328 if (rev->diffopt.degraded_cc_to_c)
329 saved_dcctc = 1;
331 rev->diffopt.degraded_cc_to_c = saved_dcctc;
332 rev->diffopt.needed_rename_limit = saved_nrl;
334 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
335 DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
336 return 02;
338 return diff_result_code(&rev->diffopt, 0);
341 static int git_log_config(const char *var, const char *value, void *cb)
343 if (!strcmp(var, "format.pretty"))
344 return git_config_string(&fmt_pretty, var, value);
345 if (!strcmp(var, "format.subjectprefix"))
346 return git_config_string(&fmt_patch_subject_prefix, var, value);
347 if (!strcmp(var, "log.abbrevcommit")) {
348 default_abbrev_commit = git_config_bool(var, value);
349 return 0;
351 if (!strcmp(var, "log.date"))
352 return git_config_string(&default_date_mode, var, value);
353 if (!strcmp(var, "log.decorate")) {
354 decoration_style = parse_decoration_style(var, value);
355 if (decoration_style < 0)
356 decoration_style = 0; /* maybe warn? */
357 return 0;
359 if (!strcmp(var, "log.showroot")) {
360 default_show_root = git_config_bool(var, value);
361 return 0;
363 if (!prefixcmp(var, "color.decorate."))
364 return parse_decorate_color_config(var, 15, value);
365 if (!strcmp(var, "log.mailmap")) {
366 use_mailmap_config = git_config_bool(var, value);
367 return 0;
370 if (grep_config(var, value, cb) < 0)
371 return -1;
372 if (git_gpg_config(var, value, cb) < 0)
373 return -1;
374 return git_diff_ui_config(var, value, cb);
377 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
379 struct rev_info rev;
380 struct setup_revision_opt opt;
382 init_grep_defaults();
383 git_config(git_log_config, NULL);
385 init_revisions(&rev, prefix);
386 rev.diff = 1;
387 rev.simplify_history = 0;
388 memset(&opt, 0, sizeof(opt));
389 opt.def = "HEAD";
390 opt.revarg_opt = REVARG_COMMITTISH;
391 cmd_log_init(argc, argv, prefix, &rev, &opt);
392 if (!rev.diffopt.output_format)
393 rev.diffopt.output_format = DIFF_FORMAT_RAW;
394 return cmd_log_walk(&rev);
397 static void show_tagger(char *buf, int len, struct rev_info *rev)
399 struct strbuf out = STRBUF_INIT;
400 struct pretty_print_context pp = {0};
402 pp.fmt = rev->commit_format;
403 pp.date_mode = rev->date_mode;
404 pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
405 printf("%s", out.buf);
406 strbuf_release(&out);
409 static int show_blob_object(const unsigned char *sha1, struct rev_info *rev, const char *obj_name)
411 unsigned char sha1c[20];
412 struct object_context obj_context;
413 char *buf;
414 unsigned long size;
416 fflush(stdout);
417 if (!DIFF_OPT_TOUCHED(&rev->diffopt, ALLOW_TEXTCONV) ||
418 !DIFF_OPT_TST(&rev->diffopt, ALLOW_TEXTCONV))
419 return stream_blob_to_fd(1, sha1, NULL, 0);
421 if (get_sha1_with_context(obj_name, 0, sha1c, &obj_context))
422 die("Not a valid object name %s", obj_name);
423 if (!obj_context.path[0] ||
424 !textconv_object(obj_context.path, obj_context.mode, sha1c, 1, &buf, &size))
425 return stream_blob_to_fd(1, sha1, NULL, 0);
427 if (!buf)
428 die("git show %s: bad file", obj_name);
430 write_or_die(1, buf, size);
431 return 0;
434 static int show_tag_object(const unsigned char *sha1, struct rev_info *rev)
436 unsigned long size;
437 enum object_type type;
438 char *buf = read_sha1_file(sha1, &type, &size);
439 int offset = 0;
441 if (!buf)
442 return error(_("Could not read object %s"), sha1_to_hex(sha1));
444 assert(type == OBJ_TAG);
445 while (offset < size && buf[offset] != '\n') {
446 int new_offset = offset + 1;
447 while (new_offset < size && buf[new_offset++] != '\n')
448 ; /* do nothing */
449 if (!prefixcmp(buf + offset, "tagger "))
450 show_tagger(buf + offset + 7,
451 new_offset - offset - 7, rev);
452 offset = new_offset;
455 if (offset < size)
456 fwrite(buf + offset, size - offset, 1, stdout);
457 free(buf);
458 return 0;
461 static int show_tree_object(const unsigned char *sha1,
462 const char *base, int baselen,
463 const char *pathname, unsigned mode, int stage, void *context)
465 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
466 return 0;
469 static void show_rev_tweak_rev(struct rev_info *rev, struct setup_revision_opt *opt)
471 if (rev->ignore_merges) {
472 /* There was no "-m" on the command line */
473 rev->ignore_merges = 0;
474 if (!rev->first_parent_only && !rev->combine_merges) {
475 /* No "--first-parent", "-c", nor "--cc" */
476 rev->combine_merges = 1;
477 rev->dense_combined_merges = 1;
480 if (!rev->diffopt.output_format)
481 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
484 int cmd_show(int argc, const char **argv, const char *prefix)
486 struct rev_info rev;
487 struct object_array_entry *objects;
488 struct setup_revision_opt opt;
489 struct pathspec match_all;
490 int i, count, ret = 0;
492 init_grep_defaults();
493 git_config(git_log_config, NULL);
495 init_pathspec(&match_all, NULL);
496 init_revisions(&rev, prefix);
497 rev.diff = 1;
498 rev.always_show_header = 1;
499 rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
500 rev.diffopt.stat_width = -1; /* Scale to real terminal size */
502 memset(&opt, 0, sizeof(opt));
503 opt.def = "HEAD";
504 opt.tweak = show_rev_tweak_rev;
505 cmd_log_init(argc, argv, prefix, &rev, &opt);
507 if (!rev.no_walk)
508 return cmd_log_walk(&rev);
510 count = rev.pending.nr;
511 objects = rev.pending.objects;
512 for (i = 0; i < count && !ret; i++) {
513 struct object *o = objects[i].item;
514 const char *name = objects[i].name;
515 switch (o->type) {
516 case OBJ_BLOB:
517 ret = show_blob_object(o->sha1, &rev, name);
518 break;
519 case OBJ_TAG: {
520 struct tag *t = (struct tag *)o;
522 if (rev.shown_one)
523 putchar('\n');
524 printf("%stag %s%s\n",
525 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
526 t->tag,
527 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
528 ret = show_tag_object(o->sha1, &rev);
529 rev.shown_one = 1;
530 if (ret)
531 break;
532 o = parse_object(t->tagged->sha1);
533 if (!o)
534 ret = error(_("Could not read object %s"),
535 sha1_to_hex(t->tagged->sha1));
536 objects[i].item = o;
537 i--;
538 break;
540 case OBJ_TREE:
541 if (rev.shown_one)
542 putchar('\n');
543 printf("%stree %s%s\n\n",
544 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
545 name,
546 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
547 read_tree_recursive((struct tree *)o, "", 0, 0, &match_all,
548 show_tree_object, NULL);
549 rev.shown_one = 1;
550 break;
551 case OBJ_COMMIT:
552 rev.pending.nr = rev.pending.alloc = 0;
553 rev.pending.objects = NULL;
554 add_object_array(o, name, &rev.pending);
555 ret = cmd_log_walk(&rev);
556 break;
557 default:
558 ret = error(_("Unknown type: %d"), o->type);
561 free(objects);
562 return ret;
566 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
568 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
570 struct rev_info rev;
571 struct setup_revision_opt opt;
573 init_grep_defaults();
574 git_config(git_log_config, NULL);
576 init_revisions(&rev, prefix);
577 init_reflog_walk(&rev.reflog_info);
578 rev.verbose_header = 1;
579 memset(&opt, 0, sizeof(opt));
580 opt.def = "HEAD";
581 cmd_log_init_defaults(&rev);
582 rev.abbrev_commit = 1;
583 rev.commit_format = CMIT_FMT_ONELINE;
584 rev.use_terminator = 1;
585 rev.always_show_header = 1;
586 cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
588 return cmd_log_walk(&rev);
591 int cmd_log(int argc, const char **argv, const char *prefix)
593 struct rev_info rev;
594 struct setup_revision_opt opt;
596 init_grep_defaults();
597 git_config(git_log_config, NULL);
599 init_revisions(&rev, prefix);
600 rev.always_show_header = 1;
601 memset(&opt, 0, sizeof(opt));
602 opt.def = "HEAD";
603 opt.revarg_opt = REVARG_COMMITTISH;
604 cmd_log_init(argc, argv, prefix, &rev, &opt);
605 return cmd_log_walk(&rev);
608 /* format-patch */
610 static const char *fmt_patch_suffix = ".patch";
611 static int numbered = 0;
612 static int auto_number = 1;
614 static char *default_attach = NULL;
616 static struct string_list extra_hdr;
617 static struct string_list extra_to;
618 static struct string_list extra_cc;
620 static void add_header(const char *value)
622 struct string_list_item *item;
623 int len = strlen(value);
624 while (len && value[len - 1] == '\n')
625 len--;
627 if (!strncasecmp(value, "to: ", 4)) {
628 item = string_list_append(&extra_to, value + 4);
629 len -= 4;
630 } else if (!strncasecmp(value, "cc: ", 4)) {
631 item = string_list_append(&extra_cc, value + 4);
632 len -= 4;
633 } else {
634 item = string_list_append(&extra_hdr, value);
637 item->string[len] = '\0';
640 #define THREAD_SHALLOW 1
641 #define THREAD_DEEP 2
642 static int thread;
643 static int do_signoff;
644 static const char *signature = git_version_string;
645 static int config_cover_letter;
647 enum {
648 COVER_UNSET,
649 COVER_OFF,
650 COVER_ON,
651 COVER_AUTO
654 static int git_format_config(const char *var, const char *value, void *cb)
656 if (!strcmp(var, "format.headers")) {
657 if (!value)
658 die(_("format.headers without value"));
659 add_header(value);
660 return 0;
662 if (!strcmp(var, "format.suffix"))
663 return git_config_string(&fmt_patch_suffix, var, value);
664 if (!strcmp(var, "format.to")) {
665 if (!value)
666 return config_error_nonbool(var);
667 string_list_append(&extra_to, value);
668 return 0;
670 if (!strcmp(var, "format.cc")) {
671 if (!value)
672 return config_error_nonbool(var);
673 string_list_append(&extra_cc, value);
674 return 0;
676 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
677 !strcmp(var, "color.ui")) {
678 return 0;
680 if (!strcmp(var, "format.numbered")) {
681 if (value && !strcasecmp(value, "auto")) {
682 auto_number = 1;
683 return 0;
685 numbered = git_config_bool(var, value);
686 auto_number = auto_number && numbered;
687 return 0;
689 if (!strcmp(var, "format.attach")) {
690 if (value && *value)
691 default_attach = xstrdup(value);
692 else
693 default_attach = xstrdup(git_version_string);
694 return 0;
696 if (!strcmp(var, "format.thread")) {
697 if (value && !strcasecmp(value, "deep")) {
698 thread = THREAD_DEEP;
699 return 0;
701 if (value && !strcasecmp(value, "shallow")) {
702 thread = THREAD_SHALLOW;
703 return 0;
705 thread = git_config_bool(var, value) && THREAD_SHALLOW;
706 return 0;
708 if (!strcmp(var, "format.signoff")) {
709 do_signoff = git_config_bool(var, value);
710 return 0;
712 if (!strcmp(var, "format.signature"))
713 return git_config_string(&signature, var, value);
714 if (!strcmp(var, "format.coverletter")) {
715 if (value && !strcasecmp(value, "auto")) {
716 config_cover_letter = COVER_AUTO;
717 return 0;
719 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
720 return 0;
723 return git_log_config(var, value, cb);
726 static FILE *realstdout = NULL;
727 static const char *output_directory = NULL;
728 static int outdir_offset;
730 static int reopen_stdout(struct commit *commit, const char *subject,
731 struct rev_info *rev, int quiet)
733 struct strbuf filename = STRBUF_INIT;
734 int suffix_len = strlen(rev->patch_suffix) + 1;
736 if (output_directory) {
737 strbuf_addstr(&filename, output_directory);
738 if (filename.len >=
739 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
740 return error(_("name of output directory is too long"));
741 if (filename.buf[filename.len - 1] != '/')
742 strbuf_addch(&filename, '/');
745 if (rev->numbered_files)
746 strbuf_addf(&filename, "%d", rev->nr);
747 else if (commit)
748 fmt_output_commit(&filename, commit, rev);
749 else
750 fmt_output_subject(&filename, subject, rev);
752 if (!quiet)
753 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
755 if (freopen(filename.buf, "w", stdout) == NULL)
756 return error(_("Cannot open patch file %s"), filename.buf);
758 strbuf_release(&filename);
759 return 0;
762 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
764 struct rev_info check_rev;
765 struct commit *commit;
766 struct object *o1, *o2;
767 unsigned flags1, flags2;
769 if (rev->pending.nr != 2)
770 die(_("Need exactly one range."));
772 o1 = rev->pending.objects[0].item;
773 flags1 = o1->flags;
774 o2 = rev->pending.objects[1].item;
775 flags2 = o2->flags;
777 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
778 die(_("Not a range."));
780 init_patch_ids(ids);
782 /* given a range a..b get all patch ids for b..a */
783 init_revisions(&check_rev, rev->prefix);
784 check_rev.max_parents = 1;
785 o1->flags ^= UNINTERESTING;
786 o2->flags ^= UNINTERESTING;
787 add_pending_object(&check_rev, o1, "o1");
788 add_pending_object(&check_rev, o2, "o2");
789 if (prepare_revision_walk(&check_rev))
790 die(_("revision walk setup failed"));
792 while ((commit = get_revision(&check_rev)) != NULL) {
793 add_commit_patch_id(commit, ids);
796 /* reset for next revision walk */
797 clear_commit_marks((struct commit *)o1,
798 SEEN | UNINTERESTING | SHOWN | ADDED);
799 clear_commit_marks((struct commit *)o2,
800 SEEN | UNINTERESTING | SHOWN | ADDED);
801 o1->flags = flags1;
802 o2->flags = flags2;
805 static void gen_message_id(struct rev_info *info, char *base)
807 struct strbuf buf = STRBUF_INIT;
808 strbuf_addf(&buf, "%s.%lu.git.%s", base,
809 (unsigned long) time(NULL),
810 git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
811 info->message_id = strbuf_detach(&buf, NULL);
814 static void print_signature(void)
816 if (signature && *signature)
817 printf("-- \n%s\n\n", signature);
820 static void add_branch_description(struct strbuf *buf, const char *branch_name)
822 struct strbuf desc = STRBUF_INIT;
823 if (!branch_name || !*branch_name)
824 return;
825 read_branch_desc(&desc, branch_name);
826 if (desc.len) {
827 strbuf_addch(buf, '\n');
828 strbuf_add(buf, desc.buf, desc.len);
829 strbuf_addch(buf, '\n');
833 static char *find_branch_name(struct rev_info *rev)
835 int i, positive = -1;
836 unsigned char branch_sha1[20];
837 const unsigned char *tip_sha1;
838 const char *ref;
839 char *full_ref, *branch = NULL;
841 for (i = 0; i < rev->cmdline.nr; i++) {
842 if (rev->cmdline.rev[i].flags & UNINTERESTING)
843 continue;
844 if (positive < 0)
845 positive = i;
846 else
847 return NULL;
849 if (positive < 0)
850 return NULL;
851 ref = rev->cmdline.rev[positive].name;
852 tip_sha1 = rev->cmdline.rev[positive].item->sha1;
853 if (dwim_ref(ref, strlen(ref), branch_sha1, &full_ref) &&
854 !prefixcmp(full_ref, "refs/heads/") &&
855 !hashcmp(tip_sha1, branch_sha1))
856 branch = xstrdup(full_ref + strlen("refs/heads/"));
857 free(full_ref);
858 return branch;
861 static void make_cover_letter(struct rev_info *rev, int use_stdout,
862 struct commit *origin,
863 int nr, struct commit **list,
864 const char *branch_name,
865 int quiet)
867 const char *committer;
868 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
869 const char *msg;
870 struct shortlog log;
871 struct strbuf sb = STRBUF_INIT;
872 int i;
873 const char *encoding = "UTF-8";
874 struct diff_options opts;
875 int need_8bit_cte = 0;
876 struct pretty_print_context pp = {0};
877 struct commit *head = list[0];
879 if (rev->commit_format != CMIT_FMT_EMAIL)
880 die(_("Cover letter needs email format"));
882 committer = git_committer_info(0);
884 if (!use_stdout &&
885 reopen_stdout(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
886 return;
888 log_write_email_headers(rev, head, &pp.subject, &pp.after_subject,
889 &need_8bit_cte);
891 for (i = 0; !need_8bit_cte && i < nr; i++)
892 if (has_non_ascii(list[i]->buffer))
893 need_8bit_cte = 1;
895 if (!branch_name)
896 branch_name = find_branch_name(rev);
898 msg = body;
899 pp.fmt = CMIT_FMT_EMAIL;
900 pp.date_mode = DATE_RFC2822;
901 pp_user_info(&pp, NULL, &sb, committer, encoding);
902 pp_title_line(&pp, &msg, &sb, encoding, need_8bit_cte);
903 pp_remainder(&pp, &msg, &sb, 0);
904 add_branch_description(&sb, branch_name);
905 printf("%s\n", sb.buf);
907 strbuf_release(&sb);
909 shortlog_init(&log);
910 log.wrap_lines = 1;
911 log.wrap = 72;
912 log.in1 = 2;
913 log.in2 = 4;
914 for (i = 0; i < nr; i++)
915 shortlog_add_commit(&log, list[i]);
917 shortlog_output(&log);
920 * We can only do diffstat with a unique reference point
922 if (!origin)
923 return;
925 memcpy(&opts, &rev->diffopt, sizeof(opts));
926 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
928 diff_setup_done(&opts);
930 diff_tree_sha1(origin->tree->object.sha1,
931 head->tree->object.sha1,
932 "", &opts);
933 diffcore_std(&opts);
934 diff_flush(&opts);
936 printf("\n");
937 print_signature();
940 static const char *clean_message_id(const char *msg_id)
942 char ch;
943 const char *a, *z, *m;
945 m = msg_id;
946 while ((ch = *m) && (isspace(ch) || (ch == '<')))
947 m++;
948 a = m;
949 z = NULL;
950 while ((ch = *m)) {
951 if (!isspace(ch) && (ch != '>'))
952 z = m;
953 m++;
955 if (!z)
956 die(_("insane in-reply-to: %s"), msg_id);
957 if (++z == m)
958 return a;
959 return xmemdupz(a, z - a);
962 static const char *set_outdir(const char *prefix, const char *output_directory)
964 if (output_directory && is_absolute_path(output_directory))
965 return output_directory;
967 if (!prefix || !*prefix) {
968 if (output_directory)
969 return output_directory;
970 /* The user did not explicitly ask for "./" */
971 outdir_offset = 2;
972 return "./";
975 outdir_offset = strlen(prefix);
976 if (!output_directory)
977 return prefix;
979 return xstrdup(prefix_filename(prefix, outdir_offset,
980 output_directory));
983 static const char * const builtin_format_patch_usage[] = {
984 N_("git format-patch [options] [<since> | <revision range>]"),
985 NULL
988 static int keep_subject = 0;
990 static int keep_callback(const struct option *opt, const char *arg, int unset)
992 ((struct rev_info *)opt->value)->total = -1;
993 keep_subject = 1;
994 return 0;
997 static int subject_prefix = 0;
999 static int subject_prefix_callback(const struct option *opt, const char *arg,
1000 int unset)
1002 subject_prefix = 1;
1003 ((struct rev_info *)opt->value)->subject_prefix = arg;
1004 return 0;
1007 static int numbered_cmdline_opt = 0;
1009 static int numbered_callback(const struct option *opt, const char *arg,
1010 int unset)
1012 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
1013 if (unset)
1014 auto_number = 0;
1015 return 0;
1018 static int no_numbered_callback(const struct option *opt, const char *arg,
1019 int unset)
1021 return numbered_callback(opt, arg, 1);
1024 static int output_directory_callback(const struct option *opt, const char *arg,
1025 int unset)
1027 const char **dir = (const char **)opt->value;
1028 if (*dir)
1029 die(_("Two output directories?"));
1030 *dir = arg;
1031 return 0;
1034 static int thread_callback(const struct option *opt, const char *arg, int unset)
1036 int *thread = (int *)opt->value;
1037 if (unset)
1038 *thread = 0;
1039 else if (!arg || !strcmp(arg, "shallow"))
1040 *thread = THREAD_SHALLOW;
1041 else if (!strcmp(arg, "deep"))
1042 *thread = THREAD_DEEP;
1043 else
1044 return 1;
1045 return 0;
1048 static int attach_callback(const struct option *opt, const char *arg, int unset)
1050 struct rev_info *rev = (struct rev_info *)opt->value;
1051 if (unset)
1052 rev->mime_boundary = NULL;
1053 else if (arg)
1054 rev->mime_boundary = arg;
1055 else
1056 rev->mime_boundary = git_version_string;
1057 rev->no_inline = unset ? 0 : 1;
1058 return 0;
1061 static int inline_callback(const struct option *opt, const char *arg, int unset)
1063 struct rev_info *rev = (struct rev_info *)opt->value;
1064 if (unset)
1065 rev->mime_boundary = NULL;
1066 else if (arg)
1067 rev->mime_boundary = arg;
1068 else
1069 rev->mime_boundary = git_version_string;
1070 rev->no_inline = 0;
1071 return 0;
1074 static int header_callback(const struct option *opt, const char *arg, int unset)
1076 if (unset) {
1077 string_list_clear(&extra_hdr, 0);
1078 string_list_clear(&extra_to, 0);
1079 string_list_clear(&extra_cc, 0);
1080 } else {
1081 add_header(arg);
1083 return 0;
1086 static int to_callback(const struct option *opt, const char *arg, int unset)
1088 if (unset)
1089 string_list_clear(&extra_to, 0);
1090 else
1091 string_list_append(&extra_to, arg);
1092 return 0;
1095 static int cc_callback(const struct option *opt, const char *arg, int unset)
1097 if (unset)
1098 string_list_clear(&extra_cc, 0);
1099 else
1100 string_list_append(&extra_cc, arg);
1101 return 0;
1104 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1106 struct commit *commit;
1107 struct commit **list = NULL;
1108 struct rev_info rev;
1109 struct setup_revision_opt s_r_opt;
1110 int nr = 0, total, i;
1111 int use_stdout = 0;
1112 int start_number = -1;
1113 int just_numbers = 0;
1114 int ignore_if_in_upstream = 0;
1115 int cover_letter = -1;
1116 int boundary_count = 0;
1117 int no_binary_diff = 0;
1118 struct commit *origin = NULL;
1119 const char *in_reply_to = NULL;
1120 struct patch_ids ids;
1121 struct strbuf buf = STRBUF_INIT;
1122 int use_patch_format = 0;
1123 int quiet = 0;
1124 int reroll_count = -1;
1125 char *branch_name = NULL;
1126 const struct option builtin_format_patch_options[] = {
1127 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
1128 N_("use [PATCH n/m] even with a single patch"),
1129 PARSE_OPT_NOARG, numbered_callback },
1130 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
1131 N_("use [PATCH] even with multiple patches"),
1132 PARSE_OPT_NOARG, no_numbered_callback },
1133 OPT_BOOL('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
1134 OPT_BOOL(0, "stdout", &use_stdout,
1135 N_("print patches to standard out")),
1136 OPT_BOOL(0, "cover-letter", &cover_letter,
1137 N_("generate a cover letter")),
1138 OPT_BOOL(0, "numbered-files", &just_numbers,
1139 N_("use simple number sequence for output file names")),
1140 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1141 N_("use <sfx> instead of '.patch'")),
1142 OPT_INTEGER(0, "start-number", &start_number,
1143 N_("start numbering patches at <n> instead of 1")),
1144 OPT_INTEGER('v', "reroll-count", &reroll_count,
1145 N_("mark the series as Nth re-roll")),
1146 { OPTION_CALLBACK, 0, "subject-prefix", &rev, N_("prefix"),
1147 N_("Use [<prefix>] instead of [PATCH]"),
1148 PARSE_OPT_NONEG, subject_prefix_callback },
1149 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
1150 N_("dir"), N_("store resulting files in <dir>"),
1151 PARSE_OPT_NONEG, output_directory_callback },
1152 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
1153 N_("don't strip/add [PATCH]"),
1154 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
1155 OPT_BOOLEAN(0, "no-binary", &no_binary_diff,
1156 N_("don't output binary diffs")),
1157 OPT_BOOLEAN(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1158 N_("don't include a patch matching a commit upstream")),
1159 { OPTION_BOOLEAN, 'p', "no-stat", &use_patch_format, NULL,
1160 N_("show patch format instead of default (patch + stat)"),
1161 PARSE_OPT_NONEG | PARSE_OPT_NOARG },
1162 OPT_GROUP(N_("Messaging")),
1163 { OPTION_CALLBACK, 0, "add-header", NULL, N_("header"),
1164 N_("add email header"), 0, header_callback },
1165 { OPTION_CALLBACK, 0, "to", NULL, N_("email"), N_("add To: header"),
1166 0, to_callback },
1167 { OPTION_CALLBACK, 0, "cc", NULL, N_("email"), N_("add Cc: header"),
1168 0, cc_callback },
1169 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1170 N_("make first mail a reply to <message-id>")),
1171 { OPTION_CALLBACK, 0, "attach", &rev, N_("boundary"),
1172 N_("attach the patch"), PARSE_OPT_OPTARG,
1173 attach_callback },
1174 { OPTION_CALLBACK, 0, "inline", &rev, N_("boundary"),
1175 N_("inline the patch"),
1176 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1177 inline_callback },
1178 { OPTION_CALLBACK, 0, "thread", &thread, N_("style"),
1179 N_("enable message threading, styles: shallow, deep"),
1180 PARSE_OPT_OPTARG, thread_callback },
1181 OPT_STRING(0, "signature", &signature, N_("signature"),
1182 N_("add a signature")),
1183 OPT_BOOLEAN(0, "quiet", &quiet,
1184 N_("don't print the patch filenames")),
1185 OPT_END()
1188 extra_hdr.strdup_strings = 1;
1189 extra_to.strdup_strings = 1;
1190 extra_cc.strdup_strings = 1;
1191 init_grep_defaults();
1192 git_config(git_format_config, NULL);
1193 init_revisions(&rev, prefix);
1194 rev.commit_format = CMIT_FMT_EMAIL;
1195 rev.verbose_header = 1;
1196 rev.diff = 1;
1197 rev.max_parents = 1;
1198 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
1199 rev.subject_prefix = fmt_patch_subject_prefix;
1200 memset(&s_r_opt, 0, sizeof(s_r_opt));
1201 s_r_opt.def = "HEAD";
1202 s_r_opt.revarg_opt = REVARG_COMMITTISH;
1204 if (default_attach) {
1205 rev.mime_boundary = default_attach;
1206 rev.no_inline = 1;
1210 * Parse the arguments before setup_revisions(), or something
1211 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1212 * possibly a valid SHA1.
1214 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1215 builtin_format_patch_usage,
1216 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1217 PARSE_OPT_KEEP_DASHDASH);
1219 if (0 < reroll_count) {
1220 struct strbuf sprefix = STRBUF_INIT;
1221 strbuf_addf(&sprefix, "%s v%d",
1222 rev.subject_prefix, reroll_count);
1223 rev.reroll_count = reroll_count;
1224 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1227 for (i = 0; i < extra_hdr.nr; i++) {
1228 strbuf_addstr(&buf, extra_hdr.items[i].string);
1229 strbuf_addch(&buf, '\n');
1232 if (extra_to.nr)
1233 strbuf_addstr(&buf, "To: ");
1234 for (i = 0; i < extra_to.nr; i++) {
1235 if (i)
1236 strbuf_addstr(&buf, " ");
1237 strbuf_addstr(&buf, extra_to.items[i].string);
1238 if (i + 1 < extra_to.nr)
1239 strbuf_addch(&buf, ',');
1240 strbuf_addch(&buf, '\n');
1243 if (extra_cc.nr)
1244 strbuf_addstr(&buf, "Cc: ");
1245 for (i = 0; i < extra_cc.nr; i++) {
1246 if (i)
1247 strbuf_addstr(&buf, " ");
1248 strbuf_addstr(&buf, extra_cc.items[i].string);
1249 if (i + 1 < extra_cc.nr)
1250 strbuf_addch(&buf, ',');
1251 strbuf_addch(&buf, '\n');
1254 rev.extra_headers = strbuf_detach(&buf, NULL);
1256 if (start_number < 0)
1257 start_number = 1;
1260 * If numbered is set solely due to format.numbered in config,
1261 * and it would conflict with --keep-subject (-k) from the
1262 * command line, reset "numbered".
1264 if (numbered && keep_subject && !numbered_cmdline_opt)
1265 numbered = 0;
1267 if (numbered && keep_subject)
1268 die (_("-n and -k are mutually exclusive."));
1269 if (keep_subject && subject_prefix)
1270 die (_("--subject-prefix and -k are mutually exclusive."));
1271 rev.preserve_subject = keep_subject;
1273 argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1274 if (argc > 1)
1275 die (_("unrecognized argument: %s"), argv[1]);
1277 if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1278 die(_("--name-only does not make sense"));
1279 if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1280 die(_("--name-status does not make sense"));
1281 if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1282 die(_("--check does not make sense"));
1284 if (!use_patch_format &&
1285 (!rev.diffopt.output_format ||
1286 rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1287 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1289 /* Always generate a patch */
1290 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1292 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
1293 DIFF_OPT_SET(&rev.diffopt, BINARY);
1295 if (rev.show_notes)
1296 init_display_notes(&rev.notes_opt);
1298 if (!use_stdout)
1299 output_directory = set_outdir(prefix, output_directory);
1300 else
1301 setup_pager();
1303 if (output_directory) {
1304 if (use_stdout)
1305 die(_("standard output, or directory, which one?"));
1306 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1307 die_errno(_("Could not create directory '%s'"),
1308 output_directory);
1311 if (rev.pending.nr == 1) {
1312 int check_head = 0;
1314 if (rev.max_count < 0 && !rev.show_root_diff) {
1316 * This is traditional behaviour of "git format-patch
1317 * origin" that prepares what the origin side still
1318 * does not have.
1320 rev.pending.objects[0].item->flags |= UNINTERESTING;
1321 add_head_to_pending(&rev);
1322 check_head = 1;
1325 * Otherwise, it is "format-patch -22 HEAD", and/or
1326 * "format-patch --root HEAD". The user wants
1327 * get_revision() to do the usual traversal.
1330 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
1331 check_head = 1;
1333 if (check_head) {
1334 unsigned char sha1[20];
1335 const char *ref;
1336 ref = resolve_ref_unsafe("HEAD", sha1, 1, NULL);
1337 if (ref && !prefixcmp(ref, "refs/heads/"))
1338 branch_name = xstrdup(ref + strlen("refs/heads/"));
1339 else
1340 branch_name = xstrdup(""); /* no branch */
1345 * We cannot move this anywhere earlier because we do want to
1346 * know if --root was given explicitly from the command line.
1348 rev.show_root_diff = 1;
1350 if (ignore_if_in_upstream) {
1351 /* Don't say anything if head and upstream are the same. */
1352 if (rev.pending.nr == 2) {
1353 struct object_array_entry *o = rev.pending.objects;
1354 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1355 return 0;
1357 get_patch_ids(&rev, &ids);
1360 if (!use_stdout)
1361 realstdout = xfdopen(xdup(1), "w");
1363 if (prepare_revision_walk(&rev))
1364 die(_("revision walk setup failed"));
1365 rev.boundary = 1;
1366 while ((commit = get_revision(&rev)) != NULL) {
1367 if (commit->object.flags & BOUNDARY) {
1368 boundary_count++;
1369 origin = (boundary_count == 1) ? commit : NULL;
1370 continue;
1373 if (ignore_if_in_upstream &&
1374 has_commit_patch_id(commit, &ids))
1375 continue;
1377 nr++;
1378 list = xrealloc(list, nr * sizeof(list[0]));
1379 list[nr - 1] = commit;
1381 if (nr == 0)
1382 /* nothing to do */
1383 return 0;
1384 total = nr;
1385 if (!keep_subject && auto_number && total > 1)
1386 numbered = 1;
1387 if (numbered)
1388 rev.total = total + start_number - 1;
1389 if (cover_letter == -1) {
1390 if (config_cover_letter == COVER_AUTO)
1391 cover_letter = (total > 1);
1392 else
1393 cover_letter = (config_cover_letter == COVER_ON);
1396 if (in_reply_to || thread || cover_letter)
1397 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1398 if (in_reply_to) {
1399 const char *msgid = clean_message_id(in_reply_to);
1400 string_list_append(rev.ref_message_ids, msgid);
1402 rev.numbered_files = just_numbers;
1403 rev.patch_suffix = fmt_patch_suffix;
1404 if (cover_letter) {
1405 if (thread)
1406 gen_message_id(&rev, "cover");
1407 make_cover_letter(&rev, use_stdout,
1408 origin, nr, list, branch_name, quiet);
1409 total++;
1410 start_number--;
1412 rev.add_signoff = do_signoff;
1413 while (0 <= --nr) {
1414 int shown;
1415 commit = list[nr];
1416 rev.nr = total - nr + (start_number - 1);
1417 /* Make the second and subsequent mails replies to the first */
1418 if (thread) {
1419 /* Have we already had a message ID? */
1420 if (rev.message_id) {
1422 * For deep threading: make every mail
1423 * a reply to the previous one, no
1424 * matter what other options are set.
1426 * For shallow threading:
1428 * Without --cover-letter and
1429 * --in-reply-to, make every mail a
1430 * reply to the one before.
1432 * With --in-reply-to but no
1433 * --cover-letter, make every mail a
1434 * reply to the <reply-to>.
1436 * With --cover-letter, make every
1437 * mail but the cover letter a reply
1438 * to the cover letter. The cover
1439 * letter is a reply to the
1440 * --in-reply-to, if specified.
1442 if (thread == THREAD_SHALLOW
1443 && rev.ref_message_ids->nr > 0
1444 && (!cover_letter || rev.nr > 1))
1445 free(rev.message_id);
1446 else
1447 string_list_append(rev.ref_message_ids,
1448 rev.message_id);
1450 gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1453 if (!use_stdout &&
1454 reopen_stdout(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
1455 die(_("Failed to create output files"));
1456 shown = log_tree_commit(&rev, commit);
1457 free(commit->buffer);
1458 commit->buffer = NULL;
1460 /* We put one extra blank line between formatted
1461 * patches and this flag is used by log-tree code
1462 * to see if it needs to emit a LF before showing
1463 * the log; when using one file per patch, we do
1464 * not want the extra blank line.
1466 if (!use_stdout)
1467 rev.shown_one = 0;
1468 if (shown) {
1469 if (rev.mime_boundary)
1470 printf("\n--%s%s--\n\n\n",
1471 mime_boundary_leader,
1472 rev.mime_boundary);
1473 else
1474 print_signature();
1476 if (!use_stdout)
1477 fclose(stdout);
1479 free(list);
1480 free(branch_name);
1481 string_list_clear(&extra_to, 0);
1482 string_list_clear(&extra_cc, 0);
1483 string_list_clear(&extra_hdr, 0);
1484 if (ignore_if_in_upstream)
1485 free_patch_ids(&ids);
1486 return 0;
1489 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1491 unsigned char sha1[20];
1492 if (get_sha1(arg, sha1) == 0) {
1493 struct commit *commit = lookup_commit_reference(sha1);
1494 if (commit) {
1495 commit->object.flags |= flags;
1496 add_pending_object(revs, &commit->object, arg);
1497 return 0;
1500 return -1;
1503 static const char * const cherry_usage[] = {
1504 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1505 NULL
1508 static void print_commit(char sign, struct commit *commit, int verbose,
1509 int abbrev)
1511 if (!verbose) {
1512 printf("%c %s\n", sign,
1513 find_unique_abbrev(commit->object.sha1, abbrev));
1514 } else {
1515 struct strbuf buf = STRBUF_INIT;
1516 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
1517 printf("%c %s %s\n", sign,
1518 find_unique_abbrev(commit->object.sha1, abbrev),
1519 buf.buf);
1520 strbuf_release(&buf);
1524 int cmd_cherry(int argc, const char **argv, const char *prefix)
1526 struct rev_info revs;
1527 struct patch_ids ids;
1528 struct commit *commit;
1529 struct commit_list *list = NULL;
1530 struct branch *current_branch;
1531 const char *upstream;
1532 const char *head = "HEAD";
1533 const char *limit = NULL;
1534 int verbose = 0, abbrev = 0;
1536 struct option options[] = {
1537 OPT__ABBREV(&abbrev),
1538 OPT__VERBOSE(&verbose, N_("be verbose")),
1539 OPT_END()
1542 argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
1544 switch (argc) {
1545 case 3:
1546 limit = argv[2];
1547 /* FALLTHROUGH */
1548 case 2:
1549 head = argv[1];
1550 /* FALLTHROUGH */
1551 case 1:
1552 upstream = argv[0];
1553 break;
1554 default:
1555 current_branch = branch_get(NULL);
1556 if (!current_branch || !current_branch->merge
1557 || !current_branch->merge[0]
1558 || !current_branch->merge[0]->dst) {
1559 fprintf(stderr, _("Could not find a tracked"
1560 " remote branch, please"
1561 " specify <upstream> manually.\n"));
1562 usage_with_options(cherry_usage, options);
1565 upstream = current_branch->merge[0]->dst;
1568 init_revisions(&revs, prefix);
1569 revs.max_parents = 1;
1571 if (add_pending_commit(head, &revs, 0))
1572 die(_("Unknown commit %s"), head);
1573 if (add_pending_commit(upstream, &revs, UNINTERESTING))
1574 die(_("Unknown commit %s"), upstream);
1576 /* Don't say anything if head and upstream are the same. */
1577 if (revs.pending.nr == 2) {
1578 struct object_array_entry *o = revs.pending.objects;
1579 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1580 return 0;
1583 get_patch_ids(&revs, &ids);
1585 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1586 die(_("Unknown commit %s"), limit);
1588 /* reverse the list of commits */
1589 if (prepare_revision_walk(&revs))
1590 die(_("revision walk setup failed"));
1591 while ((commit = get_revision(&revs)) != NULL) {
1592 commit_list_insert(commit, &list);
1595 while (list) {
1596 char sign = '+';
1598 commit = list->item;
1599 if (has_commit_patch_id(commit, &ids))
1600 sign = '-';
1601 print_commit(sign, commit, verbose, abbrev);
1602 list = list->next;
1605 free_patch_ids(&ids);
1606 return 0;