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