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