Merge branch 'jk/rm-removed-paths'
[git/jnareb-git.git] / builtin / log.c
blob0f318107e5732a08bc6f979633829ea958d8f9b0
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);
96 static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
97 struct rev_info *rev, struct setup_revision_opt *opt)
99 struct userformat_want w;
100 int quiet = 0, source = 0, mailmap = 0;
102 const struct option builtin_log_options[] = {
103 OPT_BOOLEAN(0, "quiet", &quiet, N_("suppress diff output")),
104 OPT_BOOLEAN(0, "source", &source, N_("show source")),
105 OPT_BOOLEAN(0, "use-mailmap", &mailmap, N_("Use mail map file")),
106 { OPTION_CALLBACK, 0, "decorate", NULL, NULL, N_("decorate options"),
107 PARSE_OPT_OPTARG, decorate_callback},
108 OPT_END()
111 mailmap = use_mailmap_config;
112 argc = parse_options(argc, argv, prefix,
113 builtin_log_options, builtin_log_usage,
114 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
115 PARSE_OPT_KEEP_DASHDASH);
117 if (quiet)
118 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
119 argc = setup_revisions(argc, argv, rev, opt);
121 /* Any arguments at this point are not recognized */
122 if (argc > 1)
123 die("unrecognized argument: %s", argv[1]);
125 memset(&w, 0, sizeof(w));
126 userformat_find_requirements(NULL, &w);
128 if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
129 rev->show_notes = 1;
130 if (rev->show_notes)
131 init_display_notes(&rev->notes_opt);
133 if (rev->diffopt.pickaxe || rev->diffopt.filter)
134 rev->always_show_header = 0;
135 if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
136 rev->always_show_header = 0;
137 if (rev->diffopt.pathspec.nr != 1)
138 usage("git logs can only follow renames on one pathname at a time");
141 if (source)
142 rev->show_source = 1;
144 if (mailmap) {
145 rev->mailmap = xcalloc(1, sizeof(struct string_list));
146 read_mailmap(rev->mailmap, NULL);
149 if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
151 * "log --pretty=raw" is special; ignore UI oriented
152 * configuration variables such as decoration.
154 if (!decoration_given)
155 decoration_style = 0;
156 if (!rev->abbrev_commit_given)
157 rev->abbrev_commit = 0;
160 if (decoration_style) {
161 rev->show_decorations = 1;
162 load_ref_decorations(decoration_style);
164 setup_pager();
167 static void cmd_log_init(int argc, const char **argv, const char *prefix,
168 struct rev_info *rev, struct setup_revision_opt *opt)
170 cmd_log_init_defaults(rev);
171 cmd_log_init_finish(argc, argv, prefix, rev, opt);
175 * This gives a rough estimate for how many commits we
176 * will print out in the list.
178 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
180 int n = 0;
182 while (list) {
183 struct commit *commit = list->item;
184 unsigned int flags = commit->object.flags;
185 list = list->next;
186 if (!(flags & (TREESAME | UNINTERESTING)))
187 n++;
189 return n;
192 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
194 if (rev->shown_one) {
195 rev->shown_one = 0;
196 if (rev->commit_format != CMIT_FMT_ONELINE)
197 putchar(rev->diffopt.line_termination);
199 printf(_("Final output: %d %s\n"), nr, stage);
202 static struct itimerval early_output_timer;
204 static void log_show_early(struct rev_info *revs, struct commit_list *list)
206 int i = revs->early_output;
207 int show_header = 1;
209 sort_in_topological_order(&list, revs->lifo);
210 while (list && i) {
211 struct commit *commit = list->item;
212 switch (simplify_commit(revs, commit)) {
213 case commit_show:
214 if (show_header) {
215 int n = estimate_commit_count(revs, list);
216 show_early_header(revs, "incomplete", n);
217 show_header = 0;
219 log_tree_commit(revs, commit);
220 i--;
221 break;
222 case commit_ignore:
223 break;
224 case commit_error:
225 return;
227 list = list->next;
230 /* Did we already get enough commits for the early output? */
231 if (!i)
232 return;
235 * ..if no, then repeat it twice a second until we
236 * do.
238 * NOTE! We don't use "it_interval", because if the
239 * reader isn't listening, we want our output to be
240 * throttled by the writing, and not have the timer
241 * trigger every second even if we're blocked on a
242 * reader!
244 early_output_timer.it_value.tv_sec = 0;
245 early_output_timer.it_value.tv_usec = 500000;
246 setitimer(ITIMER_REAL, &early_output_timer, NULL);
249 static void early_output(int signal)
251 show_early_output = log_show_early;
254 static void setup_early_output(struct rev_info *rev)
256 struct sigaction sa;
259 * Set up the signal handler, minimally intrusively:
260 * we only set a single volatile integer word (not
261 * using sigatomic_t - trying to avoid unnecessary
262 * system dependencies and headers), and using
263 * SA_RESTART.
265 memset(&sa, 0, sizeof(sa));
266 sa.sa_handler = early_output;
267 sigemptyset(&sa.sa_mask);
268 sa.sa_flags = SA_RESTART;
269 sigaction(SIGALRM, &sa, NULL);
272 * If we can get the whole output in less than a
273 * tenth of a second, don't even bother doing the
274 * early-output thing..
276 * This is a one-time-only trigger.
278 early_output_timer.it_value.tv_sec = 0;
279 early_output_timer.it_value.tv_usec = 100000;
280 setitimer(ITIMER_REAL, &early_output_timer, NULL);
283 static void finish_early_output(struct rev_info *rev)
285 int n = estimate_commit_count(rev, rev->commits);
286 signal(SIGALRM, SIG_IGN);
287 show_early_header(rev, "done", n);
290 static int cmd_log_walk(struct rev_info *rev)
292 struct commit *commit;
293 int saved_nrl = 0;
294 int saved_dcctc = 0;
296 if (rev->early_output)
297 setup_early_output(rev);
299 if (prepare_revision_walk(rev))
300 die(_("revision walk setup failed"));
302 if (rev->early_output)
303 finish_early_output(rev);
306 * For --check and --exit-code, the exit code is based on CHECK_FAILED
307 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
308 * retain that state information if replacing rev->diffopt in this loop
310 while ((commit = get_revision(rev)) != NULL) {
311 if (!log_tree_commit(rev, commit) &&
312 rev->max_count >= 0)
314 * We decremented max_count in get_revision,
315 * but we didn't actually show the commit.
317 rev->max_count++;
318 if (!rev->reflog_info) {
319 /* we allow cycles in reflog ancestry */
320 free(commit->buffer);
321 commit->buffer = NULL;
323 free_commit_list(commit->parents);
324 commit->parents = NULL;
325 if (saved_nrl < rev->diffopt.needed_rename_limit)
326 saved_nrl = rev->diffopt.needed_rename_limit;
327 if (rev->diffopt.degraded_cc_to_c)
328 saved_dcctc = 1;
330 rev->diffopt.degraded_cc_to_c = saved_dcctc;
331 rev->diffopt.needed_rename_limit = saved_nrl;
333 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
334 DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
335 return 02;
337 return diff_result_code(&rev->diffopt, 0);
340 static int git_log_config(const char *var, const char *value, void *cb)
342 if (!strcmp(var, "format.pretty"))
343 return git_config_string(&fmt_pretty, var, value);
344 if (!strcmp(var, "format.subjectprefix"))
345 return git_config_string(&fmt_patch_subject_prefix, var, value);
346 if (!strcmp(var, "log.abbrevcommit")) {
347 default_abbrev_commit = git_config_bool(var, value);
348 return 0;
350 if (!strcmp(var, "log.date"))
351 return git_config_string(&default_date_mode, var, value);
352 if (!strcmp(var, "log.decorate")) {
353 decoration_style = parse_decoration_style(var, value);
354 if (decoration_style < 0)
355 decoration_style = 0; /* maybe warn? */
356 return 0;
358 if (!strcmp(var, "log.showroot")) {
359 default_show_root = git_config_bool(var, value);
360 return 0;
362 if (!prefixcmp(var, "color.decorate."))
363 return parse_decorate_color_config(var, 15, value);
364 if (!strcmp(var, "log.mailmap")) {
365 use_mailmap_config = git_config_bool(var, value);
366 return 0;
369 if (grep_config(var, value, cb) < 0)
370 return -1;
371 if (git_gpg_config(var, value, cb) < 0)
372 return -1;
373 return git_diff_ui_config(var, value, cb);
376 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
378 struct rev_info rev;
379 struct setup_revision_opt opt;
381 init_grep_defaults();
382 git_config(git_log_config, NULL);
384 init_revisions(&rev, prefix);
385 rev.diff = 1;
386 rev.simplify_history = 0;
387 memset(&opt, 0, sizeof(opt));
388 opt.def = "HEAD";
389 opt.revarg_opt = REVARG_COMMITTISH;
390 cmd_log_init(argc, argv, prefix, &rev, &opt);
391 if (!rev.diffopt.output_format)
392 rev.diffopt.output_format = DIFF_FORMAT_RAW;
393 return cmd_log_walk(&rev);
396 static void show_tagger(char *buf, int len, struct rev_info *rev)
398 struct strbuf out = STRBUF_INIT;
399 struct pretty_print_context pp = {0};
401 pp.fmt = rev->commit_format;
402 pp.date_mode = rev->date_mode;
403 pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
404 printf("%s", out.buf);
405 strbuf_release(&out);
408 static int show_blob_object(const unsigned char *sha1, struct rev_info *rev)
410 fflush(stdout);
411 return stream_blob_to_fd(1, sha1, NULL, 0);
414 static int show_tag_object(const unsigned char *sha1, struct rev_info *rev)
416 unsigned long size;
417 enum object_type type;
418 char *buf = read_sha1_file(sha1, &type, &size);
419 int offset = 0;
421 if (!buf)
422 return error(_("Could not read object %s"), sha1_to_hex(sha1));
424 assert(type == OBJ_TAG);
425 while (offset < size && buf[offset] != '\n') {
426 int new_offset = offset + 1;
427 while (new_offset < size && buf[new_offset++] != '\n')
428 ; /* do nothing */
429 if (!prefixcmp(buf + offset, "tagger "))
430 show_tagger(buf + offset + 7,
431 new_offset - offset - 7, rev);
432 offset = new_offset;
435 if (offset < size)
436 fwrite(buf + offset, size - offset, 1, stdout);
437 free(buf);
438 return 0;
441 static int show_tree_object(const unsigned char *sha1,
442 const char *base, int baselen,
443 const char *pathname, unsigned mode, int stage, void *context)
445 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
446 return 0;
449 static void show_rev_tweak_rev(struct rev_info *rev, struct setup_revision_opt *opt)
451 if (rev->ignore_merges) {
452 /* There was no "-m" on the command line */
453 rev->ignore_merges = 0;
454 if (!rev->first_parent_only && !rev->combine_merges) {
455 /* No "--first-parent", "-c", nor "--cc" */
456 rev->combine_merges = 1;
457 rev->dense_combined_merges = 1;
460 if (!rev->diffopt.output_format)
461 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
464 int cmd_show(int argc, const char **argv, const char *prefix)
466 struct rev_info rev;
467 struct object_array_entry *objects;
468 struct setup_revision_opt opt;
469 struct pathspec match_all;
470 int i, count, ret = 0;
472 init_grep_defaults();
473 git_config(git_log_config, NULL);
475 init_pathspec(&match_all, NULL);
476 init_revisions(&rev, prefix);
477 rev.diff = 1;
478 rev.always_show_header = 1;
479 rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
480 rev.diffopt.stat_width = -1; /* Scale to real terminal size */
482 memset(&opt, 0, sizeof(opt));
483 opt.def = "HEAD";
484 opt.tweak = show_rev_tweak_rev;
485 cmd_log_init(argc, argv, prefix, &rev, &opt);
487 if (!rev.no_walk)
488 return cmd_log_walk(&rev);
490 count = rev.pending.nr;
491 objects = rev.pending.objects;
492 for (i = 0; i < count && !ret; i++) {
493 struct object *o = objects[i].item;
494 const char *name = objects[i].name;
495 switch (o->type) {
496 case OBJ_BLOB:
497 ret = show_blob_object(o->sha1, NULL);
498 break;
499 case OBJ_TAG: {
500 struct tag *t = (struct tag *)o;
502 if (rev.shown_one)
503 putchar('\n');
504 printf("%stag %s%s\n",
505 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
506 t->tag,
507 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
508 ret = show_tag_object(o->sha1, &rev);
509 rev.shown_one = 1;
510 if (ret)
511 break;
512 o = parse_object(t->tagged->sha1);
513 if (!o)
514 ret = error(_("Could not read object %s"),
515 sha1_to_hex(t->tagged->sha1));
516 objects[i].item = o;
517 i--;
518 break;
520 case OBJ_TREE:
521 if (rev.shown_one)
522 putchar('\n');
523 printf("%stree %s%s\n\n",
524 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
525 name,
526 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
527 read_tree_recursive((struct tree *)o, "", 0, 0, &match_all,
528 show_tree_object, NULL);
529 rev.shown_one = 1;
530 break;
531 case OBJ_COMMIT:
532 rev.pending.nr = rev.pending.alloc = 0;
533 rev.pending.objects = NULL;
534 add_object_array(o, name, &rev.pending);
535 ret = cmd_log_walk(&rev);
536 break;
537 default:
538 ret = error(_("Unknown type: %d"), o->type);
541 free(objects);
542 return ret;
546 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
548 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
550 struct rev_info rev;
551 struct setup_revision_opt opt;
553 init_grep_defaults();
554 git_config(git_log_config, NULL);
556 init_revisions(&rev, prefix);
557 init_reflog_walk(&rev.reflog_info);
558 rev.verbose_header = 1;
559 memset(&opt, 0, sizeof(opt));
560 opt.def = "HEAD";
561 cmd_log_init_defaults(&rev);
562 rev.abbrev_commit = 1;
563 rev.commit_format = CMIT_FMT_ONELINE;
564 rev.use_terminator = 1;
565 rev.always_show_header = 1;
566 cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
568 return cmd_log_walk(&rev);
571 int cmd_log(int argc, const char **argv, const char *prefix)
573 struct rev_info rev;
574 struct setup_revision_opt opt;
576 init_grep_defaults();
577 git_config(git_log_config, NULL);
579 init_revisions(&rev, prefix);
580 rev.always_show_header = 1;
581 memset(&opt, 0, sizeof(opt));
582 opt.def = "HEAD";
583 opt.revarg_opt = REVARG_COMMITTISH;
584 cmd_log_init(argc, argv, prefix, &rev, &opt);
585 return cmd_log_walk(&rev);
588 /* format-patch */
590 static const char *fmt_patch_suffix = ".patch";
591 static int numbered = 0;
592 static int auto_number = 1;
594 static char *default_attach = NULL;
596 static struct string_list extra_hdr;
597 static struct string_list extra_to;
598 static struct string_list extra_cc;
600 static void add_header(const char *value)
602 struct string_list_item *item;
603 int len = strlen(value);
604 while (len && value[len - 1] == '\n')
605 len--;
607 if (!strncasecmp(value, "to: ", 4)) {
608 item = string_list_append(&extra_to, value + 4);
609 len -= 4;
610 } else if (!strncasecmp(value, "cc: ", 4)) {
611 item = string_list_append(&extra_cc, value + 4);
612 len -= 4;
613 } else {
614 item = string_list_append(&extra_hdr, value);
617 item->string[len] = '\0';
620 #define THREAD_SHALLOW 1
621 #define THREAD_DEEP 2
622 static int thread;
623 static int do_signoff;
624 static const char *signature = git_version_string;
626 static int git_format_config(const char *var, const char *value, void *cb)
628 if (!strcmp(var, "format.headers")) {
629 if (!value)
630 die(_("format.headers without value"));
631 add_header(value);
632 return 0;
634 if (!strcmp(var, "format.suffix"))
635 return git_config_string(&fmt_patch_suffix, var, value);
636 if (!strcmp(var, "format.to")) {
637 if (!value)
638 return config_error_nonbool(var);
639 string_list_append(&extra_to, value);
640 return 0;
642 if (!strcmp(var, "format.cc")) {
643 if (!value)
644 return config_error_nonbool(var);
645 string_list_append(&extra_cc, value);
646 return 0;
648 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
649 !strcmp(var, "color.ui")) {
650 return 0;
652 if (!strcmp(var, "format.numbered")) {
653 if (value && !strcasecmp(value, "auto")) {
654 auto_number = 1;
655 return 0;
657 numbered = git_config_bool(var, value);
658 auto_number = auto_number && numbered;
659 return 0;
661 if (!strcmp(var, "format.attach")) {
662 if (value && *value)
663 default_attach = xstrdup(value);
664 else
665 default_attach = xstrdup(git_version_string);
666 return 0;
668 if (!strcmp(var, "format.thread")) {
669 if (value && !strcasecmp(value, "deep")) {
670 thread = THREAD_DEEP;
671 return 0;
673 if (value && !strcasecmp(value, "shallow")) {
674 thread = THREAD_SHALLOW;
675 return 0;
677 thread = git_config_bool(var, value) && THREAD_SHALLOW;
678 return 0;
680 if (!strcmp(var, "format.signoff")) {
681 do_signoff = git_config_bool(var, value);
682 return 0;
684 if (!strcmp(var, "format.signature"))
685 return git_config_string(&signature, var, value);
687 return git_log_config(var, value, cb);
690 static FILE *realstdout = NULL;
691 static const char *output_directory = NULL;
692 static int outdir_offset;
694 static int reopen_stdout(struct commit *commit, const char *subject,
695 struct rev_info *rev, int quiet)
697 struct strbuf filename = STRBUF_INIT;
698 int suffix_len = strlen(rev->patch_suffix) + 1;
700 if (output_directory) {
701 strbuf_addstr(&filename, output_directory);
702 if (filename.len >=
703 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
704 return error(_("name of output directory is too long"));
705 if (filename.buf[filename.len - 1] != '/')
706 strbuf_addch(&filename, '/');
709 if (rev->numbered_files)
710 strbuf_addf(&filename, "%d", rev->nr);
711 else if (commit)
712 fmt_output_commit(&filename, commit, rev);
713 else
714 fmt_output_subject(&filename, subject, rev);
716 if (!quiet)
717 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
719 if (freopen(filename.buf, "w", stdout) == NULL)
720 return error(_("Cannot open patch file %s"), filename.buf);
722 strbuf_release(&filename);
723 return 0;
726 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
728 struct rev_info check_rev;
729 struct commit *commit;
730 struct object *o1, *o2;
731 unsigned flags1, flags2;
733 if (rev->pending.nr != 2)
734 die(_("Need exactly one range."));
736 o1 = rev->pending.objects[0].item;
737 flags1 = o1->flags;
738 o2 = rev->pending.objects[1].item;
739 flags2 = o2->flags;
741 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
742 die(_("Not a range."));
744 init_patch_ids(ids);
746 /* given a range a..b get all patch ids for b..a */
747 init_revisions(&check_rev, rev->prefix);
748 check_rev.max_parents = 1;
749 o1->flags ^= UNINTERESTING;
750 o2->flags ^= UNINTERESTING;
751 add_pending_object(&check_rev, o1, "o1");
752 add_pending_object(&check_rev, o2, "o2");
753 if (prepare_revision_walk(&check_rev))
754 die(_("revision walk setup failed"));
756 while ((commit = get_revision(&check_rev)) != NULL) {
757 add_commit_patch_id(commit, ids);
760 /* reset for next revision walk */
761 clear_commit_marks((struct commit *)o1,
762 SEEN | UNINTERESTING | SHOWN | ADDED);
763 clear_commit_marks((struct commit *)o2,
764 SEEN | UNINTERESTING | SHOWN | ADDED);
765 o1->flags = flags1;
766 o2->flags = flags2;
769 static void gen_message_id(struct rev_info *info, char *base)
771 struct strbuf buf = STRBUF_INIT;
772 strbuf_addf(&buf, "%s.%lu.git.%s", base,
773 (unsigned long) time(NULL),
774 git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
775 info->message_id = strbuf_detach(&buf, NULL);
778 static void print_signature(void)
780 if (signature && *signature)
781 printf("-- \n%s\n\n", signature);
784 static void add_branch_description(struct strbuf *buf, const char *branch_name)
786 struct strbuf desc = STRBUF_INIT;
787 if (!branch_name || !*branch_name)
788 return;
789 read_branch_desc(&desc, branch_name);
790 if (desc.len) {
791 strbuf_addch(buf, '\n');
792 strbuf_add(buf, desc.buf, desc.len);
793 strbuf_addch(buf, '\n');
797 static void make_cover_letter(struct rev_info *rev, int use_stdout,
798 struct commit *origin,
799 int nr, struct commit **list, struct commit *head,
800 const char *branch_name,
801 int quiet)
803 const char *committer;
804 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
805 const char *msg;
806 struct shortlog log;
807 struct strbuf sb = STRBUF_INIT;
808 int i;
809 const char *encoding = "UTF-8";
810 struct diff_options opts;
811 int need_8bit_cte = 0;
812 struct pretty_print_context pp = {0};
814 if (rev->commit_format != CMIT_FMT_EMAIL)
815 die(_("Cover letter needs email format"));
817 committer = git_committer_info(0);
819 if (!use_stdout &&
820 reopen_stdout(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
821 return;
823 log_write_email_headers(rev, head, &pp.subject, &pp.after_subject,
824 &need_8bit_cte);
826 for (i = 0; !need_8bit_cte && i < nr; i++)
827 if (has_non_ascii(list[i]->buffer))
828 need_8bit_cte = 1;
830 msg = body;
831 pp.fmt = CMIT_FMT_EMAIL;
832 pp.date_mode = DATE_RFC2822;
833 pp_user_info(&pp, NULL, &sb, committer, encoding);
834 pp_title_line(&pp, &msg, &sb, encoding, need_8bit_cte);
835 pp_remainder(&pp, &msg, &sb, 0);
836 add_branch_description(&sb, branch_name);
837 printf("%s\n", sb.buf);
839 strbuf_release(&sb);
841 shortlog_init(&log);
842 log.wrap_lines = 1;
843 log.wrap = 72;
844 log.in1 = 2;
845 log.in2 = 4;
846 for (i = 0; i < nr; i++)
847 shortlog_add_commit(&log, list[i]);
849 shortlog_output(&log);
852 * We can only do diffstat with a unique reference point
854 if (!origin)
855 return;
857 memcpy(&opts, &rev->diffopt, sizeof(opts));
858 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
860 diff_setup_done(&opts);
862 diff_tree_sha1(origin->tree->object.sha1,
863 head->tree->object.sha1,
864 "", &opts);
865 diffcore_std(&opts);
866 diff_flush(&opts);
868 printf("\n");
869 print_signature();
872 static const char *clean_message_id(const char *msg_id)
874 char ch;
875 const char *a, *z, *m;
877 m = msg_id;
878 while ((ch = *m) && (isspace(ch) || (ch == '<')))
879 m++;
880 a = m;
881 z = NULL;
882 while ((ch = *m)) {
883 if (!isspace(ch) && (ch != '>'))
884 z = m;
885 m++;
887 if (!z)
888 die(_("insane in-reply-to: %s"), msg_id);
889 if (++z == m)
890 return a;
891 return xmemdupz(a, z - a);
894 static const char *set_outdir(const char *prefix, const char *output_directory)
896 if (output_directory && is_absolute_path(output_directory))
897 return output_directory;
899 if (!prefix || !*prefix) {
900 if (output_directory)
901 return output_directory;
902 /* The user did not explicitly ask for "./" */
903 outdir_offset = 2;
904 return "./";
907 outdir_offset = strlen(prefix);
908 if (!output_directory)
909 return prefix;
911 return xstrdup(prefix_filename(prefix, outdir_offset,
912 output_directory));
915 static const char * const builtin_format_patch_usage[] = {
916 N_("git format-patch [options] [<since> | <revision range>]"),
917 NULL
920 static int keep_subject = 0;
922 static int keep_callback(const struct option *opt, const char *arg, int unset)
924 ((struct rev_info *)opt->value)->total = -1;
925 keep_subject = 1;
926 return 0;
929 static int subject_prefix = 0;
931 static int subject_prefix_callback(const struct option *opt, const char *arg,
932 int unset)
934 subject_prefix = 1;
935 ((struct rev_info *)opt->value)->subject_prefix = arg;
936 return 0;
939 static int numbered_cmdline_opt = 0;
941 static int numbered_callback(const struct option *opt, const char *arg,
942 int unset)
944 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
945 if (unset)
946 auto_number = 0;
947 return 0;
950 static int no_numbered_callback(const struct option *opt, const char *arg,
951 int unset)
953 return numbered_callback(opt, arg, 1);
956 static int output_directory_callback(const struct option *opt, const char *arg,
957 int unset)
959 const char **dir = (const char **)opt->value;
960 if (*dir)
961 die(_("Two output directories?"));
962 *dir = arg;
963 return 0;
966 static int thread_callback(const struct option *opt, const char *arg, int unset)
968 int *thread = (int *)opt->value;
969 if (unset)
970 *thread = 0;
971 else if (!arg || !strcmp(arg, "shallow"))
972 *thread = THREAD_SHALLOW;
973 else if (!strcmp(arg, "deep"))
974 *thread = THREAD_DEEP;
975 else
976 return 1;
977 return 0;
980 static int attach_callback(const struct option *opt, const char *arg, int unset)
982 struct rev_info *rev = (struct rev_info *)opt->value;
983 if (unset)
984 rev->mime_boundary = NULL;
985 else if (arg)
986 rev->mime_boundary = arg;
987 else
988 rev->mime_boundary = git_version_string;
989 rev->no_inline = unset ? 0 : 1;
990 return 0;
993 static int inline_callback(const struct option *opt, const char *arg, int unset)
995 struct rev_info *rev = (struct rev_info *)opt->value;
996 if (unset)
997 rev->mime_boundary = NULL;
998 else if (arg)
999 rev->mime_boundary = arg;
1000 else
1001 rev->mime_boundary = git_version_string;
1002 rev->no_inline = 0;
1003 return 0;
1006 static int header_callback(const struct option *opt, const char *arg, int unset)
1008 if (unset) {
1009 string_list_clear(&extra_hdr, 0);
1010 string_list_clear(&extra_to, 0);
1011 string_list_clear(&extra_cc, 0);
1012 } else {
1013 add_header(arg);
1015 return 0;
1018 static int to_callback(const struct option *opt, const char *arg, int unset)
1020 if (unset)
1021 string_list_clear(&extra_to, 0);
1022 else
1023 string_list_append(&extra_to, arg);
1024 return 0;
1027 static int cc_callback(const struct option *opt, const char *arg, int unset)
1029 if (unset)
1030 string_list_clear(&extra_cc, 0);
1031 else
1032 string_list_append(&extra_cc, arg);
1033 return 0;
1036 static char *find_branch_name(struct rev_info *rev)
1038 int i, positive = -1;
1039 unsigned char branch_sha1[20];
1040 const unsigned char *tip_sha1;
1041 const char *ref;
1042 char *full_ref, *branch = NULL;
1044 for (i = 0; i < rev->cmdline.nr; i++) {
1045 if (rev->cmdline.rev[i].flags & UNINTERESTING)
1046 continue;
1047 if (positive < 0)
1048 positive = i;
1049 else
1050 return NULL;
1052 if (0 <= positive) {
1053 ref = rev->cmdline.rev[positive].name;
1054 tip_sha1 = rev->cmdline.rev[positive].item->sha1;
1055 } else if (!rev->cmdline.nr && rev->pending.nr == 1 &&
1056 !strcmp(rev->pending.objects[0].name, "HEAD")) {
1058 * No actual ref from command line, but "HEAD" from
1059 * rev->def was added in setup_revisions()
1060 * e.g. format-patch --cover-letter -12
1062 ref = "HEAD";
1063 tip_sha1 = rev->pending.objects[0].item->sha1;
1064 } else {
1065 return NULL;
1067 if (dwim_ref(ref, strlen(ref), branch_sha1, &full_ref) &&
1068 !prefixcmp(full_ref, "refs/heads/") &&
1069 !hashcmp(tip_sha1, branch_sha1))
1070 branch = xstrdup(full_ref + strlen("refs/heads/"));
1071 free(full_ref);
1072 return branch;
1075 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1077 struct commit *commit;
1078 struct commit **list = NULL;
1079 struct rev_info rev;
1080 struct setup_revision_opt s_r_opt;
1081 int nr = 0, total, i;
1082 int use_stdout = 0;
1083 int start_number = -1;
1084 int just_numbers = 0;
1085 int ignore_if_in_upstream = 0;
1086 int cover_letter = 0;
1087 int boundary_count = 0;
1088 int no_binary_diff = 0;
1089 struct commit *origin = NULL, *head = NULL;
1090 const char *in_reply_to = NULL;
1091 struct patch_ids ids;
1092 struct strbuf buf = STRBUF_INIT;
1093 int use_patch_format = 0;
1094 int quiet = 0;
1095 int reroll_count = -1;
1096 char *branch_name = NULL;
1097 const struct option builtin_format_patch_options[] = {
1098 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
1099 N_("use [PATCH n/m] even with a single patch"),
1100 PARSE_OPT_NOARG, numbered_callback },
1101 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
1102 N_("use [PATCH] even with multiple patches"),
1103 PARSE_OPT_NOARG, no_numbered_callback },
1104 OPT_BOOLEAN('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
1105 OPT_BOOLEAN(0, "stdout", &use_stdout,
1106 N_("print patches to standard out")),
1107 OPT_BOOLEAN(0, "cover-letter", &cover_letter,
1108 N_("generate a cover letter")),
1109 OPT_BOOLEAN(0, "numbered-files", &just_numbers,
1110 N_("use simple number sequence for output file names")),
1111 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1112 N_("use <sfx> instead of '.patch'")),
1113 OPT_INTEGER(0, "start-number", &start_number,
1114 N_("start numbering patches at <n> instead of 1")),
1115 OPT_INTEGER('v', "reroll-count", &reroll_count,
1116 N_("mark the series as Nth re-roll")),
1117 { OPTION_CALLBACK, 0, "subject-prefix", &rev, N_("prefix"),
1118 N_("Use [<prefix>] instead of [PATCH]"),
1119 PARSE_OPT_NONEG, subject_prefix_callback },
1120 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
1121 N_("dir"), N_("store resulting files in <dir>"),
1122 PARSE_OPT_NONEG, output_directory_callback },
1123 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
1124 N_("don't strip/add [PATCH]"),
1125 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
1126 OPT_BOOLEAN(0, "no-binary", &no_binary_diff,
1127 N_("don't output binary diffs")),
1128 OPT_BOOLEAN(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1129 N_("don't include a patch matching a commit upstream")),
1130 { OPTION_BOOLEAN, 'p', "no-stat", &use_patch_format, NULL,
1131 N_("show patch format instead of default (patch + stat)"),
1132 PARSE_OPT_NONEG | PARSE_OPT_NOARG },
1133 OPT_GROUP(N_("Messaging")),
1134 { OPTION_CALLBACK, 0, "add-header", NULL, N_("header"),
1135 N_("add email header"), 0, header_callback },
1136 { OPTION_CALLBACK, 0, "to", NULL, N_("email"), N_("add To: header"),
1137 0, to_callback },
1138 { OPTION_CALLBACK, 0, "cc", NULL, N_("email"), N_("add Cc: header"),
1139 0, cc_callback },
1140 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1141 N_("make first mail a reply to <message-id>")),
1142 { OPTION_CALLBACK, 0, "attach", &rev, N_("boundary"),
1143 N_("attach the patch"), PARSE_OPT_OPTARG,
1144 attach_callback },
1145 { OPTION_CALLBACK, 0, "inline", &rev, N_("boundary"),
1146 N_("inline the patch"),
1147 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1148 inline_callback },
1149 { OPTION_CALLBACK, 0, "thread", &thread, N_("style"),
1150 N_("enable message threading, styles: shallow, deep"),
1151 PARSE_OPT_OPTARG, thread_callback },
1152 OPT_STRING(0, "signature", &signature, N_("signature"),
1153 N_("add a signature")),
1154 OPT_BOOLEAN(0, "quiet", &quiet,
1155 N_("don't print the patch filenames")),
1156 OPT_END()
1159 extra_hdr.strdup_strings = 1;
1160 extra_to.strdup_strings = 1;
1161 extra_cc.strdup_strings = 1;
1162 init_grep_defaults();
1163 git_config(git_format_config, NULL);
1164 init_revisions(&rev, prefix);
1165 rev.commit_format = CMIT_FMT_EMAIL;
1166 rev.verbose_header = 1;
1167 rev.diff = 1;
1168 rev.max_parents = 1;
1169 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
1170 rev.subject_prefix = fmt_patch_subject_prefix;
1171 memset(&s_r_opt, 0, sizeof(s_r_opt));
1172 s_r_opt.def = "HEAD";
1173 s_r_opt.revarg_opt = REVARG_COMMITTISH;
1175 if (default_attach) {
1176 rev.mime_boundary = default_attach;
1177 rev.no_inline = 1;
1181 * Parse the arguments before setup_revisions(), or something
1182 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1183 * possibly a valid SHA1.
1185 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1186 builtin_format_patch_usage,
1187 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1188 PARSE_OPT_KEEP_DASHDASH);
1190 if (0 < reroll_count) {
1191 struct strbuf sprefix = STRBUF_INIT;
1192 strbuf_addf(&sprefix, "%s v%d",
1193 rev.subject_prefix, reroll_count);
1194 rev.reroll_count = reroll_count;
1195 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1198 for (i = 0; i < extra_hdr.nr; i++) {
1199 strbuf_addstr(&buf, extra_hdr.items[i].string);
1200 strbuf_addch(&buf, '\n');
1203 if (extra_to.nr)
1204 strbuf_addstr(&buf, "To: ");
1205 for (i = 0; i < extra_to.nr; i++) {
1206 if (i)
1207 strbuf_addstr(&buf, " ");
1208 strbuf_addstr(&buf, extra_to.items[i].string);
1209 if (i + 1 < extra_to.nr)
1210 strbuf_addch(&buf, ',');
1211 strbuf_addch(&buf, '\n');
1214 if (extra_cc.nr)
1215 strbuf_addstr(&buf, "Cc: ");
1216 for (i = 0; i < extra_cc.nr; i++) {
1217 if (i)
1218 strbuf_addstr(&buf, " ");
1219 strbuf_addstr(&buf, extra_cc.items[i].string);
1220 if (i + 1 < extra_cc.nr)
1221 strbuf_addch(&buf, ',');
1222 strbuf_addch(&buf, '\n');
1225 rev.extra_headers = strbuf_detach(&buf, NULL);
1227 if (start_number < 0)
1228 start_number = 1;
1231 * If numbered is set solely due to format.numbered in config,
1232 * and it would conflict with --keep-subject (-k) from the
1233 * command line, reset "numbered".
1235 if (numbered && keep_subject && !numbered_cmdline_opt)
1236 numbered = 0;
1238 if (numbered && keep_subject)
1239 die (_("-n and -k are mutually exclusive."));
1240 if (keep_subject && subject_prefix)
1241 die (_("--subject-prefix and -k are mutually exclusive."));
1242 rev.preserve_subject = keep_subject;
1244 argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1245 if (argc > 1)
1246 die (_("unrecognized argument: %s"), argv[1]);
1248 if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1249 die(_("--name-only does not make sense"));
1250 if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1251 die(_("--name-status does not make sense"));
1252 if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1253 die(_("--check does not make sense"));
1255 if (!use_patch_format &&
1256 (!rev.diffopt.output_format ||
1257 rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1258 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1260 /* Always generate a patch */
1261 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1263 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
1264 DIFF_OPT_SET(&rev.diffopt, BINARY);
1266 if (rev.show_notes)
1267 init_display_notes(&rev.notes_opt);
1269 if (!use_stdout)
1270 output_directory = set_outdir(prefix, output_directory);
1271 else
1272 setup_pager();
1274 if (output_directory) {
1275 if (use_stdout)
1276 die(_("standard output, or directory, which one?"));
1277 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1278 die_errno(_("Could not create directory '%s'"),
1279 output_directory);
1282 if (rev.pending.nr == 1) {
1283 if (rev.max_count < 0 && !rev.show_root_diff) {
1285 * This is traditional behaviour of "git format-patch
1286 * origin" that prepares what the origin side still
1287 * does not have.
1289 unsigned char sha1[20];
1290 const char *ref;
1292 rev.pending.objects[0].item->flags |= UNINTERESTING;
1293 add_head_to_pending(&rev);
1294 ref = resolve_ref_unsafe("HEAD", sha1, 1, NULL);
1295 if (ref && !prefixcmp(ref, "refs/heads/"))
1296 branch_name = xstrdup(ref + strlen("refs/heads/"));
1297 else
1298 branch_name = xstrdup(""); /* no branch */
1301 * Otherwise, it is "format-patch -22 HEAD", and/or
1302 * "format-patch --root HEAD". The user wants
1303 * get_revision() to do the usual traversal.
1308 * We cannot move this anywhere earlier because we do want to
1309 * know if --root was given explicitly from the command line.
1311 rev.show_root_diff = 1;
1313 if (cover_letter) {
1315 * NEEDSWORK:randomly pick one positive commit to show
1316 * diffstat; this is often the tip and the command
1317 * happens to do the right thing in most cases, but a
1318 * complex command like "--cover-letter a b c ^bottom"
1319 * picks "c" and shows diffstat between bottom..c
1320 * which may not match what the series represents at
1321 * all and totally broken.
1323 int i;
1324 for (i = 0; i < rev.pending.nr; i++) {
1325 struct object *o = rev.pending.objects[i].item;
1326 if (!(o->flags & UNINTERESTING))
1327 head = (struct commit *)o;
1329 /* There is nothing to show; it is not an error, though. */
1330 if (!head)
1331 return 0;
1332 if (!branch_name)
1333 branch_name = find_branch_name(&rev);
1336 if (ignore_if_in_upstream) {
1337 /* Don't say anything if head and upstream are the same. */
1338 if (rev.pending.nr == 2) {
1339 struct object_array_entry *o = rev.pending.objects;
1340 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1341 return 0;
1343 get_patch_ids(&rev, &ids);
1346 if (!use_stdout)
1347 realstdout = xfdopen(xdup(1), "w");
1349 if (prepare_revision_walk(&rev))
1350 die(_("revision walk setup failed"));
1351 rev.boundary = 1;
1352 while ((commit = get_revision(&rev)) != NULL) {
1353 if (commit->object.flags & BOUNDARY) {
1354 boundary_count++;
1355 origin = (boundary_count == 1) ? commit : NULL;
1356 continue;
1359 if (ignore_if_in_upstream &&
1360 has_commit_patch_id(commit, &ids))
1361 continue;
1363 nr++;
1364 list = xrealloc(list, nr * sizeof(list[0]));
1365 list[nr - 1] = commit;
1367 total = nr;
1368 if (!keep_subject && auto_number && total > 1)
1369 numbered = 1;
1370 if (numbered)
1371 rev.total = total + start_number - 1;
1372 if (in_reply_to || thread || cover_letter)
1373 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1374 if (in_reply_to) {
1375 const char *msgid = clean_message_id(in_reply_to);
1376 string_list_append(rev.ref_message_ids, msgid);
1378 rev.numbered_files = just_numbers;
1379 rev.patch_suffix = fmt_patch_suffix;
1380 if (cover_letter) {
1381 if (thread)
1382 gen_message_id(&rev, "cover");
1383 make_cover_letter(&rev, use_stdout,
1384 origin, nr, list, head, branch_name, quiet);
1385 total++;
1386 start_number--;
1388 rev.add_signoff = do_signoff;
1389 while (0 <= --nr) {
1390 int shown;
1391 commit = list[nr];
1392 rev.nr = total - nr + (start_number - 1);
1393 /* Make the second and subsequent mails replies to the first */
1394 if (thread) {
1395 /* Have we already had a message ID? */
1396 if (rev.message_id) {
1398 * For deep threading: make every mail
1399 * a reply to the previous one, no
1400 * matter what other options are set.
1402 * For shallow threading:
1404 * Without --cover-letter and
1405 * --in-reply-to, make every mail a
1406 * reply to the one before.
1408 * With --in-reply-to but no
1409 * --cover-letter, make every mail a
1410 * reply to the <reply-to>.
1412 * With --cover-letter, make every
1413 * mail but the cover letter a reply
1414 * to the cover letter. The cover
1415 * letter is a reply to the
1416 * --in-reply-to, if specified.
1418 if (thread == THREAD_SHALLOW
1419 && rev.ref_message_ids->nr > 0
1420 && (!cover_letter || rev.nr > 1))
1421 free(rev.message_id);
1422 else
1423 string_list_append(rev.ref_message_ids,
1424 rev.message_id);
1426 gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1429 if (!use_stdout &&
1430 reopen_stdout(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
1431 die(_("Failed to create output files"));
1432 shown = log_tree_commit(&rev, commit);
1433 free(commit->buffer);
1434 commit->buffer = NULL;
1436 /* We put one extra blank line between formatted
1437 * patches and this flag is used by log-tree code
1438 * to see if it needs to emit a LF before showing
1439 * the log; when using one file per patch, we do
1440 * not want the extra blank line.
1442 if (!use_stdout)
1443 rev.shown_one = 0;
1444 if (shown) {
1445 if (rev.mime_boundary)
1446 printf("\n--%s%s--\n\n\n",
1447 mime_boundary_leader,
1448 rev.mime_boundary);
1449 else
1450 print_signature();
1452 if (!use_stdout)
1453 fclose(stdout);
1455 free(list);
1456 free(branch_name);
1457 string_list_clear(&extra_to, 0);
1458 string_list_clear(&extra_cc, 0);
1459 string_list_clear(&extra_hdr, 0);
1460 if (ignore_if_in_upstream)
1461 free_patch_ids(&ids);
1462 return 0;
1465 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1467 unsigned char sha1[20];
1468 if (get_sha1(arg, sha1) == 0) {
1469 struct commit *commit = lookup_commit_reference(sha1);
1470 if (commit) {
1471 commit->object.flags |= flags;
1472 add_pending_object(revs, &commit->object, arg);
1473 return 0;
1476 return -1;
1479 static const char * const cherry_usage[] = {
1480 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1481 NULL
1484 static void print_commit(char sign, struct commit *commit, int verbose,
1485 int abbrev)
1487 if (!verbose) {
1488 printf("%c %s\n", sign,
1489 find_unique_abbrev(commit->object.sha1, abbrev));
1490 } else {
1491 struct strbuf buf = STRBUF_INIT;
1492 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
1493 printf("%c %s %s\n", sign,
1494 find_unique_abbrev(commit->object.sha1, abbrev),
1495 buf.buf);
1496 strbuf_release(&buf);
1500 int cmd_cherry(int argc, const char **argv, const char *prefix)
1502 struct rev_info revs;
1503 struct patch_ids ids;
1504 struct commit *commit;
1505 struct commit_list *list = NULL;
1506 struct branch *current_branch;
1507 const char *upstream;
1508 const char *head = "HEAD";
1509 const char *limit = NULL;
1510 int verbose = 0, abbrev = 0;
1512 struct option options[] = {
1513 OPT__ABBREV(&abbrev),
1514 OPT__VERBOSE(&verbose, N_("be verbose")),
1515 OPT_END()
1518 argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
1520 switch (argc) {
1521 case 3:
1522 limit = argv[2];
1523 /* FALLTHROUGH */
1524 case 2:
1525 head = argv[1];
1526 /* FALLTHROUGH */
1527 case 1:
1528 upstream = argv[0];
1529 break;
1530 default:
1531 current_branch = branch_get(NULL);
1532 if (!current_branch || !current_branch->merge
1533 || !current_branch->merge[0]
1534 || !current_branch->merge[0]->dst) {
1535 fprintf(stderr, _("Could not find a tracked"
1536 " remote branch, please"
1537 " specify <upstream> manually.\n"));
1538 usage_with_options(cherry_usage, options);
1541 upstream = current_branch->merge[0]->dst;
1544 init_revisions(&revs, prefix);
1545 revs.max_parents = 1;
1547 if (add_pending_commit(head, &revs, 0))
1548 die(_("Unknown commit %s"), head);
1549 if (add_pending_commit(upstream, &revs, UNINTERESTING))
1550 die(_("Unknown commit %s"), upstream);
1552 /* Don't say anything if head and upstream are the same. */
1553 if (revs.pending.nr == 2) {
1554 struct object_array_entry *o = revs.pending.objects;
1555 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1556 return 0;
1559 get_patch_ids(&revs, &ids);
1561 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1562 die(_("Unknown commit %s"), limit);
1564 /* reverse the list of commits */
1565 if (prepare_revision_walk(&revs))
1566 die(_("revision walk setup failed"));
1567 while ((commit = get_revision(&revs)) != NULL) {
1568 commit_list_insert(commit, &list);
1571 while (list) {
1572 char sign = '+';
1574 commit = list->item;
1575 if (has_commit_patch_id(commit, &ids))
1576 sign = '-';
1577 print_commit(sign, commit, verbose, abbrev);
1578 list = list->next;
1581 free_patch_ids(&ids);
1582 return 0;