Merge branch 'rt/completion-help'
[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 "refs.h"
9 #include "color.h"
10 #include "commit.h"
11 #include "diff.h"
12 #include "revision.h"
13 #include "log-tree.h"
14 #include "builtin.h"
15 #include "tag.h"
16 #include "reflog-walk.h"
17 #include "patch-ids.h"
18 #include "run-command.h"
19 #include "shortlog.h"
20 #include "remote.h"
21 #include "string-list.h"
22 #include "parse-options.h"
23 #include "line-log.h"
24 #include "branch.h"
25 #include "streaming.h"
26 #include "version.h"
27 #include "mailmap.h"
28 #include "gpg-interface.h"
29
30 /* Set a default date-time format for git log ("log.date" config variable) */
31 static const char *default_date_mode = NULL;
32
33 static int default_abbrev_commit;
34 static int default_show_root = 1;
35 static int default_follow;
36 static int decoration_style;
37 static int decoration_given;
38 static int use_mailmap_config;
39 static const char *fmt_patch_subject_prefix = "PATCH";
40 static const char *fmt_pretty;
41
42 static const char * const builtin_log_usage[] = {
43         N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
44         N_("git show [<options>] <object>..."),
45         NULL
46 };
47
48 struct line_opt_callback_data {
49         struct rev_info *rev;
50         const char *prefix;
51         struct string_list args;
52 };
53
54 static int parse_decoration_style(const char *var, const char *value)
55 {
56         switch (git_config_maybe_bool(var, value)) {
57         case 1:
58                 return DECORATE_SHORT_REFS;
59         case 0:
60                 return 0;
61         default:
62                 break;
63         }
64         if (!strcmp(value, "full"))
65                 return DECORATE_FULL_REFS;
66         else if (!strcmp(value, "short"))
67                 return DECORATE_SHORT_REFS;
68         else if (!strcmp(value, "auto"))
69                 return (isatty(1) || pager_in_use()) ? DECORATE_SHORT_REFS : 0;
70         return -1;
71 }
72
73 static int decorate_callback(const struct option *opt, const char *arg, int unset)
74 {
75         if (unset)
76                 decoration_style = 0;
77         else if (arg)
78                 decoration_style = parse_decoration_style("command line", arg);
79         else
80                 decoration_style = DECORATE_SHORT_REFS;
81
82         if (decoration_style < 0)
83                 die(_("invalid --decorate option: %s"), arg);
84
85         decoration_given = 1;
86
87         return 0;
88 }
89
90 static int log_line_range_callback(const struct option *option, const char *arg, int unset)
91 {
92         struct line_opt_callback_data *data = option->value;
93
94         if (!arg)
95                 return -1;
96
97         data->rev->line_level_traverse = 1;
98         string_list_append(&data->args, arg);
99
100         return 0;
101 }
102
103 static void init_log_defaults(void)
104 {
105         init_grep_defaults();
106         init_diff_ui_defaults();
107 }
108
109 static void cmd_log_init_defaults(struct rev_info *rev)
110 {
111         if (fmt_pretty)
112                 get_commit_format(fmt_pretty, rev);
113         if (default_follow)
114                 DIFF_OPT_SET(&rev->diffopt, DEFAULT_FOLLOW_RENAMES);
115         rev->verbose_header = 1;
116         DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
117         rev->diffopt.stat_width = -1; /* use full terminal width */
118         rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
119         rev->abbrev_commit = default_abbrev_commit;
120         rev->show_root_diff = default_show_root;
121         rev->subject_prefix = fmt_patch_subject_prefix;
122         DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
123
124         if (default_date_mode)
125                 parse_date_format(default_date_mode, &rev->date_mode);
126         rev->diffopt.touched_flags = 0;
127 }
128
129 static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
130                          struct rev_info *rev, struct setup_revision_opt *opt)
131 {
132         struct userformat_want w;
133         int quiet = 0, source = 0, mailmap = 0;
134         static struct line_opt_callback_data line_cb = {NULL, NULL, STRING_LIST_INIT_DUP};
135
136         const struct option builtin_log_options[] = {
137                 OPT__QUIET(&quiet, N_("suppress diff output")),
138                 OPT_BOOL(0, "source", &source, N_("show source")),
139                 OPT_BOOL(0, "use-mailmap", &mailmap, N_("Use mail map file")),
140                 { OPTION_CALLBACK, 0, "decorate", NULL, NULL, N_("decorate options"),
141                   PARSE_OPT_OPTARG, decorate_callback},
142                 OPT_CALLBACK('L', NULL, &line_cb, "n,m:file",
143                              N_("Process line range n,m in file, counting from 1"),
144                              log_line_range_callback),
145                 OPT_END()
146         };
147
148         line_cb.rev = rev;
149         line_cb.prefix = prefix;
150
151         mailmap = use_mailmap_config;
152         argc = parse_options(argc, argv, prefix,
153                              builtin_log_options, builtin_log_usage,
154                              PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
155                              PARSE_OPT_KEEP_DASHDASH);
156
157         if (quiet)
158                 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
159         argc = setup_revisions(argc, argv, rev, opt);
160
161         /* Any arguments at this point are not recognized */
162         if (argc > 1)
163                 die(_("unrecognized argument: %s"), argv[1]);
164
165         memset(&w, 0, sizeof(w));
166         userformat_find_requirements(NULL, &w);
167
168         if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
169                 rev->show_notes = 1;
170         if (rev->show_notes)
171                 init_display_notes(&rev->notes_opt);
172
173         if (rev->diffopt.pickaxe || rev->diffopt.filter ||
174             DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES))
175                 rev->always_show_header = 0;
176
177         if (source)
178                 rev->show_source = 1;
179
180         if (mailmap) {
181                 rev->mailmap = xcalloc(1, sizeof(struct string_list));
182                 read_mailmap(rev->mailmap, NULL);
183         }
184
185         if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
186                 /*
187                  * "log --pretty=raw" is special; ignore UI oriented
188                  * configuration variables such as decoration.
189                  */
190                 if (!decoration_given)
191                         decoration_style = 0;
192                 if (!rev->abbrev_commit_given)
193                         rev->abbrev_commit = 0;
194         }
195
196         if (decoration_style) {
197                 rev->show_decorations = 1;
198                 load_ref_decorations(decoration_style);
199         }
200
201         if (rev->line_level_traverse)
202                 line_log_init(rev, line_cb.prefix, &line_cb.args);
203
204         setup_pager();
205 }
206
207 static void cmd_log_init(int argc, const char **argv, const char *prefix,
208                          struct rev_info *rev, struct setup_revision_opt *opt)
209 {
210         cmd_log_init_defaults(rev);
211         cmd_log_init_finish(argc, argv, prefix, rev, opt);
212 }
213
214 /*
215  * This gives a rough estimate for how many commits we
216  * will print out in the list.
217  */
218 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
219 {
220         int n = 0;
221
222         while (list) {
223                 struct commit *commit = list->item;
224                 unsigned int flags = commit->object.flags;
225                 list = list->next;
226                 if (!(flags & (TREESAME | UNINTERESTING)))
227                         n++;
228         }
229         return n;
230 }
231
232 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
233 {
234         if (rev->shown_one) {
235                 rev->shown_one = 0;
236                 if (rev->commit_format != CMIT_FMT_ONELINE)
237                         putchar(rev->diffopt.line_termination);
238         }
239         printf(_("Final output: %d %s\n"), nr, stage);
240 }
241
242 static struct itimerval early_output_timer;
243
244 static void log_show_early(struct rev_info *revs, struct commit_list *list)
245 {
246         int i = revs->early_output;
247         int show_header = 1;
248
249         sort_in_topological_order(&list, revs->sort_order);
250         while (list && i) {
251                 struct commit *commit = list->item;
252                 switch (simplify_commit(revs, commit)) {
253                 case commit_show:
254                         if (show_header) {
255                                 int n = estimate_commit_count(revs, list);
256                                 show_early_header(revs, "incomplete", n);
257                                 show_header = 0;
258                         }
259                         log_tree_commit(revs, commit);
260                         i--;
261                         break;
262                 case commit_ignore:
263                         break;
264                 case commit_error:
265                         return;
266                 }
267                 list = list->next;
268         }
269
270         /* Did we already get enough commits for the early output? */
271         if (!i)
272                 return;
273
274         /*
275          * ..if no, then repeat it twice a second until we
276          * do.
277          *
278          * NOTE! We don't use "it_interval", because if the
279          * reader isn't listening, we want our output to be
280          * throttled by the writing, and not have the timer
281          * trigger every second even if we're blocked on a
282          * reader!
283          */
284         early_output_timer.it_value.tv_sec = 0;
285         early_output_timer.it_value.tv_usec = 500000;
286         setitimer(ITIMER_REAL, &early_output_timer, NULL);
287 }
288
289 static void early_output(int signal)
290 {
291         show_early_output = log_show_early;
292 }
293
294 static void setup_early_output(struct rev_info *rev)
295 {
296         struct sigaction sa;
297
298         /*
299          * Set up the signal handler, minimally intrusively:
300          * we only set a single volatile integer word (not
301          * using sigatomic_t - trying to avoid unnecessary
302          * system dependencies and headers), and using
303          * SA_RESTART.
304          */
305         memset(&sa, 0, sizeof(sa));
306         sa.sa_handler = early_output;
307         sigemptyset(&sa.sa_mask);
308         sa.sa_flags = SA_RESTART;
309         sigaction(SIGALRM, &sa, NULL);
310
311         /*
312          * If we can get the whole output in less than a
313          * tenth of a second, don't even bother doing the
314          * early-output thing..
315          *
316          * This is a one-time-only trigger.
317          */
318         early_output_timer.it_value.tv_sec = 0;
319         early_output_timer.it_value.tv_usec = 100000;
320         setitimer(ITIMER_REAL, &early_output_timer, NULL);
321 }
322
323 static void finish_early_output(struct rev_info *rev)
324 {
325         int n = estimate_commit_count(rev, rev->commits);
326         signal(SIGALRM, SIG_IGN);
327         show_early_header(rev, "done", n);
328 }
329
330 static int cmd_log_walk(struct rev_info *rev)
331 {
332         struct commit *commit;
333         int saved_nrl = 0;
334         int saved_dcctc = 0;
335
336         if (rev->early_output)
337                 setup_early_output(rev);
338
339         if (prepare_revision_walk(rev))
340                 die(_("revision walk setup failed"));
341
342         if (rev->early_output)
343                 finish_early_output(rev);
344
345         /*
346          * For --check and --exit-code, the exit code is based on CHECK_FAILED
347          * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
348          * retain that state information if replacing rev->diffopt in this loop
349          */
350         while ((commit = get_revision(rev)) != NULL) {
351                 if (!log_tree_commit(rev, commit) && rev->max_count >= 0)
352                         /*
353                          * We decremented max_count in get_revision,
354                          * but we didn't actually show the commit.
355                          */
356                         rev->max_count++;
357                 if (!rev->reflog_info) {
358                         /* we allow cycles in reflog ancestry */
359                         free_commit_buffer(commit);
360                 }
361                 free_commit_list(commit->parents);
362                 commit->parents = NULL;
363                 if (saved_nrl < rev->diffopt.needed_rename_limit)
364                         saved_nrl = rev->diffopt.needed_rename_limit;
365                 if (rev->diffopt.degraded_cc_to_c)
366                         saved_dcctc = 1;
367         }
368         rev->diffopt.degraded_cc_to_c = saved_dcctc;
369         rev->diffopt.needed_rename_limit = saved_nrl;
370
371         if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
372             DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
373                 return 02;
374         }
375         return diff_result_code(&rev->diffopt, 0);
376 }
377
378 static int git_log_config(const char *var, const char *value, void *cb)
379 {
380         const char *slot_name;
381
382         if (!strcmp(var, "format.pretty"))
383                 return git_config_string(&fmt_pretty, var, value);
384         if (!strcmp(var, "format.subjectprefix"))
385                 return git_config_string(&fmt_patch_subject_prefix, var, value);
386         if (!strcmp(var, "log.abbrevcommit")) {
387                 default_abbrev_commit = git_config_bool(var, value);
388                 return 0;
389         }
390         if (!strcmp(var, "log.date"))
391                 return git_config_string(&default_date_mode, var, value);
392         if (!strcmp(var, "log.decorate")) {
393                 decoration_style = parse_decoration_style(var, value);
394                 if (decoration_style < 0)
395                         decoration_style = 0; /* maybe warn? */
396                 return 0;
397         }
398         if (!strcmp(var, "log.showroot")) {
399                 default_show_root = git_config_bool(var, value);
400                 return 0;
401         }
402         if (!strcmp(var, "log.follow")) {
403                 default_follow = git_config_bool(var, value);
404                 return 0;
405         }
406         if (skip_prefix(var, "color.decorate.", &slot_name))
407                 return parse_decorate_color_config(var, slot_name, value);
408         if (!strcmp(var, "log.mailmap")) {
409                 use_mailmap_config = git_config_bool(var, value);
410                 return 0;
411         }
412
413         if (grep_config(var, value, cb) < 0)
414                 return -1;
415         if (git_gpg_config(var, value, cb) < 0)
416                 return -1;
417         return git_diff_ui_config(var, value, cb);
418 }
419
420 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
421 {
422         struct rev_info rev;
423         struct setup_revision_opt opt;
424
425         init_log_defaults();
426         git_config(git_log_config, NULL);
427
428         init_revisions(&rev, prefix);
429         rev.diff = 1;
430         rev.simplify_history = 0;
431         memset(&opt, 0, sizeof(opt));
432         opt.def = "HEAD";
433         opt.revarg_opt = REVARG_COMMITTISH;
434         cmd_log_init(argc, argv, prefix, &rev, &opt);
435         if (!rev.diffopt.output_format)
436                 rev.diffopt.output_format = DIFF_FORMAT_RAW;
437         return cmd_log_walk(&rev);
438 }
439
440 static void show_tagger(char *buf, int len, struct rev_info *rev)
441 {
442         struct strbuf out = STRBUF_INIT;
443         struct pretty_print_context pp = {0};
444
445         pp.fmt = rev->commit_format;
446         pp.date_mode = rev->date_mode;
447         pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
448         printf("%s", out.buf);
449         strbuf_release(&out);
450 }
451
452 static int show_blob_object(const unsigned char *sha1, struct rev_info *rev, const char *obj_name)
453 {
454         unsigned char sha1c[20];
455         struct object_context obj_context;
456         char *buf;
457         unsigned long size;
458
459         fflush(stdout);
460         if (!DIFF_OPT_TOUCHED(&rev->diffopt, ALLOW_TEXTCONV) ||
461             !DIFF_OPT_TST(&rev->diffopt, ALLOW_TEXTCONV))
462                 return stream_blob_to_fd(1, sha1, NULL, 0);
463
464         if (get_sha1_with_context(obj_name, 0, sha1c, &obj_context))
465                 die(_("Not a valid object name %s"), obj_name);
466         if (!obj_context.path[0] ||
467             !textconv_object(obj_context.path, obj_context.mode, sha1c, 1, &buf, &size))
468                 return stream_blob_to_fd(1, sha1, NULL, 0);
469
470         if (!buf)
471                 die(_("git show %s: bad file"), obj_name);
472
473         write_or_die(1, buf, size);
474         return 0;
475 }
476
477 static int show_tag_object(const unsigned char *sha1, struct rev_info *rev)
478 {
479         unsigned long size;
480         enum object_type type;
481         char *buf = read_sha1_file(sha1, &type, &size);
482         int offset = 0;
483
484         if (!buf)
485                 return error(_("Could not read object %s"), sha1_to_hex(sha1));
486
487         assert(type == OBJ_TAG);
488         while (offset < size && buf[offset] != '\n') {
489                 int new_offset = offset + 1;
490                 while (new_offset < size && buf[new_offset++] != '\n')
491                         ; /* do nothing */
492                 if (starts_with(buf + offset, "tagger "))
493                         show_tagger(buf + offset + 7,
494                                     new_offset - offset - 7, rev);
495                 offset = new_offset;
496         }
497
498         if (offset < size)
499                 fwrite(buf + offset, size - offset, 1, stdout);
500         free(buf);
501         return 0;
502 }
503
504 static int show_tree_object(const unsigned char *sha1,
505                 struct strbuf *base,
506                 const char *pathname, unsigned mode, int stage, void *context)
507 {
508         printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
509         return 0;
510 }
511
512 static void show_setup_revisions_tweak(struct rev_info *rev,
513                                        struct setup_revision_opt *opt)
514 {
515         if (rev->ignore_merges) {
516                 /* There was no "-m" on the command line */
517                 rev->ignore_merges = 0;
518                 if (!rev->first_parent_only && !rev->combine_merges) {
519                         /* No "--first-parent", "-c", or "--cc" */
520                         rev->combine_merges = 1;
521                         rev->dense_combined_merges = 1;
522                 }
523         }
524         if (!rev->diffopt.output_format)
525                 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
526 }
527
528 int cmd_show(int argc, const char **argv, const char *prefix)
529 {
530         struct rev_info rev;
531         struct object_array_entry *objects;
532         struct setup_revision_opt opt;
533         struct pathspec match_all;
534         int i, count, ret = 0;
535
536         init_log_defaults();
537         git_config(git_log_config, NULL);
538
539         memset(&match_all, 0, sizeof(match_all));
540         init_revisions(&rev, prefix);
541         rev.diff = 1;
542         rev.always_show_header = 1;
543         rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
544         rev.diffopt.stat_width = -1;    /* Scale to real terminal size */
545
546         memset(&opt, 0, sizeof(opt));
547         opt.def = "HEAD";
548         opt.tweak = show_setup_revisions_tweak;
549         cmd_log_init(argc, argv, prefix, &rev, &opt);
550
551         if (!rev.no_walk)
552                 return cmd_log_walk(&rev);
553
554         count = rev.pending.nr;
555         objects = rev.pending.objects;
556         for (i = 0; i < count && !ret; i++) {
557                 struct object *o = objects[i].item;
558                 const char *name = objects[i].name;
559                 switch (o->type) {
560                 case OBJ_BLOB:
561                         ret = show_blob_object(o->oid.hash, &rev, name);
562                         break;
563                 case OBJ_TAG: {
564                         struct tag *t = (struct tag *)o;
565
566                         if (rev.shown_one)
567                                 putchar('\n');
568                         printf("%stag %s%s\n",
569                                         diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
570                                         t->tag,
571                                         diff_get_color_opt(&rev.diffopt, DIFF_RESET));
572                         ret = show_tag_object(o->oid.hash, &rev);
573                         rev.shown_one = 1;
574                         if (ret)
575                                 break;
576                         o = parse_object(t->tagged->oid.hash);
577                         if (!o)
578                                 ret = error(_("Could not read object %s"),
579                                             oid_to_hex(&t->tagged->oid));
580                         objects[i].item = o;
581                         i--;
582                         break;
583                 }
584                 case OBJ_TREE:
585                         if (rev.shown_one)
586                                 putchar('\n');
587                         printf("%stree %s%s\n\n",
588                                         diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
589                                         name,
590                                         diff_get_color_opt(&rev.diffopt, DIFF_RESET));
591                         read_tree_recursive((struct tree *)o, "", 0, 0, &match_all,
592                                         show_tree_object, NULL);
593                         rev.shown_one = 1;
594                         break;
595                 case OBJ_COMMIT:
596                         rev.pending.nr = rev.pending.alloc = 0;
597                         rev.pending.objects = NULL;
598                         add_object_array(o, name, &rev.pending);
599                         ret = cmd_log_walk(&rev);
600                         break;
601                 default:
602                         ret = error(_("Unknown type: %d"), o->type);
603                 }
604         }
605         free(objects);
606         return ret;
607 }
608
609 /*
610  * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
611  */
612 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
613 {
614         struct rev_info rev;
615         struct setup_revision_opt opt;
616
617         init_log_defaults();
618         git_config(git_log_config, NULL);
619
620         init_revisions(&rev, prefix);
621         init_reflog_walk(&rev.reflog_info);
622         rev.verbose_header = 1;
623         memset(&opt, 0, sizeof(opt));
624         opt.def = "HEAD";
625         cmd_log_init_defaults(&rev);
626         rev.abbrev_commit = 1;
627         rev.commit_format = CMIT_FMT_ONELINE;
628         rev.use_terminator = 1;
629         rev.always_show_header = 1;
630         cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
631
632         return cmd_log_walk(&rev);
633 }
634
635 static void log_setup_revisions_tweak(struct rev_info *rev,
636                                       struct setup_revision_opt *opt)
637 {
638         if (DIFF_OPT_TST(&rev->diffopt, DEFAULT_FOLLOW_RENAMES) &&
639             rev->prune_data.nr == 1)
640                 DIFF_OPT_SET(&rev->diffopt, FOLLOW_RENAMES);
641
642         /* Turn --cc/-c into -p --cc/-c when -p was not given */
643         if (!rev->diffopt.output_format && rev->combine_merges)
644                 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
645
646         /* Turn -m on when --cc/-c was given */
647         if (rev->combine_merges)
648                 rev->ignore_merges = 0;
649 }
650
651 int cmd_log(int argc, const char **argv, const char *prefix)
652 {
653         struct rev_info rev;
654         struct setup_revision_opt opt;
655
656         init_log_defaults();
657         git_config(git_log_config, NULL);
658
659         init_revisions(&rev, prefix);
660         rev.always_show_header = 1;
661         memset(&opt, 0, sizeof(opt));
662         opt.def = "HEAD";
663         opt.revarg_opt = REVARG_COMMITTISH;
664         opt.tweak = log_setup_revisions_tweak;
665         cmd_log_init(argc, argv, prefix, &rev, &opt);
666         return cmd_log_walk(&rev);
667 }
668
669 /* format-patch */
670
671 static const char *fmt_patch_suffix = ".patch";
672 static int numbered = 0;
673 static int auto_number = 1;
674
675 static char *default_attach = NULL;
676
677 static struct string_list extra_hdr;
678 static struct string_list extra_to;
679 static struct string_list extra_cc;
680
681 static void add_header(const char *value)
682 {
683         struct string_list_item *item;
684         int len = strlen(value);
685         while (len && value[len - 1] == '\n')
686                 len--;
687
688         if (!strncasecmp(value, "to: ", 4)) {
689                 item = string_list_append(&extra_to, value + 4);
690                 len -= 4;
691         } else if (!strncasecmp(value, "cc: ", 4)) {
692                 item = string_list_append(&extra_cc, value + 4);
693                 len -= 4;
694         } else {
695                 item = string_list_append(&extra_hdr, value);
696         }
697
698         item->string[len] = '\0';
699 }
700
701 #define THREAD_SHALLOW 1
702 #define THREAD_DEEP 2
703 static int thread;
704 static int do_signoff;
705 static const char *signature = git_version_string;
706 static const char *signature_file;
707 static int config_cover_letter;
708 static const char *config_output_directory;
709
710 enum {
711         COVER_UNSET,
712         COVER_OFF,
713         COVER_ON,
714         COVER_AUTO
715 };
716
717 static int git_format_config(const char *var, const char *value, void *cb)
718 {
719         if (!strcmp(var, "format.headers")) {
720                 if (!value)
721                         die(_("format.headers without value"));
722                 add_header(value);
723                 return 0;
724         }
725         if (!strcmp(var, "format.suffix"))
726                 return git_config_string(&fmt_patch_suffix, var, value);
727         if (!strcmp(var, "format.to")) {
728                 if (!value)
729                         return config_error_nonbool(var);
730                 string_list_append(&extra_to, value);
731                 return 0;
732         }
733         if (!strcmp(var, "format.cc")) {
734                 if (!value)
735                         return config_error_nonbool(var);
736                 string_list_append(&extra_cc, value);
737                 return 0;
738         }
739         if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
740             !strcmp(var, "color.ui") || !strcmp(var, "diff.submodule")) {
741                 return 0;
742         }
743         if (!strcmp(var, "format.numbered")) {
744                 if (value && !strcasecmp(value, "auto")) {
745                         auto_number = 1;
746                         return 0;
747                 }
748                 numbered = git_config_bool(var, value);
749                 auto_number = auto_number && numbered;
750                 return 0;
751         }
752         if (!strcmp(var, "format.attach")) {
753                 if (value && *value)
754                         default_attach = xstrdup(value);
755                 else
756                         default_attach = xstrdup(git_version_string);
757                 return 0;
758         }
759         if (!strcmp(var, "format.thread")) {
760                 if (value && !strcasecmp(value, "deep")) {
761                         thread = THREAD_DEEP;
762                         return 0;
763                 }
764                 if (value && !strcasecmp(value, "shallow")) {
765                         thread = THREAD_SHALLOW;
766                         return 0;
767                 }
768                 thread = git_config_bool(var, value) && THREAD_SHALLOW;
769                 return 0;
770         }
771         if (!strcmp(var, "format.signoff")) {
772                 do_signoff = git_config_bool(var, value);
773                 return 0;
774         }
775         if (!strcmp(var, "format.signature"))
776                 return git_config_string(&signature, var, value);
777         if (!strcmp(var, "format.signaturefile"))
778                 return git_config_pathname(&signature_file, var, value);
779         if (!strcmp(var, "format.coverletter")) {
780                 if (value && !strcasecmp(value, "auto")) {
781                         config_cover_letter = COVER_AUTO;
782                         return 0;
783                 }
784                 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
785                 return 0;
786         }
787         if (!strcmp(var, "format.outputdirectory"))
788                 return git_config_string(&config_output_directory, var, value);
789
790         return git_log_config(var, value, cb);
791 }
792
793 static FILE *realstdout = NULL;
794 static const char *output_directory = NULL;
795 static int outdir_offset;
796
797 static int reopen_stdout(struct commit *commit, const char *subject,
798                          struct rev_info *rev, int quiet)
799 {
800         struct strbuf filename = STRBUF_INIT;
801         int suffix_len = strlen(rev->patch_suffix) + 1;
802
803         if (output_directory) {
804                 strbuf_addstr(&filename, output_directory);
805                 if (filename.len >=
806                     PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
807                         return error(_("name of output directory is too long"));
808                 strbuf_complete(&filename, '/');
809         }
810
811         if (rev->numbered_files)
812                 strbuf_addf(&filename, "%d", rev->nr);
813         else if (commit)
814                 fmt_output_commit(&filename, commit, rev);
815         else
816                 fmt_output_subject(&filename, subject, rev);
817
818         if (!quiet)
819                 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
820
821         if (freopen(filename.buf, "w", stdout) == NULL)
822                 return error(_("Cannot open patch file %s"), filename.buf);
823
824         strbuf_release(&filename);
825         return 0;
826 }
827
828 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
829 {
830         struct rev_info check_rev;
831         struct commit *commit, *c1, *c2;
832         struct object *o1, *o2;
833         unsigned flags1, flags2;
834
835         if (rev->pending.nr != 2)
836                 die(_("Need exactly one range."));
837
838         o1 = rev->pending.objects[0].item;
839         o2 = rev->pending.objects[1].item;
840         flags1 = o1->flags;
841         flags2 = o2->flags;
842         c1 = lookup_commit_reference(o1->oid.hash);
843         c2 = lookup_commit_reference(o2->oid.hash);
844
845         if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
846                 die(_("Not a range."));
847
848         init_patch_ids(ids);
849
850         /* given a range a..b get all patch ids for b..a */
851         init_revisions(&check_rev, rev->prefix);
852         check_rev.max_parents = 1;
853         o1->flags ^= UNINTERESTING;
854         o2->flags ^= UNINTERESTING;
855         add_pending_object(&check_rev, o1, "o1");
856         add_pending_object(&check_rev, o2, "o2");
857         if (prepare_revision_walk(&check_rev))
858                 die(_("revision walk setup failed"));
859
860         while ((commit = get_revision(&check_rev)) != NULL) {
861                 add_commit_patch_id(commit, ids);
862         }
863
864         /* reset for next revision walk */
865         clear_commit_marks(c1, SEEN | UNINTERESTING | SHOWN | ADDED);
866         clear_commit_marks(c2, SEEN | UNINTERESTING | SHOWN | ADDED);
867         o1->flags = flags1;
868         o2->flags = flags2;
869 }
870
871 static void gen_message_id(struct rev_info *info, char *base)
872 {
873         struct strbuf buf = STRBUF_INIT;
874         strbuf_addf(&buf, "%s.%lu.git.%s", base,
875                     (unsigned long) time(NULL),
876                     git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
877         info->message_id = strbuf_detach(&buf, NULL);
878 }
879
880 static void print_signature(void)
881 {
882         if (!signature || !*signature)
883                 return;
884
885         printf("-- \n%s", signature);
886         if (signature[strlen(signature)-1] != '\n')
887                 putchar('\n');
888         putchar('\n');
889 }
890
891 static void add_branch_description(struct strbuf *buf, const char *branch_name)
892 {
893         struct strbuf desc = STRBUF_INIT;
894         if (!branch_name || !*branch_name)
895                 return;
896         read_branch_desc(&desc, branch_name);
897         if (desc.len) {
898                 strbuf_addch(buf, '\n');
899                 strbuf_addbuf(buf, &desc);
900                 strbuf_addch(buf, '\n');
901         }
902         strbuf_release(&desc);
903 }
904
905 static char *find_branch_name(struct rev_info *rev)
906 {
907         int i, positive = -1;
908         struct object_id branch_oid;
909         const struct object_id *tip_oid;
910         const char *ref, *v;
911         char *full_ref, *branch = NULL;
912
913         for (i = 0; i < rev->cmdline.nr; i++) {
914                 if (rev->cmdline.rev[i].flags & UNINTERESTING)
915                         continue;
916                 if (positive < 0)
917                         positive = i;
918                 else
919                         return NULL;
920         }
921         if (positive < 0)
922                 return NULL;
923         ref = rev->cmdline.rev[positive].name;
924         tip_oid = &rev->cmdline.rev[positive].item->oid;
925         if (dwim_ref(ref, strlen(ref), branch_oid.hash, &full_ref) &&
926             skip_prefix(full_ref, "refs/heads/", &v) &&
927             !oidcmp(tip_oid, &branch_oid))
928                 branch = xstrdup(v);
929         free(full_ref);
930         return branch;
931 }
932
933 static void make_cover_letter(struct rev_info *rev, int use_stdout,
934                               struct commit *origin,
935                               int nr, struct commit **list,
936                               const char *branch_name,
937                               int quiet)
938 {
939         const char *committer;
940         const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
941         const char *msg;
942         struct shortlog log;
943         struct strbuf sb = STRBUF_INIT;
944         int i;
945         const char *encoding = "UTF-8";
946         struct diff_options opts;
947         int need_8bit_cte = 0;
948         struct pretty_print_context pp = {0};
949         struct commit *head = list[0];
950
951         if (rev->commit_format != CMIT_FMT_EMAIL)
952                 die(_("Cover letter needs email format"));
953
954         committer = git_committer_info(0);
955
956         if (!use_stdout &&
957             reopen_stdout(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
958                 return;
959
960         log_write_email_headers(rev, head, &pp.subject, &pp.after_subject,
961                                 &need_8bit_cte);
962
963         for (i = 0; !need_8bit_cte && i < nr; i++) {
964                 const char *buf = get_commit_buffer(list[i], NULL);
965                 if (has_non_ascii(buf))
966                         need_8bit_cte = 1;
967                 unuse_commit_buffer(list[i], buf);
968         }
969
970         if (!branch_name)
971                 branch_name = find_branch_name(rev);
972
973         msg = body;
974         pp.fmt = CMIT_FMT_EMAIL;
975         pp.date_mode.type = DATE_RFC2822;
976         pp_user_info(&pp, NULL, &sb, committer, encoding);
977         pp_title_line(&pp, &msg, &sb, encoding, need_8bit_cte);
978         pp_remainder(&pp, &msg, &sb, 0);
979         add_branch_description(&sb, branch_name);
980         printf("%s\n", sb.buf);
981
982         strbuf_release(&sb);
983
984         shortlog_init(&log);
985         log.wrap_lines = 1;
986         log.wrap = 72;
987         log.in1 = 2;
988         log.in2 = 4;
989         for (i = 0; i < nr; i++)
990                 shortlog_add_commit(&log, list[i]);
991
992         shortlog_output(&log);
993
994         /*
995          * We can only do diffstat with a unique reference point
996          */
997         if (!origin)
998                 return;
999
1000         memcpy(&opts, &rev->diffopt, sizeof(opts));
1001         opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1002
1003         diff_setup_done(&opts);
1004
1005         diff_tree_sha1(origin->tree->object.oid.hash,
1006                        head->tree->object.oid.hash,
1007                        "", &opts);
1008         diffcore_std(&opts);
1009         diff_flush(&opts);
1010
1011         printf("\n");
1012         print_signature();
1013 }
1014
1015 static const char *clean_message_id(const char *msg_id)
1016 {
1017         char ch;
1018         const char *a, *z, *m;
1019
1020         m = msg_id;
1021         while ((ch = *m) && (isspace(ch) || (ch == '<')))
1022                 m++;
1023         a = m;
1024         z = NULL;
1025         while ((ch = *m)) {
1026                 if (!isspace(ch) && (ch != '>'))
1027                         z = m;
1028                 m++;
1029         }
1030         if (!z)
1031                 die(_("insane in-reply-to: %s"), msg_id);
1032         if (++z == m)
1033                 return a;
1034         return xmemdupz(a, z - a);
1035 }
1036
1037 static const char *set_outdir(const char *prefix, const char *output_directory)
1038 {
1039         if (output_directory && is_absolute_path(output_directory))
1040                 return output_directory;
1041
1042         if (!prefix || !*prefix) {
1043                 if (output_directory)
1044                         return output_directory;
1045                 /* The user did not explicitly ask for "./" */
1046                 outdir_offset = 2;
1047                 return "./";
1048         }
1049
1050         outdir_offset = strlen(prefix);
1051         if (!output_directory)
1052                 return prefix;
1053
1054         return xstrdup(prefix_filename(prefix, outdir_offset,
1055                                        output_directory));
1056 }
1057
1058 static const char * const builtin_format_patch_usage[] = {
1059         N_("git format-patch [<options>] [<since> | <revision-range>]"),
1060         NULL
1061 };
1062
1063 static int keep_subject = 0;
1064
1065 static int keep_callback(const struct option *opt, const char *arg, int unset)
1066 {
1067         ((struct rev_info *)opt->value)->total = -1;
1068         keep_subject = 1;
1069         return 0;
1070 }
1071
1072 static int subject_prefix = 0;
1073
1074 static int subject_prefix_callback(const struct option *opt, const char *arg,
1075                             int unset)
1076 {
1077         subject_prefix = 1;
1078         ((struct rev_info *)opt->value)->subject_prefix = arg;
1079         return 0;
1080 }
1081
1082 static int numbered_cmdline_opt = 0;
1083
1084 static int numbered_callback(const struct option *opt, const char *arg,
1085                              int unset)
1086 {
1087         *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
1088         if (unset)
1089                 auto_number =  0;
1090         return 0;
1091 }
1092
1093 static int no_numbered_callback(const struct option *opt, const char *arg,
1094                                 int unset)
1095 {
1096         return numbered_callback(opt, arg, 1);
1097 }
1098
1099 static int output_directory_callback(const struct option *opt, const char *arg,
1100                               int unset)
1101 {
1102         const char **dir = (const char **)opt->value;
1103         if (*dir)
1104                 die(_("Two output directories?"));
1105         *dir = arg;
1106         return 0;
1107 }
1108
1109 static int thread_callback(const struct option *opt, const char *arg, int unset)
1110 {
1111         int *thread = (int *)opt->value;
1112         if (unset)
1113                 *thread = 0;
1114         else if (!arg || !strcmp(arg, "shallow"))
1115                 *thread = THREAD_SHALLOW;
1116         else if (!strcmp(arg, "deep"))
1117                 *thread = THREAD_DEEP;
1118         else
1119                 return 1;
1120         return 0;
1121 }
1122
1123 static int attach_callback(const struct option *opt, const char *arg, int unset)
1124 {
1125         struct rev_info *rev = (struct rev_info *)opt->value;
1126         if (unset)
1127                 rev->mime_boundary = NULL;
1128         else if (arg)
1129                 rev->mime_boundary = arg;
1130         else
1131                 rev->mime_boundary = git_version_string;
1132         rev->no_inline = unset ? 0 : 1;
1133         return 0;
1134 }
1135
1136 static int inline_callback(const struct option *opt, const char *arg, int unset)
1137 {
1138         struct rev_info *rev = (struct rev_info *)opt->value;
1139         if (unset)
1140                 rev->mime_boundary = NULL;
1141         else if (arg)
1142                 rev->mime_boundary = arg;
1143         else
1144                 rev->mime_boundary = git_version_string;
1145         rev->no_inline = 0;
1146         return 0;
1147 }
1148
1149 static int header_callback(const struct option *opt, const char *arg, int unset)
1150 {
1151         if (unset) {
1152                 string_list_clear(&extra_hdr, 0);
1153                 string_list_clear(&extra_to, 0);
1154                 string_list_clear(&extra_cc, 0);
1155         } else {
1156             add_header(arg);
1157         }
1158         return 0;
1159 }
1160
1161 static int to_callback(const struct option *opt, const char *arg, int unset)
1162 {
1163         if (unset)
1164                 string_list_clear(&extra_to, 0);
1165         else
1166                 string_list_append(&extra_to, arg);
1167         return 0;
1168 }
1169
1170 static int cc_callback(const struct option *opt, const char *arg, int unset)
1171 {
1172         if (unset)
1173                 string_list_clear(&extra_cc, 0);
1174         else
1175                 string_list_append(&extra_cc, arg);
1176         return 0;
1177 }
1178
1179 static int from_callback(const struct option *opt, const char *arg, int unset)
1180 {
1181         char **from = opt->value;
1182
1183         free(*from);
1184
1185         if (unset)
1186                 *from = NULL;
1187         else if (arg)
1188                 *from = xstrdup(arg);
1189         else
1190                 *from = xstrdup(git_committer_info(IDENT_NO_DATE));
1191         return 0;
1192 }
1193
1194 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1195 {
1196         struct commit *commit;
1197         struct commit **list = NULL;
1198         struct rev_info rev;
1199         struct setup_revision_opt s_r_opt;
1200         int nr = 0, total, i;
1201         int use_stdout = 0;
1202         int start_number = -1;
1203         int just_numbers = 0;
1204         int ignore_if_in_upstream = 0;
1205         int cover_letter = -1;
1206         int boundary_count = 0;
1207         int no_binary_diff = 0;
1208         int zero_commit = 0;
1209         struct commit *origin = NULL;
1210         const char *in_reply_to = NULL;
1211         struct patch_ids ids;
1212         struct strbuf buf = STRBUF_INIT;
1213         int use_patch_format = 0;
1214         int quiet = 0;
1215         int reroll_count = -1;
1216         char *branch_name = NULL;
1217         char *from = NULL;
1218         const struct option builtin_format_patch_options[] = {
1219                 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
1220                             N_("use [PATCH n/m] even with a single patch"),
1221                             PARSE_OPT_NOARG, numbered_callback },
1222                 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
1223                             N_("use [PATCH] even with multiple patches"),
1224                             PARSE_OPT_NOARG, no_numbered_callback },
1225                 OPT_BOOL('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
1226                 OPT_BOOL(0, "stdout", &use_stdout,
1227                             N_("print patches to standard out")),
1228                 OPT_BOOL(0, "cover-letter", &cover_letter,
1229                             N_("generate a cover letter")),
1230                 OPT_BOOL(0, "numbered-files", &just_numbers,
1231                             N_("use simple number sequence for output file names")),
1232                 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1233                             N_("use <sfx> instead of '.patch'")),
1234                 OPT_INTEGER(0, "start-number", &start_number,
1235                             N_("start numbering patches at <n> instead of 1")),
1236                 OPT_INTEGER('v', "reroll-count", &reroll_count,
1237                             N_("mark the series as Nth re-roll")),
1238                 { OPTION_CALLBACK, 0, "subject-prefix", &rev, N_("prefix"),
1239                             N_("Use [<prefix>] instead of [PATCH]"),
1240                             PARSE_OPT_NONEG, subject_prefix_callback },
1241                 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
1242                             N_("dir"), N_("store resulting files in <dir>"),
1243                             PARSE_OPT_NONEG, output_directory_callback },
1244                 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
1245                             N_("don't strip/add [PATCH]"),
1246                             PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
1247                 OPT_BOOL(0, "no-binary", &no_binary_diff,
1248                          N_("don't output binary diffs")),
1249                 OPT_BOOL(0, "zero-commit", &zero_commit,
1250                          N_("output all-zero hash in From header")),
1251                 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1252                          N_("don't include a patch matching a commit upstream")),
1253                 { OPTION_SET_INT, 'p', "no-stat", &use_patch_format, NULL,
1254                   N_("show patch format instead of default (patch + stat)"),
1255                   PARSE_OPT_NONEG | PARSE_OPT_NOARG, NULL, 1},
1256                 OPT_GROUP(N_("Messaging")),
1257                 { OPTION_CALLBACK, 0, "add-header", NULL, N_("header"),
1258                             N_("add email header"), 0, header_callback },
1259                 { OPTION_CALLBACK, 0, "to", NULL, N_("email"), N_("add To: header"),
1260                             0, to_callback },
1261                 { OPTION_CALLBACK, 0, "cc", NULL, N_("email"), N_("add Cc: header"),
1262                             0, cc_callback },
1263                 { OPTION_CALLBACK, 0, "from", &from, N_("ident"),
1264                             N_("set From address to <ident> (or committer ident if absent)"),
1265                             PARSE_OPT_OPTARG, from_callback },
1266                 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1267                             N_("make first mail a reply to <message-id>")),
1268                 { OPTION_CALLBACK, 0, "attach", &rev, N_("boundary"),
1269                             N_("attach the patch"), PARSE_OPT_OPTARG,
1270                             attach_callback },
1271                 { OPTION_CALLBACK, 0, "inline", &rev, N_("boundary"),
1272                             N_("inline the patch"),
1273                             PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1274                             inline_callback },
1275                 { OPTION_CALLBACK, 0, "thread", &thread, N_("style"),
1276                             N_("enable message threading, styles: shallow, deep"),
1277                             PARSE_OPT_OPTARG, thread_callback },
1278                 OPT_STRING(0, "signature", &signature, N_("signature"),
1279                             N_("add a signature")),
1280                 OPT_FILENAME(0, "signature-file", &signature_file,
1281                                 N_("add a signature from a file")),
1282                 OPT__QUIET(&quiet, N_("don't print the patch filenames")),
1283                 OPT_END()
1284         };
1285
1286         extra_hdr.strdup_strings = 1;
1287         extra_to.strdup_strings = 1;
1288         extra_cc.strdup_strings = 1;
1289         init_log_defaults();
1290         git_config(git_format_config, NULL);
1291         init_revisions(&rev, prefix);
1292         rev.commit_format = CMIT_FMT_EMAIL;
1293         rev.verbose_header = 1;
1294         rev.diff = 1;
1295         rev.max_parents = 1;
1296         DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
1297         rev.subject_prefix = fmt_patch_subject_prefix;
1298         memset(&s_r_opt, 0, sizeof(s_r_opt));
1299         s_r_opt.def = "HEAD";
1300         s_r_opt.revarg_opt = REVARG_COMMITTISH;
1301
1302         if (default_attach) {
1303                 rev.mime_boundary = default_attach;
1304                 rev.no_inline = 1;
1305         }
1306
1307         /*
1308          * Parse the arguments before setup_revisions(), or something
1309          * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1310          * possibly a valid SHA1.
1311          */
1312         argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1313                              builtin_format_patch_usage,
1314                              PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1315                              PARSE_OPT_KEEP_DASHDASH);
1316
1317         if (0 < reroll_count) {
1318                 struct strbuf sprefix = STRBUF_INIT;
1319                 strbuf_addf(&sprefix, "%s v%d",
1320                             rev.subject_prefix, reroll_count);
1321                 rev.reroll_count = reroll_count;
1322                 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1323         }
1324
1325         for (i = 0; i < extra_hdr.nr; i++) {
1326                 strbuf_addstr(&buf, extra_hdr.items[i].string);
1327                 strbuf_addch(&buf, '\n');
1328         }
1329
1330         if (extra_to.nr)
1331                 strbuf_addstr(&buf, "To: ");
1332         for (i = 0; i < extra_to.nr; i++) {
1333                 if (i)
1334                         strbuf_addstr(&buf, "    ");
1335                 strbuf_addstr(&buf, extra_to.items[i].string);
1336                 if (i + 1 < extra_to.nr)
1337                         strbuf_addch(&buf, ',');
1338                 strbuf_addch(&buf, '\n');
1339         }
1340
1341         if (extra_cc.nr)
1342                 strbuf_addstr(&buf, "Cc: ");
1343         for (i = 0; i < extra_cc.nr; i++) {
1344                 if (i)
1345                         strbuf_addstr(&buf, "    ");
1346                 strbuf_addstr(&buf, extra_cc.items[i].string);
1347                 if (i + 1 < extra_cc.nr)
1348                         strbuf_addch(&buf, ',');
1349                 strbuf_addch(&buf, '\n');
1350         }
1351
1352         rev.extra_headers = strbuf_detach(&buf, NULL);
1353
1354         if (from) {
1355                 if (split_ident_line(&rev.from_ident, from, strlen(from)))
1356                         die(_("invalid ident line: %s"), from);
1357         }
1358
1359         if (start_number < 0)
1360                 start_number = 1;
1361
1362         /*
1363          * If numbered is set solely due to format.numbered in config,
1364          * and it would conflict with --keep-subject (-k) from the
1365          * command line, reset "numbered".
1366          */
1367         if (numbered && keep_subject && !numbered_cmdline_opt)
1368                 numbered = 0;
1369
1370         if (numbered && keep_subject)
1371                 die (_("-n and -k are mutually exclusive."));
1372         if (keep_subject && subject_prefix)
1373                 die (_("--subject-prefix and -k are mutually exclusive."));
1374         rev.preserve_subject = keep_subject;
1375
1376         argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1377         if (argc > 1)
1378                 die (_("unrecognized argument: %s"), argv[1]);
1379
1380         if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1381                 die(_("--name-only does not make sense"));
1382         if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1383                 die(_("--name-status does not make sense"));
1384         if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1385                 die(_("--check does not make sense"));
1386
1387         if (!use_patch_format &&
1388                 (!rev.diffopt.output_format ||
1389                  rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1390                 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1391
1392         /* Always generate a patch */
1393         rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1394
1395         rev.zero_commit = zero_commit;
1396
1397         if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
1398                 DIFF_OPT_SET(&rev.diffopt, BINARY);
1399
1400         if (rev.show_notes)
1401                 init_display_notes(&rev.notes_opt);
1402
1403         if (!output_directory && !use_stdout)
1404                 output_directory = config_output_directory;
1405
1406         if (!use_stdout)
1407                 output_directory = set_outdir(prefix, output_directory);
1408         else
1409                 setup_pager();
1410
1411         if (output_directory) {
1412                 if (use_stdout)
1413                         die(_("standard output, or directory, which one?"));
1414                 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1415                         die_errno(_("Could not create directory '%s'"),
1416                                   output_directory);
1417         }
1418
1419         if (rev.pending.nr == 1) {
1420                 int check_head = 0;
1421
1422                 if (rev.max_count < 0 && !rev.show_root_diff) {
1423                         /*
1424                          * This is traditional behaviour of "git format-patch
1425                          * origin" that prepares what the origin side still
1426                          * does not have.
1427                          */
1428                         rev.pending.objects[0].item->flags |= UNINTERESTING;
1429                         add_head_to_pending(&rev);
1430                         check_head = 1;
1431                 }
1432                 /*
1433                  * Otherwise, it is "format-patch -22 HEAD", and/or
1434                  * "format-patch --root HEAD".  The user wants
1435                  * get_revision() to do the usual traversal.
1436                  */
1437
1438                 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
1439                         check_head = 1;
1440
1441                 if (check_head) {
1442                         unsigned char sha1[20];
1443                         const char *ref, *v;
1444                         ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
1445                                                  sha1, NULL);
1446                         if (ref && skip_prefix(ref, "refs/heads/", &v))
1447                                 branch_name = xstrdup(v);
1448                         else
1449                                 branch_name = xstrdup(""); /* no branch */
1450                 }
1451         }
1452
1453         /*
1454          * We cannot move this anywhere earlier because we do want to
1455          * know if --root was given explicitly from the command line.
1456          */
1457         rev.show_root_diff = 1;
1458
1459         if (ignore_if_in_upstream) {
1460                 /* Don't say anything if head and upstream are the same. */
1461                 if (rev.pending.nr == 2) {
1462                         struct object_array_entry *o = rev.pending.objects;
1463                         if (oidcmp(&o[0].item->oid, &o[1].item->oid) == 0)
1464                                 return 0;
1465                 }
1466                 get_patch_ids(&rev, &ids);
1467         }
1468
1469         if (!use_stdout)
1470                 realstdout = xfdopen(xdup(1), "w");
1471
1472         if (prepare_revision_walk(&rev))
1473                 die(_("revision walk setup failed"));
1474         rev.boundary = 1;
1475         while ((commit = get_revision(&rev)) != NULL) {
1476                 if (commit->object.flags & BOUNDARY) {
1477                         boundary_count++;
1478                         origin = (boundary_count == 1) ? commit : NULL;
1479                         continue;
1480                 }
1481
1482                 if (ignore_if_in_upstream && has_commit_patch_id(commit, &ids))
1483                         continue;
1484
1485                 nr++;
1486                 REALLOC_ARRAY(list, nr);
1487                 list[nr - 1] = commit;
1488         }
1489         if (nr == 0)
1490                 /* nothing to do */
1491                 return 0;
1492         total = nr;
1493         if (!keep_subject && auto_number && total > 1)
1494                 numbered = 1;
1495         if (numbered)
1496                 rev.total = total + start_number - 1;
1497         if (cover_letter == -1) {
1498                 if (config_cover_letter == COVER_AUTO)
1499                         cover_letter = (total > 1);
1500                 else
1501                         cover_letter = (config_cover_letter == COVER_ON);
1502         }
1503
1504         if (!signature) {
1505                 ; /* --no-signature inhibits all signatures */
1506         } else if (signature && signature != git_version_string) {
1507                 ; /* non-default signature already set */
1508         } else if (signature_file) {
1509                 struct strbuf buf = STRBUF_INIT;
1510
1511                 if (strbuf_read_file(&buf, signature_file, 128) < 0)
1512                         die_errno(_("unable to read signature file '%s'"), signature_file);
1513                 signature = strbuf_detach(&buf, NULL);
1514         }
1515
1516         if (in_reply_to || thread || cover_letter)
1517                 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1518         if (in_reply_to) {
1519                 const char *msgid = clean_message_id(in_reply_to);
1520                 string_list_append(rev.ref_message_ids, msgid);
1521         }
1522         rev.numbered_files = just_numbers;
1523         rev.patch_suffix = fmt_patch_suffix;
1524         if (cover_letter) {
1525                 if (thread)
1526                         gen_message_id(&rev, "cover");
1527                 make_cover_letter(&rev, use_stdout,
1528                                   origin, nr, list, branch_name, quiet);
1529                 total++;
1530                 start_number--;
1531         }
1532         rev.add_signoff = do_signoff;
1533         while (0 <= --nr) {
1534                 int shown;
1535                 commit = list[nr];
1536                 rev.nr = total - nr + (start_number - 1);
1537                 /* Make the second and subsequent mails replies to the first */
1538                 if (thread) {
1539                         /* Have we already had a message ID? */
1540                         if (rev.message_id) {
1541                                 /*
1542                                  * For deep threading: make every mail
1543                                  * a reply to the previous one, no
1544                                  * matter what other options are set.
1545                                  *
1546                                  * For shallow threading:
1547                                  *
1548                                  * Without --cover-letter and
1549                                  * --in-reply-to, make every mail a
1550                                  * reply to the one before.
1551                                  *
1552                                  * With --in-reply-to but no
1553                                  * --cover-letter, make every mail a
1554                                  * reply to the <reply-to>.
1555                                  *
1556                                  * With --cover-letter, make every
1557                                  * mail but the cover letter a reply
1558                                  * to the cover letter.  The cover
1559                                  * letter is a reply to the
1560                                  * --in-reply-to, if specified.
1561                                  */
1562                                 if (thread == THREAD_SHALLOW
1563                                     && rev.ref_message_ids->nr > 0
1564                                     && (!cover_letter || rev.nr > 1))
1565                                         free(rev.message_id);
1566                                 else
1567                                         string_list_append(rev.ref_message_ids,
1568                                                            rev.message_id);
1569                         }
1570                         gen_message_id(&rev, oid_to_hex(&commit->object.oid));
1571                 }
1572
1573                 if (!use_stdout &&
1574                     reopen_stdout(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
1575                         die(_("Failed to create output files"));
1576                 shown = log_tree_commit(&rev, commit);
1577                 free_commit_buffer(commit);
1578
1579                 /* We put one extra blank line between formatted
1580                  * patches and this flag is used by log-tree code
1581                  * to see if it needs to emit a LF before showing
1582                  * the log; when using one file per patch, we do
1583                  * not want the extra blank line.
1584                  */
1585                 if (!use_stdout)
1586                         rev.shown_one = 0;
1587                 if (shown) {
1588                         if (rev.mime_boundary)
1589                                 printf("\n--%s%s--\n\n\n",
1590                                        mime_boundary_leader,
1591                                        rev.mime_boundary);
1592                         else
1593                                 print_signature();
1594                 }
1595                 if (!use_stdout)
1596                         fclose(stdout);
1597         }
1598         free(list);
1599         free(branch_name);
1600         string_list_clear(&extra_to, 0);
1601         string_list_clear(&extra_cc, 0);
1602         string_list_clear(&extra_hdr, 0);
1603         if (ignore_if_in_upstream)
1604                 free_patch_ids(&ids);
1605         return 0;
1606 }
1607
1608 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1609 {
1610         unsigned char sha1[20];
1611         if (get_sha1(arg, sha1) == 0) {
1612                 struct commit *commit = lookup_commit_reference(sha1);
1613                 if (commit) {
1614                         commit->object.flags |= flags;
1615                         add_pending_object(revs, &commit->object, arg);
1616                         return 0;
1617                 }
1618         }
1619         return -1;
1620 }
1621
1622 static const char * const cherry_usage[] = {
1623         N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1624         NULL
1625 };
1626
1627 static void print_commit(char sign, struct commit *commit, int verbose,
1628                          int abbrev)
1629 {
1630         if (!verbose) {
1631                 printf("%c %s\n", sign,
1632                        find_unique_abbrev(commit->object.oid.hash, abbrev));
1633         } else {
1634                 struct strbuf buf = STRBUF_INIT;
1635                 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
1636                 printf("%c %s %s\n", sign,
1637                        find_unique_abbrev(commit->object.oid.hash, abbrev),
1638                        buf.buf);
1639                 strbuf_release(&buf);
1640         }
1641 }
1642
1643 int cmd_cherry(int argc, const char **argv, const char *prefix)
1644 {
1645         struct rev_info revs;
1646         struct patch_ids ids;
1647         struct commit *commit;
1648         struct commit_list *list = NULL;
1649         struct branch *current_branch;
1650         const char *upstream;
1651         const char *head = "HEAD";
1652         const char *limit = NULL;
1653         int verbose = 0, abbrev = 0;
1654
1655         struct option options[] = {
1656                 OPT__ABBREV(&abbrev),
1657                 OPT__VERBOSE(&verbose, N_("be verbose")),
1658                 OPT_END()
1659         };
1660
1661         argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
1662
1663         switch (argc) {
1664         case 3:
1665                 limit = argv[2];
1666                 /* FALLTHROUGH */
1667         case 2:
1668                 head = argv[1];
1669                 /* FALLTHROUGH */
1670         case 1:
1671                 upstream = argv[0];
1672                 break;
1673         default:
1674                 current_branch = branch_get(NULL);
1675                 upstream = branch_get_upstream(current_branch, NULL);
1676                 if (!upstream) {
1677                         fprintf(stderr, _("Could not find a tracked"
1678                                         " remote branch, please"
1679                                         " specify <upstream> manually.\n"));
1680                         usage_with_options(cherry_usage, options);
1681                 }
1682         }
1683
1684         init_revisions(&revs, prefix);
1685         revs.max_parents = 1;
1686
1687         if (add_pending_commit(head, &revs, 0))
1688                 die(_("Unknown commit %s"), head);
1689         if (add_pending_commit(upstream, &revs, UNINTERESTING))
1690                 die(_("Unknown commit %s"), upstream);
1691
1692         /* Don't say anything if head and upstream are the same. */
1693         if (revs.pending.nr == 2) {
1694                 struct object_array_entry *o = revs.pending.objects;
1695                 if (oidcmp(&o[0].item->oid, &o[1].item->oid) == 0)
1696                         return 0;
1697         }
1698
1699         get_patch_ids(&revs, &ids);
1700
1701         if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1702                 die(_("Unknown commit %s"), limit);
1703
1704         /* reverse the list of commits */
1705         if (prepare_revision_walk(&revs))
1706                 die(_("revision walk setup failed"));
1707         while ((commit = get_revision(&revs)) != NULL) {
1708                 commit_list_insert(commit, &list);
1709         }
1710
1711         while (list) {
1712                 char sign = '+';
1713
1714                 commit = list->item;
1715                 if (has_commit_patch_id(commit, &ids))
1716                         sign = '-';
1717                 print_commit(sign, commit, verbose, abbrev);
1718                 list = list->next;
1719         }
1720
1721         free_patch_ids(&ids);
1722         return 0;
1723 }