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