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