diff-merges: rename diff_merges_default_to_enable() to match semantics
[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         /* Turn --cc/-c into -p --cc/-c when -p was not given */
727         if (!rev->diffopt.output_format && rev->combine_merges)
728                 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
729
730         if (rev->first_parent_only)
731                 diff_merges_default_to_first_parent(rev);
732 }
733
734 int cmd_log(int argc, const char **argv, const char *prefix)
735 {
736         struct rev_info rev;
737         struct setup_revision_opt opt;
738
739         init_log_defaults();
740         git_config(git_log_config, NULL);
741
742         repo_init_revisions(the_repository, &rev, prefix);
743         rev.always_show_header = 1;
744         memset(&opt, 0, sizeof(opt));
745         opt.def = "HEAD";
746         opt.revarg_opt = REVARG_COMMITTISH;
747         opt.tweak = log_setup_revisions_tweak;
748         cmd_log_init(argc, argv, prefix, &rev, &opt);
749         return cmd_log_walk(&rev);
750 }
751
752 /* format-patch */
753
754 static const char *fmt_patch_suffix = ".patch";
755 static int numbered = 0;
756 static int auto_number = 1;
757
758 static char *default_attach = NULL;
759
760 static struct string_list extra_hdr = STRING_LIST_INIT_NODUP;
761 static struct string_list extra_to = STRING_LIST_INIT_NODUP;
762 static struct string_list extra_cc = STRING_LIST_INIT_NODUP;
763
764 static void add_header(const char *value)
765 {
766         struct string_list_item *item;
767         int len = strlen(value);
768         while (len && value[len - 1] == '\n')
769                 len--;
770
771         if (!strncasecmp(value, "to: ", 4)) {
772                 item = string_list_append(&extra_to, value + 4);
773                 len -= 4;
774         } else if (!strncasecmp(value, "cc: ", 4)) {
775                 item = string_list_append(&extra_cc, value + 4);
776                 len -= 4;
777         } else {
778                 item = string_list_append(&extra_hdr, value);
779         }
780
781         item->string[len] = '\0';
782 }
783
784 enum cover_setting {
785         COVER_UNSET,
786         COVER_OFF,
787         COVER_ON,
788         COVER_AUTO
789 };
790
791 enum thread_level {
792         THREAD_UNSET,
793         THREAD_SHALLOW,
794         THREAD_DEEP
795 };
796
797 enum cover_from_description {
798         COVER_FROM_NONE,
799         COVER_FROM_MESSAGE,
800         COVER_FROM_SUBJECT,
801         COVER_FROM_AUTO
802 };
803
804 enum auto_base_setting {
805         AUTO_BASE_NEVER,
806         AUTO_BASE_ALWAYS,
807         AUTO_BASE_WHEN_ABLE
808 };
809
810 static enum thread_level thread;
811 static int do_signoff;
812 static enum auto_base_setting auto_base;
813 static char *from;
814 static const char *signature = git_version_string;
815 static const char *signature_file;
816 static enum cover_setting config_cover_letter;
817 static const char *config_output_directory;
818 static enum cover_from_description cover_from_description_mode = COVER_FROM_MESSAGE;
819 static int show_notes;
820 static struct display_notes_opt notes_opt;
821
822 static enum cover_from_description parse_cover_from_description(const char *arg)
823 {
824         if (!arg || !strcmp(arg, "default"))
825                 return COVER_FROM_MESSAGE;
826         else if (!strcmp(arg, "none"))
827                 return COVER_FROM_NONE;
828         else if (!strcmp(arg, "message"))
829                 return COVER_FROM_MESSAGE;
830         else if (!strcmp(arg, "subject"))
831                 return COVER_FROM_SUBJECT;
832         else if (!strcmp(arg, "auto"))
833                 return COVER_FROM_AUTO;
834         else
835                 die(_("%s: invalid cover from description mode"), arg);
836 }
837
838 static int git_format_config(const char *var, const char *value, void *cb)
839 {
840         if (!strcmp(var, "format.headers")) {
841                 if (!value)
842                         die(_("format.headers without value"));
843                 add_header(value);
844                 return 0;
845         }
846         if (!strcmp(var, "format.suffix"))
847                 return git_config_string(&fmt_patch_suffix, var, value);
848         if (!strcmp(var, "format.to")) {
849                 if (!value)
850                         return config_error_nonbool(var);
851                 string_list_append(&extra_to, value);
852                 return 0;
853         }
854         if (!strcmp(var, "format.cc")) {
855                 if (!value)
856                         return config_error_nonbool(var);
857                 string_list_append(&extra_cc, value);
858                 return 0;
859         }
860         if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
861             !strcmp(var, "color.ui") || !strcmp(var, "diff.submodule")) {
862                 return 0;
863         }
864         if (!strcmp(var, "format.numbered")) {
865                 if (value && !strcasecmp(value, "auto")) {
866                         auto_number = 1;
867                         return 0;
868                 }
869                 numbered = git_config_bool(var, value);
870                 auto_number = auto_number && numbered;
871                 return 0;
872         }
873         if (!strcmp(var, "format.attach")) {
874                 if (value && *value)
875                         default_attach = xstrdup(value);
876                 else
877                         default_attach = xstrdup(git_version_string);
878                 return 0;
879         }
880         if (!strcmp(var, "format.thread")) {
881                 if (value && !strcasecmp(value, "deep")) {
882                         thread = THREAD_DEEP;
883                         return 0;
884                 }
885                 if (value && !strcasecmp(value, "shallow")) {
886                         thread = THREAD_SHALLOW;
887                         return 0;
888                 }
889                 thread = git_config_bool(var, value) ? THREAD_SHALLOW : THREAD_UNSET;
890                 return 0;
891         }
892         if (!strcmp(var, "format.signoff")) {
893                 do_signoff = git_config_bool(var, value);
894                 return 0;
895         }
896         if (!strcmp(var, "format.signature"))
897                 return git_config_string(&signature, var, value);
898         if (!strcmp(var, "format.signaturefile"))
899                 return git_config_pathname(&signature_file, var, value);
900         if (!strcmp(var, "format.coverletter")) {
901                 if (value && !strcasecmp(value, "auto")) {
902                         config_cover_letter = COVER_AUTO;
903                         return 0;
904                 }
905                 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
906                 return 0;
907         }
908         if (!strcmp(var, "format.outputdirectory"))
909                 return git_config_string(&config_output_directory, var, value);
910         if (!strcmp(var, "format.useautobase")) {
911                 if (value && !strcasecmp(value, "whenAble")) {
912                         auto_base = AUTO_BASE_WHEN_ABLE;
913                         return 0;
914                 }
915                 auto_base = git_config_bool(var, value) ? AUTO_BASE_ALWAYS : AUTO_BASE_NEVER;
916                 return 0;
917         }
918         if (!strcmp(var, "format.from")) {
919                 int b = git_parse_maybe_bool(value);
920                 free(from);
921                 if (b < 0)
922                         from = xstrdup(value);
923                 else if (b)
924                         from = xstrdup(git_committer_info(IDENT_NO_DATE));
925                 else
926                         from = NULL;
927                 return 0;
928         }
929         if (!strcmp(var, "format.notes")) {
930                 int b = git_parse_maybe_bool(value);
931                 if (b < 0)
932                         enable_ref_display_notes(&notes_opt, &show_notes, value);
933                 else if (b)
934                         enable_default_display_notes(&notes_opt, &show_notes);
935                 else
936                         disable_display_notes(&notes_opt, &show_notes);
937                 return 0;
938         }
939         if (!strcmp(var, "format.coverfromdescription")) {
940                 cover_from_description_mode = parse_cover_from_description(value);
941                 return 0;
942         }
943
944         return git_log_config(var, value, cb);
945 }
946
947 static const char *output_directory = NULL;
948 static int outdir_offset;
949
950 static int open_next_file(struct commit *commit, const char *subject,
951                          struct rev_info *rev, int quiet)
952 {
953         struct strbuf filename = STRBUF_INIT;
954         int suffix_len = strlen(rev->patch_suffix) + 1;
955
956         if (output_directory) {
957                 strbuf_addstr(&filename, output_directory);
958                 if (filename.len >=
959                     PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len) {
960                         strbuf_release(&filename);
961                         return error(_("name of output directory is too long"));
962                 }
963                 strbuf_complete(&filename, '/');
964         }
965
966         if (rev->numbered_files)
967                 strbuf_addf(&filename, "%d", rev->nr);
968         else if (commit)
969                 fmt_output_commit(&filename, commit, rev);
970         else
971                 fmt_output_subject(&filename, subject, rev);
972
973         if (!quiet)
974                 printf("%s\n", filename.buf + outdir_offset);
975
976         if ((rev->diffopt.file = fopen(filename.buf, "w")) == NULL) {
977                 error_errno(_("cannot open patch file %s"), filename.buf);
978                 strbuf_release(&filename);
979                 return -1;
980         }
981
982         strbuf_release(&filename);
983         return 0;
984 }
985
986 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
987 {
988         struct rev_info check_rev;
989         struct commit *commit, *c1, *c2;
990         struct object *o1, *o2;
991         unsigned flags1, flags2;
992
993         if (rev->pending.nr != 2)
994                 die(_("need exactly one range"));
995
996         o1 = rev->pending.objects[0].item;
997         o2 = rev->pending.objects[1].item;
998         flags1 = o1->flags;
999         flags2 = o2->flags;
1000         c1 = lookup_commit_reference(the_repository, &o1->oid);
1001         c2 = lookup_commit_reference(the_repository, &o2->oid);
1002
1003         if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
1004                 die(_("not a range"));
1005
1006         init_patch_ids(the_repository, ids);
1007
1008         /* given a range a..b get all patch ids for b..a */
1009         repo_init_revisions(the_repository, &check_rev, rev->prefix);
1010         check_rev.max_parents = 1;
1011         o1->flags ^= UNINTERESTING;
1012         o2->flags ^= UNINTERESTING;
1013         add_pending_object(&check_rev, o1, "o1");
1014         add_pending_object(&check_rev, o2, "o2");
1015         if (prepare_revision_walk(&check_rev))
1016                 die(_("revision walk setup failed"));
1017
1018         while ((commit = get_revision(&check_rev)) != NULL) {
1019                 add_commit_patch_id(commit, ids);
1020         }
1021
1022         /* reset for next revision walk */
1023         clear_commit_marks(c1, SEEN | UNINTERESTING | SHOWN | ADDED);
1024         clear_commit_marks(c2, SEEN | UNINTERESTING | SHOWN | ADDED);
1025         o1->flags = flags1;
1026         o2->flags = flags2;
1027 }
1028
1029 static void gen_message_id(struct rev_info *info, char *base)
1030 {
1031         struct strbuf buf = STRBUF_INIT;
1032         strbuf_addf(&buf, "%s.%"PRItime".git.%s", base,
1033                     (timestamp_t) time(NULL),
1034                     git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
1035         info->message_id = strbuf_detach(&buf, NULL);
1036 }
1037
1038 static void print_signature(FILE *file)
1039 {
1040         if (!signature || !*signature)
1041                 return;
1042
1043         fprintf(file, "-- \n%s", signature);
1044         if (signature[strlen(signature)-1] != '\n')
1045                 putc('\n', file);
1046         putc('\n', file);
1047 }
1048
1049 static char *find_branch_name(struct rev_info *rev)
1050 {
1051         int i, positive = -1;
1052         struct object_id branch_oid;
1053         const struct object_id *tip_oid;
1054         const char *ref, *v;
1055         char *full_ref, *branch = NULL;
1056
1057         for (i = 0; i < rev->cmdline.nr; i++) {
1058                 if (rev->cmdline.rev[i].flags & UNINTERESTING)
1059                         continue;
1060                 if (positive < 0)
1061                         positive = i;
1062                 else
1063                         return NULL;
1064         }
1065         if (positive < 0)
1066                 return NULL;
1067         ref = rev->cmdline.rev[positive].name;
1068         tip_oid = &rev->cmdline.rev[positive].item->oid;
1069         if (dwim_ref(ref, strlen(ref), &branch_oid, &full_ref, 0) &&
1070             skip_prefix(full_ref, "refs/heads/", &v) &&
1071             oideq(tip_oid, &branch_oid))
1072                 branch = xstrdup(v);
1073         free(full_ref);
1074         return branch;
1075 }
1076
1077 static void show_diffstat(struct rev_info *rev,
1078                           struct commit *origin, struct commit *head)
1079 {
1080         struct diff_options opts;
1081
1082         memcpy(&opts, &rev->diffopt, sizeof(opts));
1083         opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1084         diff_setup_done(&opts);
1085
1086         diff_tree_oid(get_commit_tree_oid(origin),
1087                       get_commit_tree_oid(head),
1088                       "", &opts);
1089         diffcore_std(&opts);
1090         diff_flush(&opts);
1091
1092         fprintf(rev->diffopt.file, "\n");
1093 }
1094
1095 static void prepare_cover_text(struct pretty_print_context *pp,
1096                                const char *branch_name,
1097                                struct strbuf *sb,
1098                                const char *encoding,
1099                                int need_8bit_cte)
1100 {
1101         const char *subject = "*** SUBJECT HERE ***";
1102         const char *body = "*** BLURB HERE ***";
1103         struct strbuf description_sb = STRBUF_INIT;
1104         struct strbuf subject_sb = STRBUF_INIT;
1105
1106         if (cover_from_description_mode == COVER_FROM_NONE)
1107                 goto do_pp;
1108
1109         if (branch_name && *branch_name)
1110                 read_branch_desc(&description_sb, branch_name);
1111         if (!description_sb.len)
1112                 goto do_pp;
1113
1114         if (cover_from_description_mode == COVER_FROM_SUBJECT ||
1115                         cover_from_description_mode == COVER_FROM_AUTO)
1116                 body = format_subject(&subject_sb, description_sb.buf, " ");
1117
1118         if (cover_from_description_mode == COVER_FROM_MESSAGE ||
1119                         (cover_from_description_mode == COVER_FROM_AUTO &&
1120                          subject_sb.len > COVER_FROM_AUTO_MAX_SUBJECT_LEN))
1121                 body = description_sb.buf;
1122         else
1123                 subject = subject_sb.buf;
1124
1125 do_pp:
1126         pp_title_line(pp, &subject, sb, encoding, need_8bit_cte);
1127         pp_remainder(pp, &body, sb, 0);
1128
1129         strbuf_release(&description_sb);
1130         strbuf_release(&subject_sb);
1131 }
1132
1133 static int get_notes_refs(struct string_list_item *item, void *arg)
1134 {
1135         strvec_pushf(arg, "--notes=%s", item->string);
1136         return 0;
1137 }
1138
1139 static void get_notes_args(struct strvec *arg, struct rev_info *rev)
1140 {
1141         if (!rev->show_notes) {
1142                 strvec_push(arg, "--no-notes");
1143         } else if (rev->notes_opt.use_default_notes > 0 ||
1144                    (rev->notes_opt.use_default_notes == -1 &&
1145                     !rev->notes_opt.extra_notes_refs.nr)) {
1146                 strvec_push(arg, "--notes");
1147         } else {
1148                 for_each_string_list(&rev->notes_opt.extra_notes_refs, get_notes_refs, arg);
1149         }
1150 }
1151
1152 static void make_cover_letter(struct rev_info *rev, int use_stdout,
1153                               struct commit *origin,
1154                               int nr, struct commit **list,
1155                               const char *branch_name,
1156                               int quiet)
1157 {
1158         const char *committer;
1159         struct shortlog log;
1160         struct strbuf sb = STRBUF_INIT;
1161         int i;
1162         const char *encoding = "UTF-8";
1163         int need_8bit_cte = 0;
1164         struct pretty_print_context pp = {0};
1165         struct commit *head = list[0];
1166
1167         if (!cmit_fmt_is_mail(rev->commit_format))
1168                 die(_("cover letter needs email format"));
1169
1170         committer = git_committer_info(0);
1171
1172         if (!use_stdout &&
1173             open_next_file(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
1174                 die(_("failed to create cover-letter file"));
1175
1176         log_write_email_headers(rev, head, &pp.after_subject, &need_8bit_cte, 0);
1177
1178         for (i = 0; !need_8bit_cte && i < nr; i++) {
1179                 const char *buf = get_commit_buffer(list[i], NULL);
1180                 if (has_non_ascii(buf))
1181                         need_8bit_cte = 1;
1182                 unuse_commit_buffer(list[i], buf);
1183         }
1184
1185         if (!branch_name)
1186                 branch_name = find_branch_name(rev);
1187
1188         pp.fmt = CMIT_FMT_EMAIL;
1189         pp.date_mode.type = DATE_RFC2822;
1190         pp.rev = rev;
1191         pp.print_email_subject = 1;
1192         pp_user_info(&pp, NULL, &sb, committer, encoding);
1193         prepare_cover_text(&pp, branch_name, &sb, encoding, need_8bit_cte);
1194         fprintf(rev->diffopt.file, "%s\n", sb.buf);
1195
1196         strbuf_release(&sb);
1197
1198         shortlog_init(&log);
1199         log.wrap_lines = 1;
1200         log.wrap = MAIL_DEFAULT_WRAP;
1201         log.in1 = 2;
1202         log.in2 = 4;
1203         log.file = rev->diffopt.file;
1204         log.groups = SHORTLOG_GROUP_AUTHOR;
1205         for (i = 0; i < nr; i++)
1206                 shortlog_add_commit(&log, list[i]);
1207
1208         shortlog_output(&log);
1209
1210         /* We can only do diffstat with a unique reference point */
1211         if (origin)
1212                 show_diffstat(rev, origin, head);
1213
1214         if (rev->idiff_oid1) {
1215                 fprintf_ln(rev->diffopt.file, "%s", rev->idiff_title);
1216                 show_interdiff(rev->idiff_oid1, rev->idiff_oid2, 0,
1217                                &rev->diffopt);
1218         }
1219
1220         if (rev->rdiff1) {
1221                 /*
1222                  * Pass minimum required diff-options to range-diff; others
1223                  * can be added later if deemed desirable.
1224                  */
1225                 struct diff_options opts;
1226                 struct strvec other_arg = STRVEC_INIT;
1227                 diff_setup(&opts);
1228                 opts.file = rev->diffopt.file;
1229                 opts.use_color = rev->diffopt.use_color;
1230                 diff_setup_done(&opts);
1231                 fprintf_ln(rev->diffopt.file, "%s", rev->rdiff_title);
1232                 get_notes_args(&other_arg, rev);
1233                 show_range_diff(rev->rdiff1, rev->rdiff2,
1234                                 rev->creation_factor, 1, &opts, &other_arg);
1235                 strvec_clear(&other_arg);
1236         }
1237 }
1238
1239 static const char *clean_message_id(const char *msg_id)
1240 {
1241         char ch;
1242         const char *a, *z, *m;
1243
1244         m = msg_id;
1245         while ((ch = *m) && (isspace(ch) || (ch == '<')))
1246                 m++;
1247         a = m;
1248         z = NULL;
1249         while ((ch = *m)) {
1250                 if (!isspace(ch) && (ch != '>'))
1251                         z = m;
1252                 m++;
1253         }
1254         if (!z)
1255                 die(_("insane in-reply-to: %s"), msg_id);
1256         if (++z == m)
1257                 return a;
1258         return xmemdupz(a, z - a);
1259 }
1260
1261 static const char *set_outdir(const char *prefix, const char *output_directory)
1262 {
1263         if (output_directory && is_absolute_path(output_directory))
1264                 return output_directory;
1265
1266         if (!prefix || !*prefix) {
1267                 if (output_directory)
1268                         return output_directory;
1269                 /* The user did not explicitly ask for "./" */
1270                 outdir_offset = 2;
1271                 return "./";
1272         }
1273
1274         outdir_offset = strlen(prefix);
1275         if (!output_directory)
1276                 return prefix;
1277
1278         return prefix_filename(prefix, output_directory);
1279 }
1280
1281 static const char * const builtin_format_patch_usage[] = {
1282         N_("git format-patch [<options>] [<since> | <revision-range>]"),
1283         NULL
1284 };
1285
1286 static int keep_subject = 0;
1287
1288 static int keep_callback(const struct option *opt, const char *arg, int unset)
1289 {
1290         BUG_ON_OPT_NEG(unset);
1291         BUG_ON_OPT_ARG(arg);
1292         ((struct rev_info *)opt->value)->total = -1;
1293         keep_subject = 1;
1294         return 0;
1295 }
1296
1297 static int subject_prefix = 0;
1298
1299 static int subject_prefix_callback(const struct option *opt, const char *arg,
1300                             int unset)
1301 {
1302         BUG_ON_OPT_NEG(unset);
1303         subject_prefix = 1;
1304         ((struct rev_info *)opt->value)->subject_prefix = arg;
1305         return 0;
1306 }
1307
1308 static int rfc_callback(const struct option *opt, const char *arg, int unset)
1309 {
1310         BUG_ON_OPT_NEG(unset);
1311         BUG_ON_OPT_ARG(arg);
1312         return subject_prefix_callback(opt, "RFC PATCH", unset);
1313 }
1314
1315 static int numbered_cmdline_opt = 0;
1316
1317 static int numbered_callback(const struct option *opt, const char *arg,
1318                              int unset)
1319 {
1320         BUG_ON_OPT_ARG(arg);
1321         *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
1322         if (unset)
1323                 auto_number =  0;
1324         return 0;
1325 }
1326
1327 static int no_numbered_callback(const struct option *opt, const char *arg,
1328                                 int unset)
1329 {
1330         BUG_ON_OPT_NEG(unset);
1331         return numbered_callback(opt, arg, 1);
1332 }
1333
1334 static int output_directory_callback(const struct option *opt, const char *arg,
1335                               int unset)
1336 {
1337         const char **dir = (const char **)opt->value;
1338         BUG_ON_OPT_NEG(unset);
1339         if (*dir)
1340                 die(_("two output directories?"));
1341         *dir = arg;
1342         return 0;
1343 }
1344
1345 static int thread_callback(const struct option *opt, const char *arg, int unset)
1346 {
1347         enum thread_level *thread = (enum thread_level *)opt->value;
1348         if (unset)
1349                 *thread = THREAD_UNSET;
1350         else if (!arg || !strcmp(arg, "shallow"))
1351                 *thread = THREAD_SHALLOW;
1352         else if (!strcmp(arg, "deep"))
1353                 *thread = THREAD_DEEP;
1354         /*
1355          * Please update _git_formatpatch() in git-completion.bash
1356          * when you add new options.
1357          */
1358         else
1359                 return 1;
1360         return 0;
1361 }
1362
1363 static int attach_callback(const struct option *opt, const char *arg, int unset)
1364 {
1365         struct rev_info *rev = (struct rev_info *)opt->value;
1366         if (unset)
1367                 rev->mime_boundary = NULL;
1368         else if (arg)
1369                 rev->mime_boundary = arg;
1370         else
1371                 rev->mime_boundary = git_version_string;
1372         rev->no_inline = unset ? 0 : 1;
1373         return 0;
1374 }
1375
1376 static int inline_callback(const struct option *opt, const char *arg, int unset)
1377 {
1378         struct rev_info *rev = (struct rev_info *)opt->value;
1379         if (unset)
1380                 rev->mime_boundary = NULL;
1381         else if (arg)
1382                 rev->mime_boundary = arg;
1383         else
1384                 rev->mime_boundary = git_version_string;
1385         rev->no_inline = 0;
1386         return 0;
1387 }
1388
1389 static int header_callback(const struct option *opt, const char *arg, int unset)
1390 {
1391         if (unset) {
1392                 string_list_clear(&extra_hdr, 0);
1393                 string_list_clear(&extra_to, 0);
1394                 string_list_clear(&extra_cc, 0);
1395         } else {
1396                 add_header(arg);
1397         }
1398         return 0;
1399 }
1400
1401 static int to_callback(const struct option *opt, const char *arg, int unset)
1402 {
1403         if (unset)
1404                 string_list_clear(&extra_to, 0);
1405         else
1406                 string_list_append(&extra_to, arg);
1407         return 0;
1408 }
1409
1410 static int cc_callback(const struct option *opt, const char *arg, int unset)
1411 {
1412         if (unset)
1413                 string_list_clear(&extra_cc, 0);
1414         else
1415                 string_list_append(&extra_cc, arg);
1416         return 0;
1417 }
1418
1419 static int from_callback(const struct option *opt, const char *arg, int unset)
1420 {
1421         char **from = opt->value;
1422
1423         free(*from);
1424
1425         if (unset)
1426                 *from = NULL;
1427         else if (arg)
1428                 *from = xstrdup(arg);
1429         else
1430                 *from = xstrdup(git_committer_info(IDENT_NO_DATE));
1431         return 0;
1432 }
1433
1434 static int base_callback(const struct option *opt, const char *arg, int unset)
1435 {
1436         const char **base_commit = opt->value;
1437
1438         if (unset) {
1439                 auto_base = AUTO_BASE_NEVER;
1440                 *base_commit = NULL;
1441         } else if (!strcmp(arg, "auto")) {
1442                 auto_base = AUTO_BASE_ALWAYS;
1443                 *base_commit = NULL;
1444         } else {
1445                 auto_base = AUTO_BASE_NEVER;
1446                 *base_commit = arg;
1447         }
1448         return 0;
1449 }
1450
1451 struct base_tree_info {
1452         struct object_id base_commit;
1453         int nr_patch_id, alloc_patch_id;
1454         struct object_id *patch_id;
1455 };
1456
1457 static struct commit *get_base_commit(const char *base_commit,
1458                                       struct commit **list,
1459                                       int total)
1460 {
1461         struct commit *base = NULL;
1462         struct commit **rev;
1463         int i = 0, rev_nr = 0, auto_select, die_on_failure;
1464
1465         switch (auto_base) {
1466         case AUTO_BASE_NEVER:
1467                 if (base_commit) {
1468                         auto_select = 0;
1469                         die_on_failure = 1;
1470                 } else {
1471                         /* no base information is requested */
1472                         return NULL;
1473                 }
1474                 break;
1475         case AUTO_BASE_ALWAYS:
1476         case AUTO_BASE_WHEN_ABLE:
1477                 if (base_commit) {
1478                         BUG("requested automatic base selection but a commit was provided");
1479                 } else {
1480                         auto_select = 1;
1481                         die_on_failure = auto_base == AUTO_BASE_ALWAYS;
1482                 }
1483                 break;
1484         default:
1485                 BUG("unexpected automatic base selection method");
1486         }
1487
1488         if (!auto_select) {
1489                 base = lookup_commit_reference_by_name(base_commit);
1490                 if (!base)
1491                         die(_("unknown commit %s"), base_commit);
1492         } else {
1493                 struct branch *curr_branch = branch_get(NULL);
1494                 const char *upstream = branch_get_upstream(curr_branch, NULL);
1495                 if (upstream) {
1496                         struct commit_list *base_list;
1497                         struct commit *commit;
1498                         struct object_id oid;
1499
1500                         if (get_oid(upstream, &oid)) {
1501                                 if (die_on_failure)
1502                                         die(_("failed to resolve '%s' as a valid ref"), upstream);
1503                                 else
1504                                         return NULL;
1505                         }
1506                         commit = lookup_commit_or_die(&oid, "upstream base");
1507                         base_list = get_merge_bases_many(commit, total, list);
1508                         /* There should be one and only one merge base. */
1509                         if (!base_list || base_list->next) {
1510                                 if (die_on_failure) {
1511                                         die(_("could not find exact merge base"));
1512                                 } else {
1513                                         free_commit_list(base_list);
1514                                         return NULL;
1515                                 }
1516                         }
1517                         base = base_list->item;
1518                         free_commit_list(base_list);
1519                 } else {
1520                         if (die_on_failure)
1521                                 die(_("failed to get upstream, if you want to record base commit automatically,\n"
1522                                       "please use git branch --set-upstream-to to track a remote branch.\n"
1523                                       "Or you could specify base commit by --base=<base-commit-id> manually"));
1524                         else
1525                                 return NULL;
1526                 }
1527         }
1528
1529         ALLOC_ARRAY(rev, total);
1530         for (i = 0; i < total; i++)
1531                 rev[i] = list[i];
1532
1533         rev_nr = total;
1534         /*
1535          * Get merge base through pair-wise computations
1536          * and store it in rev[0].
1537          */
1538         while (rev_nr > 1) {
1539                 for (i = 0; i < rev_nr / 2; i++) {
1540                         struct commit_list *merge_base;
1541                         merge_base = get_merge_bases(rev[2 * i], rev[2 * i + 1]);
1542                         if (!merge_base || merge_base->next) {
1543                                 if (die_on_failure) {
1544                                         die(_("failed to find exact merge base"));
1545                                 } else {
1546                                         free(rev);
1547                                         return NULL;
1548                                 }
1549                         }
1550
1551                         rev[i] = merge_base->item;
1552                 }
1553
1554                 if (rev_nr % 2)
1555                         rev[i] = rev[2 * i];
1556                 rev_nr = DIV_ROUND_UP(rev_nr, 2);
1557         }
1558
1559         if (!in_merge_bases(base, rev[0])) {
1560                 if (die_on_failure) {
1561                         die(_("base commit should be the ancestor of revision list"));
1562                 } else {
1563                         free(rev);
1564                         return NULL;
1565                 }
1566         }
1567
1568         for (i = 0; i < total; i++) {
1569                 if (base == list[i]) {
1570                         if (die_on_failure) {
1571                                 die(_("base commit shouldn't be in revision list"));
1572                         } else {
1573                                 free(rev);
1574                                 return NULL;
1575                         }
1576                 }
1577         }
1578
1579         free(rev);
1580         return base;
1581 }
1582
1583 define_commit_slab(commit_base, int);
1584
1585 static void prepare_bases(struct base_tree_info *bases,
1586                           struct commit *base,
1587                           struct commit **list,
1588                           int total)
1589 {
1590         struct commit *commit;
1591         struct rev_info revs;
1592         struct diff_options diffopt;
1593         struct commit_base commit_base;
1594         int i;
1595
1596         if (!base)
1597                 return;
1598
1599         init_commit_base(&commit_base);
1600         repo_diff_setup(the_repository, &diffopt);
1601         diffopt.flags.recursive = 1;
1602         diff_setup_done(&diffopt);
1603
1604         oidcpy(&bases->base_commit, &base->object.oid);
1605
1606         repo_init_revisions(the_repository, &revs, NULL);
1607         revs.max_parents = 1;
1608         revs.topo_order = 1;
1609         for (i = 0; i < total; i++) {
1610                 list[i]->object.flags &= ~UNINTERESTING;
1611                 add_pending_object(&revs, &list[i]->object, "rev_list");
1612                 *commit_base_at(&commit_base, list[i]) = 1;
1613         }
1614         base->object.flags |= UNINTERESTING;
1615         add_pending_object(&revs, &base->object, "base");
1616
1617         if (prepare_revision_walk(&revs))
1618                 die(_("revision walk setup failed"));
1619         /*
1620          * Traverse the commits list, get prerequisite patch ids
1621          * and stuff them in bases structure.
1622          */
1623         while ((commit = get_revision(&revs)) != NULL) {
1624                 struct object_id oid;
1625                 struct object_id *patch_id;
1626                 if (*commit_base_at(&commit_base, commit))
1627                         continue;
1628                 if (commit_patch_id(commit, &diffopt, &oid, 0, 1))
1629                         die(_("cannot get patch id"));
1630                 ALLOC_GROW(bases->patch_id, bases->nr_patch_id + 1, bases->alloc_patch_id);
1631                 patch_id = bases->patch_id + bases->nr_patch_id;
1632                 oidcpy(patch_id, &oid);
1633                 bases->nr_patch_id++;
1634         }
1635         clear_commit_base(&commit_base);
1636 }
1637
1638 static void print_bases(struct base_tree_info *bases, FILE *file)
1639 {
1640         int i;
1641
1642         /* Only do this once, either for the cover or for the first one */
1643         if (is_null_oid(&bases->base_commit))
1644                 return;
1645
1646         /* Show the base commit */
1647         fprintf(file, "\nbase-commit: %s\n", oid_to_hex(&bases->base_commit));
1648
1649         /* Show the prerequisite patches */
1650         for (i = bases->nr_patch_id - 1; i >= 0; i--)
1651                 fprintf(file, "prerequisite-patch-id: %s\n", oid_to_hex(&bases->patch_id[i]));
1652
1653         free(bases->patch_id);
1654         bases->nr_patch_id = 0;
1655         bases->alloc_patch_id = 0;
1656         oidclr(&bases->base_commit);
1657 }
1658
1659 static const char *diff_title(struct strbuf *sb, int reroll_count,
1660                        const char *generic, const char *rerolled)
1661 {
1662         if (reroll_count <= 0)
1663                 strbuf_addstr(sb, generic);
1664         else /* RFC may be v0, so allow -v1 to diff against v0 */
1665                 strbuf_addf(sb, rerolled, reroll_count - 1);
1666         return sb->buf;
1667 }
1668
1669 static void infer_range_diff_ranges(struct strbuf *r1,
1670                                     struct strbuf *r2,
1671                                     const char *prev,
1672                                     struct commit *origin,
1673                                     struct commit *head)
1674 {
1675         const char *head_oid = oid_to_hex(&head->object.oid);
1676         int prev_is_range = !!strstr(prev, "..");
1677
1678         if (prev_is_range)
1679                 strbuf_addstr(r1, prev);
1680         else
1681                 strbuf_addf(r1, "%s..%s", head_oid, prev);
1682
1683         if (origin)
1684                 strbuf_addf(r2, "%s..%s", oid_to_hex(&origin->object.oid), head_oid);
1685         else if (prev_is_range)
1686                 die(_("failed to infer range-diff origin of current series"));
1687         else {
1688                 warning(_("using '%s' as range-diff origin of current series"), prev);
1689                 strbuf_addf(r2, "%s..%s", prev, head_oid);
1690         }
1691 }
1692
1693 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1694 {
1695         struct commit *commit;
1696         struct commit **list = NULL;
1697         struct rev_info rev;
1698         struct setup_revision_opt s_r_opt;
1699         int nr = 0, total, i;
1700         int use_stdout = 0;
1701         int start_number = -1;
1702         int just_numbers = 0;
1703         int ignore_if_in_upstream = 0;
1704         int cover_letter = -1;
1705         int boundary_count = 0;
1706         int no_binary_diff = 0;
1707         int zero_commit = 0;
1708         struct commit *origin = NULL;
1709         const char *in_reply_to = NULL;
1710         struct patch_ids ids;
1711         struct strbuf buf = STRBUF_INIT;
1712         int use_patch_format = 0;
1713         int quiet = 0;
1714         int reroll_count = -1;
1715         char *cover_from_description_arg = NULL;
1716         char *branch_name = NULL;
1717         char *base_commit = NULL;
1718         struct base_tree_info bases;
1719         struct commit *base;
1720         int show_progress = 0;
1721         struct progress *progress = NULL;
1722         struct oid_array idiff_prev = OID_ARRAY_INIT;
1723         struct strbuf idiff_title = STRBUF_INIT;
1724         const char *rdiff_prev = NULL;
1725         struct strbuf rdiff1 = STRBUF_INIT;
1726         struct strbuf rdiff2 = STRBUF_INIT;
1727         struct strbuf rdiff_title = STRBUF_INIT;
1728         int creation_factor = -1;
1729
1730         const struct option builtin_format_patch_options[] = {
1731                 OPT_CALLBACK_F('n', "numbered", &numbered, NULL,
1732                             N_("use [PATCH n/m] even with a single patch"),
1733                             PARSE_OPT_NOARG, numbered_callback),
1734                 OPT_CALLBACK_F('N', "no-numbered", &numbered, NULL,
1735                             N_("use [PATCH] even with multiple patches"),
1736                             PARSE_OPT_NOARG | PARSE_OPT_NONEG, no_numbered_callback),
1737                 OPT_BOOL('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
1738                 OPT_BOOL(0, "stdout", &use_stdout,
1739                             N_("print patches to standard out")),
1740                 OPT_BOOL(0, "cover-letter", &cover_letter,
1741                             N_("generate a cover letter")),
1742                 OPT_BOOL(0, "numbered-files", &just_numbers,
1743                             N_("use simple number sequence for output file names")),
1744                 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1745                             N_("use <sfx> instead of '.patch'")),
1746                 OPT_INTEGER(0, "start-number", &start_number,
1747                             N_("start numbering patches at <n> instead of 1")),
1748                 OPT_INTEGER('v', "reroll-count", &reroll_count,
1749                             N_("mark the series as Nth re-roll")),
1750                 OPT_CALLBACK_F(0, "rfc", &rev, NULL,
1751                             N_("Use [RFC PATCH] instead of [PATCH]"),
1752                             PARSE_OPT_NOARG | PARSE_OPT_NONEG, rfc_callback),
1753                 OPT_STRING(0, "cover-from-description", &cover_from_description_arg,
1754                             N_("cover-from-description-mode"),
1755                             N_("generate parts of a cover letter based on a branch's description")),
1756                 OPT_CALLBACK_F(0, "subject-prefix", &rev, N_("prefix"),
1757                             N_("Use [<prefix>] instead of [PATCH]"),
1758                             PARSE_OPT_NONEG, subject_prefix_callback),
1759                 OPT_CALLBACK_F('o', "output-directory", &output_directory,
1760                             N_("dir"), N_("store resulting files in <dir>"),
1761                             PARSE_OPT_NONEG, output_directory_callback),
1762                 OPT_CALLBACK_F('k', "keep-subject", &rev, NULL,
1763                             N_("don't strip/add [PATCH]"),
1764                             PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback),
1765                 OPT_BOOL(0, "no-binary", &no_binary_diff,
1766                          N_("don't output binary diffs")),
1767                 OPT_BOOL(0, "zero-commit", &zero_commit,
1768                          N_("output all-zero hash in From header")),
1769                 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1770                          N_("don't include a patch matching a commit upstream")),
1771                 OPT_SET_INT_F('p', "no-stat", &use_patch_format,
1772                               N_("show patch format instead of default (patch + stat)"),
1773                               1, PARSE_OPT_NONEG),
1774                 OPT_GROUP(N_("Messaging")),
1775                 OPT_CALLBACK(0, "add-header", NULL, N_("header"),
1776                             N_("add email header"), header_callback),
1777                 OPT_CALLBACK(0, "to", NULL, N_("email"), N_("add To: header"), to_callback),
1778                 OPT_CALLBACK(0, "cc", NULL, N_("email"), N_("add Cc: header"), cc_callback),
1779                 OPT_CALLBACK_F(0, "from", &from, N_("ident"),
1780                             N_("set From address to <ident> (or committer ident if absent)"),
1781                             PARSE_OPT_OPTARG, from_callback),
1782                 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1783                             N_("make first mail a reply to <message-id>")),
1784                 OPT_CALLBACK_F(0, "attach", &rev, N_("boundary"),
1785                             N_("attach the patch"), PARSE_OPT_OPTARG,
1786                             attach_callback),
1787                 OPT_CALLBACK_F(0, "inline", &rev, N_("boundary"),
1788                             N_("inline the patch"),
1789                             PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1790                             inline_callback),
1791                 OPT_CALLBACK_F(0, "thread", &thread, N_("style"),
1792                             N_("enable message threading, styles: shallow, deep"),
1793                             PARSE_OPT_OPTARG, thread_callback),
1794                 OPT_STRING(0, "signature", &signature, N_("signature"),
1795                             N_("add a signature")),
1796                 OPT_CALLBACK_F(0, "base", &base_commit, N_("base-commit"),
1797                                N_("add prerequisite tree info to the patch series"),
1798                                0, base_callback),
1799                 OPT_FILENAME(0, "signature-file", &signature_file,
1800                                 N_("add a signature from a file")),
1801                 OPT__QUIET(&quiet, N_("don't print the patch filenames")),
1802                 OPT_BOOL(0, "progress", &show_progress,
1803                          N_("show progress while generating patches")),
1804                 OPT_CALLBACK(0, "interdiff", &idiff_prev, N_("rev"),
1805                              N_("show changes against <rev> in cover letter or single patch"),
1806                              parse_opt_object_name),
1807                 OPT_STRING(0, "range-diff", &rdiff_prev, N_("refspec"),
1808                            N_("show changes against <refspec> in cover letter or single patch")),
1809                 OPT_INTEGER(0, "creation-factor", &creation_factor,
1810                             N_("percentage by which creation is weighted")),
1811                 OPT_END()
1812         };
1813
1814         extra_hdr.strdup_strings = 1;
1815         extra_to.strdup_strings = 1;
1816         extra_cc.strdup_strings = 1;
1817         init_log_defaults();
1818         init_display_notes(&notes_opt);
1819         git_config(git_format_config, NULL);
1820         repo_init_revisions(the_repository, &rev, prefix);
1821         rev.show_notes = show_notes;
1822         memcpy(&rev.notes_opt, &notes_opt, sizeof(notes_opt));
1823         rev.commit_format = CMIT_FMT_EMAIL;
1824         rev.encode_email_headers = default_encode_email_headers;
1825         rev.expand_tabs_in_log_default = 0;
1826         rev.verbose_header = 1;
1827         rev.diff = 1;
1828         rev.max_parents = 1;
1829         rev.diffopt.flags.recursive = 1;
1830         rev.subject_prefix = fmt_patch_subject_prefix;
1831         memset(&s_r_opt, 0, sizeof(s_r_opt));
1832         s_r_opt.def = "HEAD";
1833         s_r_opt.revarg_opt = REVARG_COMMITTISH;
1834
1835         if (default_attach) {
1836                 rev.mime_boundary = default_attach;
1837                 rev.no_inline = 1;
1838         }
1839
1840         /*
1841          * Parse the arguments before setup_revisions(), or something
1842          * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1843          * possibly a valid SHA1.
1844          */
1845         argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1846                              builtin_format_patch_usage,
1847                              PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1848                              PARSE_OPT_KEEP_DASHDASH);
1849
1850         if (cover_from_description_arg)
1851                 cover_from_description_mode = parse_cover_from_description(cover_from_description_arg);
1852
1853         if (0 < reroll_count) {
1854                 struct strbuf sprefix = STRBUF_INIT;
1855                 strbuf_addf(&sprefix, "%s v%d",
1856                             rev.subject_prefix, reroll_count);
1857                 rev.reroll_count = reroll_count;
1858                 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1859         }
1860
1861         for (i = 0; i < extra_hdr.nr; i++) {
1862                 strbuf_addstr(&buf, extra_hdr.items[i].string);
1863                 strbuf_addch(&buf, '\n');
1864         }
1865
1866         if (extra_to.nr)
1867                 strbuf_addstr(&buf, "To: ");
1868         for (i = 0; i < extra_to.nr; i++) {
1869                 if (i)
1870                         strbuf_addstr(&buf, "    ");
1871                 strbuf_addstr(&buf, extra_to.items[i].string);
1872                 if (i + 1 < extra_to.nr)
1873                         strbuf_addch(&buf, ',');
1874                 strbuf_addch(&buf, '\n');
1875         }
1876
1877         if (extra_cc.nr)
1878                 strbuf_addstr(&buf, "Cc: ");
1879         for (i = 0; i < extra_cc.nr; i++) {
1880                 if (i)
1881                         strbuf_addstr(&buf, "    ");
1882                 strbuf_addstr(&buf, extra_cc.items[i].string);
1883                 if (i + 1 < extra_cc.nr)
1884                         strbuf_addch(&buf, ',');
1885                 strbuf_addch(&buf, '\n');
1886         }
1887
1888         rev.extra_headers = strbuf_detach(&buf, NULL);
1889
1890         if (from) {
1891                 if (split_ident_line(&rev.from_ident, from, strlen(from)))
1892                         die(_("invalid ident line: %s"), from);
1893         }
1894
1895         if (start_number < 0)
1896                 start_number = 1;
1897
1898         /*
1899          * If numbered is set solely due to format.numbered in config,
1900          * and it would conflict with --keep-subject (-k) from the
1901          * command line, reset "numbered".
1902          */
1903         if (numbered && keep_subject && !numbered_cmdline_opt)
1904                 numbered = 0;
1905
1906         if (numbered && keep_subject)
1907                 die(_("-n and -k are mutually exclusive"));
1908         if (keep_subject && subject_prefix)
1909                 die(_("--subject-prefix/--rfc and -k are mutually exclusive"));
1910         rev.preserve_subject = keep_subject;
1911
1912         argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1913         if (argc > 1)
1914                 die(_("unrecognized argument: %s"), argv[1]);
1915
1916         if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1917                 die(_("--name-only does not make sense"));
1918         if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1919                 die(_("--name-status does not make sense"));
1920         if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1921                 die(_("--check does not make sense"));
1922
1923         if (!use_patch_format &&
1924                 (!rev.diffopt.output_format ||
1925                  rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1926                 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1927         if (!rev.diffopt.stat_width)
1928                 rev.diffopt.stat_width = MAIL_DEFAULT_WRAP;
1929
1930         /* Always generate a patch */
1931         rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1932
1933         rev.zero_commit = zero_commit;
1934
1935         if (!rev.diffopt.flags.text && !no_binary_diff)
1936                 rev.diffopt.flags.binary = 1;
1937
1938         if (rev.show_notes)
1939                 load_display_notes(&rev.notes_opt);
1940
1941         if (!output_directory && !use_stdout)
1942                 output_directory = config_output_directory;
1943
1944         if (!use_stdout)
1945                 output_directory = set_outdir(prefix, output_directory);
1946         else
1947                 setup_pager();
1948
1949         if (output_directory) {
1950                 int saved;
1951                 if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
1952                         rev.diffopt.use_color = GIT_COLOR_NEVER;
1953                 if (use_stdout)
1954                         die(_("standard output, or directory, which one?"));
1955                 /*
1956                  * We consider <outdir> as 'outside of gitdir', therefore avoid
1957                  * applying adjust_shared_perm in s-c-l-d.
1958                  */
1959                 saved = get_shared_repository();
1960                 set_shared_repository(0);
1961                 switch (safe_create_leading_directories_const(output_directory)) {
1962                 case SCLD_OK:
1963                 case SCLD_EXISTS:
1964                         break;
1965                 default:
1966                         die(_("could not create leading directories "
1967                               "of '%s'"), output_directory);
1968                 }
1969                 set_shared_repository(saved);
1970                 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1971                         die_errno(_("could not create directory '%s'"),
1972                                   output_directory);
1973         }
1974
1975         if (rev.pending.nr == 1) {
1976                 int check_head = 0;
1977
1978                 if (rev.max_count < 0 && !rev.show_root_diff) {
1979                         /*
1980                          * This is traditional behaviour of "git format-patch
1981                          * origin" that prepares what the origin side still
1982                          * does not have.
1983                          */
1984                         rev.pending.objects[0].item->flags |= UNINTERESTING;
1985                         add_head_to_pending(&rev);
1986                         check_head = 1;
1987                 }
1988                 /*
1989                  * Otherwise, it is "format-patch -22 HEAD", and/or
1990                  * "format-patch --root HEAD".  The user wants
1991                  * get_revision() to do the usual traversal.
1992                  */
1993
1994                 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
1995                         check_head = 1;
1996
1997                 if (check_head) {
1998                         const char *ref, *v;
1999                         ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
2000                                                  NULL, NULL);
2001                         if (ref && skip_prefix(ref, "refs/heads/", &v))
2002                                 branch_name = xstrdup(v);
2003                         else
2004                                 branch_name = xstrdup(""); /* no branch */
2005                 }
2006         }
2007
2008         /*
2009          * We cannot move this anywhere earlier because we do want to
2010          * know if --root was given explicitly from the command line.
2011          */
2012         rev.show_root_diff = 1;
2013
2014         if (ignore_if_in_upstream) {
2015                 /* Don't say anything if head and upstream are the same. */
2016                 if (rev.pending.nr == 2) {
2017                         struct object_array_entry *o = rev.pending.objects;
2018                         if (oideq(&o[0].item->oid, &o[1].item->oid))
2019                                 goto done;
2020                 }
2021                 get_patch_ids(&rev, &ids);
2022         }
2023
2024         if (prepare_revision_walk(&rev))
2025                 die(_("revision walk setup failed"));
2026         rev.boundary = 1;
2027         while ((commit = get_revision(&rev)) != NULL) {
2028                 if (commit->object.flags & BOUNDARY) {
2029                         boundary_count++;
2030                         origin = (boundary_count == 1) ? commit : NULL;
2031                         continue;
2032                 }
2033
2034                 if (ignore_if_in_upstream && has_commit_patch_id(commit, &ids))
2035                         continue;
2036
2037                 nr++;
2038                 REALLOC_ARRAY(list, nr);
2039                 list[nr - 1] = commit;
2040         }
2041         if (nr == 0)
2042                 /* nothing to do */
2043                 goto done;
2044         total = nr;
2045         if (cover_letter == -1) {
2046                 if (config_cover_letter == COVER_AUTO)
2047                         cover_letter = (total > 1);
2048                 else
2049                         cover_letter = (config_cover_letter == COVER_ON);
2050         }
2051         if (!keep_subject && auto_number && (total > 1 || cover_letter))
2052                 numbered = 1;
2053         if (numbered)
2054                 rev.total = total + start_number - 1;
2055
2056         if (idiff_prev.nr) {
2057                 if (!cover_letter && total != 1)
2058                         die(_("--interdiff requires --cover-letter or single patch"));
2059                 rev.idiff_oid1 = &idiff_prev.oid[idiff_prev.nr - 1];
2060                 rev.idiff_oid2 = get_commit_tree_oid(list[0]);
2061                 rev.idiff_title = diff_title(&idiff_title, reroll_count,
2062                                              _("Interdiff:"),
2063                                              _("Interdiff against v%d:"));
2064         }
2065
2066         if (creation_factor < 0)
2067                 creation_factor = RANGE_DIFF_CREATION_FACTOR_DEFAULT;
2068         else if (!rdiff_prev)
2069                 die(_("--creation-factor requires --range-diff"));
2070
2071         if (rdiff_prev) {
2072                 if (!cover_letter && total != 1)
2073                         die(_("--range-diff requires --cover-letter or single patch"));
2074
2075                 infer_range_diff_ranges(&rdiff1, &rdiff2, rdiff_prev,
2076                                         origin, list[0]);
2077                 rev.rdiff1 = rdiff1.buf;
2078                 rev.rdiff2 = rdiff2.buf;
2079                 rev.creation_factor = creation_factor;
2080                 rev.rdiff_title = diff_title(&rdiff_title, reroll_count,
2081                                              _("Range-diff:"),
2082                                              _("Range-diff against v%d:"));
2083         }
2084
2085         if (!signature) {
2086                 ; /* --no-signature inhibits all signatures */
2087         } else if (signature && signature != git_version_string) {
2088                 ; /* non-default signature already set */
2089         } else if (signature_file) {
2090                 struct strbuf buf = STRBUF_INIT;
2091
2092                 if (strbuf_read_file(&buf, signature_file, 128) < 0)
2093                         die_errno(_("unable to read signature file '%s'"), signature_file);
2094                 signature = strbuf_detach(&buf, NULL);
2095         }
2096
2097         memset(&bases, 0, sizeof(bases));
2098         base = get_base_commit(base_commit, list, nr);
2099         if (base) {
2100                 reset_revision_walk();
2101                 clear_object_flags(UNINTERESTING);
2102                 prepare_bases(&bases, base, list, nr);
2103         }
2104
2105         if (in_reply_to || thread || cover_letter)
2106                 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
2107         if (in_reply_to) {
2108                 const char *msgid = clean_message_id(in_reply_to);
2109                 string_list_append(rev.ref_message_ids, msgid);
2110         }
2111         rev.numbered_files = just_numbers;
2112         rev.patch_suffix = fmt_patch_suffix;
2113         if (cover_letter) {
2114                 if (thread)
2115                         gen_message_id(&rev, "cover");
2116                 make_cover_letter(&rev, use_stdout,
2117                                   origin, nr, list, branch_name, quiet);
2118                 print_bases(&bases, rev.diffopt.file);
2119                 print_signature(rev.diffopt.file);
2120                 total++;
2121                 start_number--;
2122                 /* interdiff/range-diff in cover-letter; omit from patches */
2123                 rev.idiff_oid1 = NULL;
2124                 rev.rdiff1 = NULL;
2125         }
2126         rev.add_signoff = do_signoff;
2127
2128         if (show_progress)
2129                 progress = start_delayed_progress(_("Generating patches"), total);
2130         while (0 <= --nr) {
2131                 int shown;
2132                 display_progress(progress, total - nr);
2133                 commit = list[nr];
2134                 rev.nr = total - nr + (start_number - 1);
2135                 /* Make the second and subsequent mails replies to the first */
2136                 if (thread) {
2137                         /* Have we already had a message ID? */
2138                         if (rev.message_id) {
2139                                 /*
2140                                  * For deep threading: make every mail
2141                                  * a reply to the previous one, no
2142                                  * matter what other options are set.
2143                                  *
2144                                  * For shallow threading:
2145                                  *
2146                                  * Without --cover-letter and
2147                                  * --in-reply-to, make every mail a
2148                                  * reply to the one before.
2149                                  *
2150                                  * With --in-reply-to but no
2151                                  * --cover-letter, make every mail a
2152                                  * reply to the <reply-to>.
2153                                  *
2154                                  * With --cover-letter, make every
2155                                  * mail but the cover letter a reply
2156                                  * to the cover letter.  The cover
2157                                  * letter is a reply to the
2158                                  * --in-reply-to, if specified.
2159                                  */
2160                                 if (thread == THREAD_SHALLOW
2161                                     && rev.ref_message_ids->nr > 0
2162                                     && (!cover_letter || rev.nr > 1))
2163                                         free(rev.message_id);
2164                                 else
2165                                         string_list_append(rev.ref_message_ids,
2166                                                            rev.message_id);
2167                         }
2168                         gen_message_id(&rev, oid_to_hex(&commit->object.oid));
2169                 }
2170
2171                 if (!use_stdout &&
2172                     open_next_file(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
2173                         die(_("failed to create output files"));
2174                 shown = log_tree_commit(&rev, commit);
2175                 free_commit_buffer(the_repository->parsed_objects,
2176                                    commit);
2177
2178                 /* We put one extra blank line between formatted
2179                  * patches and this flag is used by log-tree code
2180                  * to see if it needs to emit a LF before showing
2181                  * the log; when using one file per patch, we do
2182                  * not want the extra blank line.
2183                  */
2184                 if (!use_stdout)
2185                         rev.shown_one = 0;
2186                 if (shown) {
2187                         print_bases(&bases, rev.diffopt.file);
2188                         if (rev.mime_boundary)
2189                                 fprintf(rev.diffopt.file, "\n--%s%s--\n\n\n",
2190                                        mime_boundary_leader,
2191                                        rev.mime_boundary);
2192                         else
2193                                 print_signature(rev.diffopt.file);
2194                 }
2195                 if (!use_stdout)
2196                         fclose(rev.diffopt.file);
2197         }
2198         stop_progress(&progress);
2199         free(list);
2200         free(branch_name);
2201         string_list_clear(&extra_to, 0);
2202         string_list_clear(&extra_cc, 0);
2203         string_list_clear(&extra_hdr, 0);
2204         if (ignore_if_in_upstream)
2205                 free_patch_ids(&ids);
2206
2207 done:
2208         oid_array_clear(&idiff_prev);
2209         strbuf_release(&idiff_title);
2210         strbuf_release(&rdiff1);
2211         strbuf_release(&rdiff2);
2212         strbuf_release(&rdiff_title);
2213         return 0;
2214 }
2215
2216 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
2217 {
2218         struct object_id oid;
2219         if (get_oid(arg, &oid) == 0) {
2220                 struct commit *commit = lookup_commit_reference(the_repository,
2221                                                                 &oid);
2222                 if (commit) {
2223                         commit->object.flags |= flags;
2224                         add_pending_object(revs, &commit->object, arg);
2225                         return 0;
2226                 }
2227         }
2228         return -1;
2229 }
2230
2231 static const char * const cherry_usage[] = {
2232         N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
2233         NULL
2234 };
2235
2236 static void print_commit(char sign, struct commit *commit, int verbose,
2237                          int abbrev, FILE *file)
2238 {
2239         if (!verbose) {
2240                 fprintf(file, "%c %s\n", sign,
2241                        find_unique_abbrev(&commit->object.oid, abbrev));
2242         } else {
2243                 struct strbuf buf = STRBUF_INIT;
2244                 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
2245                 fprintf(file, "%c %s %s\n", sign,
2246                        find_unique_abbrev(&commit->object.oid, abbrev),
2247                        buf.buf);
2248                 strbuf_release(&buf);
2249         }
2250 }
2251
2252 int cmd_cherry(int argc, const char **argv, const char *prefix)
2253 {
2254         struct rev_info revs;
2255         struct patch_ids ids;
2256         struct commit *commit;
2257         struct commit_list *list = NULL;
2258         struct branch *current_branch;
2259         const char *upstream;
2260         const char *head = "HEAD";
2261         const char *limit = NULL;
2262         int verbose = 0, abbrev = 0;
2263
2264         struct option options[] = {
2265                 OPT__ABBREV(&abbrev),
2266                 OPT__VERBOSE(&verbose, N_("be verbose")),
2267                 OPT_END()
2268         };
2269
2270         argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
2271
2272         switch (argc) {
2273         case 3:
2274                 limit = argv[2];
2275                 /* FALLTHROUGH */
2276         case 2:
2277                 head = argv[1];
2278                 /* FALLTHROUGH */
2279         case 1:
2280                 upstream = argv[0];
2281                 break;
2282         default:
2283                 current_branch = branch_get(NULL);
2284                 upstream = branch_get_upstream(current_branch, NULL);
2285                 if (!upstream) {
2286                         fprintf(stderr, _("Could not find a tracked"
2287                                         " remote branch, please"
2288                                         " specify <upstream> manually.\n"));
2289                         usage_with_options(cherry_usage, options);
2290                 }
2291         }
2292
2293         repo_init_revisions(the_repository, &revs, prefix);
2294         revs.max_parents = 1;
2295
2296         if (add_pending_commit(head, &revs, 0))
2297                 die(_("unknown commit %s"), head);
2298         if (add_pending_commit(upstream, &revs, UNINTERESTING))
2299                 die(_("unknown commit %s"), upstream);
2300
2301         /* Don't say anything if head and upstream are the same. */
2302         if (revs.pending.nr == 2) {
2303                 struct object_array_entry *o = revs.pending.objects;
2304                 if (oideq(&o[0].item->oid, &o[1].item->oid))
2305                         return 0;
2306         }
2307
2308         get_patch_ids(&revs, &ids);
2309
2310         if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
2311                 die(_("unknown commit %s"), limit);
2312
2313         /* reverse the list of commits */
2314         if (prepare_revision_walk(&revs))
2315                 die(_("revision walk setup failed"));
2316         while ((commit = get_revision(&revs)) != NULL) {
2317                 commit_list_insert(commit, &list);
2318         }
2319
2320         while (list) {
2321                 char sign = '+';
2322
2323                 commit = list->item;
2324                 if (has_commit_patch_id(commit, &ids))
2325                         sign = '-';
2326                 print_commit(sign, commit, verbose, abbrev, revs.diffopt.file);
2327                 list = list->next;
2328         }
2329
2330         free_patch_ids(&ids);
2331         return 0;
2332 }