2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
10 #include "object-store.h"
18 #include "reflog-walk.h"
19 #include "patch-ids.h"
20 #include "run-command.h"
23 #include "string-list.h"
24 #include "parse-options.h"
27 #include "streaming.h"
30 #include "gpg-interface.h"
32 #include "commit-slab.h"
33 #include "repository.h"
34 #include "commit-reach.h"
35 #include "interdiff.h"
36 #include "range-diff.h"
38 #define MAIL_DEFAULT_WRAP 72
40 /* Set a default date-time format for git log ("log.date" config variable) */
41 static const char *default_date_mode = NULL;
43 static int default_abbrev_commit;
44 static int default_show_root = 1;
45 static int default_follow;
46 static int default_show_signature;
47 static int decoration_style;
48 static int decoration_given;
49 static int use_mailmap_config;
50 static const char *fmt_patch_subject_prefix = "PATCH";
51 static const char *fmt_pretty;
53 static const char * const builtin_log_usage[] = {
54 N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
55 N_("git show [<options>] <object>..."),
59 struct line_opt_callback_data {
62 struct string_list args;
65 static int auto_decoration_style(void)
67 return (isatty(1) || pager_in_use()) ? DECORATE_SHORT_REFS : 0;
70 static int parse_decoration_style(const char *value)
72 switch (git_parse_maybe_bool(value)) {
74 return DECORATE_SHORT_REFS;
80 if (!strcmp(value, "full"))
81 return DECORATE_FULL_REFS;
82 else if (!strcmp(value, "short"))
83 return DECORATE_SHORT_REFS;
84 else if (!strcmp(value, "auto"))
85 return auto_decoration_style();
89 static int decorate_callback(const struct option *opt, const char *arg, int unset)
94 decoration_style = parse_decoration_style(arg);
96 decoration_style = DECORATE_SHORT_REFS;
98 if (decoration_style < 0)
99 die(_("invalid --decorate option: %s"), arg);
101 decoration_given = 1;
106 static int log_line_range_callback(const struct option *option, const char *arg, int unset)
108 struct line_opt_callback_data *data = option->value;
113 data->rev->line_level_traverse = 1;
114 string_list_append(&data->args, arg);
119 static void init_log_defaults(void)
121 init_grep_defaults(the_repository);
122 init_diff_ui_defaults();
124 decoration_style = auto_decoration_style();
127 static void cmd_log_init_defaults(struct rev_info *rev)
130 get_commit_format(fmt_pretty, rev);
132 rev->diffopt.flags.default_follow_renames = 1;
133 rev->verbose_header = 1;
134 rev->diffopt.flags.recursive = 1;
135 rev->diffopt.stat_width = -1; /* use full terminal width */
136 rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
137 rev->abbrev_commit = default_abbrev_commit;
138 rev->show_root_diff = default_show_root;
139 rev->subject_prefix = fmt_patch_subject_prefix;
140 rev->show_signature = default_show_signature;
141 rev->diffopt.flags.allow_textconv = 1;
143 if (default_date_mode)
144 parse_date_format(default_date_mode, &rev->date_mode);
147 static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
148 struct rev_info *rev, struct setup_revision_opt *opt)
150 struct userformat_want w;
151 int quiet = 0, source = 0, mailmap = 0;
152 static struct line_opt_callback_data line_cb = {NULL, NULL, STRING_LIST_INIT_DUP};
153 static struct string_list decorate_refs_exclude = STRING_LIST_INIT_NODUP;
154 static struct string_list decorate_refs_include = STRING_LIST_INIT_NODUP;
155 struct decoration_filter decoration_filter = {&decorate_refs_include,
156 &decorate_refs_exclude};
157 static struct revision_sources revision_sources;
159 const struct option builtin_log_options[] = {
160 OPT__QUIET(&quiet, N_("suppress diff output")),
161 OPT_BOOL(0, "source", &source, N_("show source")),
162 OPT_BOOL(0, "use-mailmap", &mailmap, N_("Use mail map file")),
163 OPT_STRING_LIST(0, "decorate-refs", &decorate_refs_include,
164 N_("pattern"), N_("only decorate refs that match <pattern>")),
165 OPT_STRING_LIST(0, "decorate-refs-exclude", &decorate_refs_exclude,
166 N_("pattern"), N_("do not decorate refs that match <pattern>")),
167 { OPTION_CALLBACK, 0, "decorate", NULL, NULL, N_("decorate options"),
168 PARSE_OPT_OPTARG, decorate_callback},
169 OPT_CALLBACK('L', NULL, &line_cb, "n,m:file",
170 N_("Process line range n,m in file, counting from 1"),
171 log_line_range_callback),
176 line_cb.prefix = prefix;
178 mailmap = use_mailmap_config;
179 argc = parse_options(argc, argv, prefix,
180 builtin_log_options, builtin_log_usage,
181 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
182 PARSE_OPT_KEEP_DASHDASH);
185 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
186 argc = setup_revisions(argc, argv, rev, opt);
188 /* Any arguments at this point are not recognized */
190 die(_("unrecognized argument: %s"), argv[1]);
192 memset(&w, 0, sizeof(w));
193 userformat_find_requirements(NULL, &w);
195 if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
198 init_display_notes(&rev->notes_opt);
200 if ((rev->diffopt.pickaxe_opts & DIFF_PICKAXE_KINDS_MASK) ||
201 rev->diffopt.filter || rev->diffopt.flags.follow_renames)
202 rev->always_show_header = 0;
205 init_revision_sources(&revision_sources);
206 rev->sources = &revision_sources;
210 rev->mailmap = xcalloc(1, sizeof(struct string_list));
211 read_mailmap(rev->mailmap, NULL);
214 if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
216 * "log --pretty=raw" is special; ignore UI oriented
217 * configuration variables such as decoration.
219 if (!decoration_given)
220 decoration_style = 0;
221 if (!rev->abbrev_commit_given)
222 rev->abbrev_commit = 0;
225 if (decoration_style) {
226 rev->show_decorations = 1;
227 load_ref_decorations(&decoration_filter, decoration_style);
230 if (rev->line_level_traverse)
231 line_log_init(rev, line_cb.prefix, &line_cb.args);
236 static void cmd_log_init(int argc, const char **argv, const char *prefix,
237 struct rev_info *rev, struct setup_revision_opt *opt)
239 cmd_log_init_defaults(rev);
240 cmd_log_init_finish(argc, argv, prefix, rev, opt);
244 * This gives a rough estimate for how many commits we
245 * will print out in the list.
247 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
252 struct commit *commit = list->item;
253 unsigned int flags = commit->object.flags;
255 if (!(flags & (TREESAME | UNINTERESTING)))
261 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
263 if (rev->shown_one) {
265 if (rev->commit_format != CMIT_FMT_ONELINE)
266 putchar(rev->diffopt.line_termination);
268 fprintf(rev->diffopt.file, _("Final output: %d %s\n"), nr, stage);
271 static struct itimerval early_output_timer;
273 static void log_show_early(struct rev_info *revs, struct commit_list *list)
275 int i = revs->early_output, close_file = revs->diffopt.close_file;
278 revs->diffopt.close_file = 0;
279 sort_in_topological_order(&list, revs->sort_order);
281 struct commit *commit = list->item;
282 switch (simplify_commit(revs, commit)) {
285 int n = estimate_commit_count(revs, list);
286 show_early_header(revs, "incomplete", n);
289 log_tree_commit(revs, commit);
296 fclose(revs->diffopt.file);
302 /* Did we already get enough commits for the early output? */
305 fclose(revs->diffopt.file);
310 * ..if no, then repeat it twice a second until we
313 * NOTE! We don't use "it_interval", because if the
314 * reader isn't listening, we want our output to be
315 * throttled by the writing, and not have the timer
316 * trigger every second even if we're blocked on a
319 early_output_timer.it_value.tv_sec = 0;
320 early_output_timer.it_value.tv_usec = 500000;
321 setitimer(ITIMER_REAL, &early_output_timer, NULL);
324 static void early_output(int signal)
326 show_early_output = log_show_early;
329 static void setup_early_output(struct rev_info *rev)
334 * Set up the signal handler, minimally intrusively:
335 * we only set a single volatile integer word (not
336 * using sigatomic_t - trying to avoid unnecessary
337 * system dependencies and headers), and using
340 memset(&sa, 0, sizeof(sa));
341 sa.sa_handler = early_output;
342 sigemptyset(&sa.sa_mask);
343 sa.sa_flags = SA_RESTART;
344 sigaction(SIGALRM, &sa, NULL);
347 * If we can get the whole output in less than a
348 * tenth of a second, don't even bother doing the
349 * early-output thing..
351 * This is a one-time-only trigger.
353 early_output_timer.it_value.tv_sec = 0;
354 early_output_timer.it_value.tv_usec = 100000;
355 setitimer(ITIMER_REAL, &early_output_timer, NULL);
358 static void finish_early_output(struct rev_info *rev)
360 int n = estimate_commit_count(rev, rev->commits);
361 signal(SIGALRM, SIG_IGN);
362 show_early_header(rev, "done", n);
365 static int cmd_log_walk(struct rev_info *rev)
367 struct commit *commit;
369 int saved_dcctc = 0, close_file = rev->diffopt.close_file;
371 if (rev->early_output)
372 setup_early_output(rev);
374 if (prepare_revision_walk(rev))
375 die(_("revision walk setup failed"));
377 if (rev->early_output)
378 finish_early_output(rev);
381 * For --check and --exit-code, the exit code is based on CHECK_FAILED
382 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
383 * retain that state information if replacing rev->diffopt in this loop
385 rev->diffopt.close_file = 0;
386 while ((commit = get_revision(rev)) != NULL) {
387 if (!log_tree_commit(rev, commit) && rev->max_count >= 0)
389 * We decremented max_count in get_revision,
390 * but we didn't actually show the commit.
393 if (!rev->reflog_info) {
395 * We may show a given commit multiple times when
396 * walking the reflogs.
398 free_commit_buffer(commit);
399 free_commit_list(commit->parents);
400 commit->parents = NULL;
402 if (saved_nrl < rev->diffopt.needed_rename_limit)
403 saved_nrl = rev->diffopt.needed_rename_limit;
404 if (rev->diffopt.degraded_cc_to_c)
407 rev->diffopt.degraded_cc_to_c = saved_dcctc;
408 rev->diffopt.needed_rename_limit = saved_nrl;
410 fclose(rev->diffopt.file);
412 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
413 rev->diffopt.flags.check_failed) {
416 return diff_result_code(&rev->diffopt, 0);
419 static int git_log_config(const char *var, const char *value, void *cb)
421 const char *slot_name;
423 if (!strcmp(var, "format.pretty"))
424 return git_config_string(&fmt_pretty, var, value);
425 if (!strcmp(var, "format.subjectprefix"))
426 return git_config_string(&fmt_patch_subject_prefix, var, value);
427 if (!strcmp(var, "log.abbrevcommit")) {
428 default_abbrev_commit = git_config_bool(var, value);
431 if (!strcmp(var, "log.date"))
432 return git_config_string(&default_date_mode, var, value);
433 if (!strcmp(var, "log.decorate")) {
434 decoration_style = parse_decoration_style(value);
435 if (decoration_style < 0)
436 decoration_style = 0; /* maybe warn? */
439 if (!strcmp(var, "log.showroot")) {
440 default_show_root = git_config_bool(var, value);
443 if (!strcmp(var, "log.follow")) {
444 default_follow = git_config_bool(var, value);
447 if (skip_prefix(var, "color.decorate.", &slot_name))
448 return parse_decorate_color_config(var, slot_name, value);
449 if (!strcmp(var, "log.mailmap")) {
450 use_mailmap_config = git_config_bool(var, value);
453 if (!strcmp(var, "log.showsignature")) {
454 default_show_signature = git_config_bool(var, value);
458 if (grep_config(var, value, cb) < 0)
460 if (git_gpg_config(var, value, cb) < 0)
462 return git_diff_ui_config(var, value, cb);
465 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
468 struct setup_revision_opt opt;
471 git_config(git_log_config, NULL);
473 repo_init_revisions(the_repository, &rev, prefix);
475 rev.simplify_history = 0;
476 memset(&opt, 0, sizeof(opt));
478 opt.revarg_opt = REVARG_COMMITTISH;
479 cmd_log_init(argc, argv, prefix, &rev, &opt);
480 if (!rev.diffopt.output_format)
481 rev.diffopt.output_format = DIFF_FORMAT_RAW;
482 return cmd_log_walk(&rev);
485 static void show_tagger(char *buf, int len, struct rev_info *rev)
487 struct strbuf out = STRBUF_INIT;
488 struct pretty_print_context pp = {0};
490 pp.fmt = rev->commit_format;
491 pp.date_mode = rev->date_mode;
492 pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
493 fprintf(rev->diffopt.file, "%s", out.buf);
494 strbuf_release(&out);
497 static int show_blob_object(const struct object_id *oid, struct rev_info *rev, const char *obj_name)
499 struct object_id oidc;
500 struct object_context obj_context;
504 fflush(rev->diffopt.file);
505 if (!rev->diffopt.flags.textconv_set_via_cmdline ||
506 !rev->diffopt.flags.allow_textconv)
507 return stream_blob_to_fd(1, oid, NULL, 0);
509 if (get_oid_with_context(obj_name, GET_OID_RECORD_PATH,
510 &oidc, &obj_context))
511 die(_("Not a valid object name %s"), obj_name);
512 if (!obj_context.path ||
513 !textconv_object(the_repository, obj_context.path,
514 obj_context.mode, &oidc, 1, &buf, &size)) {
515 free(obj_context.path);
516 return stream_blob_to_fd(1, oid, NULL, 0);
520 die(_("git show %s: bad file"), obj_name);
522 write_or_die(1, buf, size);
523 free(obj_context.path);
527 static int show_tag_object(const struct object_id *oid, struct rev_info *rev)
530 enum object_type type;
531 char *buf = read_object_file(oid, &type, &size);
535 return error(_("Could not read object %s"), oid_to_hex(oid));
537 assert(type == OBJ_TAG);
538 while (offset < size && buf[offset] != '\n') {
539 int new_offset = offset + 1;
540 while (new_offset < size && buf[new_offset++] != '\n')
542 if (starts_with(buf + offset, "tagger "))
543 show_tagger(buf + offset + 7,
544 new_offset - offset - 7, rev);
549 fwrite(buf + offset, size - offset, 1, rev->diffopt.file);
554 static int show_tree_object(const struct object_id *oid,
556 const char *pathname, unsigned mode, int stage, void *context)
558 FILE *file = context;
559 fprintf(file, "%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
563 static void show_setup_revisions_tweak(struct rev_info *rev,
564 struct setup_revision_opt *opt)
566 if (rev->ignore_merges) {
567 /* There was no "-m" on the command line */
568 rev->ignore_merges = 0;
569 if (!rev->first_parent_only && !rev->combine_merges) {
570 /* No "--first-parent", "-c", or "--cc" */
571 rev->combine_merges = 1;
572 rev->dense_combined_merges = 1;
575 if (!rev->diffopt.output_format)
576 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
579 int cmd_show(int argc, const char **argv, const char *prefix)
582 struct object_array_entry *objects;
583 struct setup_revision_opt opt;
584 struct pathspec match_all;
585 int i, count, ret = 0;
588 git_config(git_log_config, NULL);
590 memset(&match_all, 0, sizeof(match_all));
591 repo_init_revisions(the_repository, &rev, prefix);
593 rev.always_show_header = 1;
594 rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
595 rev.diffopt.stat_width = -1; /* Scale to real terminal size */
597 memset(&opt, 0, sizeof(opt));
599 opt.tweak = show_setup_revisions_tweak;
600 cmd_log_init(argc, argv, prefix, &rev, &opt);
603 return cmd_log_walk(&rev);
605 count = rev.pending.nr;
606 objects = rev.pending.objects;
607 for (i = 0; i < count && !ret; i++) {
608 struct object *o = objects[i].item;
609 const char *name = objects[i].name;
612 ret = show_blob_object(&o->oid, &rev, name);
615 struct tag *t = (struct tag *)o;
619 fprintf(rev.diffopt.file, "%stag %s%s\n",
620 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
622 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
623 ret = show_tag_object(&o->oid, &rev);
627 o = parse_object(the_repository, &t->tagged->oid);
629 ret = error(_("Could not read object %s"),
630 oid_to_hex(&t->tagged->oid));
638 fprintf(rev.diffopt.file, "%stree %s%s\n\n",
639 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
641 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
642 read_tree_recursive((struct tree *)o, "", 0, 0, &match_all,
643 show_tree_object, rev.diffopt.file);
647 rev.pending.nr = rev.pending.alloc = 0;
648 rev.pending.objects = NULL;
649 add_object_array(o, name, &rev.pending);
650 ret = cmd_log_walk(&rev);
653 ret = error(_("Unknown type: %d"), o->type);
661 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
663 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
666 struct setup_revision_opt opt;
669 git_config(git_log_config, NULL);
671 repo_init_revisions(the_repository, &rev, prefix);
672 init_reflog_walk(&rev.reflog_info);
673 rev.verbose_header = 1;
674 memset(&opt, 0, sizeof(opt));
676 cmd_log_init_defaults(&rev);
677 rev.abbrev_commit = 1;
678 rev.commit_format = CMIT_FMT_ONELINE;
679 rev.use_terminator = 1;
680 rev.always_show_header = 1;
681 cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
683 return cmd_log_walk(&rev);
686 static void log_setup_revisions_tweak(struct rev_info *rev,
687 struct setup_revision_opt *opt)
689 if (rev->diffopt.flags.default_follow_renames &&
690 rev->prune_data.nr == 1)
691 rev->diffopt.flags.follow_renames = 1;
693 /* Turn --cc/-c into -p --cc/-c when -p was not given */
694 if (!rev->diffopt.output_format && rev->combine_merges)
695 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
697 /* Turn -m on when --cc/-c was given */
698 if (rev->combine_merges)
699 rev->ignore_merges = 0;
702 int cmd_log(int argc, const char **argv, const char *prefix)
705 struct setup_revision_opt opt;
708 git_config(git_log_config, NULL);
710 repo_init_revisions(the_repository, &rev, prefix);
711 rev.always_show_header = 1;
712 memset(&opt, 0, sizeof(opt));
714 opt.revarg_opt = REVARG_COMMITTISH;
715 opt.tweak = log_setup_revisions_tweak;
716 cmd_log_init(argc, argv, prefix, &rev, &opt);
717 return cmd_log_walk(&rev);
722 static const char *fmt_patch_suffix = ".patch";
723 static int numbered = 0;
724 static int auto_number = 1;
726 static char *default_attach = NULL;
728 static struct string_list extra_hdr = STRING_LIST_INIT_NODUP;
729 static struct string_list extra_to = STRING_LIST_INIT_NODUP;
730 static struct string_list extra_cc = STRING_LIST_INIT_NODUP;
732 static void add_header(const char *value)
734 struct string_list_item *item;
735 int len = strlen(value);
736 while (len && value[len - 1] == '\n')
739 if (!strncasecmp(value, "to: ", 4)) {
740 item = string_list_append(&extra_to, value + 4);
742 } else if (!strncasecmp(value, "cc: ", 4)) {
743 item = string_list_append(&extra_cc, value + 4);
746 item = string_list_append(&extra_hdr, value);
749 item->string[len] = '\0';
752 #define THREAD_SHALLOW 1
753 #define THREAD_DEEP 2
755 static int do_signoff;
756 static int base_auto;
758 static const char *signature = git_version_string;
759 static const char *signature_file;
760 static int config_cover_letter;
761 static const char *config_output_directory;
770 static int git_format_config(const char *var, const char *value, void *cb)
772 if (!strcmp(var, "format.headers")) {
774 die(_("format.headers without value"));
778 if (!strcmp(var, "format.suffix"))
779 return git_config_string(&fmt_patch_suffix, var, value);
780 if (!strcmp(var, "format.to")) {
782 return config_error_nonbool(var);
783 string_list_append(&extra_to, value);
786 if (!strcmp(var, "format.cc")) {
788 return config_error_nonbool(var);
789 string_list_append(&extra_cc, value);
792 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
793 !strcmp(var, "color.ui") || !strcmp(var, "diff.submodule")) {
796 if (!strcmp(var, "format.numbered")) {
797 if (value && !strcasecmp(value, "auto")) {
801 numbered = git_config_bool(var, value);
802 auto_number = auto_number && numbered;
805 if (!strcmp(var, "format.attach")) {
807 default_attach = xstrdup(value);
809 default_attach = xstrdup(git_version_string);
812 if (!strcmp(var, "format.thread")) {
813 if (value && !strcasecmp(value, "deep")) {
814 thread = THREAD_DEEP;
817 if (value && !strcasecmp(value, "shallow")) {
818 thread = THREAD_SHALLOW;
821 thread = git_config_bool(var, value) && THREAD_SHALLOW;
824 if (!strcmp(var, "format.signoff")) {
825 do_signoff = git_config_bool(var, value);
828 if (!strcmp(var, "format.signature"))
829 return git_config_string(&signature, var, value);
830 if (!strcmp(var, "format.signaturefile"))
831 return git_config_pathname(&signature_file, var, value);
832 if (!strcmp(var, "format.coverletter")) {
833 if (value && !strcasecmp(value, "auto")) {
834 config_cover_letter = COVER_AUTO;
837 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
840 if (!strcmp(var, "format.outputdirectory"))
841 return git_config_string(&config_output_directory, var, value);
842 if (!strcmp(var, "format.useautobase")) {
843 base_auto = git_config_bool(var, value);
846 if (!strcmp(var, "format.from")) {
847 int b = git_parse_maybe_bool(value);
850 from = xstrdup(value);
852 from = xstrdup(git_committer_info(IDENT_NO_DATE));
858 return git_log_config(var, value, cb);
861 static const char *output_directory = NULL;
862 static int outdir_offset;
864 static int open_next_file(struct commit *commit, const char *subject,
865 struct rev_info *rev, int quiet)
867 struct strbuf filename = STRBUF_INIT;
868 int suffix_len = strlen(rev->patch_suffix) + 1;
870 if (output_directory) {
871 strbuf_addstr(&filename, output_directory);
873 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len) {
874 strbuf_release(&filename);
875 return error(_("name of output directory is too long"));
877 strbuf_complete(&filename, '/');
880 if (rev->numbered_files)
881 strbuf_addf(&filename, "%d", rev->nr);
883 fmt_output_commit(&filename, commit, rev);
885 fmt_output_subject(&filename, subject, rev);
888 printf("%s\n", filename.buf + outdir_offset);
890 if ((rev->diffopt.file = fopen(filename.buf, "w")) == NULL) {
891 error_errno(_("Cannot open patch file %s"), filename.buf);
892 strbuf_release(&filename);
896 strbuf_release(&filename);
900 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
902 struct rev_info check_rev;
903 struct commit *commit, *c1, *c2;
904 struct object *o1, *o2;
905 unsigned flags1, flags2;
907 if (rev->pending.nr != 2)
908 die(_("Need exactly one range."));
910 o1 = rev->pending.objects[0].item;
911 o2 = rev->pending.objects[1].item;
914 c1 = lookup_commit_reference(the_repository, &o1->oid);
915 c2 = lookup_commit_reference(the_repository, &o2->oid);
917 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
918 die(_("Not a range."));
920 init_patch_ids(the_repository, ids);
922 /* given a range a..b get all patch ids for b..a */
923 repo_init_revisions(the_repository, &check_rev, rev->prefix);
924 check_rev.max_parents = 1;
925 o1->flags ^= UNINTERESTING;
926 o2->flags ^= UNINTERESTING;
927 add_pending_object(&check_rev, o1, "o1");
928 add_pending_object(&check_rev, o2, "o2");
929 if (prepare_revision_walk(&check_rev))
930 die(_("revision walk setup failed"));
932 while ((commit = get_revision(&check_rev)) != NULL) {
933 add_commit_patch_id(commit, ids);
936 /* reset for next revision walk */
937 clear_commit_marks(c1, SEEN | UNINTERESTING | SHOWN | ADDED);
938 clear_commit_marks(c2, SEEN | UNINTERESTING | SHOWN | ADDED);
943 static void gen_message_id(struct rev_info *info, char *base)
945 struct strbuf buf = STRBUF_INIT;
946 strbuf_addf(&buf, "%s.%"PRItime".git.%s", base,
947 (timestamp_t) time(NULL),
948 git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
949 info->message_id = strbuf_detach(&buf, NULL);
952 static void print_signature(FILE *file)
954 if (!signature || !*signature)
957 fprintf(file, "-- \n%s", signature);
958 if (signature[strlen(signature)-1] != '\n')
963 static void add_branch_description(struct strbuf *buf, const char *branch_name)
965 struct strbuf desc = STRBUF_INIT;
966 if (!branch_name || !*branch_name)
968 read_branch_desc(&desc, branch_name);
970 strbuf_addch(buf, '\n');
971 strbuf_addbuf(buf, &desc);
972 strbuf_addch(buf, '\n');
974 strbuf_release(&desc);
977 static char *find_branch_name(struct rev_info *rev)
979 int i, positive = -1;
980 struct object_id branch_oid;
981 const struct object_id *tip_oid;
983 char *full_ref, *branch = NULL;
985 for (i = 0; i < rev->cmdline.nr; i++) {
986 if (rev->cmdline.rev[i].flags & UNINTERESTING)
995 ref = rev->cmdline.rev[positive].name;
996 tip_oid = &rev->cmdline.rev[positive].item->oid;
997 if (dwim_ref(ref, strlen(ref), &branch_oid, &full_ref) &&
998 skip_prefix(full_ref, "refs/heads/", &v) &&
999 oideq(tip_oid, &branch_oid))
1000 branch = xstrdup(v);
1005 static void show_diffstat(struct rev_info *rev,
1006 struct commit *origin, struct commit *head)
1008 struct diff_options opts;
1010 memcpy(&opts, &rev->diffopt, sizeof(opts));
1011 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1012 opts.stat_width = MAIL_DEFAULT_WRAP;
1014 diff_setup_done(&opts);
1016 diff_tree_oid(get_commit_tree_oid(origin),
1017 get_commit_tree_oid(head),
1019 diffcore_std(&opts);
1022 fprintf(rev->diffopt.file, "\n");
1025 static void make_cover_letter(struct rev_info *rev, int use_stdout,
1026 struct commit *origin,
1027 int nr, struct commit **list,
1028 const char *branch_name,
1031 const char *committer;
1032 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
1034 struct shortlog log;
1035 struct strbuf sb = STRBUF_INIT;
1037 const char *encoding = "UTF-8";
1038 int need_8bit_cte = 0;
1039 struct pretty_print_context pp = {0};
1040 struct commit *head = list[0];
1042 if (!cmit_fmt_is_mail(rev->commit_format))
1043 die(_("Cover letter needs email format"));
1045 committer = git_committer_info(0);
1048 open_next_file(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
1051 log_write_email_headers(rev, head, &pp.after_subject, &need_8bit_cte, 0);
1053 for (i = 0; !need_8bit_cte && i < nr; i++) {
1054 const char *buf = get_commit_buffer(list[i], NULL);
1055 if (has_non_ascii(buf))
1057 unuse_commit_buffer(list[i], buf);
1061 branch_name = find_branch_name(rev);
1064 pp.fmt = CMIT_FMT_EMAIL;
1065 pp.date_mode.type = DATE_RFC2822;
1067 pp.print_email_subject = 1;
1068 pp_user_info(&pp, NULL, &sb, committer, encoding);
1069 pp_title_line(&pp, &msg, &sb, encoding, need_8bit_cte);
1070 pp_remainder(&pp, &msg, &sb, 0);
1071 add_branch_description(&sb, branch_name);
1072 fprintf(rev->diffopt.file, "%s\n", sb.buf);
1074 strbuf_release(&sb);
1076 shortlog_init(&log);
1078 log.wrap = MAIL_DEFAULT_WRAP;
1081 log.file = rev->diffopt.file;
1082 for (i = 0; i < nr; i++)
1083 shortlog_add_commit(&log, list[i]);
1085 shortlog_output(&log);
1087 /* We can only do diffstat with a unique reference point */
1089 show_diffstat(rev, origin, head);
1091 if (rev->idiff_oid1) {
1092 fprintf_ln(rev->diffopt.file, "%s", rev->idiff_title);
1093 show_interdiff(rev, 0);
1097 fprintf_ln(rev->diffopt.file, "%s", rev->rdiff_title);
1098 show_range_diff(rev->rdiff1, rev->rdiff2,
1099 rev->creation_factor, 1, &rev->diffopt);
1103 static const char *clean_message_id(const char *msg_id)
1106 const char *a, *z, *m;
1109 while ((ch = *m) && (isspace(ch) || (ch == '<')))
1114 if (!isspace(ch) && (ch != '>'))
1119 die(_("insane in-reply-to: %s"), msg_id);
1122 return xmemdupz(a, z - a);
1125 static const char *set_outdir(const char *prefix, const char *output_directory)
1127 if (output_directory && is_absolute_path(output_directory))
1128 return output_directory;
1130 if (!prefix || !*prefix) {
1131 if (output_directory)
1132 return output_directory;
1133 /* The user did not explicitly ask for "./" */
1138 outdir_offset = strlen(prefix);
1139 if (!output_directory)
1142 return prefix_filename(prefix, output_directory);
1145 static const char * const builtin_format_patch_usage[] = {
1146 N_("git format-patch [<options>] [<since> | <revision-range>]"),
1150 static int keep_subject = 0;
1152 static int keep_callback(const struct option *opt, const char *arg, int unset)
1154 ((struct rev_info *)opt->value)->total = -1;
1159 static int subject_prefix = 0;
1161 static int subject_prefix_callback(const struct option *opt, const char *arg,
1165 ((struct rev_info *)opt->value)->subject_prefix = arg;
1169 static int rfc_callback(const struct option *opt, const char *arg, int unset)
1171 return subject_prefix_callback(opt, "RFC PATCH", unset);
1174 static int numbered_cmdline_opt = 0;
1176 static int numbered_callback(const struct option *opt, const char *arg,
1179 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
1185 static int no_numbered_callback(const struct option *opt, const char *arg,
1188 return numbered_callback(opt, arg, 1);
1191 static int output_directory_callback(const struct option *opt, const char *arg,
1194 const char **dir = (const char **)opt->value;
1196 die(_("Two output directories?"));
1201 static int thread_callback(const struct option *opt, const char *arg, int unset)
1203 int *thread = (int *)opt->value;
1206 else if (!arg || !strcmp(arg, "shallow"))
1207 *thread = THREAD_SHALLOW;
1208 else if (!strcmp(arg, "deep"))
1209 *thread = THREAD_DEEP;
1215 static int attach_callback(const struct option *opt, const char *arg, int unset)
1217 struct rev_info *rev = (struct rev_info *)opt->value;
1219 rev->mime_boundary = NULL;
1221 rev->mime_boundary = arg;
1223 rev->mime_boundary = git_version_string;
1224 rev->no_inline = unset ? 0 : 1;
1228 static int inline_callback(const struct option *opt, const char *arg, int unset)
1230 struct rev_info *rev = (struct rev_info *)opt->value;
1232 rev->mime_boundary = NULL;
1234 rev->mime_boundary = arg;
1236 rev->mime_boundary = git_version_string;
1241 static int header_callback(const struct option *opt, const char *arg, int unset)
1244 string_list_clear(&extra_hdr, 0);
1245 string_list_clear(&extra_to, 0);
1246 string_list_clear(&extra_cc, 0);
1253 static int to_callback(const struct option *opt, const char *arg, int unset)
1256 string_list_clear(&extra_to, 0);
1258 string_list_append(&extra_to, arg);
1262 static int cc_callback(const struct option *opt, const char *arg, int unset)
1265 string_list_clear(&extra_cc, 0);
1267 string_list_append(&extra_cc, arg);
1271 static int from_callback(const struct option *opt, const char *arg, int unset)
1273 char **from = opt->value;
1280 *from = xstrdup(arg);
1282 *from = xstrdup(git_committer_info(IDENT_NO_DATE));
1286 struct base_tree_info {
1287 struct object_id base_commit;
1288 int nr_patch_id, alloc_patch_id;
1289 struct object_id *patch_id;
1292 static struct commit *get_base_commit(const char *base_commit,
1293 struct commit **list,
1296 struct commit *base = NULL;
1297 struct commit **rev;
1298 int i = 0, rev_nr = 0;
1300 if (base_commit && strcmp(base_commit, "auto")) {
1301 base = lookup_commit_reference_by_name(base_commit);
1303 die(_("Unknown commit %s"), base_commit);
1304 } else if ((base_commit && !strcmp(base_commit, "auto")) || base_auto) {
1305 struct branch *curr_branch = branch_get(NULL);
1306 const char *upstream = branch_get_upstream(curr_branch, NULL);
1308 struct commit_list *base_list;
1309 struct commit *commit;
1310 struct object_id oid;
1312 if (get_oid(upstream, &oid))
1313 die(_("Failed to resolve '%s' as a valid ref."), upstream);
1314 commit = lookup_commit_or_die(&oid, "upstream base");
1315 base_list = get_merge_bases_many(commit, total, list);
1316 /* There should be one and only one merge base. */
1317 if (!base_list || base_list->next)
1318 die(_("Could not find exact merge base."));
1319 base = base_list->item;
1320 free_commit_list(base_list);
1322 die(_("Failed to get upstream, if you want to record base commit automatically,\n"
1323 "please use git branch --set-upstream-to to track a remote branch.\n"
1324 "Or you could specify base commit by --base=<base-commit-id> manually."));
1328 ALLOC_ARRAY(rev, total);
1329 for (i = 0; i < total; i++)
1334 * Get merge base through pair-wise computations
1335 * and store it in rev[0].
1337 while (rev_nr > 1) {
1338 for (i = 0; i < rev_nr / 2; i++) {
1339 struct commit_list *merge_base;
1340 merge_base = get_merge_bases(rev[2 * i], rev[2 * i + 1]);
1341 if (!merge_base || merge_base->next)
1342 die(_("Failed to find exact merge base"));
1344 rev[i] = merge_base->item;
1348 rev[i] = rev[2 * i];
1349 rev_nr = DIV_ROUND_UP(rev_nr, 2);
1352 if (!in_merge_bases(base, rev[0]))
1353 die(_("base commit should be the ancestor of revision list"));
1355 for (i = 0; i < total; i++) {
1356 if (base == list[i])
1357 die(_("base commit shouldn't be in revision list"));
1364 define_commit_slab(commit_base, int);
1366 static void prepare_bases(struct base_tree_info *bases,
1367 struct commit *base,
1368 struct commit **list,
1371 struct commit *commit;
1372 struct rev_info revs;
1373 struct diff_options diffopt;
1374 struct commit_base commit_base;
1380 init_commit_base(&commit_base);
1381 repo_diff_setup(the_repository, &diffopt);
1382 diffopt.flags.recursive = 1;
1383 diff_setup_done(&diffopt);
1385 oidcpy(&bases->base_commit, &base->object.oid);
1387 repo_init_revisions(the_repository, &revs, NULL);
1388 revs.max_parents = 1;
1389 revs.topo_order = 1;
1390 for (i = 0; i < total; i++) {
1391 list[i]->object.flags &= ~UNINTERESTING;
1392 add_pending_object(&revs, &list[i]->object, "rev_list");
1393 *commit_base_at(&commit_base, list[i]) = 1;
1395 base->object.flags |= UNINTERESTING;
1396 add_pending_object(&revs, &base->object, "base");
1398 if (prepare_revision_walk(&revs))
1399 die(_("revision walk setup failed"));
1401 * Traverse the commits list, get prerequisite patch ids
1402 * and stuff them in bases structure.
1404 while ((commit = get_revision(&revs)) != NULL) {
1405 struct object_id oid;
1406 struct object_id *patch_id;
1407 if (*commit_base_at(&commit_base, commit))
1409 if (commit_patch_id(commit, &diffopt, &oid, 0))
1410 die(_("cannot get patch id"));
1411 ALLOC_GROW(bases->patch_id, bases->nr_patch_id + 1, bases->alloc_patch_id);
1412 patch_id = bases->patch_id + bases->nr_patch_id;
1413 oidcpy(patch_id, &oid);
1414 bases->nr_patch_id++;
1416 clear_commit_base(&commit_base);
1419 static void print_bases(struct base_tree_info *bases, FILE *file)
1423 /* Only do this once, either for the cover or for the first one */
1424 if (is_null_oid(&bases->base_commit))
1427 /* Show the base commit */
1428 fprintf(file, "\nbase-commit: %s\n", oid_to_hex(&bases->base_commit));
1430 /* Show the prerequisite patches */
1431 for (i = bases->nr_patch_id - 1; i >= 0; i--)
1432 fprintf(file, "prerequisite-patch-id: %s\n", oid_to_hex(&bases->patch_id[i]));
1434 free(bases->patch_id);
1435 bases->nr_patch_id = 0;
1436 bases->alloc_patch_id = 0;
1437 oidclr(&bases->base_commit);
1440 static const char *diff_title(struct strbuf *sb, int reroll_count,
1441 const char *generic, const char *rerolled)
1443 if (reroll_count <= 0)
1444 strbuf_addstr(sb, generic);
1445 else /* RFC may be v0, so allow -v1 to diff against v0 */
1446 strbuf_addf(sb, rerolled, reroll_count - 1);
1450 static void infer_range_diff_ranges(struct strbuf *r1,
1453 struct commit *origin,
1454 struct commit *head)
1456 const char *head_oid = oid_to_hex(&head->object.oid);
1458 if (!strstr(prev, "..")) {
1459 strbuf_addf(r1, "%s..%s", head_oid, prev);
1460 strbuf_addf(r2, "%s..%s", prev, head_oid);
1461 } else if (!origin) {
1462 die(_("failed to infer range-diff ranges"));
1464 strbuf_addstr(r1, prev);
1465 strbuf_addf(r2, "%s..%s",
1466 oid_to_hex(&origin->object.oid), head_oid);
1470 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1472 struct commit *commit;
1473 struct commit **list = NULL;
1474 struct rev_info rev;
1475 struct setup_revision_opt s_r_opt;
1476 int nr = 0, total, i;
1478 int start_number = -1;
1479 int just_numbers = 0;
1480 int ignore_if_in_upstream = 0;
1481 int cover_letter = -1;
1482 int boundary_count = 0;
1483 int no_binary_diff = 0;
1484 int zero_commit = 0;
1485 struct commit *origin = NULL;
1486 const char *in_reply_to = NULL;
1487 struct patch_ids ids;
1488 struct strbuf buf = STRBUF_INIT;
1489 int use_patch_format = 0;
1491 int reroll_count = -1;
1492 char *branch_name = NULL;
1493 char *base_commit = NULL;
1494 struct base_tree_info bases;
1495 int show_progress = 0;
1496 struct progress *progress = NULL;
1497 struct oid_array idiff_prev = OID_ARRAY_INIT;
1498 struct strbuf idiff_title = STRBUF_INIT;
1499 const char *rdiff_prev = NULL;
1500 struct strbuf rdiff1 = STRBUF_INIT;
1501 struct strbuf rdiff2 = STRBUF_INIT;
1502 struct strbuf rdiff_title = STRBUF_INIT;
1503 int creation_factor = -1;
1505 const struct option builtin_format_patch_options[] = {
1506 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
1507 N_("use [PATCH n/m] even with a single patch"),
1508 PARSE_OPT_NOARG, numbered_callback },
1509 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
1510 N_("use [PATCH] even with multiple patches"),
1511 PARSE_OPT_NOARG, no_numbered_callback },
1512 OPT_BOOL('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
1513 OPT_BOOL(0, "stdout", &use_stdout,
1514 N_("print patches to standard out")),
1515 OPT_BOOL(0, "cover-letter", &cover_letter,
1516 N_("generate a cover letter")),
1517 OPT_BOOL(0, "numbered-files", &just_numbers,
1518 N_("use simple number sequence for output file names")),
1519 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1520 N_("use <sfx> instead of '.patch'")),
1521 OPT_INTEGER(0, "start-number", &start_number,
1522 N_("start numbering patches at <n> instead of 1")),
1523 OPT_INTEGER('v', "reroll-count", &reroll_count,
1524 N_("mark the series as Nth re-roll")),
1525 { OPTION_CALLBACK, 0, "rfc", &rev, NULL,
1526 N_("Use [RFC PATCH] instead of [PATCH]"),
1527 PARSE_OPT_NOARG | PARSE_OPT_NONEG, rfc_callback },
1528 { OPTION_CALLBACK, 0, "subject-prefix", &rev, N_("prefix"),
1529 N_("Use [<prefix>] instead of [PATCH]"),
1530 PARSE_OPT_NONEG, subject_prefix_callback },
1531 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
1532 N_("dir"), N_("store resulting files in <dir>"),
1533 PARSE_OPT_NONEG, output_directory_callback },
1534 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
1535 N_("don't strip/add [PATCH]"),
1536 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
1537 OPT_BOOL(0, "no-binary", &no_binary_diff,
1538 N_("don't output binary diffs")),
1539 OPT_BOOL(0, "zero-commit", &zero_commit,
1540 N_("output all-zero hash in From header")),
1541 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1542 N_("don't include a patch matching a commit upstream")),
1543 OPT_SET_INT_F('p', "no-stat", &use_patch_format,
1544 N_("show patch format instead of default (patch + stat)"),
1545 1, PARSE_OPT_NONEG),
1546 OPT_GROUP(N_("Messaging")),
1547 { OPTION_CALLBACK, 0, "add-header", NULL, N_("header"),
1548 N_("add email header"), 0, header_callback },
1549 { OPTION_CALLBACK, 0, "to", NULL, N_("email"), N_("add To: header"),
1551 { OPTION_CALLBACK, 0, "cc", NULL, N_("email"), N_("add Cc: header"),
1553 { OPTION_CALLBACK, 0, "from", &from, N_("ident"),
1554 N_("set From address to <ident> (or committer ident if absent)"),
1555 PARSE_OPT_OPTARG, from_callback },
1556 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1557 N_("make first mail a reply to <message-id>")),
1558 { OPTION_CALLBACK, 0, "attach", &rev, N_("boundary"),
1559 N_("attach the patch"), PARSE_OPT_OPTARG,
1561 { OPTION_CALLBACK, 0, "inline", &rev, N_("boundary"),
1562 N_("inline the patch"),
1563 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1565 { OPTION_CALLBACK, 0, "thread", &thread, N_("style"),
1566 N_("enable message threading, styles: shallow, deep"),
1567 PARSE_OPT_OPTARG, thread_callback },
1568 OPT_STRING(0, "signature", &signature, N_("signature"),
1569 N_("add a signature")),
1570 OPT_STRING(0, "base", &base_commit, N_("base-commit"),
1571 N_("add prerequisite tree info to the patch series")),
1572 OPT_FILENAME(0, "signature-file", &signature_file,
1573 N_("add a signature from a file")),
1574 OPT__QUIET(&quiet, N_("don't print the patch filenames")),
1575 OPT_BOOL(0, "progress", &show_progress,
1576 N_("show progress while generating patches")),
1577 OPT_CALLBACK(0, "interdiff", &idiff_prev, N_("rev"),
1578 N_("show changes against <rev> in cover letter or single patch"),
1579 parse_opt_object_name),
1580 OPT_STRING(0, "range-diff", &rdiff_prev, N_("refspec"),
1581 N_("show changes against <refspec> in cover letter or single patch")),
1582 OPT_INTEGER(0, "creation-factor", &creation_factor,
1583 N_("percentage by which creation is weighted")),
1587 extra_hdr.strdup_strings = 1;
1588 extra_to.strdup_strings = 1;
1589 extra_cc.strdup_strings = 1;
1590 init_log_defaults();
1591 git_config(git_format_config, NULL);
1592 repo_init_revisions(the_repository, &rev, prefix);
1593 rev.commit_format = CMIT_FMT_EMAIL;
1594 rev.expand_tabs_in_log_default = 0;
1595 rev.verbose_header = 1;
1597 rev.max_parents = 1;
1598 rev.diffopt.flags.recursive = 1;
1599 rev.subject_prefix = fmt_patch_subject_prefix;
1600 memset(&s_r_opt, 0, sizeof(s_r_opt));
1601 s_r_opt.def = "HEAD";
1602 s_r_opt.revarg_opt = REVARG_COMMITTISH;
1604 if (default_attach) {
1605 rev.mime_boundary = default_attach;
1610 * Parse the arguments before setup_revisions(), or something
1611 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1612 * possibly a valid SHA1.
1614 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1615 builtin_format_patch_usage,
1616 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1617 PARSE_OPT_KEEP_DASHDASH);
1619 if (0 < reroll_count) {
1620 struct strbuf sprefix = STRBUF_INIT;
1621 strbuf_addf(&sprefix, "%s v%d",
1622 rev.subject_prefix, reroll_count);
1623 rev.reroll_count = reroll_count;
1624 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1627 for (i = 0; i < extra_hdr.nr; i++) {
1628 strbuf_addstr(&buf, extra_hdr.items[i].string);
1629 strbuf_addch(&buf, '\n');
1633 strbuf_addstr(&buf, "To: ");
1634 for (i = 0; i < extra_to.nr; i++) {
1636 strbuf_addstr(&buf, " ");
1637 strbuf_addstr(&buf, extra_to.items[i].string);
1638 if (i + 1 < extra_to.nr)
1639 strbuf_addch(&buf, ',');
1640 strbuf_addch(&buf, '\n');
1644 strbuf_addstr(&buf, "Cc: ");
1645 for (i = 0; i < extra_cc.nr; i++) {
1647 strbuf_addstr(&buf, " ");
1648 strbuf_addstr(&buf, extra_cc.items[i].string);
1649 if (i + 1 < extra_cc.nr)
1650 strbuf_addch(&buf, ',');
1651 strbuf_addch(&buf, '\n');
1654 rev.extra_headers = strbuf_detach(&buf, NULL);
1657 if (split_ident_line(&rev.from_ident, from, strlen(from)))
1658 die(_("invalid ident line: %s"), from);
1661 if (start_number < 0)
1665 * If numbered is set solely due to format.numbered in config,
1666 * and it would conflict with --keep-subject (-k) from the
1667 * command line, reset "numbered".
1669 if (numbered && keep_subject && !numbered_cmdline_opt)
1672 if (numbered && keep_subject)
1673 die(_("-n and -k are mutually exclusive"));
1674 if (keep_subject && subject_prefix)
1675 die(_("--subject-prefix/--rfc and -k are mutually exclusive"));
1676 rev.preserve_subject = keep_subject;
1678 argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1680 die(_("unrecognized argument: %s"), argv[1]);
1682 if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1683 die(_("--name-only does not make sense"));
1684 if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1685 die(_("--name-status does not make sense"));
1686 if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1687 die(_("--check does not make sense"));
1689 if (!use_patch_format &&
1690 (!rev.diffopt.output_format ||
1691 rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1692 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1693 if (!rev.diffopt.stat_width)
1694 rev.diffopt.stat_width = MAIL_DEFAULT_WRAP;
1696 /* Always generate a patch */
1697 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1699 rev.zero_commit = zero_commit;
1701 if (!rev.diffopt.flags.text && !no_binary_diff)
1702 rev.diffopt.flags.binary = 1;
1705 init_display_notes(&rev.notes_opt);
1707 if (!output_directory && !use_stdout)
1708 output_directory = config_output_directory;
1711 output_directory = set_outdir(prefix, output_directory);
1715 if (output_directory) {
1716 if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
1717 rev.diffopt.use_color = GIT_COLOR_NEVER;
1719 die(_("standard output, or directory, which one?"));
1720 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1721 die_errno(_("Could not create directory '%s'"),
1725 if (rev.pending.nr == 1) {
1728 if (rev.max_count < 0 && !rev.show_root_diff) {
1730 * This is traditional behaviour of "git format-patch
1731 * origin" that prepares what the origin side still
1734 rev.pending.objects[0].item->flags |= UNINTERESTING;
1735 add_head_to_pending(&rev);
1739 * Otherwise, it is "format-patch -22 HEAD", and/or
1740 * "format-patch --root HEAD". The user wants
1741 * get_revision() to do the usual traversal.
1744 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
1748 const char *ref, *v;
1749 ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
1751 if (ref && skip_prefix(ref, "refs/heads/", &v))
1752 branch_name = xstrdup(v);
1754 branch_name = xstrdup(""); /* no branch */
1759 * We cannot move this anywhere earlier because we do want to
1760 * know if --root was given explicitly from the command line.
1762 rev.show_root_diff = 1;
1764 if (ignore_if_in_upstream) {
1765 /* Don't say anything if head and upstream are the same. */
1766 if (rev.pending.nr == 2) {
1767 struct object_array_entry *o = rev.pending.objects;
1768 if (oideq(&o[0].item->oid, &o[1].item->oid))
1771 get_patch_ids(&rev, &ids);
1774 if (prepare_revision_walk(&rev))
1775 die(_("revision walk setup failed"));
1777 while ((commit = get_revision(&rev)) != NULL) {
1778 if (commit->object.flags & BOUNDARY) {
1780 origin = (boundary_count == 1) ? commit : NULL;
1784 if (ignore_if_in_upstream && has_commit_patch_id(commit, &ids))
1788 REALLOC_ARRAY(list, nr);
1789 list[nr - 1] = commit;
1795 if (cover_letter == -1) {
1796 if (config_cover_letter == COVER_AUTO)
1797 cover_letter = (total > 1);
1799 cover_letter = (config_cover_letter == COVER_ON);
1801 if (!keep_subject && auto_number && (total > 1 || cover_letter))
1804 rev.total = total + start_number - 1;
1806 if (idiff_prev.nr) {
1807 if (!cover_letter && total != 1)
1808 die(_("--interdiff requires --cover-letter or single patch"));
1809 rev.idiff_oid1 = &idiff_prev.oid[idiff_prev.nr - 1];
1810 rev.idiff_oid2 = get_commit_tree_oid(list[0]);
1811 rev.idiff_title = diff_title(&idiff_title, reroll_count,
1813 _("Interdiff against v%d:"));
1816 if (creation_factor < 0)
1817 creation_factor = RANGE_DIFF_CREATION_FACTOR_DEFAULT;
1818 else if (!rdiff_prev)
1819 die(_("--creation-factor requires --range-diff"));
1822 if (!cover_letter && total != 1)
1823 die(_("--range-diff requires --cover-letter or single patch"));
1825 infer_range_diff_ranges(&rdiff1, &rdiff2, rdiff_prev,
1827 rev.rdiff1 = rdiff1.buf;
1828 rev.rdiff2 = rdiff2.buf;
1829 rev.creation_factor = creation_factor;
1830 rev.rdiff_title = diff_title(&rdiff_title, reroll_count,
1832 _("Range-diff against v%d:"));
1836 ; /* --no-signature inhibits all signatures */
1837 } else if (signature && signature != git_version_string) {
1838 ; /* non-default signature already set */
1839 } else if (signature_file) {
1840 struct strbuf buf = STRBUF_INIT;
1842 if (strbuf_read_file(&buf, signature_file, 128) < 0)
1843 die_errno(_("unable to read signature file '%s'"), signature_file);
1844 signature = strbuf_detach(&buf, NULL);
1847 memset(&bases, 0, sizeof(bases));
1848 if (base_commit || base_auto) {
1849 struct commit *base = get_base_commit(base_commit, list, nr);
1850 reset_revision_walk();
1851 clear_object_flags(UNINTERESTING);
1852 prepare_bases(&bases, base, list, nr);
1855 if (in_reply_to || thread || cover_letter)
1856 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1858 const char *msgid = clean_message_id(in_reply_to);
1859 string_list_append(rev.ref_message_ids, msgid);
1861 rev.numbered_files = just_numbers;
1862 rev.patch_suffix = fmt_patch_suffix;
1865 gen_message_id(&rev, "cover");
1866 make_cover_letter(&rev, use_stdout,
1867 origin, nr, list, branch_name, quiet);
1868 print_bases(&bases, rev.diffopt.file);
1869 print_signature(rev.diffopt.file);
1872 /* interdiff/range-diff in cover-letter; omit from patches */
1873 rev.idiff_oid1 = NULL;
1876 rev.add_signoff = do_signoff;
1879 progress = start_delayed_progress(_("Generating patches"), total);
1882 display_progress(progress, total - nr);
1884 rev.nr = total - nr + (start_number - 1);
1885 /* Make the second and subsequent mails replies to the first */
1887 /* Have we already had a message ID? */
1888 if (rev.message_id) {
1890 * For deep threading: make every mail
1891 * a reply to the previous one, no
1892 * matter what other options are set.
1894 * For shallow threading:
1896 * Without --cover-letter and
1897 * --in-reply-to, make every mail a
1898 * reply to the one before.
1900 * With --in-reply-to but no
1901 * --cover-letter, make every mail a
1902 * reply to the <reply-to>.
1904 * With --cover-letter, make every
1905 * mail but the cover letter a reply
1906 * to the cover letter. The cover
1907 * letter is a reply to the
1908 * --in-reply-to, if specified.
1910 if (thread == THREAD_SHALLOW
1911 && rev.ref_message_ids->nr > 0
1912 && (!cover_letter || rev.nr > 1))
1913 free(rev.message_id);
1915 string_list_append(rev.ref_message_ids,
1918 gen_message_id(&rev, oid_to_hex(&commit->object.oid));
1922 open_next_file(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
1923 die(_("Failed to create output files"));
1924 shown = log_tree_commit(&rev, commit);
1925 free_commit_buffer(commit);
1927 /* We put one extra blank line between formatted
1928 * patches and this flag is used by log-tree code
1929 * to see if it needs to emit a LF before showing
1930 * the log; when using one file per patch, we do
1931 * not want the extra blank line.
1936 print_bases(&bases, rev.diffopt.file);
1937 if (rev.mime_boundary)
1938 fprintf(rev.diffopt.file, "\n--%s%s--\n\n\n",
1939 mime_boundary_leader,
1942 print_signature(rev.diffopt.file);
1945 fclose(rev.diffopt.file);
1947 stop_progress(&progress);
1950 string_list_clear(&extra_to, 0);
1951 string_list_clear(&extra_cc, 0);
1952 string_list_clear(&extra_hdr, 0);
1953 if (ignore_if_in_upstream)
1954 free_patch_ids(&ids);
1957 oid_array_clear(&idiff_prev);
1958 strbuf_release(&idiff_title);
1959 strbuf_release(&rdiff1);
1960 strbuf_release(&rdiff2);
1961 strbuf_release(&rdiff_title);
1965 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1967 struct object_id oid;
1968 if (get_oid(arg, &oid) == 0) {
1969 struct commit *commit = lookup_commit_reference(the_repository,
1972 commit->object.flags |= flags;
1973 add_pending_object(revs, &commit->object, arg);
1980 static const char * const cherry_usage[] = {
1981 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1985 static void print_commit(char sign, struct commit *commit, int verbose,
1986 int abbrev, FILE *file)
1989 fprintf(file, "%c %s\n", sign,
1990 find_unique_abbrev(&commit->object.oid, abbrev));
1992 struct strbuf buf = STRBUF_INIT;
1993 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
1994 fprintf(file, "%c %s %s\n", sign,
1995 find_unique_abbrev(&commit->object.oid, abbrev),
1997 strbuf_release(&buf);
2001 int cmd_cherry(int argc, const char **argv, const char *prefix)
2003 struct rev_info revs;
2004 struct patch_ids ids;
2005 struct commit *commit;
2006 struct commit_list *list = NULL;
2007 struct branch *current_branch;
2008 const char *upstream;
2009 const char *head = "HEAD";
2010 const char *limit = NULL;
2011 int verbose = 0, abbrev = 0;
2013 struct option options[] = {
2014 OPT__ABBREV(&abbrev),
2015 OPT__VERBOSE(&verbose, N_("be verbose")),
2019 argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
2032 current_branch = branch_get(NULL);
2033 upstream = branch_get_upstream(current_branch, NULL);
2035 fprintf(stderr, _("Could not find a tracked"
2036 " remote branch, please"
2037 " specify <upstream> manually.\n"));
2038 usage_with_options(cherry_usage, options);
2042 repo_init_revisions(the_repository, &revs, prefix);
2043 revs.max_parents = 1;
2045 if (add_pending_commit(head, &revs, 0))
2046 die(_("Unknown commit %s"), head);
2047 if (add_pending_commit(upstream, &revs, UNINTERESTING))
2048 die(_("Unknown commit %s"), upstream);
2050 /* Don't say anything if head and upstream are the same. */
2051 if (revs.pending.nr == 2) {
2052 struct object_array_entry *o = revs.pending.objects;
2053 if (oideq(&o[0].item->oid, &o[1].item->oid))
2057 get_patch_ids(&revs, &ids);
2059 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
2060 die(_("Unknown commit %s"), limit);
2062 /* reverse the list of commits */
2063 if (prepare_revision_walk(&revs))
2064 die(_("revision walk setup failed"));
2065 while ((commit = get_revision(&revs)) != NULL) {
2066 commit_list_insert(commit, &list);
2072 commit = list->item;
2073 if (has_commit_patch_id(commit, &ids))
2075 print_commit(sign, commit, verbose, abbrev, revs.diffopt.file);
2079 free_patch_ids(&ids);