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