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