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