add 'git credential' plumbing command
[git/git.git] / builtin / log.c
1 /*
2 * Builtin "git log" and related commands (show, whatchanged)
3 *
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
26 /* Set a default date-time format for git log ("log.date" config variable) */
27 static const char *default_date_mode = NULL;
28
29 static int default_abbrev_commit;
30 static int default_show_root = 1;
31 static int decoration_style;
32 static int decoration_given;
33 static const char *fmt_patch_subject_prefix = "PATCH";
34 static const char *fmt_pretty;
35
36 static const char * const builtin_log_usage[] = {
37 "git log [<options>] [<since>..<until>] [[--] <path>...]\n"
38 " or: git show [options] <object>...",
39 NULL
40 };
41
42 static int parse_decoration_style(const char *var, const char *value)
43 {
44 switch (git_config_maybe_bool(var, value)) {
45 case 1:
46 return DECORATE_SHORT_REFS;
47 case 0:
48 return 0;
49 default:
50 break;
51 }
52 if (!strcmp(value, "full"))
53 return DECORATE_FULL_REFS;
54 else if (!strcmp(value, "short"))
55 return DECORATE_SHORT_REFS;
56 return -1;
57 }
58
59 static int decorate_callback(const struct option *opt, const char *arg, int unset)
60 {
61 if (unset)
62 decoration_style = 0;
63 else if (arg)
64 decoration_style = parse_decoration_style("command line", arg);
65 else
66 decoration_style = DECORATE_SHORT_REFS;
67
68 if (decoration_style < 0)
69 die("invalid --decorate option: %s", arg);
70
71 decoration_given = 1;
72
73 return 0;
74 }
75
76 static void cmd_log_init_defaults(struct rev_info *rev)
77 {
78 if (fmt_pretty)
79 get_commit_format(fmt_pretty, rev);
80 rev->verbose_header = 1;
81 DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
82 rev->diffopt.stat_width = -1; /* use full terminal width */
83 rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
84 rev->abbrev_commit = default_abbrev_commit;
85 rev->show_root_diff = default_show_root;
86 rev->subject_prefix = fmt_patch_subject_prefix;
87 DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
88
89 if (default_date_mode)
90 rev->date_mode = parse_date_format(default_date_mode);
91 }
92
93 static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
94 struct rev_info *rev, struct setup_revision_opt *opt)
95 {
96 struct userformat_want w;
97 int quiet = 0, source = 0;
98
99 const struct option builtin_log_options[] = {
100 OPT_BOOLEAN(0, "quiet", &quiet, "suppress diff output"),
101 OPT_BOOLEAN(0, "source", &source, "show source"),
102 { OPTION_CALLBACK, 0, "decorate", NULL, NULL, "decorate options",
103 PARSE_OPT_OPTARG, decorate_callback},
104 OPT_END()
105 };
106
107 argc = parse_options(argc, argv, prefix,
108 builtin_log_options, builtin_log_usage,
109 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
110 PARSE_OPT_KEEP_DASHDASH);
111
112 argc = setup_revisions(argc, argv, rev, opt);
113 if (quiet)
114 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
115
116 /* Any arguments at this point are not recognized */
117 if (argc > 1)
118 die("unrecognized argument: %s", argv[1]);
119
120 memset(&w, 0, sizeof(w));
121 userformat_find_requirements(NULL, &w);
122
123 if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
124 rev->show_notes = 1;
125 if (rev->show_notes)
126 init_display_notes(&rev->notes_opt);
127
128 if (rev->diffopt.pickaxe || rev->diffopt.filter)
129 rev->always_show_header = 0;
130 if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
131 rev->always_show_header = 0;
132 if (rev->diffopt.pathspec.nr != 1)
133 usage("git logs can only follow renames on one pathname at a time");
134 }
135
136 if (source)
137 rev->show_source = 1;
138
139 if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
140 /*
141 * "log --pretty=raw" is special; ignore UI oriented
142 * configuration variables such as decoration.
143 */
144 if (!decoration_given)
145 decoration_style = 0;
146 if (!rev->abbrev_commit_given)
147 rev->abbrev_commit = 0;
148 }
149
150 if (decoration_style) {
151 rev->show_decorations = 1;
152 load_ref_decorations(decoration_style);
153 }
154 setup_pager();
155 }
156
157 static void cmd_log_init(int argc, const char **argv, const char *prefix,
158 struct rev_info *rev, struct setup_revision_opt *opt)
159 {
160 cmd_log_init_defaults(rev);
161 cmd_log_init_finish(argc, argv, prefix, rev, opt);
162 }
163
164 /*
165 * This gives a rough estimate for how many commits we
166 * will print out in the list.
167 */
168 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
169 {
170 int n = 0;
171
172 while (list) {
173 struct commit *commit = list->item;
174 unsigned int flags = commit->object.flags;
175 list = list->next;
176 if (!(flags & (TREESAME | UNINTERESTING)))
177 n++;
178 }
179 return n;
180 }
181
182 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
183 {
184 if (rev->shown_one) {
185 rev->shown_one = 0;
186 if (rev->commit_format != CMIT_FMT_ONELINE)
187 putchar(rev->diffopt.line_termination);
188 }
189 printf(_("Final output: %d %s\n"), nr, stage);
190 }
191
192 static struct itimerval early_output_timer;
193
194 static void log_show_early(struct rev_info *revs, struct commit_list *list)
195 {
196 int i = revs->early_output;
197 int show_header = 1;
198
199 sort_in_topological_order(&list, revs->lifo);
200 while (list && i) {
201 struct commit *commit = list->item;
202 switch (simplify_commit(revs, commit)) {
203 case commit_show:
204 if (show_header) {
205 int n = estimate_commit_count(revs, list);
206 show_early_header(revs, "incomplete", n);
207 show_header = 0;
208 }
209 log_tree_commit(revs, commit);
210 i--;
211 break;
212 case commit_ignore:
213 break;
214 case commit_error:
215 return;
216 }
217 list = list->next;
218 }
219
220 /* Did we already get enough commits for the early output? */
221 if (!i)
222 return;
223
224 /*
225 * ..if no, then repeat it twice a second until we
226 * do.
227 *
228 * NOTE! We don't use "it_interval", because if the
229 * reader isn't listening, we want our output to be
230 * throttled by the writing, and not have the timer
231 * trigger every second even if we're blocked on a
232 * reader!
233 */
234 early_output_timer.it_value.tv_sec = 0;
235 early_output_timer.it_value.tv_usec = 500000;
236 setitimer(ITIMER_REAL, &early_output_timer, NULL);
237 }
238
239 static void early_output(int signal)
240 {
241 show_early_output = log_show_early;
242 }
243
244 static void setup_early_output(struct rev_info *rev)
245 {
246 struct sigaction sa;
247
248 /*
249 * Set up the signal handler, minimally intrusively:
250 * we only set a single volatile integer word (not
251 * using sigatomic_t - trying to avoid unnecessary
252 * system dependencies and headers), and using
253 * SA_RESTART.
254 */
255 memset(&sa, 0, sizeof(sa));
256 sa.sa_handler = early_output;
257 sigemptyset(&sa.sa_mask);
258 sa.sa_flags = SA_RESTART;
259 sigaction(SIGALRM, &sa, NULL);
260
261 /*
262 * If we can get the whole output in less than a
263 * tenth of a second, don't even bother doing the
264 * early-output thing..
265 *
266 * This is a one-time-only trigger.
267 */
268 early_output_timer.it_value.tv_sec = 0;
269 early_output_timer.it_value.tv_usec = 100000;
270 setitimer(ITIMER_REAL, &early_output_timer, NULL);
271 }
272
273 static void finish_early_output(struct rev_info *rev)
274 {
275 int n = estimate_commit_count(rev, rev->commits);
276 signal(SIGALRM, SIG_IGN);
277 show_early_header(rev, "done", n);
278 }
279
280 static int cmd_log_walk(struct rev_info *rev)
281 {
282 struct commit *commit;
283 int saved_nrl = 0;
284 int saved_dcctc = 0;
285
286 if (rev->early_output)
287 setup_early_output(rev);
288
289 if (prepare_revision_walk(rev))
290 die(_("revision walk setup failed"));
291
292 if (rev->early_output)
293 finish_early_output(rev);
294
295 /*
296 * For --check and --exit-code, the exit code is based on CHECK_FAILED
297 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
298 * retain that state information if replacing rev->diffopt in this loop
299 */
300 while ((commit = get_revision(rev)) != NULL) {
301 if (!log_tree_commit(rev, commit) &&
302 rev->max_count >= 0)
303 /*
304 * We decremented max_count in get_revision,
305 * but we didn't actually show the commit.
306 */
307 rev->max_count++;
308 if (!rev->reflog_info) {
309 /* we allow cycles in reflog ancestry */
310 free(commit->buffer);
311 commit->buffer = NULL;
312 }
313 free_commit_list(commit->parents);
314 commit->parents = NULL;
315 if (saved_nrl < rev->diffopt.needed_rename_limit)
316 saved_nrl = rev->diffopt.needed_rename_limit;
317 if (rev->diffopt.degraded_cc_to_c)
318 saved_dcctc = 1;
319 }
320 rev->diffopt.degraded_cc_to_c = saved_dcctc;
321 rev->diffopt.needed_rename_limit = saved_nrl;
322
323 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
324 DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
325 return 02;
326 }
327 return diff_result_code(&rev->diffopt, 0);
328 }
329
330 static int git_log_config(const char *var, const char *value, void *cb)
331 {
332 if (!strcmp(var, "format.pretty"))
333 return git_config_string(&fmt_pretty, var, value);
334 if (!strcmp(var, "format.subjectprefix"))
335 return git_config_string(&fmt_patch_subject_prefix, var, value);
336 if (!strcmp(var, "log.abbrevcommit")) {
337 default_abbrev_commit = git_config_bool(var, value);
338 return 0;
339 }
340 if (!strcmp(var, "log.date"))
341 return git_config_string(&default_date_mode, var, value);
342 if (!strcmp(var, "log.decorate")) {
343 decoration_style = parse_decoration_style(var, value);
344 if (decoration_style < 0)
345 decoration_style = 0; /* maybe warn? */
346 return 0;
347 }
348 if (!strcmp(var, "log.showroot")) {
349 default_show_root = git_config_bool(var, value);
350 return 0;
351 }
352 if (!prefixcmp(var, "color.decorate."))
353 return parse_decorate_color_config(var, 15, value);
354
355 return git_diff_ui_config(var, value, cb);
356 }
357
358 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
359 {
360 struct rev_info rev;
361 struct setup_revision_opt opt;
362
363 git_config(git_log_config, NULL);
364
365 init_revisions(&rev, prefix);
366 rev.diff = 1;
367 rev.simplify_history = 0;
368 memset(&opt, 0, sizeof(opt));
369 opt.def = "HEAD";
370 cmd_log_init(argc, argv, prefix, &rev, &opt);
371 if (!rev.diffopt.output_format)
372 rev.diffopt.output_format = DIFF_FORMAT_RAW;
373 return cmd_log_walk(&rev);
374 }
375
376 static void show_tagger(char *buf, int len, struct rev_info *rev)
377 {
378 struct strbuf out = STRBUF_INIT;
379 struct pretty_print_context pp = {0};
380
381 pp.fmt = rev->commit_format;
382 pp.date_mode = rev->date_mode;
383 pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
384 printf("%s", out.buf);
385 strbuf_release(&out);
386 }
387
388 static int show_blob_object(const unsigned char *sha1, struct rev_info *rev)
389 {
390 fflush(stdout);
391 return stream_blob_to_fd(1, sha1, NULL, 0);
392 }
393
394 static int show_tag_object(const unsigned char *sha1, struct rev_info *rev)
395 {
396 unsigned long size;
397 enum object_type type;
398 char *buf = read_sha1_file(sha1, &type, &size);
399 int offset = 0;
400
401 if (!buf)
402 return error(_("Could not read object %s"), sha1_to_hex(sha1));
403
404 assert(type == OBJ_TAG);
405 while (offset < size && buf[offset] != '\n') {
406 int new_offset = offset + 1;
407 while (new_offset < size && buf[new_offset++] != '\n')
408 ; /* do nothing */
409 if (!prefixcmp(buf + offset, "tagger "))
410 show_tagger(buf + offset + 7,
411 new_offset - offset - 7, rev);
412 offset = new_offset;
413 }
414
415 if (offset < size)
416 fwrite(buf + offset, size - offset, 1, stdout);
417 free(buf);
418 return 0;
419 }
420
421 static int show_tree_object(const unsigned char *sha1,
422 const char *base, int baselen,
423 const char *pathname, unsigned mode, int stage, void *context)
424 {
425 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
426 return 0;
427 }
428
429 static void show_rev_tweak_rev(struct rev_info *rev, struct setup_revision_opt *opt)
430 {
431 if (rev->ignore_merges) {
432 /* There was no "-m" on the command line */
433 rev->ignore_merges = 0;
434 if (!rev->first_parent_only && !rev->combine_merges) {
435 /* No "--first-parent", "-c", nor "--cc" */
436 rev->combine_merges = 1;
437 rev->dense_combined_merges = 1;
438 }
439 }
440 if (!rev->diffopt.output_format)
441 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
442 }
443
444 int cmd_show(int argc, const char **argv, const char *prefix)
445 {
446 struct rev_info rev;
447 struct object_array_entry *objects;
448 struct setup_revision_opt opt;
449 struct pathspec match_all;
450 int i, count, ret = 0;
451
452 git_config(git_log_config, NULL);
453
454 init_pathspec(&match_all, NULL);
455 init_revisions(&rev, prefix);
456 rev.diff = 1;
457 rev.always_show_header = 1;
458 rev.no_walk = 1;
459 rev.diffopt.stat_width = -1; /* Scale to real terminal size */
460
461 memset(&opt, 0, sizeof(opt));
462 opt.def = "HEAD";
463 opt.tweak = show_rev_tweak_rev;
464 cmd_log_init(argc, argv, prefix, &rev, &opt);
465
466 count = rev.pending.nr;
467 objects = rev.pending.objects;
468 for (i = 0; i < count && !ret; i++) {
469 struct object *o = objects[i].item;
470 const char *name = objects[i].name;
471 switch (o->type) {
472 case OBJ_BLOB:
473 ret = show_blob_object(o->sha1, NULL);
474 break;
475 case OBJ_TAG: {
476 struct tag *t = (struct tag *)o;
477
478 if (rev.shown_one)
479 putchar('\n');
480 printf("%stag %s%s\n",
481 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
482 t->tag,
483 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
484 ret = show_tag_object(o->sha1, &rev);
485 rev.shown_one = 1;
486 if (ret)
487 break;
488 o = parse_object(t->tagged->sha1);
489 if (!o)
490 ret = error(_("Could not read object %s"),
491 sha1_to_hex(t->tagged->sha1));
492 objects[i].item = o;
493 i--;
494 break;
495 }
496 case OBJ_TREE:
497 if (rev.shown_one)
498 putchar('\n');
499 printf("%stree %s%s\n\n",
500 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
501 name,
502 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
503 read_tree_recursive((struct tree *)o, "", 0, 0, &match_all,
504 show_tree_object, NULL);
505 rev.shown_one = 1;
506 break;
507 case OBJ_COMMIT:
508 rev.pending.nr = rev.pending.alloc = 0;
509 rev.pending.objects = NULL;
510 add_object_array(o, name, &rev.pending);
511 ret = cmd_log_walk(&rev);
512 break;
513 default:
514 ret = error(_("Unknown type: %d"), o->type);
515 }
516 }
517 free(objects);
518 return ret;
519 }
520
521 /*
522 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
523 */
524 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
525 {
526 struct rev_info rev;
527 struct setup_revision_opt opt;
528
529 git_config(git_log_config, NULL);
530
531 init_revisions(&rev, prefix);
532 init_reflog_walk(&rev.reflog_info);
533 rev.verbose_header = 1;
534 memset(&opt, 0, sizeof(opt));
535 opt.def = "HEAD";
536 cmd_log_init_defaults(&rev);
537 rev.abbrev_commit = 1;
538 rev.commit_format = CMIT_FMT_ONELINE;
539 rev.use_terminator = 1;
540 rev.always_show_header = 1;
541 cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
542
543 return cmd_log_walk(&rev);
544 }
545
546 int cmd_log(int argc, const char **argv, const char *prefix)
547 {
548 struct rev_info rev;
549 struct setup_revision_opt opt;
550
551 git_config(git_log_config, NULL);
552
553 init_revisions(&rev, prefix);
554 rev.always_show_header = 1;
555 memset(&opt, 0, sizeof(opt));
556 opt.def = "HEAD";
557 cmd_log_init(argc, argv, prefix, &rev, &opt);
558 return cmd_log_walk(&rev);
559 }
560
561 /* format-patch */
562
563 static const char *fmt_patch_suffix = ".patch";
564 static int numbered = 0;
565 static int auto_number = 1;
566
567 static char *default_attach = NULL;
568
569 static struct string_list extra_hdr;
570 static struct string_list extra_to;
571 static struct string_list extra_cc;
572
573 static void add_header(const char *value)
574 {
575 struct string_list_item *item;
576 int len = strlen(value);
577 while (len && value[len - 1] == '\n')
578 len--;
579
580 if (!strncasecmp(value, "to: ", 4)) {
581 item = string_list_append(&extra_to, value + 4);
582 len -= 4;
583 } else if (!strncasecmp(value, "cc: ", 4)) {
584 item = string_list_append(&extra_cc, value + 4);
585 len -= 4;
586 } else {
587 item = string_list_append(&extra_hdr, value);
588 }
589
590 item->string[len] = '\0';
591 }
592
593 #define THREAD_SHALLOW 1
594 #define THREAD_DEEP 2
595 static int thread;
596 static int do_signoff;
597 static const char *signature = git_version_string;
598
599 static int git_format_config(const char *var, const char *value, void *cb)
600 {
601 if (!strcmp(var, "format.headers")) {
602 if (!value)
603 die(_("format.headers without value"));
604 add_header(value);
605 return 0;
606 }
607 if (!strcmp(var, "format.suffix"))
608 return git_config_string(&fmt_patch_suffix, var, value);
609 if (!strcmp(var, "format.to")) {
610 if (!value)
611 return config_error_nonbool(var);
612 string_list_append(&extra_to, value);
613 return 0;
614 }
615 if (!strcmp(var, "format.cc")) {
616 if (!value)
617 return config_error_nonbool(var);
618 string_list_append(&extra_cc, value);
619 return 0;
620 }
621 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
622 !strcmp(var, "color.ui")) {
623 return 0;
624 }
625 if (!strcmp(var, "format.numbered")) {
626 if (value && !strcasecmp(value, "auto")) {
627 auto_number = 1;
628 return 0;
629 }
630 numbered = git_config_bool(var, value);
631 auto_number = auto_number && numbered;
632 return 0;
633 }
634 if (!strcmp(var, "format.attach")) {
635 if (value && *value)
636 default_attach = xstrdup(value);
637 else
638 default_attach = xstrdup(git_version_string);
639 return 0;
640 }
641 if (!strcmp(var, "format.thread")) {
642 if (value && !strcasecmp(value, "deep")) {
643 thread = THREAD_DEEP;
644 return 0;
645 }
646 if (value && !strcasecmp(value, "shallow")) {
647 thread = THREAD_SHALLOW;
648 return 0;
649 }
650 thread = git_config_bool(var, value) && THREAD_SHALLOW;
651 return 0;
652 }
653 if (!strcmp(var, "format.signoff")) {
654 do_signoff = git_config_bool(var, value);
655 return 0;
656 }
657 if (!strcmp(var, "format.signature"))
658 return git_config_string(&signature, var, value);
659
660 return git_log_config(var, value, cb);
661 }
662
663 static FILE *realstdout = NULL;
664 static const char *output_directory = NULL;
665 static int outdir_offset;
666
667 static int reopen_stdout(struct commit *commit, const char *subject,
668 struct rev_info *rev, int quiet)
669 {
670 struct strbuf filename = STRBUF_INIT;
671 int suffix_len = strlen(fmt_patch_suffix) + 1;
672
673 if (output_directory) {
674 strbuf_addstr(&filename, output_directory);
675 if (filename.len >=
676 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
677 return error(_("name of output directory is too long"));
678 if (filename.buf[filename.len - 1] != '/')
679 strbuf_addch(&filename, '/');
680 }
681
682 get_patch_filename(commit, subject, rev->nr, fmt_patch_suffix, &filename);
683
684 if (!quiet)
685 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
686
687 if (freopen(filename.buf, "w", stdout) == NULL)
688 return error(_("Cannot open patch file %s"), filename.buf);
689
690 strbuf_release(&filename);
691 return 0;
692 }
693
694 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids, const char *prefix)
695 {
696 struct rev_info check_rev;
697 struct commit *commit;
698 struct object *o1, *o2;
699 unsigned flags1, flags2;
700
701 if (rev->pending.nr != 2)
702 die(_("Need exactly one range."));
703
704 o1 = rev->pending.objects[0].item;
705 flags1 = o1->flags;
706 o2 = rev->pending.objects[1].item;
707 flags2 = o2->flags;
708
709 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
710 die(_("Not a range."));
711
712 init_patch_ids(ids);
713
714 /* given a range a..b get all patch ids for b..a */
715 init_revisions(&check_rev, prefix);
716 o1->flags ^= UNINTERESTING;
717 o2->flags ^= UNINTERESTING;
718 add_pending_object(&check_rev, o1, "o1");
719 add_pending_object(&check_rev, o2, "o2");
720 if (prepare_revision_walk(&check_rev))
721 die(_("revision walk setup failed"));
722
723 while ((commit = get_revision(&check_rev)) != NULL) {
724 /* ignore merges */
725 if (commit->parents && commit->parents->next)
726 continue;
727
728 add_commit_patch_id(commit, ids);
729 }
730
731 /* reset for next revision walk */
732 clear_commit_marks((struct commit *)o1,
733 SEEN | UNINTERESTING | SHOWN | ADDED);
734 clear_commit_marks((struct commit *)o2,
735 SEEN | UNINTERESTING | SHOWN | ADDED);
736 o1->flags = flags1;
737 o2->flags = flags2;
738 }
739
740 static void gen_message_id(struct rev_info *info, char *base)
741 {
742 struct strbuf buf = STRBUF_INIT;
743 strbuf_addf(&buf, "%s.%lu.git.%s", base,
744 (unsigned long) time(NULL),
745 git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
746 info->message_id = strbuf_detach(&buf, NULL);
747 }
748
749 static void print_signature(void)
750 {
751 if (signature && *signature)
752 printf("-- \n%s\n\n", signature);
753 }
754
755 static void add_branch_description(struct strbuf *buf, const char *branch_name)
756 {
757 struct strbuf desc = STRBUF_INIT;
758 if (!branch_name || !*branch_name)
759 return;
760 read_branch_desc(&desc, branch_name);
761 if (desc.len) {
762 strbuf_addch(buf, '\n');
763 strbuf_add(buf, desc.buf, desc.len);
764 strbuf_addch(buf, '\n');
765 }
766 }
767
768 static void make_cover_letter(struct rev_info *rev, int use_stdout,
769 int numbered, int numbered_files,
770 struct commit *origin,
771 int nr, struct commit **list, struct commit *head,
772 const char *branch_name,
773 int quiet)
774 {
775 const char *committer;
776 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
777 const char *msg;
778 struct shortlog log;
779 struct strbuf sb = STRBUF_INIT;
780 int i;
781 const char *encoding = "UTF-8";
782 struct diff_options opts;
783 int need_8bit_cte = 0;
784 struct pretty_print_context pp = {0};
785
786 if (rev->commit_format != CMIT_FMT_EMAIL)
787 die(_("Cover letter needs email format"));
788
789 committer = git_committer_info(0);
790
791 if (!use_stdout &&
792 reopen_stdout(NULL, numbered_files ? NULL : "cover-letter", rev, quiet))
793 return;
794
795 log_write_email_headers(rev, head, &pp.subject, &pp.after_subject,
796 &need_8bit_cte);
797
798 for (i = 0; !need_8bit_cte && i < nr; i++)
799 if (has_non_ascii(list[i]->buffer))
800 need_8bit_cte = 1;
801
802 msg = body;
803 pp.fmt = CMIT_FMT_EMAIL;
804 pp.date_mode = DATE_RFC2822;
805 pp_user_info(&pp, NULL, &sb, committer, encoding);
806 pp_title_line(&pp, &msg, &sb, encoding, need_8bit_cte);
807 pp_remainder(&pp, &msg, &sb, 0);
808 add_branch_description(&sb, branch_name);
809 printf("%s\n", sb.buf);
810
811 strbuf_release(&sb);
812
813 shortlog_init(&log);
814 log.wrap_lines = 1;
815 log.wrap = 72;
816 log.in1 = 2;
817 log.in2 = 4;
818 for (i = 0; i < nr; i++)
819 shortlog_add_commit(&log, list[i]);
820
821 shortlog_output(&log);
822
823 /*
824 * We can only do diffstat with a unique reference point
825 */
826 if (!origin)
827 return;
828
829 memcpy(&opts, &rev->diffopt, sizeof(opts));
830 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
831
832 diff_setup_done(&opts);
833
834 diff_tree_sha1(origin->tree->object.sha1,
835 head->tree->object.sha1,
836 "", &opts);
837 diffcore_std(&opts);
838 diff_flush(&opts);
839
840 printf("\n");
841 print_signature();
842 }
843
844 static const char *clean_message_id(const char *msg_id)
845 {
846 char ch;
847 const char *a, *z, *m;
848
849 m = msg_id;
850 while ((ch = *m) && (isspace(ch) || (ch == '<')))
851 m++;
852 a = m;
853 z = NULL;
854 while ((ch = *m)) {
855 if (!isspace(ch) && (ch != '>'))
856 z = m;
857 m++;
858 }
859 if (!z)
860 die(_("insane in-reply-to: %s"), msg_id);
861 if (++z == m)
862 return a;
863 return xmemdupz(a, z - a);
864 }
865
866 static const char *set_outdir(const char *prefix, const char *output_directory)
867 {
868 if (output_directory && is_absolute_path(output_directory))
869 return output_directory;
870
871 if (!prefix || !*prefix) {
872 if (output_directory)
873 return output_directory;
874 /* The user did not explicitly ask for "./" */
875 outdir_offset = 2;
876 return "./";
877 }
878
879 outdir_offset = strlen(prefix);
880 if (!output_directory)
881 return prefix;
882
883 return xstrdup(prefix_filename(prefix, outdir_offset,
884 output_directory));
885 }
886
887 static const char * const builtin_format_patch_usage[] = {
888 "git format-patch [options] [<since> | <revision range>]",
889 NULL
890 };
891
892 static int keep_subject = 0;
893
894 static int keep_callback(const struct option *opt, const char *arg, int unset)
895 {
896 ((struct rev_info *)opt->value)->total = -1;
897 keep_subject = 1;
898 return 0;
899 }
900
901 static int subject_prefix = 0;
902
903 static int subject_prefix_callback(const struct option *opt, const char *arg,
904 int unset)
905 {
906 subject_prefix = 1;
907 ((struct rev_info *)opt->value)->subject_prefix = arg;
908 return 0;
909 }
910
911 static int numbered_cmdline_opt = 0;
912
913 static int numbered_callback(const struct option *opt, const char *arg,
914 int unset)
915 {
916 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
917 if (unset)
918 auto_number = 0;
919 return 0;
920 }
921
922 static int no_numbered_callback(const struct option *opt, const char *arg,
923 int unset)
924 {
925 return numbered_callback(opt, arg, 1);
926 }
927
928 static int output_directory_callback(const struct option *opt, const char *arg,
929 int unset)
930 {
931 const char **dir = (const char **)opt->value;
932 if (*dir)
933 die(_("Two output directories?"));
934 *dir = arg;
935 return 0;
936 }
937
938 static int thread_callback(const struct option *opt, const char *arg, int unset)
939 {
940 int *thread = (int *)opt->value;
941 if (unset)
942 *thread = 0;
943 else if (!arg || !strcmp(arg, "shallow"))
944 *thread = THREAD_SHALLOW;
945 else if (!strcmp(arg, "deep"))
946 *thread = THREAD_DEEP;
947 else
948 return 1;
949 return 0;
950 }
951
952 static int attach_callback(const struct option *opt, const char *arg, int unset)
953 {
954 struct rev_info *rev = (struct rev_info *)opt->value;
955 if (unset)
956 rev->mime_boundary = NULL;
957 else if (arg)
958 rev->mime_boundary = arg;
959 else
960 rev->mime_boundary = git_version_string;
961 rev->no_inline = unset ? 0 : 1;
962 return 0;
963 }
964
965 static int inline_callback(const struct option *opt, const char *arg, int unset)
966 {
967 struct rev_info *rev = (struct rev_info *)opt->value;
968 if (unset)
969 rev->mime_boundary = NULL;
970 else if (arg)
971 rev->mime_boundary = arg;
972 else
973 rev->mime_boundary = git_version_string;
974 rev->no_inline = 0;
975 return 0;
976 }
977
978 static int header_callback(const struct option *opt, const char *arg, int unset)
979 {
980 if (unset) {
981 string_list_clear(&extra_hdr, 0);
982 string_list_clear(&extra_to, 0);
983 string_list_clear(&extra_cc, 0);
984 } else {
985 add_header(arg);
986 }
987 return 0;
988 }
989
990 static int to_callback(const struct option *opt, const char *arg, int unset)
991 {
992 if (unset)
993 string_list_clear(&extra_to, 0);
994 else
995 string_list_append(&extra_to, arg);
996 return 0;
997 }
998
999 static int cc_callback(const struct option *opt, const char *arg, int unset)
1000 {
1001 if (unset)
1002 string_list_clear(&extra_cc, 0);
1003 else
1004 string_list_append(&extra_cc, arg);
1005 return 0;
1006 }
1007
1008 static char *find_branch_name(struct rev_info *rev)
1009 {
1010 int i, positive = -1;
1011 unsigned char branch_sha1[20];
1012 struct strbuf buf = STRBUF_INIT;
1013 const char *branch;
1014
1015 for (i = 0; i < rev->cmdline.nr; i++) {
1016 if (rev->cmdline.rev[i].flags & UNINTERESTING)
1017 continue;
1018 if (positive < 0)
1019 positive = i;
1020 else
1021 return NULL;
1022 }
1023 if (positive < 0)
1024 return NULL;
1025 strbuf_addf(&buf, "refs/heads/%s", rev->cmdline.rev[positive].name);
1026 branch = resolve_ref_unsafe(buf.buf, branch_sha1, 1, NULL);
1027 if (!branch ||
1028 prefixcmp(branch, "refs/heads/") ||
1029 hashcmp(rev->cmdline.rev[positive].item->sha1, branch_sha1))
1030 branch = NULL;
1031 strbuf_release(&buf);
1032 if (branch)
1033 return xstrdup(rev->cmdline.rev[positive].name);
1034 return NULL;
1035 }
1036
1037 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1038 {
1039 struct commit *commit;
1040 struct commit **list = NULL;
1041 struct rev_info rev;
1042 struct setup_revision_opt s_r_opt;
1043 int nr = 0, total, i;
1044 int use_stdout = 0;
1045 int start_number = -1;
1046 int numbered_files = 0; /* _just_ numbers */
1047 int ignore_if_in_upstream = 0;
1048 int cover_letter = 0;
1049 int boundary_count = 0;
1050 int no_binary_diff = 0;
1051 struct commit *origin = NULL, *head = NULL;
1052 const char *in_reply_to = NULL;
1053 struct patch_ids ids;
1054 char *add_signoff = NULL;
1055 struct strbuf buf = STRBUF_INIT;
1056 int use_patch_format = 0;
1057 int quiet = 0;
1058 char *branch_name = NULL;
1059 const struct option builtin_format_patch_options[] = {
1060 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
1061 "use [PATCH n/m] even with a single patch",
1062 PARSE_OPT_NOARG, numbered_callback },
1063 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
1064 "use [PATCH] even with multiple patches",
1065 PARSE_OPT_NOARG, no_numbered_callback },
1066 OPT_BOOLEAN('s', "signoff", &do_signoff, "add Signed-off-by:"),
1067 OPT_BOOLEAN(0, "stdout", &use_stdout,
1068 "print patches to standard out"),
1069 OPT_BOOLEAN(0, "cover-letter", &cover_letter,
1070 "generate a cover letter"),
1071 OPT_BOOLEAN(0, "numbered-files", &numbered_files,
1072 "use simple number sequence for output file names"),
1073 OPT_STRING(0, "suffix", &fmt_patch_suffix, "sfx",
1074 "use <sfx> instead of '.patch'"),
1075 OPT_INTEGER(0, "start-number", &start_number,
1076 "start numbering patches at <n> instead of 1"),
1077 { OPTION_CALLBACK, 0, "subject-prefix", &rev, "prefix",
1078 "Use [<prefix>] instead of [PATCH]",
1079 PARSE_OPT_NONEG, subject_prefix_callback },
1080 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
1081 "dir", "store resulting files in <dir>",
1082 PARSE_OPT_NONEG, output_directory_callback },
1083 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
1084 "don't strip/add [PATCH]",
1085 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
1086 OPT_BOOLEAN(0, "no-binary", &no_binary_diff,
1087 "don't output binary diffs"),
1088 OPT_BOOLEAN(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1089 "don't include a patch matching a commit upstream"),
1090 { OPTION_BOOLEAN, 'p', "no-stat", &use_patch_format, NULL,
1091 "show patch format instead of default (patch + stat)",
1092 PARSE_OPT_NONEG | PARSE_OPT_NOARG },
1093 OPT_GROUP("Messaging"),
1094 { OPTION_CALLBACK, 0, "add-header", NULL, "header",
1095 "add email header", 0, header_callback },
1096 { OPTION_CALLBACK, 0, "to", NULL, "email", "add To: header",
1097 0, to_callback },
1098 { OPTION_CALLBACK, 0, "cc", NULL, "email", "add Cc: header",
1099 0, cc_callback },
1100 OPT_STRING(0, "in-reply-to", &in_reply_to, "message-id",
1101 "make first mail a reply to <message-id>"),
1102 { OPTION_CALLBACK, 0, "attach", &rev, "boundary",
1103 "attach the patch", PARSE_OPT_OPTARG,
1104 attach_callback },
1105 { OPTION_CALLBACK, 0, "inline", &rev, "boundary",
1106 "inline the patch",
1107 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1108 inline_callback },
1109 { OPTION_CALLBACK, 0, "thread", &thread, "style",
1110 "enable message threading, styles: shallow, deep",
1111 PARSE_OPT_OPTARG, thread_callback },
1112 OPT_STRING(0, "signature", &signature, "signature",
1113 "add a signature"),
1114 OPT_BOOLEAN(0, "quiet", &quiet,
1115 "don't print the patch filenames"),
1116 OPT_END()
1117 };
1118
1119 extra_hdr.strdup_strings = 1;
1120 extra_to.strdup_strings = 1;
1121 extra_cc.strdup_strings = 1;
1122 git_config(git_format_config, NULL);
1123 init_revisions(&rev, prefix);
1124 rev.commit_format = CMIT_FMT_EMAIL;
1125 rev.verbose_header = 1;
1126 rev.diff = 1;
1127 rev.max_parents = 1;
1128 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
1129 rev.subject_prefix = fmt_patch_subject_prefix;
1130 memset(&s_r_opt, 0, sizeof(s_r_opt));
1131 s_r_opt.def = "HEAD";
1132
1133 if (default_attach) {
1134 rev.mime_boundary = default_attach;
1135 rev.no_inline = 1;
1136 }
1137
1138 /*
1139 * Parse the arguments before setup_revisions(), or something
1140 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1141 * possibly a valid SHA1.
1142 */
1143 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1144 builtin_format_patch_usage,
1145 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1146 PARSE_OPT_KEEP_DASHDASH);
1147
1148 if (do_signoff) {
1149 const char *committer;
1150 const char *endpos;
1151 committer = git_committer_info(IDENT_STRICT);
1152 endpos = strchr(committer, '>');
1153 if (!endpos)
1154 die(_("bogus committer info %s"), committer);
1155 add_signoff = xmemdupz(committer, endpos - committer + 1);
1156 }
1157
1158 for (i = 0; i < extra_hdr.nr; i++) {
1159 strbuf_addstr(&buf, extra_hdr.items[i].string);
1160 strbuf_addch(&buf, '\n');
1161 }
1162
1163 if (extra_to.nr)
1164 strbuf_addstr(&buf, "To: ");
1165 for (i = 0; i < extra_to.nr; i++) {
1166 if (i)
1167 strbuf_addstr(&buf, " ");
1168 strbuf_addstr(&buf, extra_to.items[i].string);
1169 if (i + 1 < extra_to.nr)
1170 strbuf_addch(&buf, ',');
1171 strbuf_addch(&buf, '\n');
1172 }
1173
1174 if (extra_cc.nr)
1175 strbuf_addstr(&buf, "Cc: ");
1176 for (i = 0; i < extra_cc.nr; i++) {
1177 if (i)
1178 strbuf_addstr(&buf, " ");
1179 strbuf_addstr(&buf, extra_cc.items[i].string);
1180 if (i + 1 < extra_cc.nr)
1181 strbuf_addch(&buf, ',');
1182 strbuf_addch(&buf, '\n');
1183 }
1184
1185 rev.extra_headers = strbuf_detach(&buf, NULL);
1186
1187 if (start_number < 0)
1188 start_number = 1;
1189
1190 /*
1191 * If numbered is set solely due to format.numbered in config,
1192 * and it would conflict with --keep-subject (-k) from the
1193 * command line, reset "numbered".
1194 */
1195 if (numbered && keep_subject && !numbered_cmdline_opt)
1196 numbered = 0;
1197
1198 if (numbered && keep_subject)
1199 die (_("-n and -k are mutually exclusive."));
1200 if (keep_subject && subject_prefix)
1201 die (_("--subject-prefix and -k are mutually exclusive."));
1202 rev.preserve_subject = keep_subject;
1203
1204 argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1205 if (argc > 1)
1206 die (_("unrecognized argument: %s"), argv[1]);
1207
1208 if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1209 die(_("--name-only does not make sense"));
1210 if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1211 die(_("--name-status does not make sense"));
1212 if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1213 die(_("--check does not make sense"));
1214
1215 if (!use_patch_format &&
1216 (!rev.diffopt.output_format ||
1217 rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1218 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1219
1220 /* Always generate a patch */
1221 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1222
1223 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
1224 DIFF_OPT_SET(&rev.diffopt, BINARY);
1225
1226 if (rev.show_notes)
1227 init_display_notes(&rev.notes_opt);
1228
1229 if (!use_stdout)
1230 output_directory = set_outdir(prefix, output_directory);
1231 else
1232 setup_pager();
1233
1234 if (output_directory) {
1235 if (use_stdout)
1236 die(_("standard output, or directory, which one?"));
1237 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1238 die_errno(_("Could not create directory '%s'"),
1239 output_directory);
1240 }
1241
1242 if (rev.pending.nr == 1) {
1243 if (rev.max_count < 0 && !rev.show_root_diff) {
1244 /*
1245 * This is traditional behaviour of "git format-patch
1246 * origin" that prepares what the origin side still
1247 * does not have.
1248 */
1249 unsigned char sha1[20];
1250 const char *ref;
1251
1252 rev.pending.objects[0].item->flags |= UNINTERESTING;
1253 add_head_to_pending(&rev);
1254 ref = resolve_ref_unsafe("HEAD", sha1, 1, NULL);
1255 if (ref && !prefixcmp(ref, "refs/heads/"))
1256 branch_name = xstrdup(ref + strlen("refs/heads/"));
1257 else
1258 branch_name = xstrdup(""); /* no branch */
1259 }
1260 /*
1261 * Otherwise, it is "format-patch -22 HEAD", and/or
1262 * "format-patch --root HEAD". The user wants
1263 * get_revision() to do the usual traversal.
1264 */
1265 }
1266
1267 /*
1268 * We cannot move this anywhere earlier because we do want to
1269 * know if --root was given explicitly from the command line.
1270 */
1271 rev.show_root_diff = 1;
1272
1273 if (cover_letter) {
1274 /*
1275 * NEEDSWORK:randomly pick one positive commit to show
1276 * diffstat; this is often the tip and the command
1277 * happens to do the right thing in most cases, but a
1278 * complex command like "--cover-letter a b c ^bottom"
1279 * picks "c" and shows diffstat between bottom..c
1280 * which may not match what the series represents at
1281 * all and totally broken.
1282 */
1283 int i;
1284 for (i = 0; i < rev.pending.nr; i++) {
1285 struct object *o = rev.pending.objects[i].item;
1286 if (!(o->flags & UNINTERESTING))
1287 head = (struct commit *)o;
1288 }
1289 /* There is nothing to show; it is not an error, though. */
1290 if (!head)
1291 return 0;
1292 if (!branch_name)
1293 branch_name = find_branch_name(&rev);
1294 }
1295
1296 if (ignore_if_in_upstream) {
1297 /* Don't say anything if head and upstream are the same. */
1298 if (rev.pending.nr == 2) {
1299 struct object_array_entry *o = rev.pending.objects;
1300 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1301 return 0;
1302 }
1303 get_patch_ids(&rev, &ids, prefix);
1304 }
1305
1306 if (!use_stdout)
1307 realstdout = xfdopen(xdup(1), "w");
1308
1309 if (prepare_revision_walk(&rev))
1310 die(_("revision walk setup failed"));
1311 rev.boundary = 1;
1312 while ((commit = get_revision(&rev)) != NULL) {
1313 if (commit->object.flags & BOUNDARY) {
1314 boundary_count++;
1315 origin = (boundary_count == 1) ? commit : NULL;
1316 continue;
1317 }
1318
1319 if (ignore_if_in_upstream &&
1320 has_commit_patch_id(commit, &ids))
1321 continue;
1322
1323 nr++;
1324 list = xrealloc(list, nr * sizeof(list[0]));
1325 list[nr - 1] = commit;
1326 }
1327 total = nr;
1328 if (!keep_subject && auto_number && total > 1)
1329 numbered = 1;
1330 if (numbered)
1331 rev.total = total + start_number - 1;
1332 if (in_reply_to || thread || cover_letter)
1333 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1334 if (in_reply_to) {
1335 const char *msgid = clean_message_id(in_reply_to);
1336 string_list_append(rev.ref_message_ids, msgid);
1337 }
1338 rev.numbered_files = numbered_files;
1339 rev.patch_suffix = fmt_patch_suffix;
1340 if (cover_letter) {
1341 if (thread)
1342 gen_message_id(&rev, "cover");
1343 make_cover_letter(&rev, use_stdout, numbered, numbered_files,
1344 origin, nr, list, head, branch_name, quiet);
1345 total++;
1346 start_number--;
1347 }
1348 rev.add_signoff = add_signoff;
1349 while (0 <= --nr) {
1350 int shown;
1351 commit = list[nr];
1352 rev.nr = total - nr + (start_number - 1);
1353 /* Make the second and subsequent mails replies to the first */
1354 if (thread) {
1355 /* Have we already had a message ID? */
1356 if (rev.message_id) {
1357 /*
1358 * For deep threading: make every mail
1359 * a reply to the previous one, no
1360 * matter what other options are set.
1361 *
1362 * For shallow threading:
1363 *
1364 * Without --cover-letter and
1365 * --in-reply-to, make every mail a
1366 * reply to the one before.
1367 *
1368 * With --in-reply-to but no
1369 * --cover-letter, make every mail a
1370 * reply to the <reply-to>.
1371 *
1372 * With --cover-letter, make every
1373 * mail but the cover letter a reply
1374 * to the cover letter. The cover
1375 * letter is a reply to the
1376 * --in-reply-to, if specified.
1377 */
1378 if (thread == THREAD_SHALLOW
1379 && rev.ref_message_ids->nr > 0
1380 && (!cover_letter || rev.nr > 1))
1381 free(rev.message_id);
1382 else
1383 string_list_append(rev.ref_message_ids,
1384 rev.message_id);
1385 }
1386 gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1387 }
1388
1389 if (!use_stdout &&
1390 reopen_stdout(numbered_files ? NULL : commit, NULL, &rev, quiet))
1391 die(_("Failed to create output files"));
1392 shown = log_tree_commit(&rev, commit);
1393 free(commit->buffer);
1394 commit->buffer = NULL;
1395
1396 /* We put one extra blank line between formatted
1397 * patches and this flag is used by log-tree code
1398 * to see if it needs to emit a LF before showing
1399 * the log; when using one file per patch, we do
1400 * not want the extra blank line.
1401 */
1402 if (!use_stdout)
1403 rev.shown_one = 0;
1404 if (shown) {
1405 if (rev.mime_boundary)
1406 printf("\n--%s%s--\n\n\n",
1407 mime_boundary_leader,
1408 rev.mime_boundary);
1409 else
1410 print_signature();
1411 }
1412 if (!use_stdout)
1413 fclose(stdout);
1414 }
1415 free(list);
1416 free(branch_name);
1417 string_list_clear(&extra_to, 0);
1418 string_list_clear(&extra_cc, 0);
1419 string_list_clear(&extra_hdr, 0);
1420 if (ignore_if_in_upstream)
1421 free_patch_ids(&ids);
1422 return 0;
1423 }
1424
1425 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1426 {
1427 unsigned char sha1[20];
1428 if (get_sha1(arg, sha1) == 0) {
1429 struct commit *commit = lookup_commit_reference(sha1);
1430 if (commit) {
1431 commit->object.flags |= flags;
1432 add_pending_object(revs, &commit->object, arg);
1433 return 0;
1434 }
1435 }
1436 return -1;
1437 }
1438
1439 static const char * const cherry_usage[] = {
1440 "git cherry [-v] [<upstream> [<head> [<limit>]]]",
1441 NULL
1442 };
1443
1444 static void print_commit(char sign, struct commit *commit, int verbose,
1445 int abbrev)
1446 {
1447 if (!verbose) {
1448 printf("%c %s\n", sign,
1449 find_unique_abbrev(commit->object.sha1, abbrev));
1450 } else {
1451 struct strbuf buf = STRBUF_INIT;
1452 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
1453 printf("%c %s %s\n", sign,
1454 find_unique_abbrev(commit->object.sha1, abbrev),
1455 buf.buf);
1456 strbuf_release(&buf);
1457 }
1458 }
1459
1460 int cmd_cherry(int argc, const char **argv, const char *prefix)
1461 {
1462 struct rev_info revs;
1463 struct patch_ids ids;
1464 struct commit *commit;
1465 struct commit_list *list = NULL;
1466 struct branch *current_branch;
1467 const char *upstream;
1468 const char *head = "HEAD";
1469 const char *limit = NULL;
1470 int verbose = 0, abbrev = 0;
1471
1472 struct option options[] = {
1473 OPT__ABBREV(&abbrev),
1474 OPT__VERBOSE(&verbose, "be verbose"),
1475 OPT_END()
1476 };
1477
1478 argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
1479
1480 switch (argc) {
1481 case 3:
1482 limit = argv[2];
1483 /* FALLTHROUGH */
1484 case 2:
1485 head = argv[1];
1486 /* FALLTHROUGH */
1487 case 1:
1488 upstream = argv[0];
1489 break;
1490 default:
1491 current_branch = branch_get(NULL);
1492 if (!current_branch || !current_branch->merge
1493 || !current_branch->merge[0]
1494 || !current_branch->merge[0]->dst) {
1495 fprintf(stderr, _("Could not find a tracked"
1496 " remote branch, please"
1497 " specify <upstream> manually.\n"));
1498 usage_with_options(cherry_usage, options);
1499 }
1500
1501 upstream = current_branch->merge[0]->dst;
1502 }
1503
1504 init_revisions(&revs, prefix);
1505 revs.diff = 1;
1506 revs.combine_merges = 0;
1507 revs.ignore_merges = 1;
1508 DIFF_OPT_SET(&revs.diffopt, RECURSIVE);
1509
1510 if (add_pending_commit(head, &revs, 0))
1511 die(_("Unknown commit %s"), head);
1512 if (add_pending_commit(upstream, &revs, UNINTERESTING))
1513 die(_("Unknown commit %s"), upstream);
1514
1515 /* Don't say anything if head and upstream are the same. */
1516 if (revs.pending.nr == 2) {
1517 struct object_array_entry *o = revs.pending.objects;
1518 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1519 return 0;
1520 }
1521
1522 get_patch_ids(&revs, &ids, prefix);
1523
1524 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1525 die(_("Unknown commit %s"), limit);
1526
1527 /* reverse the list of commits */
1528 if (prepare_revision_walk(&revs))
1529 die(_("revision walk setup failed"));
1530 while ((commit = get_revision(&revs)) != NULL) {
1531 /* ignore merges */
1532 if (commit->parents && commit->parents->next)
1533 continue;
1534
1535 commit_list_insert(commit, &list);
1536 }
1537
1538 while (list) {
1539 char sign = '+';
1540
1541 commit = list->item;
1542 if (has_commit_patch_id(commit, &ids))
1543 sign = '-';
1544 print_commit(sign, commit, verbose, abbrev);
1545 list = list->next;
1546 }
1547
1548 free_patch_ids(&ids);
1549 return 0;
1550 }