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