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