]> git.ipfire.org Git - thirdparty/git.git/blob - builtin/log.c
projects / thirdparty / git.git / blob
? search:


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