]> git.ipfire.org Git - thirdparty/git.git/blame - builtin-log.c
Add is_regex_special()
[thirdparty/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"
70827b15 19
dd0ffd5b
HO
20/* Set a default date-time format for git log ("log.date" config variable) */
21static const char *default_date_mode = NULL;
22
0f03ca94 23static int default_show_root = 1;
d54276f2 24static const char *fmt_patch_subject_prefix = "PATCH";
94c22a5e 25static const char *fmt_pretty;
0f03ca94 26
a633fca0 27static void cmd_log_init(int argc, const char **argv, const char *prefix,
70827b15
LT
28 struct rev_info *rev)
29{
52883fbd
JH
30 int i;
31
70827b15
LT
32 rev->abbrev = DEFAULT_ABBREV;
33 rev->commit_format = CMIT_FMT_DEFAULT;
94c22a5e 34 if (fmt_pretty)
4da45bef 35 get_commit_format(fmt_pretty, rev);
70827b15 36 rev->verbose_header = 1;
8f67f8ae 37 DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
0f03ca94 38 rev->show_root_diff = default_show_root;
d54276f2 39 rev->subject_prefix = fmt_patch_subject_prefix;
5ec11af6 40 DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
dd0ffd5b
HO
41
42 if (default_date_mode)
43 rev->date_mode = parse_date_format(default_date_mode);
44
70827b15 45 argc = setup_revisions(argc, argv, rev, "HEAD");
dd0ffd5b 46
9dafea26
TH
47 if (rev->diffopt.pickaxe || rev->diffopt.filter)
48 rev->always_show_header = 0;
8f67f8ae 49 if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
750f7b66
LT
50 rev->always_show_header = 0;
51 if (rev->diffopt.nr_paths != 1)
52 usage("git logs can only follow renames on one pathname at a time");
53 }
52883fbd
JH
54 for (i = 1; i < argc; i++) {
55 const char *arg = argv[i];
66688334 56 if (!strcmp(arg, "--decorate")) {
5e9bf11c 57 load_ref_decorations();
d467a525 58 rev->show_decorations = 1;
0f3a290b
LT
59 } else if (!strcmp(arg, "--source")) {
60 rev->show_source = 1;
ca135e7a 61 } else
52883fbd
JH
62 die("unrecognized argument: %s", arg);
63 }
9dafea26
TH
64}
65
252a7c02
LT
66/*
67 * This gives a rough estimate for how many commits we
68 * will print out in the list.
69 */
70static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
71{
72 int n = 0;
73
74 while (list) {
75 struct commit *commit = list->item;
76 unsigned int flags = commit->object.flags;
252a7c02 77 list = list->next;
7dc0fe3b 78 if (!(flags & (TREESAME | UNINTERESTING)))
53b2c823 79 n++;
252a7c02
LT
80 }
81 return n;
82}
83
84static void show_early_header(struct rev_info *rev, const char *stage, int nr)
85{
86 if (rev->shown_one) {
87 rev->shown_one = 0;
88 if (rev->commit_format != CMIT_FMT_ONELINE)
89 putchar(rev->diffopt.line_termination);
90 }
91 printf("Final output: %d %s\n", nr, stage);
92}
93
94struct itimerval early_output_timer;
95
cdcefbc9
LT
96static void log_show_early(struct rev_info *revs, struct commit_list *list)
97{
98 int i = revs->early_output;
252a7c02 99 int show_header = 1;
cdcefbc9
LT
100
101 sort_in_topological_order(&list, revs->lifo);
102 while (list && i) {
103 struct commit *commit = list->item;
252a7c02
LT
104 switch (simplify_commit(revs, commit)) {
105 case commit_show:
106 if (show_header) {
107 int n = estimate_commit_count(revs, list);
108 show_early_header(revs, "incomplete", n);
109 show_header = 0;
110 }
111 log_tree_commit(revs, commit);
112 i--;
113 break;
114 case commit_ignore:
115 break;
116 case commit_error:
117 return;
118 }
cdcefbc9 119 list = list->next;
cdcefbc9 120 }
252a7c02
LT
121
122 /* Did we already get enough commits for the early output? */
123 if (!i)
124 return;
125
126 /*
127 * ..if no, then repeat it twice a second until we
128 * do.
129 *
130 * NOTE! We don't use "it_interval", because if the
131 * reader isn't listening, we want our output to be
132 * throttled by the writing, and not have the timer
133 * trigger every second even if we're blocked on a
134 * reader!
135 */
136 early_output_timer.it_value.tv_sec = 0;
137 early_output_timer.it_value.tv_usec = 500000;
138 setitimer(ITIMER_REAL, &early_output_timer, NULL);
cdcefbc9
LT
139}
140
141static void early_output(int signal)
142{
143 show_early_output = log_show_early;
144}
145
146static void setup_early_output(struct rev_info *rev)
147{
148 struct sigaction sa;
cdcefbc9
LT
149
150 /*
151 * Set up the signal handler, minimally intrusively:
152 * we only set a single volatile integer word (not
153 * using sigatomic_t - trying to avoid unnecessary
154 * system dependencies and headers), and using
155 * SA_RESTART.
156 */
157 memset(&sa, 0, sizeof(sa));
158 sa.sa_handler = early_output;
159 sigemptyset(&sa.sa_mask);
160 sa.sa_flags = SA_RESTART;
161 sigaction(SIGALRM, &sa, NULL);
162
163 /*
164 * If we can get the whole output in less than a
165 * tenth of a second, don't even bother doing the
166 * early-output thing..
167 *
168 * This is a one-time-only trigger.
169 */
252a7c02
LT
170 early_output_timer.it_value.tv_sec = 0;
171 early_output_timer.it_value.tv_usec = 100000;
172 setitimer(ITIMER_REAL, &early_output_timer, NULL);
cdcefbc9
LT
173}
174
175static void finish_early_output(struct rev_info *rev)
176{
252a7c02 177 int n = estimate_commit_count(rev, rev->commits);
cdcefbc9 178 signal(SIGALRM, SIG_IGN);
252a7c02 179 show_early_header(rev, "done", n);
cdcefbc9
LT
180}
181
9dafea26
TH
182static int cmd_log_walk(struct rev_info *rev)
183{
184 struct commit *commit;
70827b15 185
cdcefbc9
LT
186 if (rev->early_output)
187 setup_early_output(rev);
188
3d51e1b5
MK
189 if (prepare_revision_walk(rev))
190 die("revision walk setup failed");
cdcefbc9
LT
191
192 if (rev->early_output)
193 finish_early_output(rev);
194
036d17fe 195 /*
84102a33
PVM
196 * For --check and --exit-code, the exit code is based on CHECK_FAILED
197 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
198 * retain that state information if replacing rev->diffopt in this loop
036d17fe 199 */
70827b15
LT
200 while ((commit = get_revision(rev)) != NULL) {
201 log_tree_commit(rev, commit);
a6c73064
JS
202 if (!rev->reflog_info) {
203 /* we allow cycles in reflog ancestry */
204 free(commit->buffer);
205 commit->buffer = NULL;
206 }
cb115748
LT
207 free_commit_list(commit->parents);
208 commit->parents = NULL;
70827b15 209 }
036d17fe
PVM
210 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
211 DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
212 return 02;
213 }
84102a33 214 return diff_result_code(&rev->diffopt, 0);
70827b15
LT
215}
216
ef90d6d4 217static int git_log_config(const char *var, const char *value, void *cb)
0f03ca94 218{
94c22a5e
CR
219 if (!strcmp(var, "format.pretty"))
220 return git_config_string(&fmt_pretty, var, value);
70cff3ac
BH
221 if (!strcmp(var, "format.subjectprefix"))
222 return git_config_string(&fmt_patch_subject_prefix, var, value);
dd0ffd5b
HO
223 if (!strcmp(var, "log.date"))
224 return git_config_string(&default_date_mode, var, value);
0f03ca94
PB
225 if (!strcmp(var, "log.showroot")) {
226 default_show_root = git_config_bool(var, value);
227 return 0;
228 }
ef90d6d4 229 return git_diff_ui_config(var, value, cb);
0f03ca94
PB
230}
231
a633fca0 232int cmd_whatchanged(int argc, const char **argv, const char *prefix)
70827b15
LT
233{
234 struct rev_info rev;
235
ef90d6d4 236 git_config(git_log_config, NULL);
6b2f2d98
MK
237
238 if (diff_use_color_default == -1)
239 diff_use_color_default = git_use_color_default;
240
db6296a5 241 init_revisions(&rev, prefix);
70827b15 242 rev.diff = 1;
9202434c 243 rev.simplify_history = 0;
a633fca0 244 cmd_log_init(argc, argv, prefix, &rev);
9dafea26
TH
245 if (!rev.diffopt.output_format)
246 rev.diffopt.output_format = DIFF_FORMAT_RAW;
247 return cmd_log_walk(&rev);
70827b15
LT
248}
249
56122ed8
JS
250static void show_tagger(char *buf, int len, struct rev_info *rev)
251{
ea718e65 252 struct strbuf out = STRBUF_INIT;
56122ed8 253
ea718e65
JS
254 pp_user_info("Tagger", rev->commit_format, &out, buf, rev->date_mode,
255 git_log_output_encoding ?
256 git_log_output_encoding: git_commit_encoding);
257 printf("%s\n", out.buf);
258 strbuf_release(&out);
56122ed8
JS
259}
260
261static int show_object(const unsigned char *sha1, int show_tag_object,
262 struct rev_info *rev)
5d7eeee2
JS
263{
264 unsigned long size;
21666f1a
NP
265 enum object_type type;
266 char *buf = read_sha1_file(sha1, &type, &size);
5d7eeee2
JS
267 int offset = 0;
268
269 if (!buf)
270 return error("Could not read object %s", sha1_to_hex(sha1));
271
56122ed8
JS
272 if (show_tag_object)
273 while (offset < size && buf[offset] != '\n') {
274 int new_offset = offset + 1;
5d7eeee2
JS
275 while (new_offset < size && buf[new_offset++] != '\n')
276 ; /* do nothing */
56122ed8
JS
277 if (!prefixcmp(buf + offset, "tagger "))
278 show_tagger(buf + offset + 7,
279 new_offset - offset - 7, rev);
5d7eeee2
JS
280 offset = new_offset;
281 }
282
283 if (offset < size)
284 fwrite(buf + offset, size - offset, 1, stdout);
285 free(buf);
286 return 0;
287}
288
289static int show_tree_object(const unsigned char *sha1,
290 const char *base, int baselen,
671f0707 291 const char *pathname, unsigned mode, int stage, void *context)
5d7eeee2
JS
292{
293 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
294 return 0;
295}
296
a633fca0 297int cmd_show(int argc, const char **argv, const char *prefix)
70827b15
LT
298{
299 struct rev_info rev;
5d7eeee2
JS
300 struct object_array_entry *objects;
301 int i, count, ret = 0;
70827b15 302
ef90d6d4 303 git_config(git_log_config, NULL);
6b2f2d98
MK
304
305 if (diff_use_color_default == -1)
306 diff_use_color_default = git_use_color_default;
307
db6296a5 308 init_revisions(&rev, prefix);
70827b15 309 rev.diff = 1;
70827b15
LT
310 rev.combine_merges = 1;
311 rev.dense_combined_merges = 1;
312 rev.always_show_header = 1;
313 rev.ignore_merges = 0;
314 rev.no_walk = 1;
a633fca0 315 cmd_log_init(argc, argv, prefix, &rev);
5d7eeee2
JS
316
317 count = rev.pending.nr;
318 objects = rev.pending.objects;
319 for (i = 0; i < count && !ret; i++) {
320 struct object *o = objects[i].item;
321 const char *name = objects[i].name;
322 switch (o->type) {
323 case OBJ_BLOB:
56122ed8 324 ret = show_object(o->sha1, 0, NULL);
5d7eeee2
JS
325 break;
326 case OBJ_TAG: {
327 struct tag *t = (struct tag *)o;
328
56122ed8 329 printf("%stag %s%s\n",
8f67f8ae 330 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
5d7eeee2 331 t->tag,
8f67f8ae 332 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
56122ed8 333 ret = show_object(o->sha1, 1, &rev);
d2dadfe8
JH
334 if (ret)
335 break;
336 o = parse_object(t->tagged->sha1);
337 if (!o)
338 ret = error("Could not read object %s",
339 sha1_to_hex(t->tagged->sha1));
340 objects[i].item = o;
5d7eeee2
JS
341 i--;
342 break;
343 }
344 case OBJ_TREE:
345 printf("%stree %s%s\n\n",
8f67f8ae 346 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
5d7eeee2 347 name,
8f67f8ae 348 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
5d7eeee2 349 read_tree_recursive((struct tree *)o, "", 0, 0, NULL,
671f0707 350 show_tree_object, NULL);
5d7eeee2
JS
351 break;
352 case OBJ_COMMIT:
353 rev.pending.nr = rev.pending.alloc = 0;
354 rev.pending.objects = NULL;
355 add_object_array(o, name, &rev.pending);
356 ret = cmd_log_walk(&rev);
357 break;
358 default:
359 ret = error("Unknown type: %d", o->type);
360 }
361 }
362 free(objects);
363 return ret;
70827b15
LT
364}
365
cf39f54e
LT
366/*
367 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
368 */
369int cmd_log_reflog(int argc, const char **argv, const char *prefix)
370{
371 struct rev_info rev;
372
ef90d6d4 373 git_config(git_log_config, NULL);
6b2f2d98
MK
374
375 if (diff_use_color_default == -1)
376 diff_use_color_default = git_use_color_default;
377
cf39f54e
LT
378 init_revisions(&rev, prefix);
379 init_reflog_walk(&rev.reflog_info);
380 rev.abbrev_commit = 1;
381 rev.verbose_header = 1;
382 cmd_log_init(argc, argv, prefix, &rev);
383
384 /*
385 * This means that we override whatever commit format the user gave
386 * on the cmd line. Sad, but cmd_log_init() currently doesn't
387 * allow us to set a different default.
388 */
389 rev.commit_format = CMIT_FMT_ONELINE;
4da45bef 390 rev.use_terminator = 1;
cf39f54e
LT
391 rev.always_show_header = 1;
392
393 /*
394 * We get called through "git reflog", so unlike the other log
395 * routines, we need to set up our pager manually..
396 */
397 setup_pager();
398
399 return cmd_log_walk(&rev);
400}
401
a633fca0 402int cmd_log(int argc, const char **argv, const char *prefix)
70827b15
LT
403{
404 struct rev_info rev;
405
ef90d6d4 406 git_config(git_log_config, NULL);
6b2f2d98
MK
407
408 if (diff_use_color_default == -1)
409 diff_use_color_default = git_use_color_default;
410
db6296a5 411 init_revisions(&rev, prefix);
70827b15 412 rev.always_show_header = 1;
a633fca0 413 cmd_log_init(argc, argv, prefix, &rev);
9dafea26 414 return cmd_log_walk(&rev);
70827b15 415}
91efcf60 416
c06d2daa
RR
417/* format-patch */
418#define FORMAT_PATCH_NAME_MAX 64
419
0377db77
JS
420static int istitlechar(char c)
421{
422 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
423 (c >= '0' && c <= '9') || c == '.' || c == '_';
424}
425
917a8f89 426static const char *fmt_patch_suffix = ".patch";
49604a4d 427static int numbered = 0;
a567fdcb 428static int auto_number = 1;
20ff0680 429
3ee79d9f
DB
430static char **extra_hdr;
431static int extra_hdr_nr;
432static int extra_hdr_alloc;
433
434static char **extra_to;
435static int extra_to_nr;
436static int extra_to_alloc;
437
438static char **extra_cc;
439static int extra_cc_nr;
440static int extra_cc_alloc;
441
442static void add_header(const char *value)
443{
444 int len = strlen(value);
c8c4450e 445 while (len && value[len - 1] == '\n')
3ee79d9f
DB
446 len--;
447 if (!strncasecmp(value, "to: ", 4)) {
448 ALLOC_GROW(extra_to, extra_to_nr + 1, extra_to_alloc);
449 extra_to[extra_to_nr++] = xstrndup(value + 4, len - 4);
450 return;
451 }
452 if (!strncasecmp(value, "cc: ", 4)) {
453 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
454 extra_cc[extra_cc_nr++] = xstrndup(value + 4, len - 4);
455 return;
456 }
457 ALLOC_GROW(extra_hdr, extra_hdr_nr + 1, extra_hdr_alloc);
458 extra_hdr[extra_hdr_nr++] = xstrndup(value, len);
459}
460
ef90d6d4 461static int git_format_config(const char *var, const char *value, void *cb)
20ff0680
JS
462{
463 if (!strcmp(var, "format.headers")) {
d7fb91c6
JH
464 if (!value)
465 die("format.headers without value");
3ee79d9f 466 add_header(value);
20ff0680
JS
467 return 0;
468 }
70cff3ac
BH
469 if (!strcmp(var, "format.suffix"))
470 return git_config_string(&fmt_patch_suffix, var, value);
fe8928e6
MV
471 if (!strcmp(var, "format.cc")) {
472 if (!value)
473 return config_error_nonbool(var);
474 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
475 extra_cc[extra_cc_nr++] = xstrdup(value);
476 return 0;
477 }
a159ca0c 478 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff")) {
f3aafa4d
RA
479 return 0;
480 }
49604a4d 481 if (!strcmp(var, "format.numbered")) {
90f5c186 482 if (value && !strcasecmp(value, "auto")) {
49604a4d
BG
483 auto_number = 1;
484 return 0;
485 }
49604a4d 486 numbered = git_config_bool(var, value);
a567fdcb 487 auto_number = auto_number && numbered;
49604a4d
BG
488 return 0;
489 }
dbd21447 490
ef90d6d4 491 return git_log_config(var, value, cb);
20ff0680
JS
492}
493
494
a5a27c79
DB
495static const char *get_oneline_for_filename(struct commit *commit,
496 int keep_subject)
497{
498 static char filename[PATH_MAX];
499 char *sol;
500 int len = 0;
501 int suffix_len = strlen(fmt_patch_suffix) + 1;
502
503 sol = strstr(commit->buffer, "\n\n");
504 if (!sol)
505 filename[0] = '\0';
506 else {
507 int j, space = 0;
508
509 sol += 2;
510 /* strip [PATCH] or [PATCH blabla] */
511 if (!keep_subject && !prefixcmp(sol, "[PATCH")) {
512 char *eos = strchr(sol + 6, ']');
513 if (eos) {
514 while (isspace(*eos))
515 eos++;
516 sol = eos;
517 }
518 }
519
520 for (j = 0;
521 j < FORMAT_PATCH_NAME_MAX - suffix_len - 5 &&
522 len < sizeof(filename) - suffix_len &&
523 sol[j] && sol[j] != '\n';
524 j++) {
525 if (istitlechar(sol[j])) {
526 if (space) {
527 filename[len++] = '-';
528 space = 0;
529 }
530 filename[len++] = sol[j];
531 if (sol[j] == '.')
532 while (sol[j + 1] == '.')
533 j++;
534 } else
535 space = 1;
536 }
537 while (filename[len - 1] == '.'
538 || filename[len - 1] == '-')
539 len--;
540 filename[len] = '\0';
541 }
542 return filename;
543}
544
81f3a188 545static FILE *realstdout = NULL;
efd02016 546static const char *output_directory = NULL;
81f3a188 547
a5a27c79 548static int reopen_stdout(const char *oneline, int nr, int total)
0377db77 549{
c06d2daa 550 char filename[PATH_MAX];
2448482b 551 int len = 0;
c06d2daa 552 int suffix_len = strlen(fmt_patch_suffix) + 1;
0377db77 553
2448482b 554 if (output_directory) {
a5a27c79
DB
555 len = snprintf(filename, sizeof(filename), "%s",
556 output_directory);
557 if (len >=
c06d2daa
RR
558 sizeof(filename) - FORMAT_PATCH_NAME_MAX - suffix_len)
559 return error("name of output directory is too long");
2448482b
JS
560 if (filename[len - 1] != '/')
561 filename[len++] = '/';
562 }
0377db77 563
a5a27c79
DB
564 if (!oneline)
565 len += sprintf(filename + len, "%d", nr);
566 else {
567 len += sprintf(filename + len, "%04d-", nr);
568 len += snprintf(filename + len, sizeof(filename) - len - 1
569 - suffix_len, "%s", oneline);
e6ff0f42 570 strcpy(filename + len, fmt_patch_suffix);
0377db77 571 }
e6ff0f42 572
81f3a188 573 fprintf(realstdout, "%s\n", filename);
c06d2daa
RR
574 if (freopen(filename, "w", stdout) == NULL)
575 return error("Cannot open patch file %s",filename);
c06d2daa 576
e6ff0f42 577 return 0;
0377db77
JS
578}
579
5d23e133 580static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids, const char *prefix)
9c6efa36
JS
581{
582 struct rev_info check_rev;
583 struct commit *commit;
584 struct object *o1, *o2;
585 unsigned flags1, flags2;
9c6efa36
JS
586
587 if (rev->pending.nr != 2)
588 die("Need exactly one range.");
589
590 o1 = rev->pending.objects[0].item;
591 flags1 = o1->flags;
592 o2 = rev->pending.objects[1].item;
593 flags2 = o2->flags;
594
595 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
596 die("Not a range.");
597
5d23e133 598 init_patch_ids(ids);
9c6efa36
JS
599
600 /* given a range a..b get all patch ids for b..a */
db6296a5 601 init_revisions(&check_rev, prefix);
9c6efa36
JS
602 o1->flags ^= UNINTERESTING;
603 o2->flags ^= UNINTERESTING;
604 add_pending_object(&check_rev, o1, "o1");
605 add_pending_object(&check_rev, o2, "o2");
3d51e1b5
MK
606 if (prepare_revision_walk(&check_rev))
607 die("revision walk setup failed");
9c6efa36
JS
608
609 while ((commit = get_revision(&check_rev)) != NULL) {
610 /* ignore merges */
611 if (commit->parents && commit->parents->next)
612 continue;
613
5d23e133 614 add_commit_patch_id(commit, ids);
9c6efa36
JS
615 }
616
617 /* reset for next revision walk */
81db0941
JS
618 clear_commit_marks((struct commit *)o1,
619 SEEN | UNINTERESTING | SHOWN | ADDED);
620 clear_commit_marks((struct commit *)o2,
621 SEEN | UNINTERESTING | SHOWN | ADDED);
9c6efa36
JS
622 o1->flags = flags1;
623 o2->flags = flags2;
624}
625
e1a37346 626static void gen_message_id(struct rev_info *info, char *base)
d1566f78 627{
774751a8 628 const char *committer = git_committer_info(IDENT_WARN_ON_NO_NAME);
d1566f78
JT
629 const char *email_start = strrchr(committer, '<');
630 const char *email_end = strrchr(committer, '>');
f285a2d7 631 struct strbuf buf = STRBUF_INIT;
e1a37346 632 if (!email_start || !email_end || email_start > email_end - 1)
d1566f78 633 die("Could not extract email from committer identity.");
e1a37346
DB
634 strbuf_addf(&buf, "%s.%lu.git.%.*s", base,
635 (unsigned long) time(NULL),
636 (int)(email_end - email_start - 1), email_start + 1);
637 info->message_id = strbuf_detach(&buf, NULL);
d1566f78
JT
638}
639
2bda2cf4
DB
640static void make_cover_letter(struct rev_info *rev, int use_stdout,
641 int numbered, int numbered_files,
642 struct commit *origin,
643 int nr, struct commit **list, struct commit *head)
a5a27c79
DB
644{
645 const char *committer;
39fe578b 646 char *head_sha1;
a5a27c79
DB
647 const char *subject_start = NULL;
648 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
649 const char *msg;
650 const char *extra_headers = rev->extra_headers;
2bda2cf4 651 struct shortlog log;
f285a2d7 652 struct strbuf sb = STRBUF_INIT;
2bda2cf4 653 int i;
a5a27c79 654 const char *encoding = "utf-8";
39fe578b 655 struct diff_options opts;
267123b4 656 int need_8bit_cte = 0;
a5a27c79
DB
657
658 if (rev->commit_format != CMIT_FMT_EMAIL)
659 die("Cover letter needs email format");
660
661 if (!use_stdout && reopen_stdout(numbered_files ?
662 NULL : "cover-letter", 0, rev->total))
663 return;
664
a5a27c79
DB
665 head_sha1 = sha1_to_hex(head->object.sha1);
666
267123b4
JH
667 log_write_email_headers(rev, head_sha1, &subject_start, &extra_headers,
668 &need_8bit_cte);
a5a27c79
DB
669
670 committer = git_committer_info(0);
671
672 msg = body;
a5a27c79
DB
673 pp_user_info(NULL, CMIT_FMT_EMAIL, &sb, committer, DATE_RFC2822,
674 encoding);
675 pp_title_line(CMIT_FMT_EMAIL, &msg, &sb, subject_start, extra_headers,
267123b4 676 encoding, need_8bit_cte);
a5a27c79
DB
677 pp_remainder(CMIT_FMT_EMAIL, &msg, &sb, 0);
678 printf("%s\n", sb.buf);
679
680 strbuf_release(&sb);
681
2bda2cf4 682 shortlog_init(&log);
859c4fbe
JS
683 log.wrap_lines = 1;
684 log.wrap = 72;
685 log.in1 = 2;
686 log.in2 = 4;
2bda2cf4
DB
687 for (i = 0; i < nr; i++)
688 shortlog_add_commit(&log, list[i]);
689
690 shortlog_output(&log);
691
a5a27c79 692 /*
2bda2cf4 693 * We can only do diffstat with a unique reference point
a5a27c79
DB
694 */
695 if (!origin)
696 return;
697
5d02294c
JS
698 memcpy(&opts, &rev->diffopt, sizeof(opts));
699 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
a5a27c79 700
39fe578b
DB
701 diff_setup_done(&opts);
702
703 diff_tree_sha1(origin->tree->object.sha1,
704 head->tree->object.sha1,
705 "", &opts);
706 diffcore_std(&opts);
707 diff_flush(&opts);
a5a27c79 708
a5a27c79 709 printf("\n");
d1566f78
JT
710}
711
8419d2ee
JH
712static const char *clean_message_id(const char *msg_id)
713{
714 char ch;
715 const char *a, *z, *m;
8419d2ee
JH
716
717 m = msg_id;
718 while ((ch = *m) && (isspace(ch) || (ch == '<')))
719 m++;
720 a = m;
721 z = NULL;
722 while ((ch = *m)) {
723 if (!isspace(ch) && (ch != '>'))
724 z = m;
725 m++;
726 }
727 if (!z)
728 die("insane in-reply-to: %s", msg_id);
729 if (++z == m)
730 return a;
182af834 731 return xmemdupz(a, z - a);
8419d2ee
JH
732}
733
a633fca0 734int cmd_format_patch(int argc, const char **argv, const char *prefix)
91efcf60
JH
735{
736 struct commit *commit;
737 struct commit **list = NULL;
738 struct rev_info rev;
2448482b 739 int nr = 0, total, i, j;
0377db77 740 int use_stdout = 0;
fa0f02df 741 int start_number = -1;
8ac80a57 742 int keep_subject = 0;
e6ff0f42 743 int numbered_files = 0; /* _just_ numbers */
2d9e4a47 744 int subject_prefix = 0;
9c6efa36 745 int ignore_if_in_upstream = 0;
cc35de84 746 int thread = 0;
a5a27c79 747 int cover_letter = 0;
2bda2cf4 748 int boundary_count = 0;
37c22a4b 749 int no_binary_diff = 0;
a5a27c79 750 struct commit *origin = NULL, *head = NULL;
76af0734 751 const char *in_reply_to = NULL;
5d23e133 752 struct patch_ids ids;
cf2251b6 753 char *add_signoff = NULL;
f285a2d7 754 struct strbuf buf = STRBUF_INIT;
91efcf60 755
ef90d6d4 756 git_config(git_format_config, NULL);
db6296a5 757 init_revisions(&rev, prefix);
91efcf60
JH
758 rev.commit_format = CMIT_FMT_EMAIL;
759 rev.verbose_header = 1;
760 rev.diff = 1;
91efcf60
JH
761 rev.combine_merges = 0;
762 rev.ignore_merges = 1;
8f67f8ae 763 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
91efcf60 764
dbd21447 765 rev.subject_prefix = fmt_patch_subject_prefix;
20ff0680 766
2448482b
JS
767 /*
768 * Parse the arguments before setup_revisions(), or something
2dc189a3 769 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
2448482b
JS
770 * possibly a valid SHA1.
771 */
772 for (i = 1, j = 1; i < argc; i++) {
773 if (!strcmp(argv[i], "--stdout"))
0377db77 774 use_stdout = 1;
596524b3
JS
775 else if (!strcmp(argv[i], "-n") ||
776 !strcmp(argv[i], "--numbered"))
777 numbered = 1;
49604a4d
BG
778 else if (!strcmp(argv[i], "-N") ||
779 !strcmp(argv[i], "--no-numbered")) {
780 numbered = 0;
781 auto_number = 0;
782 }
cc44c765 783 else if (!prefixcmp(argv[i], "--start-number="))
fa0f02df 784 start_number = strtol(argv[i] + 15, NULL, 10);
e6ff0f42
JL
785 else if (!strcmp(argv[i], "--numbered-files"))
786 numbered_files = 1;
fa0f02df
JS
787 else if (!strcmp(argv[i], "--start-number")) {
788 i++;
789 if (i == argc)
790 die("Need a number for --start-number");
791 start_number = strtol(argv[i], NULL, 10);
cf2251b6 792 }
736cc67d
DB
793 else if (!prefixcmp(argv[i], "--cc=")) {
794 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
795 extra_cc[extra_cc_nr++] = xstrdup(argv[i] + 5);
796 }
cf2251b6 797 else if (!strcmp(argv[i], "-k") ||
8ac80a57
JS
798 !strcmp(argv[i], "--keep-subject")) {
799 keep_subject = 1;
800 rev.total = -1;
cf2251b6 801 }
efd02016
JH
802 else if (!strcmp(argv[i], "--output-directory") ||
803 !strcmp(argv[i], "-o")) {
2448482b 804 i++;
efd02016
JH
805 if (argc <= i)
806 die("Which directory?");
807 if (output_directory)
808 die("Two output directories?");
809 output_directory = argv[i];
698ce6f8 810 }
cf2251b6
JH
811 else if (!strcmp(argv[i], "--signoff") ||
812 !strcmp(argv[i], "-s")) {
6c4cca1c
EB
813 const char *committer;
814 const char *endpos;
774751a8 815 committer = git_committer_info(IDENT_ERROR_ON_NO_NAME);
6c4cca1c 816 endpos = strchr(committer, '>');
cf2251b6 817 if (!endpos)
d7530708 818 die("bogus committer info %s", committer);
182af834 819 add_signoff = xmemdupz(committer, endpos - committer + 1);
cf2251b6 820 }
c112f689 821 else if (!strcmp(argv[i], "--attach")) {
698ce6f8 822 rev.mime_boundary = git_version_string;
c112f689
JS
823 rev.no_inline = 1;
824 }
825 else if (!prefixcmp(argv[i], "--attach=")) {
826 rev.mime_boundary = argv[i] + 9;
827 rev.no_inline = 1;
828 }
829 else if (!strcmp(argv[i], "--inline")) {
830 rev.mime_boundary = git_version_string;
831 rev.no_inline = 0;
832 }
833 else if (!prefixcmp(argv[i], "--inline=")) {
698ce6f8 834 rev.mime_boundary = argv[i] + 9;
c112f689
JS
835 rev.no_inline = 0;
836 }
9c6efa36
JS
837 else if (!strcmp(argv[i], "--ignore-if-in-upstream"))
838 ignore_if_in_upstream = 1;
cc35de84
JT
839 else if (!strcmp(argv[i], "--thread"))
840 thread = 1;
cc44c765 841 else if (!prefixcmp(argv[i], "--in-reply-to="))
da56645d
JT
842 in_reply_to = argv[i] + 14;
843 else if (!strcmp(argv[i], "--in-reply-to")) {
844 i++;
845 if (i == argc)
846 die("Need a Message-Id for --in-reply-to");
847 in_reply_to = argv[i];
2d9e4a47
RJ
848 } else if (!prefixcmp(argv[i], "--subject-prefix=")) {
849 subject_prefix = 1;
850 rev.subject_prefix = argv[i] + 17;
851 } else if (!prefixcmp(argv[i], "--suffix="))
03eeaeae 852 fmt_patch_suffix = argv[i] + 9;
a5a27c79
DB
853 else if (!strcmp(argv[i], "--cover-letter"))
854 cover_letter = 1;
37c22a4b
CMOF
855 else if (!strcmp(argv[i], "--no-binary"))
856 no_binary_diff = 1;
698ce6f8 857 else
2448482b 858 argv[j++] = argv[i];
0377db77 859 }
2448482b
JS
860 argc = j;
861
3ee79d9f
DB
862 for (i = 0; i < extra_hdr_nr; i++) {
863 strbuf_addstr(&buf, extra_hdr[i]);
864 strbuf_addch(&buf, '\n');
865 }
866
867 if (extra_to_nr)
868 strbuf_addstr(&buf, "To: ");
869 for (i = 0; i < extra_to_nr; i++) {
870 if (i)
871 strbuf_addstr(&buf, " ");
872 strbuf_addstr(&buf, extra_to[i]);
873 if (i + 1 < extra_to_nr)
874 strbuf_addch(&buf, ',');
875 strbuf_addch(&buf, '\n');
876 }
877
878 if (extra_cc_nr)
879 strbuf_addstr(&buf, "Cc: ");
880 for (i = 0; i < extra_cc_nr; i++) {
881 if (i)
882 strbuf_addstr(&buf, " ");
883 strbuf_addstr(&buf, extra_cc[i]);
884 if (i + 1 < extra_cc_nr)
885 strbuf_addch(&buf, ',');
886 strbuf_addch(&buf, '\n');
887 }
888
889 rev.extra_headers = strbuf_detach(&buf, 0);
890
add5c8a5 891 if (start_number < 0)
fa0f02df 892 start_number = 1;
63b398a4 893 if (numbered && keep_subject)
8ac80a57 894 die ("-n and -k are mutually exclusive.");
2d9e4a47
RJ
895 if (keep_subject && subject_prefix)
896 die ("--subject-prefix and -k are mutually exclusive.");
e6ff0f42
JL
897 if (numbered_files && use_stdout)
898 die ("--numbered-files and --stdout are mutually exclusive.");
8ac80a57 899
2448482b
JS
900 argc = setup_revisions(argc, argv, &rev, "HEAD");
901 if (argc > 1)
902 die ("unrecognized argument: %s", argv[1]);
0377db77 903
68daa64d
JK
904 if (!rev.diffopt.output_format
905 || rev.diffopt.output_format == DIFF_FORMAT_PATCH)
c261e438 906 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY | DIFF_FORMAT_PATCH;
c9b5ef99 907
37c22a4b 908 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
8f67f8ae 909 DIFF_OPT_SET(&rev.diffopt, BINARY);
e47f306d 910
90f70a91 911 if (!output_directory && !use_stdout)
77e565d8
ML
912 output_directory = prefix;
913
efd02016
JH
914 if (output_directory) {
915 if (use_stdout)
916 die("standard output, or directory, which one?");
917 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
918 die("Could not create directory %s",
919 output_directory);
920 }
921
1f1e895f 922 if (rev.pending.nr == 1) {
8a1d076e
JH
923 if (rev.max_count < 0 && !rev.show_root_diff) {
924 /*
925 * This is traditional behaviour of "git format-patch
926 * origin" that prepares what the origin side still
927 * does not have.
928 */
7c496280 929 rev.pending.objects[0].item->flags |= UNINTERESTING;
3384a2df 930 add_head_to_pending(&rev);
7c496280 931 }
8a1d076e
JH
932 /*
933 * Otherwise, it is "format-patch -22 HEAD", and/or
934 * "format-patch --root HEAD". The user wants
935 * get_revision() to do the usual traversal.
7c496280 936 */
e686eb98 937 }
a5a27c79
DB
938 if (cover_letter) {
939 /* remember the range */
a5a27c79
DB
940 int i;
941 for (i = 0; i < rev.pending.nr; i++) {
942 struct object *o = rev.pending.objects[i].item;
2bda2cf4 943 if (!(o->flags & UNINTERESTING))
a5a27c79
DB
944 head = (struct commit *)o;
945 }
a5a27c79
DB
946 /* We can't generate a cover letter without any patches */
947 if (!head)
948 return 0;
949 }
e686eb98 950
9c6efa36 951 if (ignore_if_in_upstream)
5d23e133 952 get_patch_ids(&rev, &ids, prefix);
9c6efa36 953
81f3a188 954 if (!use_stdout)
f5788250 955 realstdout = xfdopen(xdup(1), "w");
81f3a188 956
3d51e1b5
MK
957 if (prepare_revision_walk(&rev))
958 die("revision walk setup failed");
2bda2cf4 959 rev.boundary = 1;
91efcf60 960 while ((commit = get_revision(&rev)) != NULL) {
2bda2cf4 961 if (commit->object.flags & BOUNDARY) {
2bda2cf4
DB
962 boundary_count++;
963 origin = (boundary_count == 1) ? commit : NULL;
964 continue;
965 }
966
0377db77
JS
967 /* ignore merges */
968 if (commit->parents && commit->parents->next)
969 continue;
9c6efa36
JS
970
971 if (ignore_if_in_upstream &&
5d23e133 972 has_commit_patch_id(commit, &ids))
9c6efa36
JS
973 continue;
974
91efcf60 975 nr++;
83572c1a 976 list = xrealloc(list, nr * sizeof(list[0]));
91efcf60
JH
977 list[nr - 1] = commit;
978 }
0377db77 979 total = nr;
49604a4d
BG
980 if (!keep_subject && auto_number && total > 1)
981 numbered = 1;
596524b3 982 if (numbered)
fa0f02df 983 rev.total = total + start_number - 1;
8419d2ee
JH
984 if (in_reply_to)
985 rev.ref_message_id = clean_message_id(in_reply_to);
a5a27c79
DB
986 if (cover_letter) {
987 if (thread)
988 gen_message_id(&rev, "cover");
989 make_cover_letter(&rev, use_stdout, numbered, numbered_files,
2bda2cf4 990 origin, nr, list, head);
a5a27c79
DB
991 total++;
992 start_number--;
993 }
994 rev.add_signoff = add_signoff;
91efcf60
JH
995 while (0 <= --nr) {
996 int shown;
997 commit = list[nr];
add5c8a5 998 rev.nr = total - nr + (start_number - 1);
d1566f78 999 /* Make the second and subsequent mails replies to the first */
cc35de84 1000 if (thread) {
a5a27c79 1001 /* Have we already had a message ID? */
e1a37346 1002 if (rev.message_id) {
a5a27c79
DB
1003 /*
1004 * If we've got the ID to be a reply
1005 * to, discard the current ID;
1006 * otherwise, make everything a reply
1007 * to that.
1008 */
e1a37346
DB
1009 if (rev.ref_message_id)
1010 free(rev.message_id);
1011 else
1012 rev.ref_message_id = rev.message_id;
cc35de84 1013 }
e1a37346 1014 gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
d1566f78 1015 }
a5a27c79
DB
1016 if (!use_stdout && reopen_stdout(numbered_files ? NULL :
1017 get_oneline_for_filename(commit, keep_subject),
1018 rev.nr, rev.total))
1019 die("Failed to create output files");
91efcf60
JH
1020 shown = log_tree_commit(&rev, commit);
1021 free(commit->buffer);
1022 commit->buffer = NULL;
add5c8a5
JH
1023
1024 /* We put one extra blank line between formatted
1025 * patches and this flag is used by log-tree code
1026 * to see if it needs to emit a LF before showing
1027 * the log; when using one file per patch, we do
1028 * not want the extra blank line.
1029 */
1030 if (!use_stdout)
1031 rev.shown_one = 0;
698ce6f8
JS
1032 if (shown) {
1033 if (rev.mime_boundary)
1034 printf("\n--%s%s--\n\n\n",
1035 mime_boundary_leader,
1036 rev.mime_boundary);
1037 else
1038 printf("-- \n%s\n\n", git_version_string);
1039 }
0377db77
JS
1040 if (!use_stdout)
1041 fclose(stdout);
91efcf60
JH
1042 }
1043 free(list);
5d23e133
JH
1044 if (ignore_if_in_upstream)
1045 free_patch_ids(&ids);
91efcf60
JH
1046 return 0;
1047}
1048
e827633a
RS
1049static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1050{
1051 unsigned char sha1[20];
1052 if (get_sha1(arg, sha1) == 0) {
1053 struct commit *commit = lookup_commit_reference(sha1);
1054 if (commit) {
1055 commit->object.flags |= flags;
1056 add_pending_object(revs, &commit->object, arg);
1057 return 0;
1058 }
1059 }
1060 return -1;
1061}
1062
1063static const char cherry_usage[] =
1b1dd23f 1064"git cherry [-v] <upstream> [<head>] [<limit>]";
e827633a
RS
1065int cmd_cherry(int argc, const char **argv, const char *prefix)
1066{
1067 struct rev_info revs;
5d23e133 1068 struct patch_ids ids;
e827633a
RS
1069 struct commit *commit;
1070 struct commit_list *list = NULL;
1071 const char *upstream;
1072 const char *head = "HEAD";
1073 const char *limit = NULL;
1074 int verbose = 0;
1075
1076 if (argc > 1 && !strcmp(argv[1], "-v")) {
1077 verbose = 1;
1078 argc--;
1079 argv++;
1080 }
1081
1082 switch (argc) {
1083 case 4:
1084 limit = argv[3];
1085 /* FALLTHROUGH */
1086 case 3:
1087 head = argv[2];
1088 /* FALLTHROUGH */
1089 case 2:
1090 upstream = argv[1];
1091 break;
1092 default:
1093 usage(cherry_usage);
1094 }
1095
1096 init_revisions(&revs, prefix);
1097 revs.diff = 1;
1098 revs.combine_merges = 0;
1099 revs.ignore_merges = 1;
8f67f8ae 1100 DIFF_OPT_SET(&revs.diffopt, RECURSIVE);
e827633a
RS
1101
1102 if (add_pending_commit(head, &revs, 0))
1103 die("Unknown commit %s", head);
1104 if (add_pending_commit(upstream, &revs, UNINTERESTING))
1105 die("Unknown commit %s", upstream);
1106
1107 /* Don't say anything if head and upstream are the same. */
1108 if (revs.pending.nr == 2) {
1109 struct object_array_entry *o = revs.pending.objects;
1110 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1111 return 0;
1112 }
1113
5d23e133 1114 get_patch_ids(&revs, &ids, prefix);
e827633a
RS
1115
1116 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1117 die("Unknown commit %s", limit);
1118
1119 /* reverse the list of commits */
3d51e1b5
MK
1120 if (prepare_revision_walk(&revs))
1121 die("revision walk setup failed");
e827633a
RS
1122 while ((commit = get_revision(&revs)) != NULL) {
1123 /* ignore merges */
1124 if (commit->parents && commit->parents->next)
1125 continue;
1126
1127 commit_list_insert(commit, &list);
1128 }
1129
1130 while (list) {
e827633a
RS
1131 char sign = '+';
1132
1133 commit = list->item;
5d23e133 1134 if (has_commit_patch_id(commit, &ids))
e827633a
RS
1135 sign = '-';
1136
1137 if (verbose) {
f285a2d7 1138 struct strbuf buf = STRBUF_INIT;
674d1727 1139 pretty_print_commit(CMIT_FMT_ONELINE, commit,
4593fb84 1140 &buf, 0, NULL, NULL, 0, 0);
e827633a 1141 printf("%c %s %s\n", sign,
674d1727
PH
1142 sha1_to_hex(commit->object.sha1), buf.buf);
1143 strbuf_release(&buf);
e827633a
RS
1144 }
1145 else {
1146 printf("%c %s\n", sign,
1147 sha1_to_hex(commit->object.sha1));
1148 }
1149
1150 list = list->next;
1151 }
1152
5d23e133 1153 free_patch_ids(&ids);
e827633a
RS
1154 return 0;
1155}