grep: use designated initializers for `grep_defaults`
[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 #define USE_THE_INDEX_COMPATIBILITY_MACROS
8 #include "cache.h"
9 #include "config.h"
10 #include "refs.h"
11 #include "object-store.h"
12 #include "color.h"
13 #include "commit.h"
14 #include "diff.h"
15 #include "revision.h"
16 #include "log-tree.h"
17 #include "builtin.h"
18 #include "tag.h"
19 #include "reflog-walk.h"
20 #include "patch-ids.h"
21 #include "run-command.h"
22 #include "shortlog.h"
23 #include "remote.h"
24 #include "string-list.h"
25 #include "parse-options.h"
26 #include "line-log.h"
27 #include "branch.h"
28 #include "streaming.h"
29 #include "version.h"
30 #include "mailmap.h"
31 #include "gpg-interface.h"
32 #include "progress.h"
33 #include "commit-slab.h"
34 #include "repository.h"
35 #include "commit-reach.h"
36 #include "range-diff.h"
37
38 #define MAIL_DEFAULT_WRAP 72
39 #define COVER_FROM_AUTO_MAX_SUBJECT_LEN 100
40
41 /* Set a default date-time format for git log ("log.date" config variable) */
42 static const char *default_date_mode = NULL;
43
44 static int default_abbrev_commit;
45 static int default_show_root = 1;
46 static int default_follow;
47 static int default_show_signature;
48 static int default_encode_email_headers = 1;
49 static int decoration_style;
50 static int decoration_given;
51 static int use_mailmap_config = 1;
52 static const char *fmt_patch_subject_prefix = "PATCH";
53 static const char *fmt_pretty;
54
55 static const char * const builtin_log_usage[] = {
56         N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
57         N_("git show [<options>] <object>..."),
58         NULL
59 };
60
61 struct line_opt_callback_data {
62         struct rev_info *rev;
63         const char *prefix;
64         struct string_list args;
65 };
66
67 static int session_is_interactive(void)
68 {
69         return isatty(1) || pager_in_use();
70 }
71
72 static int auto_decoration_style(void)
73 {
74         return session_is_interactive() ? DECORATE_SHORT_REFS : 0;
75 }
76
77 static int parse_decoration_style(const char *value)
78 {
79         switch (git_parse_maybe_bool(value)) {
80         case 1:
81                 return DECORATE_SHORT_REFS;
82         case 0:
83                 return 0;
84         default:
85                 break;
86         }
87         if (!strcmp(value, "full"))
88                 return DECORATE_FULL_REFS;
89         else if (!strcmp(value, "short"))
90                 return DECORATE_SHORT_REFS;
91         else if (!strcmp(value, "auto"))
92                 return auto_decoration_style();
93         /*
94          * Please update _git_log() in git-completion.bash when you
95          * add new decoration styles.
96          */
97         return -1;
98 }
99
100 static int decorate_callback(const struct option *opt, const char *arg, int unset)
101 {
102         if (unset)
103                 decoration_style = 0;
104         else if (arg)
105                 decoration_style = parse_decoration_style(arg);
106         else
107                 decoration_style = DECORATE_SHORT_REFS;
108
109         if (decoration_style < 0)
110                 die(_("invalid --decorate option: %s"), arg);
111
112         decoration_given = 1;
113
114         return 0;
115 }
116
117 static int log_line_range_callback(const struct option *option, const char *arg, int unset)
118 {
119         struct line_opt_callback_data *data = option->value;
120
121         BUG_ON_OPT_NEG(unset);
122
123         if (!arg)
124                 return -1;
125
126         data->rev->line_level_traverse = 1;
127         string_list_append(&data->args, arg);
128
129         return 0;
130 }
131
132 static void init_log_defaults(void)
133 {
134         init_diff_ui_defaults();
135
136         decoration_style = auto_decoration_style();
137 }
138
139 static void cmd_log_init_defaults(struct rev_info *rev)
140 {
141         if (fmt_pretty)
142                 get_commit_format(fmt_pretty, rev);
143         if (default_follow)
144                 rev->diffopt.flags.default_follow_renames = 1;
145         rev->verbose_header = 1;
146         rev->diffopt.flags.recursive = 1;
147         rev->diffopt.stat_width = -1; /* use full terminal width */
148         rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
149         rev->abbrev_commit = default_abbrev_commit;
150         rev->show_root_diff = default_show_root;
151         rev->subject_prefix = fmt_patch_subject_prefix;
152         rev->show_signature = default_show_signature;
153         rev->encode_email_headers = default_encode_email_headers;
154         rev->diffopt.flags.allow_textconv = 1;
155
156         if (default_date_mode)
157                 parse_date_format(default_date_mode, &rev->date_mode);
158 }
159
160 static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
161                          struct rev_info *rev, struct setup_revision_opt *opt)
162 {
163         struct userformat_want w;
164         int quiet = 0, source = 0, mailmap;
165         static struct line_opt_callback_data line_cb = {NULL, NULL, STRING_LIST_INIT_DUP};
166         static struct string_list decorate_refs_exclude = STRING_LIST_INIT_NODUP;
167         static struct string_list decorate_refs_exclude_config = STRING_LIST_INIT_NODUP;
168         static struct string_list decorate_refs_include = STRING_LIST_INIT_NODUP;
169         struct decoration_filter decoration_filter = {&decorate_refs_include,
170                                                       &decorate_refs_exclude,
171                                                       &decorate_refs_exclude_config};
172         static struct revision_sources revision_sources;
173
174         const struct option builtin_log_options[] = {
175                 OPT__QUIET(&quiet, N_("suppress diff output")),
176                 OPT_BOOL(0, "source", &source, N_("show source")),
177                 OPT_BOOL(0, "use-mailmap", &mailmap, N_("Use mail map file")),
178                 OPT_ALIAS(0, "mailmap", "use-mailmap"),
179                 OPT_STRING_LIST(0, "decorate-refs", &decorate_refs_include,
180                                 N_("pattern"), N_("only decorate refs that match <pattern>")),
181                 OPT_STRING_LIST(0, "decorate-refs-exclude", &decorate_refs_exclude,
182                                 N_("pattern"), N_("do not decorate refs that match <pattern>")),
183                 OPT_CALLBACK_F(0, "decorate", NULL, NULL, N_("decorate options"),
184                                PARSE_OPT_OPTARG, decorate_callback),
185                 OPT_CALLBACK('L', NULL, &line_cb, "range:file",
186                              N_("Trace the evolution of line range <start>,<end> or function :<funcname> in <file>"),
187                              log_line_range_callback),
188                 OPT_END()
189         };
190
191         line_cb.rev = rev;
192         line_cb.prefix = prefix;
193
194         mailmap = use_mailmap_config;
195         argc = parse_options(argc, argv, prefix,
196                              builtin_log_options, builtin_log_usage,
197                              PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
198                              PARSE_OPT_KEEP_DASHDASH);
199
200         if (quiet)
201                 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
202         argc = setup_revisions(argc, argv, rev, opt);
203
204         /* Any arguments at this point are not recognized */
205         if (argc > 1)
206                 die(_("unrecognized argument: %s"), argv[1]);
207
208         if (rev->line_level_traverse && rev->prune_data.nr)
209                 die(_("-L<range>:<file> cannot be used with pathspec"));
210
211         memset(&w, 0, sizeof(w));
212         userformat_find_requirements(NULL, &w);
213
214         if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
215                 rev->show_notes = 1;
216         if (rev->show_notes)
217                 load_display_notes(&rev->notes_opt);
218
219         if ((rev->diffopt.pickaxe_opts & DIFF_PICKAXE_KINDS_MASK) ||
220             rev->diffopt.filter || rev->diffopt.flags.follow_renames)
221                 rev->always_show_header = 0;
222
223         if (source || w.source) {
224                 init_revision_sources(&revision_sources);
225                 rev->sources = &revision_sources;
226         }
227
228         if (mailmap) {
229                 rev->mailmap = xcalloc(1, sizeof(struct string_list));
230                 read_mailmap(rev->mailmap, NULL);
231         }
232
233         if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
234                 /*
235                  * "log --pretty=raw" is special; ignore UI oriented
236                  * configuration variables such as decoration.
237                  */
238                 if (!decoration_given)
239                         decoration_style = 0;
240                 if (!rev->abbrev_commit_given)
241                         rev->abbrev_commit = 0;
242         }
243
244         if (decoration_style) {
245                 const struct string_list *config_exclude =
246                         repo_config_get_value_multi(the_repository,
247                                                     "log.excludeDecoration");
248
249                 if (config_exclude) {
250                         struct string_list_item *item;
251                         for_each_string_list_item(item, config_exclude)
252                                 string_list_append(&decorate_refs_exclude_config,
253                                                    item->string);
254                 }
255
256                 rev->show_decorations = 1;
257
258                 load_ref_decorations(&decoration_filter, decoration_style);
259         }
260
261         if (rev->line_level_traverse)
262                 line_log_init(rev, line_cb.prefix, &line_cb.args);
263
264         setup_pager();
265 }
266
267 static void cmd_log_init(int argc, const char **argv, const char *prefix,
268                          struct rev_info *rev, struct setup_revision_opt *opt)
269 {
270         cmd_log_init_defaults(rev);
271         cmd_log_init_finish(argc, argv, prefix, rev, opt);
272 }
273
274 /*
275  * This gives a rough estimate for how many commits we
276  * will print out in the list.
277  */
278 static int estimate_commit_count(struct commit_list *list)
279 {
280         int n = 0;
281
282         while (list) {
283                 struct commit *commit = list->item;
284                 unsigned int flags = commit->object.flags;
285                 list = list->next;
286                 if (!(flags & (TREESAME | UNINTERESTING)))
287                         n++;
288         }
289         return n;
290 }
291
292 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
293 {
294         if (rev->shown_one) {
295                 rev->shown_one = 0;
296                 if (rev->commit_format != CMIT_FMT_ONELINE)
297                         putchar(rev->diffopt.line_termination);
298         }
299         fprintf(rev->diffopt.file, _("Final output: %d %s\n"), nr, stage);
300 }
301
302 static struct itimerval early_output_timer;
303
304 static void log_show_early(struct rev_info *revs, struct commit_list *list)
305 {
306         int i = revs->early_output, close_file = revs->diffopt.close_file;
307         int show_header = 1;
308
309         revs->diffopt.close_file = 0;
310         sort_in_topological_order(&list, revs->sort_order);
311         while (list && i) {
312                 struct commit *commit = list->item;
313                 switch (simplify_commit(revs, commit)) {
314                 case commit_show:
315                         if (show_header) {
316                                 int n = estimate_commit_count(list);
317                                 show_early_header(revs, "incomplete", n);
318                                 show_header = 0;
319                         }
320                         log_tree_commit(revs, commit);
321                         i--;
322                         break;
323                 case commit_ignore:
324                         break;
325                 case commit_error:
326                         if (close_file)
327                                 fclose(revs->diffopt.file);
328                         return;
329                 }
330                 list = list->next;
331         }
332
333         /* Did we already get enough commits for the early output? */
334         if (!i) {
335                 if (close_file)
336                         fclose(revs->diffopt.file);
337                 return;
338         }
339
340         /*
341          * ..if no, then repeat it twice a second until we
342          * do.
343          *
344          * NOTE! We don't use "it_interval", because if the
345          * reader isn't listening, we want our output to be
346          * throttled by the writing, and not have the timer
347          * trigger every second even if we're blocked on a
348          * reader!
349          */
350         early_output_timer.it_value.tv_sec = 0;
351         early_output_timer.it_value.tv_usec = 500000;
352         setitimer(ITIMER_REAL, &early_output_timer, NULL);
353 }
354
355 static void early_output(int signal)
356 {
357         show_early_output = log_show_early;
358 }
359
360 static void setup_early_output(void)
361 {
362         struct sigaction sa;
363
364         /*
365          * Set up the signal handler, minimally intrusively:
366          * we only set a single volatile integer word (not
367          * using sigatomic_t - trying to avoid unnecessary
368          * system dependencies and headers), and using
369          * SA_RESTART.
370          */
371         memset(&sa, 0, sizeof(sa));
372         sa.sa_handler = early_output;
373         sigemptyset(&sa.sa_mask);
374         sa.sa_flags = SA_RESTART;
375         sigaction(SIGALRM, &sa, NULL);
376
377         /*
378          * If we can get the whole output in less than a
379          * tenth of a second, don't even bother doing the
380          * early-output thing..
381          *
382          * This is a one-time-only trigger.
383          */
384         early_output_timer.it_value.tv_sec = 0;
385         early_output_timer.it_value.tv_usec = 100000;
386         setitimer(ITIMER_REAL, &early_output_timer, NULL);
387 }
388
389 static void finish_early_output(struct rev_info *rev)
390 {
391         int n = estimate_commit_count(rev->commits);
392         signal(SIGALRM, SIG_IGN);
393         show_early_header(rev, "done", n);
394 }
395
396 static int cmd_log_walk(struct rev_info *rev)
397 {
398         struct commit *commit;
399         int saved_nrl = 0;
400         int saved_dcctc = 0, close_file = rev->diffopt.close_file;
401
402         if (rev->early_output)
403                 setup_early_output();
404
405         if (prepare_revision_walk(rev))
406                 die(_("revision walk setup failed"));
407
408         if (rev->early_output)
409                 finish_early_output(rev);
410
411         /*
412          * For --check and --exit-code, the exit code is based on CHECK_FAILED
413          * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
414          * retain that state information if replacing rev->diffopt in this loop
415          */
416         rev->diffopt.close_file = 0;
417         while ((commit = get_revision(rev)) != NULL) {
418                 if (!log_tree_commit(rev, commit) && rev->max_count >= 0)
419                         /*
420                          * We decremented max_count in get_revision,
421                          * but we didn't actually show the commit.
422                          */
423                         rev->max_count++;
424                 if (!rev->reflog_info) {
425                         /*
426                          * We may show a given commit multiple times when
427                          * walking the reflogs.
428                          */
429                         free_commit_buffer(the_repository->parsed_objects,
430                                            commit);
431                         free_commit_list(commit->parents);
432                         commit->parents = NULL;
433                 }
434                 if (saved_nrl < rev->diffopt.needed_rename_limit)
435                         saved_nrl = rev->diffopt.needed_rename_limit;
436                 if (rev->diffopt.degraded_cc_to_c)
437                         saved_dcctc = 1;
438         }
439         rev->diffopt.degraded_cc_to_c = saved_dcctc;
440         rev->diffopt.needed_rename_limit = saved_nrl;
441         if (close_file)
442                 fclose(rev->diffopt.file);
443
444         if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
445             rev->diffopt.flags.check_failed) {
446                 return 02;
447         }
448         return diff_result_code(&rev->diffopt, 0);
449 }
450
451 static int git_log_config(const char *var, const char *value, void *cb)
452 {
453         const char *slot_name;
454
455         if (!strcmp(var, "format.pretty"))
456                 return git_config_string(&fmt_pretty, var, value);
457         if (!strcmp(var, "format.subjectprefix"))
458                 return git_config_string(&fmt_patch_subject_prefix, var, value);
459         if (!strcmp(var, "format.encodeemailheaders")) {
460                 default_encode_email_headers = git_config_bool(var, value);
461                 return 0;
462         }
463         if (!strcmp(var, "log.abbrevcommit")) {
464                 default_abbrev_commit = git_config_bool(var, value);
465                 return 0;
466         }
467         if (!strcmp(var, "log.date"))
468                 return git_config_string(&default_date_mode, var, value);
469         if (!strcmp(var, "log.decorate")) {
470                 decoration_style = parse_decoration_style(value);
471                 if (decoration_style < 0)
472                         decoration_style = 0; /* maybe warn? */
473                 return 0;
474         }
475         if (!strcmp(var, "log.showroot")) {
476                 default_show_root = git_config_bool(var, value);
477                 return 0;
478         }
479         if (!strcmp(var, "log.follow")) {
480                 default_follow = git_config_bool(var, value);
481                 return 0;
482         }
483         if (skip_prefix(var, "color.decorate.", &slot_name))
484                 return parse_decorate_color_config(var, slot_name, value);
485         if (!strcmp(var, "log.mailmap")) {
486                 use_mailmap_config = git_config_bool(var, value);
487                 return 0;
488         }
489         if (!strcmp(var, "log.showsignature")) {
490                 default_show_signature = git_config_bool(var, value);
491                 return 0;
492         }
493
494         if (grep_config(var, value, cb) < 0)
495                 return -1;
496         if (git_gpg_config(var, value, cb) < 0)
497                 return -1;
498         return git_diff_ui_config(var, value, cb);
499 }
500
501 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
502 {
503         struct rev_info rev;
504         struct setup_revision_opt opt;
505
506         init_log_defaults();
507         git_config(git_log_config, NULL);
508
509         repo_init_revisions(the_repository, &rev, prefix);
510         rev.diff = 1;
511         rev.simplify_history = 0;
512         memset(&opt, 0, sizeof(opt));
513         opt.def = "HEAD";
514         opt.revarg_opt = REVARG_COMMITTISH;
515         cmd_log_init(argc, argv, prefix, &rev, &opt);
516         if (!rev.diffopt.output_format)
517                 rev.diffopt.output_format = DIFF_FORMAT_RAW;
518         return cmd_log_walk(&rev);
519 }
520
521 static void show_tagger(const char *buf, struct rev_info *rev)
522 {
523         struct strbuf out = STRBUF_INIT;
524         struct pretty_print_context pp = {0};
525
526         pp.fmt = rev->commit_format;
527         pp.date_mode = rev->date_mode;
528         pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
529         fprintf(rev->diffopt.file, "%s", out.buf);
530         strbuf_release(&out);
531 }
532
533 static int show_blob_object(const struct object_id *oid, struct rev_info *rev, const char *obj_name)
534 {
535         struct object_id oidc;
536         struct object_context obj_context;
537         char *buf;
538         unsigned long size;
539
540         fflush(rev->diffopt.file);
541         if (!rev->diffopt.flags.textconv_set_via_cmdline ||
542             !rev->diffopt.flags.allow_textconv)
543                 return stream_blob_to_fd(1, oid, NULL, 0);
544
545         if (get_oid_with_context(the_repository, obj_name,
546                                  GET_OID_RECORD_PATH,
547                                  &oidc, &obj_context))
548                 die(_("not a valid object name %s"), obj_name);
549         if (!obj_context.path ||
550             !textconv_object(the_repository, obj_context.path,
551                              obj_context.mode, &oidc, 1, &buf, &size)) {
552                 free(obj_context.path);
553                 return stream_blob_to_fd(1, oid, NULL, 0);
554         }
555
556         if (!buf)
557                 die(_("git show %s: bad file"), obj_name);
558
559         write_or_die(1, buf, size);
560         free(obj_context.path);
561         return 0;
562 }
563
564 static int show_tag_object(const struct object_id *oid, struct rev_info *rev)
565 {
566         unsigned long size;
567         enum object_type type;
568         char *buf = read_object_file(oid, &type, &size);
569         int offset = 0;
570
571         if (!buf)
572                 return error(_("could not read object %s"), oid_to_hex(oid));
573
574         assert(type == OBJ_TAG);
575         while (offset < size && buf[offset] != '\n') {
576                 int new_offset = offset + 1;
577                 const char *ident;
578                 while (new_offset < size && buf[new_offset++] != '\n')
579                         ; /* do nothing */
580                 if (skip_prefix(buf + offset, "tagger ", &ident))
581                         show_tagger(ident, rev);
582                 offset = new_offset;
583         }
584
585         if (offset < size)
586                 fwrite(buf + offset, size - offset, 1, rev->diffopt.file);
587         free(buf);
588         return 0;
589 }
590
591 static int show_tree_object(const struct object_id *oid,
592                 struct strbuf *base,
593                 const char *pathname, unsigned mode, int stage, void *context)
594 {
595         FILE *file = context;
596         fprintf(file, "%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
597         return 0;
598 }
599
600 static void show_setup_revisions_tweak(struct rev_info *rev,
601                                        struct setup_revision_opt *opt)
602 {
603         if (rev->ignore_merges < 0) {
604                 /* There was no "-m" variant on the command line */
605                 rev->ignore_merges = 0;
606                 if (!rev->first_parent_only && !rev->combine_merges) {
607                         /* No "--first-parent", "-c", or "--cc" */
608                         rev->combine_merges = 1;
609                         rev->dense_combined_merges = 1;
610                 }
611         }
612         if (!rev->diffopt.output_format)
613                 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
614 }
615
616 int cmd_show(int argc, const char **argv, const char *prefix)
617 {
618         struct rev_info rev;
619         struct object_array_entry *objects;
620         struct setup_revision_opt opt;
621         struct pathspec match_all;
622         int i, count, ret = 0;
623
624         init_log_defaults();
625         git_config(git_log_config, NULL);
626
627         memset(&match_all, 0, sizeof(match_all));
628         repo_init_revisions(the_repository, &rev, prefix);
629         rev.diff = 1;
630         rev.always_show_header = 1;
631         rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
632         rev.diffopt.stat_width = -1;    /* Scale to real terminal size */
633
634         memset(&opt, 0, sizeof(opt));
635         opt.def = "HEAD";
636         opt.tweak = show_setup_revisions_tweak;
637         cmd_log_init(argc, argv, prefix, &rev, &opt);
638
639         if (!rev.no_walk)
640                 return cmd_log_walk(&rev);
641
642         count = rev.pending.nr;
643         objects = rev.pending.objects;
644         for (i = 0; i < count && !ret; i++) {
645                 struct object *o = objects[i].item;
646                 const char *name = objects[i].name;
647                 switch (o->type) {
648                 case OBJ_BLOB:
649                         ret = show_blob_object(&o->oid, &rev, name);
650                         break;
651                 case OBJ_TAG: {
652                         struct tag *t = (struct tag *)o;
653                         struct object_id *oid = get_tagged_oid(t);
654
655                         if (rev.shown_one)
656                                 putchar('\n');
657                         fprintf(rev.diffopt.file, "%stag %s%s\n",
658                                         diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
659                                         t->tag,
660                                         diff_get_color_opt(&rev.diffopt, DIFF_RESET));
661                         ret = show_tag_object(&o->oid, &rev);
662                         rev.shown_one = 1;
663                         if (ret)
664                                 break;
665                         o = parse_object(the_repository, oid);
666                         if (!o)
667                                 ret = error(_("could not read object %s"),
668                                             oid_to_hex(oid));
669                         objects[i].item = o;
670                         i--;
671                         break;
672                 }
673                 case OBJ_TREE:
674                         if (rev.shown_one)
675                                 putchar('\n');
676                         fprintf(rev.diffopt.file, "%stree %s%s\n\n",
677                                         diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
678                                         name,
679                                         diff_get_color_opt(&rev.diffopt, DIFF_RESET));
680                         read_tree_recursive(the_repository, (struct tree *)o, "",
681                                             0, 0, &match_all, show_tree_object,
682                                             rev.diffopt.file);
683                         rev.shown_one = 1;
684                         break;
685                 case OBJ_COMMIT:
686                         rev.pending.nr = rev.pending.alloc = 0;
687                         rev.pending.objects = NULL;
688                         add_object_array(o, name, &rev.pending);
689                         ret = cmd_log_walk(&rev);
690                         break;
691                 default:
692                         ret = error(_("unknown type: %d"), o->type);
693                 }
694         }
695         free(objects);
696         return ret;
697 }
698
699 /*
700  * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
701  */
702 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
703 {
704         struct rev_info rev;
705         struct setup_revision_opt opt;
706
707         init_log_defaults();
708         git_config(git_log_config, NULL);
709
710         repo_init_revisions(the_repository, &rev, prefix);
711         init_reflog_walk(&rev.reflog_info);
712         rev.verbose_header = 1;
713         memset(&opt, 0, sizeof(opt));
714         opt.def = "HEAD";
715         cmd_log_init_defaults(&rev);
716         rev.abbrev_commit = 1;
717         rev.commit_format = CMIT_FMT_ONELINE;
718         rev.use_terminator = 1;
719         rev.always_show_header = 1;
720         cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
721
722         return cmd_log_walk(&rev);
723 }
724
725 static void log_setup_revisions_tweak(struct rev_info *rev,
726                                       struct setup_revision_opt *opt)
727 {
728         if (rev->diffopt.flags.default_follow_renames &&
729             rev->prune_data.nr == 1)
730                 rev->diffopt.flags.follow_renames = 1;
731
732         /* Turn --cc/-c into -p --cc/-c when -p was not given */
733         if (!rev->diffopt.output_format && rev->combine_merges)
734                 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
735
736         if (rev->first_parent_only && rev->ignore_merges < 0)
737                 rev->ignore_merges = 0;
738 }
739
740 int cmd_log(int argc, const char **argv, const char *prefix)
741 {
742         struct rev_info rev;
743         struct setup_revision_opt opt;
744
745         init_log_defaults();
746         git_config(git_log_config, NULL);
747
748         repo_init_revisions(the_repository, &rev, prefix);
749         rev.always_show_header = 1;
750         memset(&opt, 0, sizeof(opt));
751         opt.def = "HEAD";
752         opt.revarg_opt = REVARG_COMMITTISH;
753         opt.tweak = log_setup_revisions_tweak;
754         cmd_log_init(argc, argv, prefix, &rev, &opt);
755         return cmd_log_walk(&rev);
756 }
757
758 /* format-patch */
759
760 static const char *fmt_patch_suffix = ".patch";
761 static int numbered = 0;
762 static int auto_number = 1;
763
764 static char *default_attach = NULL;
765
766 static struct string_list extra_hdr = STRING_LIST_INIT_NODUP;
767 static struct string_list extra_to = STRING_LIST_INIT_NODUP;
768 static struct string_list extra_cc = STRING_LIST_INIT_NODUP;
769
770 static void add_header(const char *value)
771 {
772         struct string_list_item *item;
773         int len = strlen(value);
774         while (len && value[len - 1] == '\n')
775                 len--;
776
777         if (!strncasecmp(value, "to: ", 4)) {
778                 item = string_list_append(&extra_to, value + 4);
779                 len -= 4;
780         } else if (!strncasecmp(value, "cc: ", 4)) {
781                 item = string_list_append(&extra_cc, value + 4);
782                 len -= 4;
783         } else {
784                 item = string_list_append(&extra_hdr, value);
785         }
786
787         item->string[len] = '\0';
788 }
789
790 enum cover_setting {
791         COVER_UNSET,
792         COVER_OFF,
793         COVER_ON,
794         COVER_AUTO
795 };
796
797 enum thread_level {
798         THREAD_UNSET,
799         THREAD_SHALLOW,
800         THREAD_DEEP
801 };
802
803 enum cover_from_description {
804         COVER_FROM_NONE,
805         COVER_FROM_MESSAGE,
806         COVER_FROM_SUBJECT,
807         COVER_FROM_AUTO
808 };
809
810 enum auto_base_setting {
811         AUTO_BASE_NEVER,
812         AUTO_BASE_ALWAYS,
813         AUTO_BASE_WHEN_ABLE
814 };
815
816 static enum thread_level thread;
817 static int do_signoff;
818 static enum auto_base_setting auto_base;
819 static char *from;
820 static const char *signature = git_version_string;
821 static const char *signature_file;
822 static enum cover_setting config_cover_letter;
823 static const char *config_output_directory;
824 static enum cover_from_description cover_from_description_mode = COVER_FROM_MESSAGE;
825 static int show_notes;
826 static struct display_notes_opt notes_opt;
827
828 static enum cover_from_description parse_cover_from_description(const char *arg)
829 {
830         if (!arg || !strcmp(arg, "default"))
831                 return COVER_FROM_MESSAGE;
832         else if (!strcmp(arg, "none"))
833                 return COVER_FROM_NONE;
834         else if (!strcmp(arg, "message"))
835                 return COVER_FROM_MESSAGE;
836         else if (!strcmp(arg, "subject"))
837                 return COVER_FROM_SUBJECT;
838         else if (!strcmp(arg, "auto"))
839                 return COVER_FROM_AUTO;
840         else
841                 die(_("%s: invalid cover from description mode"), arg);
842 }
843
844 static int git_format_config(const char *var, const char *value, void *cb)
845 {
846         if (!strcmp(var, "format.headers")) {
847                 if (!value)
848                         die(_("format.headers without value"));
849                 add_header(value);
850                 return 0;
851         }
852         if (!strcmp(var, "format.suffix"))
853                 return git_config_string(&fmt_patch_suffix, var, value);
854         if (!strcmp(var, "format.to")) {
855                 if (!value)
856                         return config_error_nonbool(var);
857                 string_list_append(&extra_to, value);
858                 return 0;
859         }
860         if (!strcmp(var, "format.cc")) {
861                 if (!value)
862                         return config_error_nonbool(var);
863                 string_list_append(&extra_cc, value);
864                 return 0;
865         }
866         if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
867             !strcmp(var, "color.ui") || !strcmp(var, "diff.submodule")) {
868                 return 0;
869         }
870         if (!strcmp(var, "format.numbered")) {
871                 if (value && !strcasecmp(value, "auto")) {
872                         auto_number = 1;
873                         return 0;
874                 }
875                 numbered = git_config_bool(var, value);
876                 auto_number = auto_number && numbered;
877                 return 0;
878         }
879         if (!strcmp(var, "format.attach")) {
880                 if (value && *value)
881                         default_attach = xstrdup(value);
882                 else
883                         default_attach = xstrdup(git_version_string);
884                 return 0;
885         }
886         if (!strcmp(var, "format.thread")) {
887                 if (value && !strcasecmp(value, "deep")) {
888                         thread = THREAD_DEEP;
889                         return 0;
890                 }
891                 if (value && !strcasecmp(value, "shallow")) {
892                         thread = THREAD_SHALLOW;
893                         return 0;
894                 }
895                 thread = git_config_bool(var, value) ? THREAD_SHALLOW : THREAD_UNSET;
896                 return 0;
897         }
898         if (!strcmp(var, "format.signoff")) {
899                 do_signoff = git_config_bool(var, value);
900                 return 0;
901         }
902         if (!strcmp(var, "format.signature"))
903                 return git_config_string(&signature, var, value);
904         if (!strcmp(var, "format.signaturefile"))
905                 return git_config_pathname(&signature_file, var, value);
906         if (!strcmp(var, "format.coverletter")) {
907                 if (value && !strcasecmp(value, "auto")) {
908                         config_cover_letter = COVER_AUTO;
909                         return 0;
910                 }
911                 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
912                 return 0;
913         }
914         if (!strcmp(var, "format.outputdirectory"))
915                 return git_config_string(&config_output_directory, var, value);
916         if (!strcmp(var, "format.useautobase")) {
917                 if (value && !strcasecmp(value, "whenAble")) {
918                         auto_base = AUTO_BASE_WHEN_ABLE;
919                         return 0;
920                 }
921                 auto_base = git_config_bool(var, value) ? AUTO_BASE_ALWAYS : AUTO_BASE_NEVER;
922                 return 0;
923         }
924         if (!strcmp(var, "format.from")) {
925                 int b = git_parse_maybe_bool(value);
926                 free(from);
927                 if (b < 0)
928                         from = xstrdup(value);
929                 else if (b)
930                         from = xstrdup(git_committer_info(IDENT_NO_DATE));
931                 else
932                         from = NULL;
933                 return 0;
934         }
935         if (!strcmp(var, "format.notes")) {
936                 int b = git_parse_maybe_bool(value);
937                 if (b < 0)
938                         enable_ref_display_notes(&notes_opt, &show_notes, value);
939                 else if (b)
940                         enable_default_display_notes(&notes_opt, &show_notes);
941                 else
942                         disable_display_notes(&notes_opt, &show_notes);
943                 return 0;
944         }
945         if (!strcmp(var, "format.coverfromdescription")) {
946                 cover_from_description_mode = parse_cover_from_description(value);
947                 return 0;
948         }
949
950         return git_log_config(var, value, cb);
951 }
952
953 static const char *output_directory = NULL;
954 static int outdir_offset;
955
956 static int open_next_file(struct commit *commit, const char *subject,
957                          struct rev_info *rev, int quiet)
958 {
959         struct strbuf filename = STRBUF_INIT;
960         int suffix_len = strlen(rev->patch_suffix) + 1;
961
962         if (output_directory) {
963                 strbuf_addstr(&filename, output_directory);
964                 if (filename.len >=
965                     PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len) {
966                         strbuf_release(&filename);
967                         return error(_("name of output directory is too long"));
968                 }
969                 strbuf_complete(&filename, '/');
970         }
971
972         if (rev->numbered_files)
973                 strbuf_addf(&filename, "%d", rev->nr);
974         else if (commit)
975                 fmt_output_commit(&filename, commit, rev);
976         else
977                 fmt_output_subject(&filename, subject, rev);
978
979         if (!quiet)
980                 printf("%s\n", filename.buf + outdir_offset);
981
982         if ((rev->diffopt.file = fopen(filename.buf, "w")) == NULL) {
983                 error_errno(_("cannot open patch file %s"), filename.buf);
984                 strbuf_release(&filename);
985                 return -1;
986         }
987
988         strbuf_release(&filename);
989         return 0;
990 }
991
992 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
993 {
994         struct rev_info check_rev;
995         struct commit *commit, *c1, *c2;
996         struct object *o1, *o2;
997         unsigned flags1, flags2;
998
999         if (rev->pending.nr != 2)
1000                 die(_("need exactly one range"));
1001
1002         o1 = rev->pending.objects[0].item;
1003         o2 = rev->pending.objects[1].item;
1004         flags1 = o1->flags;
1005         flags2 = o2->flags;
1006         c1 = lookup_commit_reference(the_repository, &o1->oid);
1007         c2 = lookup_commit_reference(the_repository, &o2->oid);
1008
1009         if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
1010                 die(_("not a range"));
1011
1012         init_patch_ids(the_repository, ids);
1013
1014         /* given a range a..b get all patch ids for b..a */
1015         repo_init_revisions(the_repository, &check_rev, rev->prefix);
1016         check_rev.max_parents = 1;
1017         o1->flags ^= UNINTERESTING;
1018         o2->flags ^= UNINTERESTING;
1019         add_pending_object(&check_rev, o1, "o1");
1020         add_pending_object(&check_rev, o2, "o2");
1021         if (prepare_revision_walk(&check_rev))
1022                 die(_("revision walk setup failed"));
1023
1024         while ((commit = get_revision(&check_rev)) != NULL) {
1025                 add_commit_patch_id(commit, ids);
1026         }
1027
1028         /* reset for next revision walk */
1029         clear_commit_marks(c1, SEEN | UNINTERESTING | SHOWN | ADDED);
1030         clear_commit_marks(c2, SEEN | UNINTERESTING | SHOWN | ADDED);
1031         o1->flags = flags1;
1032         o2->flags = flags2;
1033 }
1034
1035 static void gen_message_id(struct rev_info *info, char *base)
1036 {
1037         struct strbuf buf = STRBUF_INIT;
1038         strbuf_addf(&buf, "%s.%"PRItime".git.%s", base,
1039                     (timestamp_t) time(NULL),
1040                     git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
1041         info->message_id = strbuf_detach(&buf, NULL);
1042 }
1043
1044 static void print_signature(FILE *file)
1045 {
1046         if (!signature || !*signature)
1047                 return;
1048
1049         fprintf(file, "-- \n%s", signature);
1050         if (signature[strlen(signature)-1] != '\n')
1051                 putc('\n', file);
1052         putc('\n', file);
1053 }
1054
1055 static char *find_branch_name(struct rev_info *rev)
1056 {
1057         int i, positive = -1;
1058         struct object_id branch_oid;
1059         const struct object_id *tip_oid;
1060         const char *ref, *v;
1061         char *full_ref, *branch = NULL;
1062
1063         for (i = 0; i < rev->cmdline.nr; i++) {
1064                 if (rev->cmdline.rev[i].flags & UNINTERESTING)
1065                         continue;
1066                 if (positive < 0)
1067                         positive = i;
1068                 else
1069                         return NULL;
1070         }
1071         if (positive < 0)
1072                 return NULL;
1073         ref = rev->cmdline.rev[positive].name;
1074         tip_oid = &rev->cmdline.rev[positive].item->oid;
1075         if (dwim_ref(ref, strlen(ref), &branch_oid, &full_ref, 0) &&
1076             skip_prefix(full_ref, "refs/heads/", &v) &&
1077             oideq(tip_oid, &branch_oid))
1078                 branch = xstrdup(v);
1079         free(full_ref);
1080         return branch;
1081 }
1082
1083 static void show_diffstat(struct rev_info *rev,
1084                           struct commit *origin, struct commit *head)
1085 {
1086         struct diff_options opts;
1087
1088         memcpy(&opts, &rev->diffopt, sizeof(opts));
1089         opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1090         diff_setup_done(&opts);
1091
1092         diff_tree_oid(get_commit_tree_oid(origin),
1093                       get_commit_tree_oid(head),
1094                       "", &opts);
1095         diffcore_std(&opts);
1096         diff_flush(&opts);
1097
1098         fprintf(rev->diffopt.file, "\n");
1099 }
1100
1101 static void prepare_cover_text(struct pretty_print_context *pp,
1102                                const char *branch_name,
1103                                struct strbuf *sb,
1104                                const char *encoding,
1105                                int need_8bit_cte)
1106 {
1107         const char *subject = "*** SUBJECT HERE ***";
1108         const char *body = "*** BLURB HERE ***";
1109         struct strbuf description_sb = STRBUF_INIT;
1110         struct strbuf subject_sb = STRBUF_INIT;
1111
1112         if (cover_from_description_mode == COVER_FROM_NONE)
1113                 goto do_pp;
1114
1115         if (branch_name && *branch_name)
1116                 read_branch_desc(&description_sb, branch_name);
1117         if (!description_sb.len)
1118                 goto do_pp;
1119
1120         if (cover_from_description_mode == COVER_FROM_SUBJECT ||
1121                         cover_from_description_mode == COVER_FROM_AUTO)
1122                 body = format_subject(&subject_sb, description_sb.buf, " ");
1123
1124         if (cover_from_description_mode == COVER_FROM_MESSAGE ||
1125                         (cover_from_description_mode == COVER_FROM_AUTO &&
1126                          subject_sb.len > COVER_FROM_AUTO_MAX_SUBJECT_LEN))
1127                 body = description_sb.buf;
1128         else
1129                 subject = subject_sb.buf;
1130
1131 do_pp:
1132         pp_title_line(pp, &subject, sb, encoding, need_8bit_cte);
1133         pp_remainder(pp, &body, sb, 0);
1134
1135         strbuf_release(&description_sb);
1136         strbuf_release(&subject_sb);
1137 }
1138
1139 static int get_notes_refs(struct string_list_item *item, void *arg)
1140 {
1141         strvec_pushf(arg, "--notes=%s", item->string);
1142         return 0;
1143 }
1144
1145 static void get_notes_args(struct strvec *arg, struct rev_info *rev)
1146 {
1147         if (!rev->show_notes) {
1148                 strvec_push(arg, "--no-notes");
1149         } else if (rev->notes_opt.use_default_notes > 0 ||
1150                    (rev->notes_opt.use_default_notes == -1 &&
1151                     !rev->notes_opt.extra_notes_refs.nr)) {
1152                 strvec_push(arg, "--notes");
1153         } else {
1154                 for_each_string_list(&rev->notes_opt.extra_notes_refs, get_notes_refs, arg);
1155         }
1156 }
1157
1158 static void make_cover_letter(struct rev_info *rev, int use_separate_file,
1159                               struct commit *origin,
1160                               int nr, struct commit **list,
1161                               const char *branch_name,
1162                               int quiet)
1163 {
1164         const char *committer;
1165         struct shortlog log;
1166         struct strbuf sb = STRBUF_INIT;
1167         int i;
1168         const char *encoding = "UTF-8";
1169         int need_8bit_cte = 0;
1170         struct pretty_print_context pp = {0};
1171         struct commit *head = list[0];
1172
1173         if (!cmit_fmt_is_mail(rev->commit_format))
1174                 die(_("cover letter needs email format"));
1175
1176         committer = git_committer_info(0);
1177
1178         if (use_separate_file &&
1179             open_next_file(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
1180                 die(_("failed to create cover-letter file"));
1181
1182         log_write_email_headers(rev, head, &pp.after_subject, &need_8bit_cte, 0);
1183
1184         for (i = 0; !need_8bit_cte && i < nr; i++) {
1185                 const char *buf = get_commit_buffer(list[i], NULL);
1186                 if (has_non_ascii(buf))
1187                         need_8bit_cte = 1;
1188                 unuse_commit_buffer(list[i], buf);
1189         }
1190
1191         if (!branch_name)
1192                 branch_name = find_branch_name(rev);
1193
1194         pp.fmt = CMIT_FMT_EMAIL;
1195         pp.date_mode.type = DATE_RFC2822;
1196         pp.rev = rev;
1197         pp.print_email_subject = 1;
1198         pp_user_info(&pp, NULL, &sb, committer, encoding);
1199         prepare_cover_text(&pp, branch_name, &sb, encoding, need_8bit_cte);
1200         fprintf(rev->diffopt.file, "%s\n", sb.buf);
1201
1202         strbuf_release(&sb);
1203
1204         shortlog_init(&log);
1205         log.wrap_lines = 1;
1206         log.wrap = MAIL_DEFAULT_WRAP;
1207         log.in1 = 2;
1208         log.in2 = 4;
1209         log.file = rev->diffopt.file;
1210         log.groups = SHORTLOG_GROUP_AUTHOR;
1211         for (i = 0; i < nr; i++)
1212                 shortlog_add_commit(&log, list[i]);
1213
1214         shortlog_output(&log);
1215
1216         /* We can only do diffstat with a unique reference point */
1217         if (origin)
1218                 show_diffstat(rev, origin, head);
1219
1220         if (rev->idiff_oid1) {
1221                 fprintf_ln(rev->diffopt.file, "%s", rev->idiff_title);
1222                 show_interdiff(rev->idiff_oid1, rev->idiff_oid2, 0,
1223                                &rev->diffopt);
1224         }
1225
1226         if (rev->rdiff1) {
1227                 /*
1228                  * Pass minimum required diff-options to range-diff; others
1229                  * can be added later if deemed desirable.
1230                  */
1231                 struct diff_options opts;
1232                 struct strvec other_arg = STRVEC_INIT;
1233                 diff_setup(&opts);
1234                 opts.file = rev->diffopt.file;
1235                 opts.use_color = rev->diffopt.use_color;
1236                 diff_setup_done(&opts);
1237                 fprintf_ln(rev->diffopt.file, "%s", rev->rdiff_title);
1238                 get_notes_args(&other_arg, rev);
1239                 show_range_diff(rev->rdiff1, rev->rdiff2,
1240                                 rev->creation_factor, 1, &opts, &other_arg);
1241                 strvec_clear(&other_arg);
1242         }
1243 }
1244
1245 static const char *clean_message_id(const char *msg_id)
1246 {
1247         char ch;
1248         const char *a, *z, *m;
1249
1250         m = msg_id;
1251         while ((ch = *m) && (isspace(ch) || (ch == '<')))
1252                 m++;
1253         a = m;
1254         z = NULL;
1255         while ((ch = *m)) {
1256                 if (!isspace(ch) && (ch != '>'))
1257                         z = m;
1258                 m++;
1259         }
1260         if (!z)
1261                 die(_("insane in-reply-to: %s"), msg_id);
1262         if (++z == m)
1263                 return a;
1264         return xmemdupz(a, z - a);
1265 }
1266
1267 static const char *set_outdir(const char *prefix, const char *output_directory)
1268 {
1269         if (output_directory && is_absolute_path(output_directory))
1270                 return output_directory;
1271
1272         if (!prefix || !*prefix) {
1273                 if (output_directory)
1274                         return output_directory;
1275                 /* The user did not explicitly ask for "./" */
1276                 outdir_offset = 2;
1277                 return "./";
1278         }
1279
1280         outdir_offset = strlen(prefix);
1281         if (!output_directory)
1282                 return prefix;
1283
1284         return prefix_filename(prefix, output_directory);
1285 }
1286
1287 static const char * const builtin_format_patch_usage[] = {
1288         N_("git format-patch [<options>] [<since> | <revision-range>]"),
1289         NULL
1290 };
1291
1292 static int keep_subject = 0;
1293
1294 static int keep_callback(const struct option *opt, const char *arg, int unset)
1295 {
1296         BUG_ON_OPT_NEG(unset);
1297         BUG_ON_OPT_ARG(arg);
1298         ((struct rev_info *)opt->value)->total = -1;
1299         keep_subject = 1;
1300         return 0;
1301 }
1302
1303 static int subject_prefix = 0;
1304
1305 static int subject_prefix_callback(const struct option *opt, const char *arg,
1306                             int unset)
1307 {
1308         BUG_ON_OPT_NEG(unset);
1309         subject_prefix = 1;
1310         ((struct rev_info *)opt->value)->subject_prefix = arg;
1311         return 0;
1312 }
1313
1314 static int rfc_callback(const struct option *opt, const char *arg, int unset)
1315 {
1316         BUG_ON_OPT_NEG(unset);
1317         BUG_ON_OPT_ARG(arg);
1318         return subject_prefix_callback(opt, "RFC PATCH", unset);
1319 }
1320
1321 static int numbered_cmdline_opt = 0;
1322
1323 static int numbered_callback(const struct option *opt, const char *arg,
1324                              int unset)
1325 {
1326         BUG_ON_OPT_ARG(arg);
1327         *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
1328         if (unset)
1329                 auto_number =  0;
1330         return 0;
1331 }
1332
1333 static int no_numbered_callback(const struct option *opt, const char *arg,
1334                                 int unset)
1335 {
1336         BUG_ON_OPT_NEG(unset);
1337         return numbered_callback(opt, arg, 1);
1338 }
1339
1340 static int output_directory_callback(const struct option *opt, const char *arg,
1341                               int unset)
1342 {
1343         const char **dir = (const char **)opt->value;
1344         BUG_ON_OPT_NEG(unset);
1345         if (*dir)
1346                 die(_("two output directories?"));
1347         *dir = arg;
1348         return 0;
1349 }
1350
1351 static int thread_callback(const struct option *opt, const char *arg, int unset)
1352 {
1353         enum thread_level *thread = (enum thread_level *)opt->value;
1354         if (unset)
1355                 *thread = THREAD_UNSET;
1356         else if (!arg || !strcmp(arg, "shallow"))
1357                 *thread = THREAD_SHALLOW;
1358         else if (!strcmp(arg, "deep"))
1359                 *thread = THREAD_DEEP;
1360         /*
1361          * Please update _git_formatpatch() in git-completion.bash
1362          * when you add new options.
1363          */
1364         else
1365                 return 1;
1366         return 0;
1367 }
1368
1369 static int attach_callback(const struct option *opt, const char *arg, int unset)
1370 {
1371         struct rev_info *rev = (struct rev_info *)opt->value;
1372         if (unset)
1373                 rev->mime_boundary = NULL;
1374         else if (arg)
1375                 rev->mime_boundary = arg;
1376         else
1377                 rev->mime_boundary = git_version_string;
1378         rev->no_inline = unset ? 0 : 1;
1379         return 0;
1380 }
1381
1382 static int inline_callback(const struct option *opt, const char *arg, int unset)
1383 {
1384         struct rev_info *rev = (struct rev_info *)opt->value;
1385         if (unset)
1386                 rev->mime_boundary = NULL;
1387         else if (arg)
1388                 rev->mime_boundary = arg;
1389         else
1390                 rev->mime_boundary = git_version_string;
1391         rev->no_inline = 0;
1392         return 0;
1393 }
1394
1395 static int header_callback(const struct option *opt, const char *arg, int unset)
1396 {
1397         if (unset) {
1398                 string_list_clear(&extra_hdr, 0);
1399                 string_list_clear(&extra_to, 0);
1400                 string_list_clear(&extra_cc, 0);
1401         } else {
1402                 add_header(arg);
1403         }
1404         return 0;
1405 }
1406
1407 static int to_callback(const struct option *opt, const char *arg, int unset)
1408 {
1409         if (unset)
1410                 string_list_clear(&extra_to, 0);
1411         else
1412                 string_list_append(&extra_to, arg);
1413         return 0;
1414 }
1415
1416 static int cc_callback(const struct option *opt, const char *arg, int unset)
1417 {
1418         if (unset)
1419                 string_list_clear(&extra_cc, 0);
1420         else
1421                 string_list_append(&extra_cc, arg);
1422         return 0;
1423 }
1424
1425 static int from_callback(const struct option *opt, const char *arg, int unset)
1426 {
1427         char **from = opt->value;
1428
1429         free(*from);
1430
1431         if (unset)
1432                 *from = NULL;
1433         else if (arg)
1434                 *from = xstrdup(arg);
1435         else
1436                 *from = xstrdup(git_committer_info(IDENT_NO_DATE));
1437         return 0;
1438 }
1439
1440 static int base_callback(const struct option *opt, const char *arg, int unset)
1441 {
1442         const char **base_commit = opt->value;
1443
1444         if (unset) {
1445                 auto_base = AUTO_BASE_NEVER;
1446                 *base_commit = NULL;
1447         } else if (!strcmp(arg, "auto")) {
1448                 auto_base = AUTO_BASE_ALWAYS;
1449                 *base_commit = NULL;
1450         } else {
1451                 auto_base = AUTO_BASE_NEVER;
1452                 *base_commit = arg;
1453         }
1454         return 0;
1455 }
1456
1457 struct base_tree_info {
1458         struct object_id base_commit;
1459         int nr_patch_id, alloc_patch_id;
1460         struct object_id *patch_id;
1461 };
1462
1463 static struct commit *get_base_commit(const char *base_commit,
1464                                       struct commit **list,
1465                                       int total)
1466 {
1467         struct commit *base = NULL;
1468         struct commit **rev;
1469         int i = 0, rev_nr = 0, auto_select, die_on_failure;
1470
1471         switch (auto_base) {
1472         case AUTO_BASE_NEVER:
1473                 if (base_commit) {
1474                         auto_select = 0;
1475                         die_on_failure = 1;
1476                 } else {
1477                         /* no base information is requested */
1478                         return NULL;
1479                 }
1480                 break;
1481         case AUTO_BASE_ALWAYS:
1482         case AUTO_BASE_WHEN_ABLE:
1483                 if (base_commit) {
1484                         BUG("requested automatic base selection but a commit was provided");
1485                 } else {
1486                         auto_select = 1;
1487                         die_on_failure = auto_base == AUTO_BASE_ALWAYS;
1488                 }
1489                 break;
1490         default:
1491                 BUG("unexpected automatic base selection method");
1492         }
1493
1494         if (!auto_select) {
1495                 base = lookup_commit_reference_by_name(base_commit);
1496                 if (!base)
1497                         die(_("unknown commit %s"), base_commit);
1498         } else {
1499                 struct branch *curr_branch = branch_get(NULL);
1500                 const char *upstream = branch_get_upstream(curr_branch, NULL);
1501                 if (upstream) {
1502                         struct commit_list *base_list;
1503                         struct commit *commit;
1504                         struct object_id oid;
1505
1506                         if (get_oid(upstream, &oid)) {
1507                                 if (die_on_failure)
1508                                         die(_("failed to resolve '%s' as a valid ref"), upstream);
1509                                 else
1510                                         return NULL;
1511                         }
1512                         commit = lookup_commit_or_die(&oid, "upstream base");
1513                         base_list = get_merge_bases_many(commit, total, list);
1514                         /* There should be one and only one merge base. */
1515                         if (!base_list || base_list->next) {
1516                                 if (die_on_failure) {
1517                                         die(_("could not find exact merge base"));
1518                                 } else {
1519                                         free_commit_list(base_list);
1520                                         return NULL;
1521                                 }
1522                         }
1523                         base = base_list->item;
1524                         free_commit_list(base_list);
1525                 } else {
1526                         if (die_on_failure)
1527                                 die(_("failed to get upstream, if you want to record base commit automatically,\n"
1528                                       "please use git branch --set-upstream-to to track a remote branch.\n"
1529                                       "Or you could specify base commit by --base=<base-commit-id> manually"));
1530                         else
1531                                 return NULL;
1532                 }
1533         }
1534
1535         ALLOC_ARRAY(rev, total);
1536         for (i = 0; i < total; i++)
1537                 rev[i] = list[i];
1538
1539         rev_nr = total;
1540         /*
1541          * Get merge base through pair-wise computations
1542          * and store it in rev[0].
1543          */
1544         while (rev_nr > 1) {
1545                 for (i = 0; i < rev_nr / 2; i++) {
1546                         struct commit_list *merge_base;
1547                         merge_base = get_merge_bases(rev[2 * i], rev[2 * i + 1]);
1548                         if (!merge_base || merge_base->next) {
1549                                 if (die_on_failure) {
1550                                         die(_("failed to find exact merge base"));
1551                                 } else {
1552                                         free(rev);
1553                                         return NULL;
1554                                 }
1555                         }
1556
1557                         rev[i] = merge_base->item;
1558                 }
1559
1560                 if (rev_nr % 2)
1561                         rev[i] = rev[2 * i];
1562                 rev_nr = DIV_ROUND_UP(rev_nr, 2);
1563         }
1564
1565         if (!in_merge_bases(base, rev[0])) {
1566                 if (die_on_failure) {
1567                         die(_("base commit should be the ancestor of revision list"));
1568                 } else {
1569                         free(rev);
1570                         return NULL;
1571                 }
1572         }
1573
1574         for (i = 0; i < total; i++) {
1575                 if (base == list[i]) {
1576                         if (die_on_failure) {
1577                                 die(_("base commit shouldn't be in revision list"));
1578                         } else {
1579                                 free(rev);
1580                                 return NULL;
1581                         }
1582                 }
1583         }
1584
1585         free(rev);
1586         return base;
1587 }
1588
1589 define_commit_slab(commit_base, int);
1590
1591 static void prepare_bases(struct base_tree_info *bases,
1592                           struct commit *base,
1593                           struct commit **list,
1594                           int total)
1595 {
1596         struct commit *commit;
1597         struct rev_info revs;
1598         struct diff_options diffopt;
1599         struct commit_base commit_base;
1600         int i;
1601
1602         if (!base)
1603                 return;
1604
1605         init_commit_base(&commit_base);
1606         repo_diff_setup(the_repository, &diffopt);
1607         diffopt.flags.recursive = 1;
1608         diff_setup_done(&diffopt);
1609
1610         oidcpy(&bases->base_commit, &base->object.oid);
1611
1612         repo_init_revisions(the_repository, &revs, NULL);
1613         revs.max_parents = 1;
1614         revs.topo_order = 1;
1615         for (i = 0; i < total; i++) {
1616                 list[i]->object.flags &= ~UNINTERESTING;
1617                 add_pending_object(&revs, &list[i]->object, "rev_list");
1618                 *commit_base_at(&commit_base, list[i]) = 1;
1619         }
1620         base->object.flags |= UNINTERESTING;
1621         add_pending_object(&revs, &base->object, "base");
1622
1623         if (prepare_revision_walk(&revs))
1624                 die(_("revision walk setup failed"));
1625         /*
1626          * Traverse the commits list, get prerequisite patch ids
1627          * and stuff them in bases structure.
1628          */
1629         while ((commit = get_revision(&revs)) != NULL) {
1630                 struct object_id oid;
1631                 struct object_id *patch_id;
1632                 if (*commit_base_at(&commit_base, commit))
1633                         continue;
1634                 if (commit_patch_id(commit, &diffopt, &oid, 0, 1))
1635                         die(_("cannot get patch id"));
1636                 ALLOC_GROW(bases->patch_id, bases->nr_patch_id + 1, bases->alloc_patch_id);
1637                 patch_id = bases->patch_id + bases->nr_patch_id;
1638                 oidcpy(patch_id, &oid);
1639                 bases->nr_patch_id++;
1640         }
1641         clear_commit_base(&commit_base);
1642 }
1643
1644 static void print_bases(struct base_tree_info *bases, FILE *file)
1645 {
1646         int i;
1647
1648         /* Only do this once, either for the cover or for the first one */
1649         if (is_null_oid(&bases->base_commit))
1650                 return;
1651
1652         /* Show the base commit */
1653         fprintf(file, "\nbase-commit: %s\n", oid_to_hex(&bases->base_commit));
1654
1655         /* Show the prerequisite patches */
1656         for (i = bases->nr_patch_id - 1; i >= 0; i--)
1657                 fprintf(file, "prerequisite-patch-id: %s\n", oid_to_hex(&bases->patch_id[i]));
1658
1659         free(bases->patch_id);
1660         bases->nr_patch_id = 0;
1661         bases->alloc_patch_id = 0;
1662         oidclr(&bases->base_commit);
1663 }
1664
1665 static const char *diff_title(struct strbuf *sb, int reroll_count,
1666                        const char *generic, const char *rerolled)
1667 {
1668         if (reroll_count <= 0)
1669                 strbuf_addstr(sb, generic);
1670         else /* RFC may be v0, so allow -v1 to diff against v0 */
1671                 strbuf_addf(sb, rerolled, reroll_count - 1);
1672         return sb->buf;
1673 }
1674
1675 static void infer_range_diff_ranges(struct strbuf *r1,
1676                                     struct strbuf *r2,
1677                                     const char *prev,
1678                                     struct commit *origin,
1679                                     struct commit *head)
1680 {
1681         const char *head_oid = oid_to_hex(&head->object.oid);
1682         int prev_is_range = !!strstr(prev, "..");
1683
1684         if (prev_is_range)
1685                 strbuf_addstr(r1, prev);
1686         else
1687                 strbuf_addf(r1, "%s..%s", head_oid, prev);
1688
1689         if (origin)
1690                 strbuf_addf(r2, "%s..%s", oid_to_hex(&origin->object.oid), head_oid);
1691         else if (prev_is_range)
1692                 die(_("failed to infer range-diff origin of current series"));
1693         else {
1694                 warning(_("using '%s' as range-diff origin of current series"), prev);
1695                 strbuf_addf(r2, "%s..%s", prev, head_oid);
1696         }
1697 }
1698
1699 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1700 {
1701         struct commit *commit;
1702         struct commit **list = NULL;
1703         struct rev_info rev;
1704         struct setup_revision_opt s_r_opt;
1705         int nr = 0, total, i;
1706         int use_stdout = 0;
1707         int start_number = -1;
1708         int just_numbers = 0;
1709         int ignore_if_in_upstream = 0;
1710         int cover_letter = -1;
1711         int boundary_count = 0;
1712         int no_binary_diff = 0;
1713         int zero_commit = 0;
1714         struct commit *origin = NULL;
1715         const char *in_reply_to = NULL;
1716         struct patch_ids ids;
1717         struct strbuf buf = STRBUF_INIT;
1718         int use_patch_format = 0;
1719         int quiet = 0;
1720         int reroll_count = -1;
1721         char *cover_from_description_arg = NULL;
1722         char *branch_name = NULL;
1723         char *base_commit = NULL;
1724         struct base_tree_info bases;
1725         struct commit *base;
1726         int show_progress = 0;
1727         struct progress *progress = NULL;
1728         struct oid_array idiff_prev = OID_ARRAY_INIT;
1729         struct strbuf idiff_title = STRBUF_INIT;
1730         const char *rdiff_prev = NULL;
1731         struct strbuf rdiff1 = STRBUF_INIT;
1732         struct strbuf rdiff2 = STRBUF_INIT;
1733         struct strbuf rdiff_title = STRBUF_INIT;
1734         int creation_factor = -1;
1735
1736         const struct option builtin_format_patch_options[] = {
1737                 OPT_CALLBACK_F('n', "numbered", &numbered, NULL,
1738                             N_("use [PATCH n/m] even with a single patch"),
1739                             PARSE_OPT_NOARG, numbered_callback),
1740                 OPT_CALLBACK_F('N', "no-numbered", &numbered, NULL,
1741                             N_("use [PATCH] even with multiple patches"),
1742                             PARSE_OPT_NOARG | PARSE_OPT_NONEG, no_numbered_callback),
1743                 OPT_BOOL('s', "signoff", &do_signoff, N_("add a Signed-off-by trailer")),
1744                 OPT_BOOL(0, "stdout", &use_stdout,
1745                             N_("print patches to standard out")),
1746                 OPT_BOOL(0, "cover-letter", &cover_letter,
1747                             N_("generate a cover letter")),
1748                 OPT_BOOL(0, "numbered-files", &just_numbers,
1749                             N_("use simple number sequence for output file names")),
1750                 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1751                             N_("use <sfx> instead of '.patch'")),
1752                 OPT_INTEGER(0, "start-number", &start_number,
1753                             N_("start numbering patches at <n> instead of 1")),
1754                 OPT_INTEGER('v', "reroll-count", &reroll_count,
1755                             N_("mark the series as Nth re-roll")),
1756                 OPT_CALLBACK_F(0, "rfc", &rev, NULL,
1757                             N_("Use [RFC PATCH] instead of [PATCH]"),
1758                             PARSE_OPT_NOARG | PARSE_OPT_NONEG, rfc_callback),
1759                 OPT_STRING(0, "cover-from-description", &cover_from_description_arg,
1760                             N_("cover-from-description-mode"),
1761                             N_("generate parts of a cover letter based on a branch's description")),
1762                 OPT_CALLBACK_F(0, "subject-prefix", &rev, N_("prefix"),
1763                             N_("Use [<prefix>] instead of [PATCH]"),
1764                             PARSE_OPT_NONEG, subject_prefix_callback),
1765                 OPT_CALLBACK_F('o', "output-directory", &output_directory,
1766                             N_("dir"), N_("store resulting files in <dir>"),
1767                             PARSE_OPT_NONEG, output_directory_callback),
1768                 OPT_CALLBACK_F('k', "keep-subject", &rev, NULL,
1769                             N_("don't strip/add [PATCH]"),
1770                             PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback),
1771                 OPT_BOOL(0, "no-binary", &no_binary_diff,
1772                          N_("don't output binary diffs")),
1773                 OPT_BOOL(0, "zero-commit", &zero_commit,
1774                          N_("output all-zero hash in From header")),
1775                 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1776                          N_("don't include a patch matching a commit upstream")),
1777                 OPT_SET_INT_F('p', "no-stat", &use_patch_format,
1778                               N_("show patch format instead of default (patch + stat)"),
1779                               1, PARSE_OPT_NONEG),
1780                 OPT_GROUP(N_("Messaging")),
1781                 OPT_CALLBACK(0, "add-header", NULL, N_("header"),
1782                             N_("add email header"), header_callback),
1783                 OPT_CALLBACK(0, "to", NULL, N_("email"), N_("add To: header"), to_callback),
1784                 OPT_CALLBACK(0, "cc", NULL, N_("email"), N_("add Cc: header"), cc_callback),
1785                 OPT_CALLBACK_F(0, "from", &from, N_("ident"),
1786                             N_("set From address to <ident> (or committer ident if absent)"),
1787                             PARSE_OPT_OPTARG, from_callback),
1788                 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1789                             N_("make first mail a reply to <message-id>")),
1790                 OPT_CALLBACK_F(0, "attach", &rev, N_("boundary"),
1791                             N_("attach the patch"), PARSE_OPT_OPTARG,
1792                             attach_callback),
1793                 OPT_CALLBACK_F(0, "inline", &rev, N_("boundary"),
1794                             N_("inline the patch"),
1795                             PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1796                             inline_callback),
1797                 OPT_CALLBACK_F(0, "thread", &thread, N_("style"),
1798                             N_("enable message threading, styles: shallow, deep"),
1799                             PARSE_OPT_OPTARG, thread_callback),
1800                 OPT_STRING(0, "signature", &signature, N_("signature"),
1801                             N_("add a signature")),
1802                 OPT_CALLBACK_F(0, "base", &base_commit, N_("base-commit"),
1803                                N_("add prerequisite tree info to the patch series"),
1804                                0, base_callback),
1805                 OPT_FILENAME(0, "signature-file", &signature_file,
1806                                 N_("add a signature from a file")),
1807                 OPT__QUIET(&quiet, N_("don't print the patch filenames")),
1808                 OPT_BOOL(0, "progress", &show_progress,
1809                          N_("show progress while generating patches")),
1810                 OPT_CALLBACK(0, "interdiff", &idiff_prev, N_("rev"),
1811                              N_("show changes against <rev> in cover letter or single patch"),
1812                              parse_opt_object_name),
1813                 OPT_STRING(0, "range-diff", &rdiff_prev, N_("refspec"),
1814                            N_("show changes against <refspec> in cover letter or single patch")),
1815                 OPT_INTEGER(0, "creation-factor", &creation_factor,
1816                             N_("percentage by which creation is weighted")),
1817                 OPT_END()
1818         };
1819
1820         extra_hdr.strdup_strings = 1;
1821         extra_to.strdup_strings = 1;
1822         extra_cc.strdup_strings = 1;
1823         init_log_defaults();
1824         init_display_notes(&notes_opt);
1825         git_config(git_format_config, NULL);
1826         repo_init_revisions(the_repository, &rev, prefix);
1827         rev.show_notes = show_notes;
1828         memcpy(&rev.notes_opt, &notes_opt, sizeof(notes_opt));
1829         rev.commit_format = CMIT_FMT_EMAIL;
1830         rev.encode_email_headers = default_encode_email_headers;
1831         rev.expand_tabs_in_log_default = 0;
1832         rev.verbose_header = 1;
1833         rev.diff = 1;
1834         rev.max_parents = 1;
1835         rev.diffopt.flags.recursive = 1;
1836         rev.subject_prefix = fmt_patch_subject_prefix;
1837         memset(&s_r_opt, 0, sizeof(s_r_opt));
1838         s_r_opt.def = "HEAD";
1839         s_r_opt.revarg_opt = REVARG_COMMITTISH;
1840
1841         if (default_attach) {
1842                 rev.mime_boundary = default_attach;
1843                 rev.no_inline = 1;
1844         }
1845
1846         /*
1847          * Parse the arguments before setup_revisions(), or something
1848          * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1849          * possibly a valid SHA1.
1850          */
1851         argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1852                              builtin_format_patch_usage,
1853                              PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1854                              PARSE_OPT_KEEP_DASHDASH);
1855
1856         if (cover_from_description_arg)
1857                 cover_from_description_mode = parse_cover_from_description(cover_from_description_arg);
1858
1859         if (0 < reroll_count) {
1860                 struct strbuf sprefix = STRBUF_INIT;
1861                 strbuf_addf(&sprefix, "%s v%d",
1862                             rev.subject_prefix, reroll_count);
1863                 rev.reroll_count = reroll_count;
1864                 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1865         }
1866
1867         for (i = 0; i < extra_hdr.nr; i++) {
1868                 strbuf_addstr(&buf, extra_hdr.items[i].string);
1869                 strbuf_addch(&buf, '\n');
1870         }
1871
1872         if (extra_to.nr)
1873                 strbuf_addstr(&buf, "To: ");
1874         for (i = 0; i < extra_to.nr; i++) {
1875                 if (i)
1876                         strbuf_addstr(&buf, "    ");
1877                 strbuf_addstr(&buf, extra_to.items[i].string);
1878                 if (i + 1 < extra_to.nr)
1879                         strbuf_addch(&buf, ',');
1880                 strbuf_addch(&buf, '\n');
1881         }
1882
1883         if (extra_cc.nr)
1884                 strbuf_addstr(&buf, "Cc: ");
1885         for (i = 0; i < extra_cc.nr; i++) {
1886                 if (i)
1887                         strbuf_addstr(&buf, "    ");
1888                 strbuf_addstr(&buf, extra_cc.items[i].string);
1889                 if (i + 1 < extra_cc.nr)
1890                         strbuf_addch(&buf, ',');
1891                 strbuf_addch(&buf, '\n');
1892         }
1893
1894         rev.extra_headers = strbuf_detach(&buf, NULL);
1895
1896         if (from) {
1897                 if (split_ident_line(&rev.from_ident, from, strlen(from)))
1898                         die(_("invalid ident line: %s"), from);
1899         }
1900
1901         if (start_number < 0)
1902                 start_number = 1;
1903
1904         /*
1905          * If numbered is set solely due to format.numbered in config,
1906          * and it would conflict with --keep-subject (-k) from the
1907          * command line, reset "numbered".
1908          */
1909         if (numbered && keep_subject && !numbered_cmdline_opt)
1910                 numbered = 0;
1911
1912         if (numbered && keep_subject)
1913                 die(_("-n and -k are mutually exclusive"));
1914         if (keep_subject && subject_prefix)
1915                 die(_("--subject-prefix/--rfc and -k are mutually exclusive"));
1916         rev.preserve_subject = keep_subject;
1917
1918         argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1919         if (argc > 1)
1920                 die(_("unrecognized argument: %s"), argv[1]);
1921
1922         if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1923                 die(_("--name-only does not make sense"));
1924         if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1925                 die(_("--name-status does not make sense"));
1926         if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1927                 die(_("--check does not make sense"));
1928
1929         if (!use_patch_format &&
1930                 (!rev.diffopt.output_format ||
1931                  rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1932                 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1933         if (!rev.diffopt.stat_width)
1934                 rev.diffopt.stat_width = MAIL_DEFAULT_WRAP;
1935
1936         /* Always generate a patch */
1937         rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1938
1939         rev.zero_commit = zero_commit;
1940
1941         if (!rev.diffopt.flags.text && !no_binary_diff)
1942                 rev.diffopt.flags.binary = 1;
1943
1944         if (rev.show_notes)
1945                 load_display_notes(&rev.notes_opt);
1946
1947         if (use_stdout + rev.diffopt.close_file + !!output_directory > 1)
1948                 die(_("--stdout, --output, and --output-directory are mutually exclusive"));
1949
1950         if (use_stdout) {
1951                 setup_pager();
1952         } else if (rev.diffopt.close_file) {
1953                 /*
1954                  * The diff code parsed --output; it has already opened the
1955                  * file, but but we must instruct it not to close after each
1956                  * diff.
1957                  */
1958                 rev.diffopt.close_file = 0;
1959         } else {
1960                 int saved;
1961
1962                 if (!output_directory)
1963                         output_directory = config_output_directory;
1964                 output_directory = set_outdir(prefix, output_directory);
1965
1966                 if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
1967                         rev.diffopt.use_color = GIT_COLOR_NEVER;
1968                 /*
1969                  * We consider <outdir> as 'outside of gitdir', therefore avoid
1970                  * applying adjust_shared_perm in s-c-l-d.
1971                  */
1972                 saved = get_shared_repository();
1973                 set_shared_repository(0);
1974                 switch (safe_create_leading_directories_const(output_directory)) {
1975                 case SCLD_OK:
1976                 case SCLD_EXISTS:
1977                         break;
1978                 default:
1979                         die(_("could not create leading directories "
1980                               "of '%s'"), output_directory);
1981                 }
1982                 set_shared_repository(saved);
1983                 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1984                         die_errno(_("could not create directory '%s'"),
1985                                   output_directory);
1986         }
1987
1988         if (rev.pending.nr == 1) {
1989                 int check_head = 0;
1990
1991                 if (rev.max_count < 0 && !rev.show_root_diff) {
1992                         /*
1993                          * This is traditional behaviour of "git format-patch
1994                          * origin" that prepares what the origin side still
1995                          * does not have.
1996                          */
1997                         rev.pending.objects[0].item->flags |= UNINTERESTING;
1998                         add_head_to_pending(&rev);
1999                         check_head = 1;
2000                 }
2001                 /*
2002                  * Otherwise, it is "format-patch -22 HEAD", and/or
2003                  * "format-patch --root HEAD".  The user wants
2004                  * get_revision() to do the usual traversal.
2005                  */
2006
2007                 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
2008                         check_head = 1;
2009
2010                 if (check_head) {
2011                         const char *ref, *v;
2012                         ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
2013                                                  NULL, NULL);
2014                         if (ref && skip_prefix(ref, "refs/heads/", &v))
2015                                 branch_name = xstrdup(v);
2016                         else
2017                                 branch_name = xstrdup(""); /* no branch */
2018                 }
2019         }
2020
2021         /*
2022          * We cannot move this anywhere earlier because we do want to
2023          * know if --root was given explicitly from the command line.
2024          */
2025         rev.show_root_diff = 1;
2026
2027         if (ignore_if_in_upstream) {
2028                 /* Don't say anything if head and upstream are the same. */
2029                 if (rev.pending.nr == 2) {
2030                         struct object_array_entry *o = rev.pending.objects;
2031                         if (oideq(&o[0].item->oid, &o[1].item->oid))
2032                                 goto done;
2033                 }
2034                 get_patch_ids(&rev, &ids);
2035         }
2036
2037         if (prepare_revision_walk(&rev))
2038                 die(_("revision walk setup failed"));
2039         rev.boundary = 1;
2040         while ((commit = get_revision(&rev)) != NULL) {
2041                 if (commit->object.flags & BOUNDARY) {
2042                         boundary_count++;
2043                         origin = (boundary_count == 1) ? commit : NULL;
2044                         continue;
2045                 }
2046
2047                 if (ignore_if_in_upstream && has_commit_patch_id(commit, &ids))
2048                         continue;
2049
2050                 nr++;
2051                 REALLOC_ARRAY(list, nr);
2052                 list[nr - 1] = commit;
2053         }
2054         if (nr == 0)
2055                 /* nothing to do */
2056                 goto done;
2057         total = nr;
2058         if (cover_letter == -1) {
2059                 if (config_cover_letter == COVER_AUTO)
2060                         cover_letter = (total > 1);
2061                 else
2062                         cover_letter = (config_cover_letter == COVER_ON);
2063         }
2064         if (!keep_subject && auto_number && (total > 1 || cover_letter))
2065                 numbered = 1;
2066         if (numbered)
2067                 rev.total = total + start_number - 1;
2068
2069         if (idiff_prev.nr) {
2070                 if (!cover_letter && total != 1)
2071                         die(_("--interdiff requires --cover-letter or single patch"));
2072                 rev.idiff_oid1 = &idiff_prev.oid[idiff_prev.nr - 1];
2073                 rev.idiff_oid2 = get_commit_tree_oid(list[0]);
2074                 rev.idiff_title = diff_title(&idiff_title, reroll_count,
2075                                              _("Interdiff:"),
2076                                              _("Interdiff against v%d:"));
2077         }
2078
2079         if (creation_factor < 0)
2080                 creation_factor = RANGE_DIFF_CREATION_FACTOR_DEFAULT;
2081         else if (!rdiff_prev)
2082                 die(_("--creation-factor requires --range-diff"));
2083
2084         if (rdiff_prev) {
2085                 if (!cover_letter && total != 1)
2086                         die(_("--range-diff requires --cover-letter or single patch"));
2087
2088                 infer_range_diff_ranges(&rdiff1, &rdiff2, rdiff_prev,
2089                                         origin, list[0]);
2090                 rev.rdiff1 = rdiff1.buf;
2091                 rev.rdiff2 = rdiff2.buf;
2092                 rev.creation_factor = creation_factor;
2093                 rev.rdiff_title = diff_title(&rdiff_title, reroll_count,
2094                                              _("Range-diff:"),
2095                                              _("Range-diff against v%d:"));
2096         }
2097
2098         if (!signature) {
2099                 ; /* --no-signature inhibits all signatures */
2100         } else if (signature && signature != git_version_string) {
2101                 ; /* non-default signature already set */
2102         } else if (signature_file) {
2103                 struct strbuf buf = STRBUF_INIT;
2104
2105                 if (strbuf_read_file(&buf, signature_file, 128) < 0)
2106                         die_errno(_("unable to read signature file '%s'"), signature_file);
2107                 signature = strbuf_detach(&buf, NULL);
2108         }
2109
2110         memset(&bases, 0, sizeof(bases));
2111         base = get_base_commit(base_commit, list, nr);
2112         if (base) {
2113                 reset_revision_walk();
2114                 clear_object_flags(UNINTERESTING);
2115                 prepare_bases(&bases, base, list, nr);
2116         }
2117
2118         if (in_reply_to || thread || cover_letter)
2119                 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
2120         if (in_reply_to) {
2121                 const char *msgid = clean_message_id(in_reply_to);
2122                 string_list_append(rev.ref_message_ids, msgid);
2123         }
2124         rev.numbered_files = just_numbers;
2125         rev.patch_suffix = fmt_patch_suffix;
2126         if (cover_letter) {
2127                 if (thread)
2128                         gen_message_id(&rev, "cover");
2129                 make_cover_letter(&rev, !!output_directory,
2130                                   origin, nr, list, branch_name, quiet);
2131                 print_bases(&bases, rev.diffopt.file);
2132                 print_signature(rev.diffopt.file);
2133                 total++;
2134                 start_number--;
2135                 /* interdiff/range-diff in cover-letter; omit from patches */
2136                 rev.idiff_oid1 = NULL;
2137                 rev.rdiff1 = NULL;
2138         }
2139         rev.add_signoff = do_signoff;
2140
2141         if (show_progress)
2142                 progress = start_delayed_progress(_("Generating patches"), total);
2143         while (0 <= --nr) {
2144                 int shown;
2145                 display_progress(progress, total - nr);
2146                 commit = list[nr];
2147                 rev.nr = total - nr + (start_number - 1);
2148                 /* Make the second and subsequent mails replies to the first */
2149                 if (thread) {
2150                         /* Have we already had a message ID? */
2151                         if (rev.message_id) {
2152                                 /*
2153                                  * For deep threading: make every mail
2154                                  * a reply to the previous one, no
2155                                  * matter what other options are set.
2156                                  *
2157                                  * For shallow threading:
2158                                  *
2159                                  * Without --cover-letter and
2160                                  * --in-reply-to, make every mail a
2161                                  * reply to the one before.
2162                                  *
2163                                  * With --in-reply-to but no
2164                                  * --cover-letter, make every mail a
2165                                  * reply to the <reply-to>.
2166                                  *
2167                                  * With --cover-letter, make every
2168                                  * mail but the cover letter a reply
2169                                  * to the cover letter.  The cover
2170                                  * letter is a reply to the
2171                                  * --in-reply-to, if specified.
2172                                  */
2173                                 if (thread == THREAD_SHALLOW
2174                                     && rev.ref_message_ids->nr > 0
2175                                     && (!cover_letter || rev.nr > 1))
2176                                         free(rev.message_id);
2177                                 else
2178                                         string_list_append(rev.ref_message_ids,
2179                                                            rev.message_id);
2180                         }
2181                         gen_message_id(&rev, oid_to_hex(&commit->object.oid));
2182                 }
2183
2184                 if (output_directory &&
2185                     open_next_file(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
2186                         die(_("failed to create output files"));
2187                 shown = log_tree_commit(&rev, commit);
2188                 free_commit_buffer(the_repository->parsed_objects,
2189                                    commit);
2190
2191                 /* We put one extra blank line between formatted
2192                  * patches and this flag is used by log-tree code
2193                  * to see if it needs to emit a LF before showing
2194                  * the log; when using one file per patch, we do
2195                  * not want the extra blank line.
2196                  */
2197                 if (output_directory)
2198                         rev.shown_one = 0;
2199                 if (shown) {
2200                         print_bases(&bases, rev.diffopt.file);
2201                         if (rev.mime_boundary)
2202                                 fprintf(rev.diffopt.file, "\n--%s%s--\n\n\n",
2203                                        mime_boundary_leader,
2204                                        rev.mime_boundary);
2205                         else
2206                                 print_signature(rev.diffopt.file);
2207                 }
2208                 if (output_directory)
2209                         fclose(rev.diffopt.file);
2210         }
2211         stop_progress(&progress);
2212         free(list);
2213         free(branch_name);
2214         string_list_clear(&extra_to, 0);
2215         string_list_clear(&extra_cc, 0);
2216         string_list_clear(&extra_hdr, 0);
2217         if (ignore_if_in_upstream)
2218                 free_patch_ids(&ids);
2219
2220 done:
2221         oid_array_clear(&idiff_prev);
2222         strbuf_release(&idiff_title);
2223         strbuf_release(&rdiff1);
2224         strbuf_release(&rdiff2);
2225         strbuf_release(&rdiff_title);
2226         return 0;
2227 }
2228
2229 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
2230 {
2231         struct object_id oid;
2232         if (get_oid(arg, &oid) == 0) {
2233                 struct commit *commit = lookup_commit_reference(the_repository,
2234                                                                 &oid);
2235                 if (commit) {
2236                         commit->object.flags |= flags;
2237                         add_pending_object(revs, &commit->object, arg);
2238                         return 0;
2239                 }
2240         }
2241         return -1;
2242 }
2243
2244 static const char * const cherry_usage[] = {
2245         N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
2246         NULL
2247 };
2248
2249 static void print_commit(char sign, struct commit *commit, int verbose,
2250                          int abbrev, FILE *file)
2251 {
2252         if (!verbose) {
2253                 fprintf(file, "%c %s\n", sign,
2254                        find_unique_abbrev(&commit->object.oid, abbrev));
2255         } else {
2256                 struct strbuf buf = STRBUF_INIT;
2257                 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
2258                 fprintf(file, "%c %s %s\n", sign,
2259                        find_unique_abbrev(&commit->object.oid, abbrev),
2260                        buf.buf);
2261                 strbuf_release(&buf);
2262         }
2263 }
2264
2265 int cmd_cherry(int argc, const char **argv, const char *prefix)
2266 {
2267         struct rev_info revs;
2268         struct patch_ids ids;
2269         struct commit *commit;
2270         struct commit_list *list = NULL;
2271         struct branch *current_branch;
2272         const char *upstream;
2273         const char *head = "HEAD";
2274         const char *limit = NULL;
2275         int verbose = 0, abbrev = 0;
2276
2277         struct option options[] = {
2278                 OPT__ABBREV(&abbrev),
2279                 OPT__VERBOSE(&verbose, N_("be verbose")),
2280                 OPT_END()
2281         };
2282
2283         argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
2284
2285         switch (argc) {
2286         case 3:
2287                 limit = argv[2];
2288                 /* FALLTHROUGH */
2289         case 2:
2290                 head = argv[1];
2291                 /* FALLTHROUGH */
2292         case 1:
2293                 upstream = argv[0];
2294                 break;
2295         default:
2296                 current_branch = branch_get(NULL);
2297                 upstream = branch_get_upstream(current_branch, NULL);
2298                 if (!upstream) {
2299                         fprintf(stderr, _("Could not find a tracked"
2300                                         " remote branch, please"
2301                                         " specify <upstream> manually.\n"));
2302                         usage_with_options(cherry_usage, options);
2303                 }
2304         }
2305
2306         repo_init_revisions(the_repository, &revs, prefix);
2307         revs.max_parents = 1;
2308
2309         if (add_pending_commit(head, &revs, 0))
2310                 die(_("unknown commit %s"), head);
2311         if (add_pending_commit(upstream, &revs, UNINTERESTING))
2312                 die(_("unknown commit %s"), upstream);
2313
2314         /* Don't say anything if head and upstream are the same. */
2315         if (revs.pending.nr == 2) {
2316                 struct object_array_entry *o = revs.pending.objects;
2317                 if (oideq(&o[0].item->oid, &o[1].item->oid))
2318                         return 0;
2319         }
2320
2321         get_patch_ids(&revs, &ids);
2322
2323         if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
2324                 die(_("unknown commit %s"), limit);
2325
2326         /* reverse the list of commits */
2327         if (prepare_revision_walk(&revs))
2328                 die(_("revision walk setup failed"));
2329         while ((commit = get_revision(&revs)) != NULL) {
2330                 commit_list_insert(commit, &list);
2331         }
2332
2333         while (list) {
2334                 char sign = '+';
2335
2336                 commit = list->item;
2337                 if (has_commit_patch_id(commit, &ids))
2338                         sign = '-';
2339                 print_commit(sign, commit, verbose, abbrev, revs.diffopt.file);
2340                 list = list->next;
2341         }
2342
2343         free_patch_ids(&ids);
2344         return 0;
2345 }