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