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