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