2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
7 #define USE_THE_INDEX_COMPATIBILITY_MACROS
11 #include "object-store.h"
15 #include "diff-merges.h"
20 #include "reflog-walk.h"
21 #include "patch-ids.h"
22 #include "run-command.h"
25 #include "string-list.h"
26 #include "parse-options.h"
29 #include "streaming.h"
32 #include "gpg-interface.h"
34 #include "commit-slab.h"
35 #include "repository.h"
36 #include "commit-reach.h"
37 #include "range-diff.h"
39 #define MAIL_DEFAULT_WRAP 72
40 #define COVER_FROM_AUTO_MAX_SUBJECT_LEN 100
41 #define FORMAT_PATCH_NAME_MAX_DEFAULT 64
43 /* Set a default date-time format for git log ("log.date" config variable) */
44 static const char *default_date_mode = NULL;
46 static int default_abbrev_commit;
47 static int default_show_root = 1;
48 static int default_follow;
49 static int default_show_signature;
50 static int default_encode_email_headers = 1;
51 static int decoration_style;
52 static int decoration_given;
53 static int use_mailmap_config = 1;
54 static const char *fmt_patch_subject_prefix = "PATCH";
55 static int fmt_patch_name_max = FORMAT_PATCH_NAME_MAX_DEFAULT;
56 static const char *fmt_pretty;
58 static const char * const builtin_log_usage[] = {
59 N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
60 N_("git show [<options>] <object>..."),
64 struct line_opt_callback_data {
67 struct string_list args;
70 static int session_is_interactive(void)
72 return isatty(1) || pager_in_use();
75 static int auto_decoration_style(void)
77 return session_is_interactive() ? DECORATE_SHORT_REFS : 0;
80 static int parse_decoration_style(const char *value)
82 switch (git_parse_maybe_bool(value)) {
84 return DECORATE_SHORT_REFS;
90 if (!strcmp(value, "full"))
91 return DECORATE_FULL_REFS;
92 else if (!strcmp(value, "short"))
93 return DECORATE_SHORT_REFS;
94 else if (!strcmp(value, "auto"))
95 return auto_decoration_style();
97 * Please update _git_log() in git-completion.bash when you
98 * add new decoration styles.
103 static int decorate_callback(const struct option *opt, const char *arg, int unset)
106 decoration_style = 0;
108 decoration_style = parse_decoration_style(arg);
110 decoration_style = DECORATE_SHORT_REFS;
112 if (decoration_style < 0)
113 die(_("invalid --decorate option: %s"), arg);
115 decoration_given = 1;
120 static int log_line_range_callback(const struct option *option, const char *arg, int unset)
122 struct line_opt_callback_data *data = option->value;
124 BUG_ON_OPT_NEG(unset);
129 data->rev->line_level_traverse = 1;
130 string_list_append(&data->args, arg);
135 static void init_log_defaults(void)
137 init_diff_ui_defaults();
139 decoration_style = auto_decoration_style();
142 static void cmd_log_init_defaults(struct rev_info *rev)
145 get_commit_format(fmt_pretty, rev);
147 rev->diffopt.flags.default_follow_renames = 1;
148 rev->verbose_header = 1;
149 rev->diffopt.flags.recursive = 1;
150 rev->diffopt.stat_width = -1; /* use full terminal width */
151 rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
152 rev->abbrev_commit = default_abbrev_commit;
153 rev->show_root_diff = default_show_root;
154 rev->subject_prefix = fmt_patch_subject_prefix;
155 rev->patch_name_max = fmt_patch_name_max;
156 rev->show_signature = default_show_signature;
157 rev->encode_email_headers = default_encode_email_headers;
158 rev->diffopt.flags.allow_textconv = 1;
160 if (default_date_mode)
161 parse_date_format(default_date_mode, &rev->date_mode);
164 static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
165 struct rev_info *rev, struct setup_revision_opt *opt)
167 struct userformat_want w;
168 int quiet = 0, source = 0, mailmap;
169 static struct line_opt_callback_data line_cb = {NULL, NULL, STRING_LIST_INIT_DUP};
170 static struct string_list decorate_refs_exclude = STRING_LIST_INIT_NODUP;
171 static struct string_list decorate_refs_exclude_config = STRING_LIST_INIT_NODUP;
172 static struct string_list decorate_refs_include = STRING_LIST_INIT_NODUP;
173 struct decoration_filter decoration_filter = {&decorate_refs_include,
174 &decorate_refs_exclude,
175 &decorate_refs_exclude_config};
176 static struct revision_sources revision_sources;
178 const struct option builtin_log_options[] = {
179 OPT__QUIET(&quiet, N_("suppress diff output")),
180 OPT_BOOL(0, "source", &source, N_("show source")),
181 OPT_BOOL(0, "use-mailmap", &mailmap, N_("use mail map file")),
182 OPT_ALIAS(0, "mailmap", "use-mailmap"),
183 OPT_STRING_LIST(0, "decorate-refs", &decorate_refs_include,
184 N_("pattern"), N_("only decorate refs that match <pattern>")),
185 OPT_STRING_LIST(0, "decorate-refs-exclude", &decorate_refs_exclude,
186 N_("pattern"), N_("do not decorate refs that match <pattern>")),
187 OPT_CALLBACK_F(0, "decorate", NULL, NULL, N_("decorate options"),
188 PARSE_OPT_OPTARG, decorate_callback),
189 OPT_CALLBACK('L', NULL, &line_cb, "range:file",
190 N_("trace the evolution of line range <start>,<end> or function :<funcname> in <file>"),
191 log_line_range_callback),
196 line_cb.prefix = prefix;
198 mailmap = use_mailmap_config;
199 argc = parse_options(argc, argv, prefix,
200 builtin_log_options, builtin_log_usage,
201 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
202 PARSE_OPT_KEEP_DASHDASH);
205 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
206 argc = setup_revisions(argc, argv, rev, opt);
208 /* Any arguments at this point are not recognized */
210 die(_("unrecognized argument: %s"), argv[1]);
212 if (rev->line_level_traverse && rev->prune_data.nr)
213 die(_("-L<range>:<file> cannot be used with pathspec"));
215 memset(&w, 0, sizeof(w));
216 userformat_find_requirements(NULL, &w);
218 if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
221 load_display_notes(&rev->notes_opt);
223 if ((rev->diffopt.pickaxe_opts & DIFF_PICKAXE_KINDS_MASK) ||
224 rev->diffopt.filter || rev->diffopt.flags.follow_renames)
225 rev->always_show_header = 0;
227 if (source || w.source) {
228 init_revision_sources(&revision_sources);
229 rev->sources = &revision_sources;
233 rev->mailmap = xcalloc(1, sizeof(struct string_list));
234 read_mailmap(rev->mailmap);
237 if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
239 * "log --pretty=raw" is special; ignore UI oriented
240 * configuration variables such as decoration.
242 if (!decoration_given)
243 decoration_style = 0;
244 if (!rev->abbrev_commit_given)
245 rev->abbrev_commit = 0;
248 if (decoration_style) {
249 const struct string_list *config_exclude =
250 repo_config_get_value_multi(the_repository,
251 "log.excludeDecoration");
253 if (config_exclude) {
254 struct string_list_item *item;
255 for_each_string_list_item(item, config_exclude)
256 string_list_append(&decorate_refs_exclude_config,
260 rev->show_decorations = 1;
262 load_ref_decorations(&decoration_filter, decoration_style);
265 if (rev->line_level_traverse)
266 line_log_init(rev, line_cb.prefix, &line_cb.args);
271 static void cmd_log_init(int argc, const char **argv, const char *prefix,
272 struct rev_info *rev, struct setup_revision_opt *opt)
274 cmd_log_init_defaults(rev);
275 cmd_log_init_finish(argc, argv, prefix, rev, opt);
279 * This gives a rough estimate for how many commits we
280 * will print out in the list.
282 static int estimate_commit_count(struct commit_list *list)
287 struct commit *commit = list->item;
288 unsigned int flags = commit->object.flags;
290 if (!(flags & (TREESAME | UNINTERESTING)))
296 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
298 if (rev->shown_one) {
300 if (rev->commit_format != CMIT_FMT_ONELINE)
301 putchar(rev->diffopt.line_termination);
303 fprintf(rev->diffopt.file, _("Final output: %d %s\n"), nr, stage);
306 static struct itimerval early_output_timer;
308 static void log_show_early(struct rev_info *revs, struct commit_list *list)
310 int i = revs->early_output, close_file = revs->diffopt.close_file;
313 revs->diffopt.close_file = 0;
314 sort_in_topological_order(&list, revs->sort_order);
316 struct commit *commit = list->item;
317 switch (simplify_commit(revs, commit)) {
320 int n = estimate_commit_count(list);
321 show_early_header(revs, "incomplete", n);
324 log_tree_commit(revs, commit);
331 fclose(revs->diffopt.file);
337 /* Did we already get enough commits for the early output? */
340 fclose(revs->diffopt.file);
345 * ..if no, then repeat it twice a second until we
348 * NOTE! We don't use "it_interval", because if the
349 * reader isn't listening, we want our output to be
350 * throttled by the writing, and not have the timer
351 * trigger every second even if we're blocked on a
354 early_output_timer.it_value.tv_sec = 0;
355 early_output_timer.it_value.tv_usec = 500000;
356 setitimer(ITIMER_REAL, &early_output_timer, NULL);
359 static void early_output(int signal)
361 show_early_output = log_show_early;
364 static void setup_early_output(void)
369 * Set up the signal handler, minimally intrusively:
370 * we only set a single volatile integer word (not
371 * using sigatomic_t - trying to avoid unnecessary
372 * system dependencies and headers), and using
375 memset(&sa, 0, sizeof(sa));
376 sa.sa_handler = early_output;
377 sigemptyset(&sa.sa_mask);
378 sa.sa_flags = SA_RESTART;
379 sigaction(SIGALRM, &sa, NULL);
382 * If we can get the whole output in less than a
383 * tenth of a second, don't even bother doing the
384 * early-output thing..
386 * This is a one-time-only trigger.
388 early_output_timer.it_value.tv_sec = 0;
389 early_output_timer.it_value.tv_usec = 100000;
390 setitimer(ITIMER_REAL, &early_output_timer, NULL);
393 static void finish_early_output(struct rev_info *rev)
395 int n = estimate_commit_count(rev->commits);
396 signal(SIGALRM, SIG_IGN);
397 show_early_header(rev, "done", n);
400 static int cmd_log_walk(struct rev_info *rev)
402 struct commit *commit;
404 int saved_dcctc = 0, close_file = rev->diffopt.close_file;
406 if (rev->early_output)
407 setup_early_output();
409 if (prepare_revision_walk(rev))
410 die(_("revision walk setup failed"));
412 if (rev->early_output)
413 finish_early_output(rev);
416 * For --check and --exit-code, the exit code is based on CHECK_FAILED
417 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
418 * retain that state information if replacing rev->diffopt in this loop
420 rev->diffopt.close_file = 0;
421 while ((commit = get_revision(rev)) != NULL) {
422 if (!log_tree_commit(rev, commit) && rev->max_count >= 0)
424 * We decremented max_count in get_revision,
425 * but we didn't actually show the commit.
428 if (!rev->reflog_info) {
430 * We may show a given commit multiple times when
431 * walking the reflogs.
433 free_commit_buffer(the_repository->parsed_objects,
435 free_commit_list(commit->parents);
436 commit->parents = NULL;
438 if (saved_nrl < rev->diffopt.needed_rename_limit)
439 saved_nrl = rev->diffopt.needed_rename_limit;
440 if (rev->diffopt.degraded_cc_to_c)
443 rev->diffopt.degraded_cc_to_c = saved_dcctc;
444 rev->diffopt.needed_rename_limit = saved_nrl;
446 fclose(rev->diffopt.file);
448 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
449 rev->diffopt.flags.check_failed) {
452 return diff_result_code(&rev->diffopt, 0);
455 static int git_log_config(const char *var, const char *value, void *cb)
457 const char *slot_name;
459 if (!strcmp(var, "format.pretty"))
460 return git_config_string(&fmt_pretty, var, value);
461 if (!strcmp(var, "format.subjectprefix"))
462 return git_config_string(&fmt_patch_subject_prefix, var, value);
463 if (!strcmp(var, "format.filenamemaxlength")) {
464 fmt_patch_name_max = git_config_int(var, value);
467 if (!strcmp(var, "format.encodeemailheaders")) {
468 default_encode_email_headers = git_config_bool(var, value);
471 if (!strcmp(var, "log.abbrevcommit")) {
472 default_abbrev_commit = git_config_bool(var, value);
475 if (!strcmp(var, "log.date"))
476 return git_config_string(&default_date_mode, var, value);
477 if (!strcmp(var, "log.decorate")) {
478 decoration_style = parse_decoration_style(value);
479 if (decoration_style < 0)
480 decoration_style = 0; /* maybe warn? */
483 if (!strcmp(var, "log.showroot")) {
484 default_show_root = git_config_bool(var, value);
487 if (!strcmp(var, "log.follow")) {
488 default_follow = git_config_bool(var, value);
491 if (skip_prefix(var, "color.decorate.", &slot_name))
492 return parse_decorate_color_config(var, slot_name, value);
493 if (!strcmp(var, "log.mailmap")) {
494 use_mailmap_config = git_config_bool(var, value);
497 if (!strcmp(var, "log.showsignature")) {
498 default_show_signature = git_config_bool(var, value);
502 if (grep_config(var, value, cb) < 0)
504 if (git_gpg_config(var, value, cb) < 0)
506 return git_diff_ui_config(var, value, cb);
509 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
512 struct setup_revision_opt opt;
515 git_config(git_log_config, NULL);
517 repo_init_revisions(the_repository, &rev, prefix);
519 rev.simplify_history = 0;
520 memset(&opt, 0, sizeof(opt));
522 opt.revarg_opt = REVARG_COMMITTISH;
523 cmd_log_init(argc, argv, prefix, &rev, &opt);
524 if (!rev.diffopt.output_format)
525 rev.diffopt.output_format = DIFF_FORMAT_RAW;
526 return cmd_log_walk(&rev);
529 static void show_tagger(const char *buf, struct rev_info *rev)
531 struct strbuf out = STRBUF_INIT;
532 struct pretty_print_context pp = {0};
534 pp.fmt = rev->commit_format;
535 pp.date_mode = rev->date_mode;
536 pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
537 fprintf(rev->diffopt.file, "%s", out.buf);
538 strbuf_release(&out);
541 static int show_blob_object(const struct object_id *oid, struct rev_info *rev, const char *obj_name)
543 struct object_id oidc;
544 struct object_context obj_context;
548 fflush(rev->diffopt.file);
549 if (!rev->diffopt.flags.textconv_set_via_cmdline ||
550 !rev->diffopt.flags.allow_textconv)
551 return stream_blob_to_fd(1, oid, NULL, 0);
553 if (get_oid_with_context(the_repository, obj_name,
555 &oidc, &obj_context))
556 die(_("not a valid object name %s"), obj_name);
557 if (!obj_context.path ||
558 !textconv_object(the_repository, obj_context.path,
559 obj_context.mode, &oidc, 1, &buf, &size)) {
560 free(obj_context.path);
561 return stream_blob_to_fd(1, oid, NULL, 0);
565 die(_("git show %s: bad file"), obj_name);
567 write_or_die(1, buf, size);
568 free(obj_context.path);
572 static int show_tag_object(const struct object_id *oid, struct rev_info *rev)
575 enum object_type type;
576 char *buf = read_object_file(oid, &type, &size);
580 return error(_("could not read object %s"), oid_to_hex(oid));
582 assert(type == OBJ_TAG);
583 while (offset < size && buf[offset] != '\n') {
584 int new_offset = offset + 1;
586 while (new_offset < size && buf[new_offset++] != '\n')
588 if (skip_prefix(buf + offset, "tagger ", &ident))
589 show_tagger(ident, rev);
594 fwrite(buf + offset, size - offset, 1, rev->diffopt.file);
599 static int show_tree_object(const struct object_id *oid,
601 const char *pathname, unsigned mode, int stage, void *context)
603 FILE *file = context;
604 fprintf(file, "%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
608 static void show_setup_revisions_tweak(struct rev_info *rev,
609 struct setup_revision_opt *opt)
611 if (rev->first_parent_only)
612 diff_merges_default_to_first_parent(rev);
614 diff_merges_default_to_dense_combined(rev);
615 if (!rev->diffopt.output_format)
616 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
619 int cmd_show(int argc, const char **argv, const char *prefix)
622 struct object_array_entry *objects;
623 struct setup_revision_opt opt;
624 struct pathspec match_all;
625 int i, count, ret = 0;
628 git_config(git_log_config, NULL);
630 memset(&match_all, 0, sizeof(match_all));
631 repo_init_revisions(the_repository, &rev, prefix);
633 rev.always_show_header = 1;
634 rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
635 rev.diffopt.stat_width = -1; /* Scale to real terminal size */
637 memset(&opt, 0, sizeof(opt));
639 opt.tweak = show_setup_revisions_tweak;
640 cmd_log_init(argc, argv, prefix, &rev, &opt);
643 return cmd_log_walk(&rev);
645 count = rev.pending.nr;
646 objects = rev.pending.objects;
647 for (i = 0; i < count && !ret; i++) {
648 struct object *o = objects[i].item;
649 const char *name = objects[i].name;
652 ret = show_blob_object(&o->oid, &rev, name);
655 struct tag *t = (struct tag *)o;
656 struct object_id *oid = get_tagged_oid(t);
660 fprintf(rev.diffopt.file, "%stag %s%s\n",
661 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
663 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
664 ret = show_tag_object(&o->oid, &rev);
668 o = parse_object(the_repository, oid);
670 ret = error(_("could not read object %s"),
679 fprintf(rev.diffopt.file, "%stree %s%s\n\n",
680 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
682 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
683 read_tree_recursive(the_repository, (struct tree *)o, "",
684 0, 0, &match_all, show_tree_object,
689 rev.pending.nr = rev.pending.alloc = 0;
690 rev.pending.objects = NULL;
691 add_object_array(o, name, &rev.pending);
692 ret = cmd_log_walk(&rev);
695 ret = error(_("unknown type: %d"), o->type);
703 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
705 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
708 struct setup_revision_opt opt;
711 git_config(git_log_config, NULL);
713 repo_init_revisions(the_repository, &rev, prefix);
714 init_reflog_walk(&rev.reflog_info);
715 rev.verbose_header = 1;
716 memset(&opt, 0, sizeof(opt));
718 cmd_log_init_defaults(&rev);
719 rev.abbrev_commit = 1;
720 rev.commit_format = CMIT_FMT_ONELINE;
721 rev.use_terminator = 1;
722 rev.always_show_header = 1;
723 cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
725 return cmd_log_walk(&rev);
728 static void log_setup_revisions_tweak(struct rev_info *rev,
729 struct setup_revision_opt *opt)
731 if (rev->diffopt.flags.default_follow_renames &&
732 rev->prune_data.nr == 1)
733 rev->diffopt.flags.follow_renames = 1;
735 if (rev->first_parent_only)
736 diff_merges_default_to_first_parent(rev);
739 int cmd_log(int argc, const char **argv, const char *prefix)
742 struct setup_revision_opt opt;
745 git_config(git_log_config, NULL);
747 repo_init_revisions(the_repository, &rev, prefix);
748 rev.always_show_header = 1;
749 memset(&opt, 0, sizeof(opt));
751 opt.revarg_opt = REVARG_COMMITTISH;
752 opt.tweak = log_setup_revisions_tweak;
753 cmd_log_init(argc, argv, prefix, &rev, &opt);
754 return cmd_log_walk(&rev);
759 static const char *fmt_patch_suffix = ".patch";
760 static int numbered = 0;
761 static int auto_number = 1;
763 static char *default_attach = NULL;
765 static struct string_list extra_hdr = STRING_LIST_INIT_NODUP;
766 static struct string_list extra_to = STRING_LIST_INIT_NODUP;
767 static struct string_list extra_cc = STRING_LIST_INIT_NODUP;
769 static void add_header(const char *value)
771 struct string_list_item *item;
772 int len = strlen(value);
773 while (len && value[len - 1] == '\n')
776 if (!strncasecmp(value, "to: ", 4)) {
777 item = string_list_append(&extra_to, value + 4);
779 } else if (!strncasecmp(value, "cc: ", 4)) {
780 item = string_list_append(&extra_cc, value + 4);
783 item = string_list_append(&extra_hdr, value);
786 item->string[len] = '\0';
802 enum cover_from_description {
809 enum auto_base_setting {
815 static enum thread_level thread;
816 static int do_signoff;
817 static enum auto_base_setting auto_base;
819 static const char *signature = git_version_string;
820 static const char *signature_file;
821 static enum cover_setting config_cover_letter;
822 static const char *config_output_directory;
823 static enum cover_from_description cover_from_description_mode = COVER_FROM_MESSAGE;
824 static int show_notes;
825 static struct display_notes_opt notes_opt;
827 static enum cover_from_description parse_cover_from_description(const char *arg)
829 if (!arg || !strcmp(arg, "default"))
830 return COVER_FROM_MESSAGE;
831 else if (!strcmp(arg, "none"))
832 return COVER_FROM_NONE;
833 else if (!strcmp(arg, "message"))
834 return COVER_FROM_MESSAGE;
835 else if (!strcmp(arg, "subject"))
836 return COVER_FROM_SUBJECT;
837 else if (!strcmp(arg, "auto"))
838 return COVER_FROM_AUTO;
840 die(_("%s: invalid cover from description mode"), arg);
843 static int git_format_config(const char *var, const char *value, void *cb)
845 if (!strcmp(var, "format.headers")) {
847 die(_("format.headers without value"));
851 if (!strcmp(var, "format.suffix"))
852 return git_config_string(&fmt_patch_suffix, var, value);
853 if (!strcmp(var, "format.to")) {
855 return config_error_nonbool(var);
856 string_list_append(&extra_to, value);
859 if (!strcmp(var, "format.cc")) {
861 return config_error_nonbool(var);
862 string_list_append(&extra_cc, value);
865 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
866 !strcmp(var, "color.ui") || !strcmp(var, "diff.submodule")) {
869 if (!strcmp(var, "format.numbered")) {
870 if (value && !strcasecmp(value, "auto")) {
874 numbered = git_config_bool(var, value);
875 auto_number = auto_number && numbered;
878 if (!strcmp(var, "format.attach")) {
880 default_attach = xstrdup(value);
882 default_attach = xstrdup(git_version_string);
885 if (!strcmp(var, "format.thread")) {
886 if (value && !strcasecmp(value, "deep")) {
887 thread = THREAD_DEEP;
890 if (value && !strcasecmp(value, "shallow")) {
891 thread = THREAD_SHALLOW;
894 thread = git_config_bool(var, value) ? THREAD_SHALLOW : THREAD_UNSET;
897 if (!strcmp(var, "format.signoff")) {
898 do_signoff = git_config_bool(var, value);
901 if (!strcmp(var, "format.signature"))
902 return git_config_string(&signature, var, value);
903 if (!strcmp(var, "format.signaturefile"))
904 return git_config_pathname(&signature_file, var, value);
905 if (!strcmp(var, "format.coverletter")) {
906 if (value && !strcasecmp(value, "auto")) {
907 config_cover_letter = COVER_AUTO;
910 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
913 if (!strcmp(var, "format.outputdirectory"))
914 return git_config_string(&config_output_directory, var, value);
915 if (!strcmp(var, "format.useautobase")) {
916 if (value && !strcasecmp(value, "whenAble")) {
917 auto_base = AUTO_BASE_WHEN_ABLE;
920 auto_base = git_config_bool(var, value) ? AUTO_BASE_ALWAYS : AUTO_BASE_NEVER;
923 if (!strcmp(var, "format.from")) {
924 int b = git_parse_maybe_bool(value);
927 from = xstrdup(value);
929 from = xstrdup(git_committer_info(IDENT_NO_DATE));
934 if (!strcmp(var, "format.notes")) {
935 int b = git_parse_maybe_bool(value);
937 enable_ref_display_notes(¬es_opt, &show_notes, value);
939 enable_default_display_notes(¬es_opt, &show_notes);
941 disable_display_notes(¬es_opt, &show_notes);
944 if (!strcmp(var, "format.coverfromdescription")) {
945 cover_from_description_mode = parse_cover_from_description(value);
949 return git_log_config(var, value, cb);
952 static const char *output_directory = NULL;
953 static int outdir_offset;
955 static int open_next_file(struct commit *commit, const char *subject,
956 struct rev_info *rev, int quiet)
958 struct strbuf filename = STRBUF_INIT;
960 if (output_directory) {
961 strbuf_addstr(&filename, output_directory);
962 strbuf_complete(&filename, '/');
965 if (rev->numbered_files)
966 strbuf_addf(&filename, "%d", rev->nr);
968 fmt_output_commit(&filename, commit, rev);
970 fmt_output_subject(&filename, subject, rev);
973 printf("%s\n", filename.buf + outdir_offset);
975 if ((rev->diffopt.file = fopen(filename.buf, "w")) == NULL) {
976 error_errno(_("cannot open patch file %s"), filename.buf);
977 strbuf_release(&filename);
981 strbuf_release(&filename);
985 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
987 struct rev_info check_rev;
988 struct commit *commit, *c1, *c2;
989 struct object *o1, *o2;
990 unsigned flags1, flags2;
992 if (rev->pending.nr != 2)
993 die(_("need exactly one range"));
995 o1 = rev->pending.objects[0].item;
996 o2 = rev->pending.objects[1].item;
999 c1 = lookup_commit_reference(the_repository, &o1->oid);
1000 c2 = lookup_commit_reference(the_repository, &o2->oid);
1002 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
1003 die(_("not a range"));
1005 init_patch_ids(the_repository, ids);
1007 /* given a range a..b get all patch ids for b..a */
1008 repo_init_revisions(the_repository, &check_rev, rev->prefix);
1009 check_rev.max_parents = 1;
1010 o1->flags ^= UNINTERESTING;
1011 o2->flags ^= UNINTERESTING;
1012 add_pending_object(&check_rev, o1, "o1");
1013 add_pending_object(&check_rev, o2, "o2");
1014 if (prepare_revision_walk(&check_rev))
1015 die(_("revision walk setup failed"));
1017 while ((commit = get_revision(&check_rev)) != NULL) {
1018 add_commit_patch_id(commit, ids);
1021 /* reset for next revision walk */
1022 clear_commit_marks(c1, SEEN | UNINTERESTING | SHOWN | ADDED);
1023 clear_commit_marks(c2, SEEN | UNINTERESTING | SHOWN | ADDED);
1028 static void gen_message_id(struct rev_info *info, char *base)
1030 struct strbuf buf = STRBUF_INIT;
1031 strbuf_addf(&buf, "%s.%"PRItime".git.%s", base,
1032 (timestamp_t) time(NULL),
1033 git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
1034 info->message_id = strbuf_detach(&buf, NULL);
1037 static void print_signature(FILE *file)
1039 if (!signature || !*signature)
1042 fprintf(file, "-- \n%s", signature);
1043 if (signature[strlen(signature)-1] != '\n')
1048 static char *find_branch_name(struct rev_info *rev)
1050 int i, positive = -1;
1051 struct object_id branch_oid;
1052 const struct object_id *tip_oid;
1053 const char *ref, *v;
1054 char *full_ref, *branch = NULL;
1056 for (i = 0; i < rev->cmdline.nr; i++) {
1057 if (rev->cmdline.rev[i].flags & UNINTERESTING)
1066 ref = rev->cmdline.rev[positive].name;
1067 tip_oid = &rev->cmdline.rev[positive].item->oid;
1068 if (dwim_ref(ref, strlen(ref), &branch_oid, &full_ref, 0) &&
1069 skip_prefix(full_ref, "refs/heads/", &v) &&
1070 oideq(tip_oid, &branch_oid))
1071 branch = xstrdup(v);
1076 static void show_diffstat(struct rev_info *rev,
1077 struct commit *origin, struct commit *head)
1079 struct diff_options opts;
1081 memcpy(&opts, &rev->diffopt, sizeof(opts));
1082 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1083 diff_setup_done(&opts);
1085 diff_tree_oid(get_commit_tree_oid(origin),
1086 get_commit_tree_oid(head),
1088 diffcore_std(&opts);
1091 fprintf(rev->diffopt.file, "\n");
1094 static void prepare_cover_text(struct pretty_print_context *pp,
1095 const char *branch_name,
1097 const char *encoding,
1100 const char *subject = "*** SUBJECT HERE ***";
1101 const char *body = "*** BLURB HERE ***";
1102 struct strbuf description_sb = STRBUF_INIT;
1103 struct strbuf subject_sb = STRBUF_INIT;
1105 if (cover_from_description_mode == COVER_FROM_NONE)
1108 if (branch_name && *branch_name)
1109 read_branch_desc(&description_sb, branch_name);
1110 if (!description_sb.len)
1113 if (cover_from_description_mode == COVER_FROM_SUBJECT ||
1114 cover_from_description_mode == COVER_FROM_AUTO)
1115 body = format_subject(&subject_sb, description_sb.buf, " ");
1117 if (cover_from_description_mode == COVER_FROM_MESSAGE ||
1118 (cover_from_description_mode == COVER_FROM_AUTO &&
1119 subject_sb.len > COVER_FROM_AUTO_MAX_SUBJECT_LEN))
1120 body = description_sb.buf;
1122 subject = subject_sb.buf;
1125 pp_title_line(pp, &subject, sb, encoding, need_8bit_cte);
1126 pp_remainder(pp, &body, sb, 0);
1128 strbuf_release(&description_sb);
1129 strbuf_release(&subject_sb);
1132 static int get_notes_refs(struct string_list_item *item, void *arg)
1134 strvec_pushf(arg, "--notes=%s", item->string);
1138 static void get_notes_args(struct strvec *arg, struct rev_info *rev)
1140 if (!rev->show_notes) {
1141 strvec_push(arg, "--no-notes");
1142 } else if (rev->notes_opt.use_default_notes > 0 ||
1143 (rev->notes_opt.use_default_notes == -1 &&
1144 !rev->notes_opt.extra_notes_refs.nr)) {
1145 strvec_push(arg, "--notes");
1147 for_each_string_list(&rev->notes_opt.extra_notes_refs, get_notes_refs, arg);
1151 static void make_cover_letter(struct rev_info *rev, int use_separate_file,
1152 struct commit *origin,
1153 int nr, struct commit **list,
1154 const char *branch_name,
1157 const char *committer;
1158 struct shortlog log;
1159 struct strbuf sb = STRBUF_INIT;
1161 const char *encoding = "UTF-8";
1162 int need_8bit_cte = 0;
1163 struct pretty_print_context pp = {0};
1164 struct commit *head = list[0];
1166 if (!cmit_fmt_is_mail(rev->commit_format))
1167 die(_("cover letter needs email format"));
1169 committer = git_committer_info(0);
1171 if (use_separate_file &&
1172 open_next_file(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
1173 die(_("failed to create cover-letter file"));
1175 log_write_email_headers(rev, head, &pp.after_subject, &need_8bit_cte, 0);
1177 for (i = 0; !need_8bit_cte && i < nr; i++) {
1178 const char *buf = get_commit_buffer(list[i], NULL);
1179 if (has_non_ascii(buf))
1181 unuse_commit_buffer(list[i], buf);
1185 branch_name = find_branch_name(rev);
1187 pp.fmt = CMIT_FMT_EMAIL;
1188 pp.date_mode.type = DATE_RFC2822;
1190 pp.print_email_subject = 1;
1191 pp_user_info(&pp, NULL, &sb, committer, encoding);
1192 prepare_cover_text(&pp, branch_name, &sb, encoding, need_8bit_cte);
1193 fprintf(rev->diffopt.file, "%s\n", sb.buf);
1195 strbuf_release(&sb);
1197 shortlog_init(&log);
1199 log.wrap = MAIL_DEFAULT_WRAP;
1202 log.file = rev->diffopt.file;
1203 log.groups = SHORTLOG_GROUP_AUTHOR;
1204 for (i = 0; i < nr; i++)
1205 shortlog_add_commit(&log, list[i]);
1207 shortlog_output(&log);
1209 /* We can only do diffstat with a unique reference point */
1211 show_diffstat(rev, origin, head);
1213 if (rev->idiff_oid1) {
1214 fprintf_ln(rev->diffopt.file, "%s", rev->idiff_title);
1215 show_interdiff(rev->idiff_oid1, rev->idiff_oid2, 0,
1221 * Pass minimum required diff-options to range-diff; others
1222 * can be added later if deemed desirable.
1224 struct diff_options opts;
1225 struct strvec other_arg = STRVEC_INIT;
1227 opts.file = rev->diffopt.file;
1228 opts.use_color = rev->diffopt.use_color;
1229 diff_setup_done(&opts);
1230 fprintf_ln(rev->diffopt.file, "%s", rev->rdiff_title);
1231 get_notes_args(&other_arg, rev);
1232 show_range_diff(rev->rdiff1, rev->rdiff2,
1233 rev->creation_factor, 1, &opts, &other_arg);
1234 strvec_clear(&other_arg);
1238 static const char *clean_message_id(const char *msg_id)
1241 const char *a, *z, *m;
1244 while ((ch = *m) && (isspace(ch) || (ch == '<')))
1249 if (!isspace(ch) && (ch != '>'))
1254 die(_("insane in-reply-to: %s"), msg_id);
1257 return xmemdupz(a, z - a);
1260 static const char *set_outdir(const char *prefix, const char *output_directory)
1262 if (output_directory && is_absolute_path(output_directory))
1263 return output_directory;
1265 if (!prefix || !*prefix) {
1266 if (output_directory)
1267 return output_directory;
1268 /* The user did not explicitly ask for "./" */
1273 outdir_offset = strlen(prefix);
1274 if (!output_directory)
1277 return prefix_filename(prefix, output_directory);
1280 static const char * const builtin_format_patch_usage[] = {
1281 N_("git format-patch [<options>] [<since> | <revision-range>]"),
1285 static int keep_subject = 0;
1287 static int keep_callback(const struct option *opt, const char *arg, int unset)
1289 BUG_ON_OPT_NEG(unset);
1290 BUG_ON_OPT_ARG(arg);
1291 ((struct rev_info *)opt->value)->total = -1;
1296 static int subject_prefix = 0;
1298 static int subject_prefix_callback(const struct option *opt, const char *arg,
1301 BUG_ON_OPT_NEG(unset);
1303 ((struct rev_info *)opt->value)->subject_prefix = arg;
1307 static int rfc_callback(const struct option *opt, const char *arg, int unset)
1309 BUG_ON_OPT_NEG(unset);
1310 BUG_ON_OPT_ARG(arg);
1311 return subject_prefix_callback(opt, "RFC PATCH", unset);
1314 static int numbered_cmdline_opt = 0;
1316 static int numbered_callback(const struct option *opt, const char *arg,
1319 BUG_ON_OPT_ARG(arg);
1320 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
1326 static int no_numbered_callback(const struct option *opt, const char *arg,
1329 BUG_ON_OPT_NEG(unset);
1330 return numbered_callback(opt, arg, 1);
1333 static int output_directory_callback(const struct option *opt, const char *arg,
1336 const char **dir = (const char **)opt->value;
1337 BUG_ON_OPT_NEG(unset);
1339 die(_("two output directories?"));
1344 static int thread_callback(const struct option *opt, const char *arg, int unset)
1346 enum thread_level *thread = (enum thread_level *)opt->value;
1348 *thread = THREAD_UNSET;
1349 else if (!arg || !strcmp(arg, "shallow"))
1350 *thread = THREAD_SHALLOW;
1351 else if (!strcmp(arg, "deep"))
1352 *thread = THREAD_DEEP;
1354 * Please update _git_formatpatch() in git-completion.bash
1355 * when you add new options.
1362 static int attach_callback(const struct option *opt, const char *arg, int unset)
1364 struct rev_info *rev = (struct rev_info *)opt->value;
1366 rev->mime_boundary = NULL;
1368 rev->mime_boundary = arg;
1370 rev->mime_boundary = git_version_string;
1371 rev->no_inline = unset ? 0 : 1;
1375 static int inline_callback(const struct option *opt, const char *arg, int unset)
1377 struct rev_info *rev = (struct rev_info *)opt->value;
1379 rev->mime_boundary = NULL;
1381 rev->mime_boundary = arg;
1383 rev->mime_boundary = git_version_string;
1388 static int header_callback(const struct option *opt, const char *arg, int unset)
1391 string_list_clear(&extra_hdr, 0);
1392 string_list_clear(&extra_to, 0);
1393 string_list_clear(&extra_cc, 0);
1400 static int to_callback(const struct option *opt, const char *arg, int unset)
1403 string_list_clear(&extra_to, 0);
1405 string_list_append(&extra_to, arg);
1409 static int cc_callback(const struct option *opt, const char *arg, int unset)
1412 string_list_clear(&extra_cc, 0);
1414 string_list_append(&extra_cc, arg);
1418 static int from_callback(const struct option *opt, const char *arg, int unset)
1420 char **from = opt->value;
1427 *from = xstrdup(arg);
1429 *from = xstrdup(git_committer_info(IDENT_NO_DATE));
1433 static int base_callback(const struct option *opt, const char *arg, int unset)
1435 const char **base_commit = opt->value;
1438 auto_base = AUTO_BASE_NEVER;
1439 *base_commit = NULL;
1440 } else if (!strcmp(arg, "auto")) {
1441 auto_base = AUTO_BASE_ALWAYS;
1442 *base_commit = NULL;
1444 auto_base = AUTO_BASE_NEVER;
1450 struct base_tree_info {
1451 struct object_id base_commit;
1452 int nr_patch_id, alloc_patch_id;
1453 struct object_id *patch_id;
1456 static struct commit *get_base_commit(const char *base_commit,
1457 struct commit **list,
1460 struct commit *base = NULL;
1461 struct commit **rev;
1462 int i = 0, rev_nr = 0, auto_select, die_on_failure;
1464 switch (auto_base) {
1465 case AUTO_BASE_NEVER:
1470 /* no base information is requested */
1474 case AUTO_BASE_ALWAYS:
1475 case AUTO_BASE_WHEN_ABLE:
1477 BUG("requested automatic base selection but a commit was provided");
1480 die_on_failure = auto_base == AUTO_BASE_ALWAYS;
1484 BUG("unexpected automatic base selection method");
1488 base = lookup_commit_reference_by_name(base_commit);
1490 die(_("unknown commit %s"), base_commit);
1492 struct branch *curr_branch = branch_get(NULL);
1493 const char *upstream = branch_get_upstream(curr_branch, NULL);
1495 struct commit_list *base_list;
1496 struct commit *commit;
1497 struct object_id oid;
1499 if (get_oid(upstream, &oid)) {
1501 die(_("failed to resolve '%s' as a valid ref"), upstream);
1505 commit = lookup_commit_or_die(&oid, "upstream base");
1506 base_list = get_merge_bases_many(commit, total, list);
1507 /* There should be one and only one merge base. */
1508 if (!base_list || base_list->next) {
1509 if (die_on_failure) {
1510 die(_("could not find exact merge base"));
1512 free_commit_list(base_list);
1516 base = base_list->item;
1517 free_commit_list(base_list);
1520 die(_("failed to get upstream, if you want to record base commit automatically,\n"
1521 "please use git branch --set-upstream-to to track a remote branch.\n"
1522 "Or you could specify base commit by --base=<base-commit-id> manually"));
1528 ALLOC_ARRAY(rev, total);
1529 for (i = 0; i < total; i++)
1534 * Get merge base through pair-wise computations
1535 * and store it in rev[0].
1537 while (rev_nr > 1) {
1538 for (i = 0; i < rev_nr / 2; i++) {
1539 struct commit_list *merge_base;
1540 merge_base = get_merge_bases(rev[2 * i], rev[2 * i + 1]);
1541 if (!merge_base || merge_base->next) {
1542 if (die_on_failure) {
1543 die(_("failed to find exact merge base"));
1550 rev[i] = merge_base->item;
1554 rev[i] = rev[2 * i];
1555 rev_nr = DIV_ROUND_UP(rev_nr, 2);
1558 if (!in_merge_bases(base, rev[0])) {
1559 if (die_on_failure) {
1560 die(_("base commit should be the ancestor of revision list"));
1567 for (i = 0; i < total; i++) {
1568 if (base == list[i]) {
1569 if (die_on_failure) {
1570 die(_("base commit shouldn't be in revision list"));
1582 define_commit_slab(commit_base, int);
1584 static void prepare_bases(struct base_tree_info *bases,
1585 struct commit *base,
1586 struct commit **list,
1589 struct commit *commit;
1590 struct rev_info revs;
1591 struct diff_options diffopt;
1592 struct commit_base commit_base;
1598 init_commit_base(&commit_base);
1599 repo_diff_setup(the_repository, &diffopt);
1600 diffopt.flags.recursive = 1;
1601 diff_setup_done(&diffopt);
1603 oidcpy(&bases->base_commit, &base->object.oid);
1605 repo_init_revisions(the_repository, &revs, NULL);
1606 revs.max_parents = 1;
1607 revs.topo_order = 1;
1608 for (i = 0; i < total; i++) {
1609 list[i]->object.flags &= ~UNINTERESTING;
1610 add_pending_object(&revs, &list[i]->object, "rev_list");
1611 *commit_base_at(&commit_base, list[i]) = 1;
1613 base->object.flags |= UNINTERESTING;
1614 add_pending_object(&revs, &base->object, "base");
1616 if (prepare_revision_walk(&revs))
1617 die(_("revision walk setup failed"));
1619 * Traverse the commits list, get prerequisite patch ids
1620 * and stuff them in bases structure.
1622 while ((commit = get_revision(&revs)) != NULL) {
1623 struct object_id oid;
1624 struct object_id *patch_id;
1625 if (*commit_base_at(&commit_base, commit))
1627 if (commit_patch_id(commit, &diffopt, &oid, 0, 1))
1628 die(_("cannot get patch id"));
1629 ALLOC_GROW(bases->patch_id, bases->nr_patch_id + 1, bases->alloc_patch_id);
1630 patch_id = bases->patch_id + bases->nr_patch_id;
1631 oidcpy(patch_id, &oid);
1632 bases->nr_patch_id++;
1634 clear_commit_base(&commit_base);
1637 static void print_bases(struct base_tree_info *bases, FILE *file)
1641 /* Only do this once, either for the cover or for the first one */
1642 if (is_null_oid(&bases->base_commit))
1645 /* Show the base commit */
1646 fprintf(file, "\nbase-commit: %s\n", oid_to_hex(&bases->base_commit));
1648 /* Show the prerequisite patches */
1649 for (i = bases->nr_patch_id - 1; i >= 0; i--)
1650 fprintf(file, "prerequisite-patch-id: %s\n", oid_to_hex(&bases->patch_id[i]));
1652 free(bases->patch_id);
1653 bases->nr_patch_id = 0;
1654 bases->alloc_patch_id = 0;
1655 oidclr(&bases->base_commit);
1658 static const char *diff_title(struct strbuf *sb, int reroll_count,
1659 const char *generic, const char *rerolled)
1661 if (reroll_count <= 0)
1662 strbuf_addstr(sb, generic);
1663 else /* RFC may be v0, so allow -v1 to diff against v0 */
1664 strbuf_addf(sb, rerolled, reroll_count - 1);
1668 static void infer_range_diff_ranges(struct strbuf *r1,
1671 struct commit *origin,
1672 struct commit *head)
1674 const char *head_oid = oid_to_hex(&head->object.oid);
1675 int prev_is_range = !!strstr(prev, "..");
1678 strbuf_addstr(r1, prev);
1680 strbuf_addf(r1, "%s..%s", head_oid, prev);
1683 strbuf_addf(r2, "%s..%s", oid_to_hex(&origin->object.oid), head_oid);
1684 else if (prev_is_range)
1685 die(_("failed to infer range-diff origin of current series"));
1687 warning(_("using '%s' as range-diff origin of current series"), prev);
1688 strbuf_addf(r2, "%s..%s", prev, head_oid);
1692 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1694 struct commit *commit;
1695 struct commit **list = NULL;
1696 struct rev_info rev;
1697 struct setup_revision_opt s_r_opt;
1698 int nr = 0, total, i;
1700 int start_number = -1;
1701 int just_numbers = 0;
1702 int ignore_if_in_upstream = 0;
1703 int cover_letter = -1;
1704 int boundary_count = 0;
1705 int no_binary_diff = 0;
1706 int zero_commit = 0;
1707 struct commit *origin = NULL;
1708 const char *in_reply_to = NULL;
1709 struct patch_ids ids;
1710 struct strbuf buf = STRBUF_INIT;
1711 int use_patch_format = 0;
1713 int reroll_count = -1;
1714 char *cover_from_description_arg = NULL;
1715 char *branch_name = NULL;
1716 char *base_commit = NULL;
1717 struct base_tree_info bases;
1718 struct commit *base;
1719 int show_progress = 0;
1720 struct progress *progress = NULL;
1721 struct oid_array idiff_prev = OID_ARRAY_INIT;
1722 struct strbuf idiff_title = STRBUF_INIT;
1723 const char *rdiff_prev = NULL;
1724 struct strbuf rdiff1 = STRBUF_INIT;
1725 struct strbuf rdiff2 = STRBUF_INIT;
1726 struct strbuf rdiff_title = STRBUF_INIT;
1727 int creation_factor = -1;
1729 const struct option builtin_format_patch_options[] = {
1730 OPT_CALLBACK_F('n', "numbered", &numbered, NULL,
1731 N_("use [PATCH n/m] even with a single patch"),
1732 PARSE_OPT_NOARG, numbered_callback),
1733 OPT_CALLBACK_F('N', "no-numbered", &numbered, NULL,
1734 N_("use [PATCH] even with multiple patches"),
1735 PARSE_OPT_NOARG | PARSE_OPT_NONEG, no_numbered_callback),
1736 OPT_BOOL('s', "signoff", &do_signoff, N_("add a Signed-off-by trailer")),
1737 OPT_BOOL(0, "stdout", &use_stdout,
1738 N_("print patches to standard out")),
1739 OPT_BOOL(0, "cover-letter", &cover_letter,
1740 N_("generate a cover letter")),
1741 OPT_BOOL(0, "numbered-files", &just_numbers,
1742 N_("use simple number sequence for output file names")),
1743 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1744 N_("use <sfx> instead of '.patch'")),
1745 OPT_INTEGER(0, "start-number", &start_number,
1746 N_("start numbering patches at <n> instead of 1")),
1747 OPT_INTEGER('v', "reroll-count", &reroll_count,
1748 N_("mark the series as Nth re-roll")),
1749 OPT_INTEGER(0, "filename-max-length", &fmt_patch_name_max,
1750 N_("max length of output filename")),
1751 OPT_CALLBACK_F(0, "rfc", &rev, NULL,
1752 N_("use [RFC PATCH] instead of [PATCH]"),
1753 PARSE_OPT_NOARG | PARSE_OPT_NONEG, rfc_callback),
1754 OPT_STRING(0, "cover-from-description", &cover_from_description_arg,
1755 N_("cover-from-description-mode"),
1756 N_("generate parts of a cover letter based on a branch's description")),
1757 OPT_CALLBACK_F(0, "subject-prefix", &rev, N_("prefix"),
1758 N_("use [<prefix>] instead of [PATCH]"),
1759 PARSE_OPT_NONEG, subject_prefix_callback),
1760 OPT_CALLBACK_F('o', "output-directory", &output_directory,
1761 N_("dir"), N_("store resulting files in <dir>"),
1762 PARSE_OPT_NONEG, output_directory_callback),
1763 OPT_CALLBACK_F('k', "keep-subject", &rev, NULL,
1764 N_("don't strip/add [PATCH]"),
1765 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback),
1766 OPT_BOOL(0, "no-binary", &no_binary_diff,
1767 N_("don't output binary diffs")),
1768 OPT_BOOL(0, "zero-commit", &zero_commit,
1769 N_("output all-zero hash in From header")),
1770 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1771 N_("don't include a patch matching a commit upstream")),
1772 OPT_SET_INT_F('p', "no-stat", &use_patch_format,
1773 N_("show patch format instead of default (patch + stat)"),
1774 1, PARSE_OPT_NONEG),
1775 OPT_GROUP(N_("Messaging")),
1776 OPT_CALLBACK(0, "add-header", NULL, N_("header"),
1777 N_("add email header"), header_callback),
1778 OPT_CALLBACK(0, "to", NULL, N_("email"), N_("add To: header"), to_callback),
1779 OPT_CALLBACK(0, "cc", NULL, N_("email"), N_("add Cc: header"), cc_callback),
1780 OPT_CALLBACK_F(0, "from", &from, N_("ident"),
1781 N_("set From address to <ident> (or committer ident if absent)"),
1782 PARSE_OPT_OPTARG, from_callback),
1783 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1784 N_("make first mail a reply to <message-id>")),
1785 OPT_CALLBACK_F(0, "attach", &rev, N_("boundary"),
1786 N_("attach the patch"), PARSE_OPT_OPTARG,
1788 OPT_CALLBACK_F(0, "inline", &rev, N_("boundary"),
1789 N_("inline the patch"),
1790 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1792 OPT_CALLBACK_F(0, "thread", &thread, N_("style"),
1793 N_("enable message threading, styles: shallow, deep"),
1794 PARSE_OPT_OPTARG, thread_callback),
1795 OPT_STRING(0, "signature", &signature, N_("signature"),
1796 N_("add a signature")),
1797 OPT_CALLBACK_F(0, "base", &base_commit, N_("base-commit"),
1798 N_("add prerequisite tree info to the patch series"),
1800 OPT_FILENAME(0, "signature-file", &signature_file,
1801 N_("add a signature from a file")),
1802 OPT__QUIET(&quiet, N_("don't print the patch filenames")),
1803 OPT_BOOL(0, "progress", &show_progress,
1804 N_("show progress while generating patches")),
1805 OPT_CALLBACK(0, "interdiff", &idiff_prev, N_("rev"),
1806 N_("show changes against <rev> in cover letter or single patch"),
1807 parse_opt_object_name),
1808 OPT_STRING(0, "range-diff", &rdiff_prev, N_("refspec"),
1809 N_("show changes against <refspec> in cover letter or single patch")),
1810 OPT_INTEGER(0, "creation-factor", &creation_factor,
1811 N_("percentage by which creation is weighted")),
1815 extra_hdr.strdup_strings = 1;
1816 extra_to.strdup_strings = 1;
1817 extra_cc.strdup_strings = 1;
1818 init_log_defaults();
1819 init_display_notes(¬es_opt);
1820 git_config(git_format_config, NULL);
1821 repo_init_revisions(the_repository, &rev, prefix);
1822 rev.show_notes = show_notes;
1823 memcpy(&rev.notes_opt, ¬es_opt, sizeof(notes_opt));
1824 rev.commit_format = CMIT_FMT_EMAIL;
1825 rev.encode_email_headers = default_encode_email_headers;
1826 rev.expand_tabs_in_log_default = 0;
1827 rev.verbose_header = 1;
1829 rev.max_parents = 1;
1830 rev.diffopt.flags.recursive = 1;
1831 rev.subject_prefix = fmt_patch_subject_prefix;
1832 memset(&s_r_opt, 0, sizeof(s_r_opt));
1833 s_r_opt.def = "HEAD";
1834 s_r_opt.revarg_opt = REVARG_COMMITTISH;
1836 if (default_attach) {
1837 rev.mime_boundary = default_attach;
1842 * Parse the arguments before setup_revisions(), or something
1843 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1844 * possibly a valid SHA1.
1846 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1847 builtin_format_patch_usage,
1848 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1849 PARSE_OPT_KEEP_DASHDASH);
1851 /* Make sure "0000-$sub.patch" gives non-negative length for $sub */
1852 if (fmt_patch_name_max <= strlen("0000-") + strlen(fmt_patch_suffix))
1853 fmt_patch_name_max = strlen("0000-") + strlen(fmt_patch_suffix);
1855 if (cover_from_description_arg)
1856 cover_from_description_mode = parse_cover_from_description(cover_from_description_arg);
1858 if (0 < reroll_count) {
1859 struct strbuf sprefix = STRBUF_INIT;
1860 strbuf_addf(&sprefix, "%s v%d",
1861 rev.subject_prefix, reroll_count);
1862 rev.reroll_count = reroll_count;
1863 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1866 for (i = 0; i < extra_hdr.nr; i++) {
1867 strbuf_addstr(&buf, extra_hdr.items[i].string);
1868 strbuf_addch(&buf, '\n');
1872 strbuf_addstr(&buf, "To: ");
1873 for (i = 0; i < extra_to.nr; i++) {
1875 strbuf_addstr(&buf, " ");
1876 strbuf_addstr(&buf, extra_to.items[i].string);
1877 if (i + 1 < extra_to.nr)
1878 strbuf_addch(&buf, ',');
1879 strbuf_addch(&buf, '\n');
1883 strbuf_addstr(&buf, "Cc: ");
1884 for (i = 0; i < extra_cc.nr; i++) {
1886 strbuf_addstr(&buf, " ");
1887 strbuf_addstr(&buf, extra_cc.items[i].string);
1888 if (i + 1 < extra_cc.nr)
1889 strbuf_addch(&buf, ',');
1890 strbuf_addch(&buf, '\n');
1893 rev.extra_headers = strbuf_detach(&buf, NULL);
1896 if (split_ident_line(&rev.from_ident, from, strlen(from)))
1897 die(_("invalid ident line: %s"), from);
1900 if (start_number < 0)
1904 * If numbered is set solely due to format.numbered in config,
1905 * and it would conflict with --keep-subject (-k) from the
1906 * command line, reset "numbered".
1908 if (numbered && keep_subject && !numbered_cmdline_opt)
1911 if (numbered && keep_subject)
1912 die(_("-n and -k are mutually exclusive"));
1913 if (keep_subject && subject_prefix)
1914 die(_("--subject-prefix/--rfc and -k are mutually exclusive"));
1915 rev.preserve_subject = keep_subject;
1917 argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1919 die(_("unrecognized argument: %s"), argv[1]);
1921 if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1922 die(_("--name-only does not make sense"));
1923 if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1924 die(_("--name-status does not make sense"));
1925 if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1926 die(_("--check does not make sense"));
1928 if (!use_patch_format &&
1929 (!rev.diffopt.output_format ||
1930 rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1931 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1932 if (!rev.diffopt.stat_width)
1933 rev.diffopt.stat_width = MAIL_DEFAULT_WRAP;
1935 /* Always generate a patch */
1936 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1938 rev.zero_commit = zero_commit;
1939 rev.patch_name_max = fmt_patch_name_max;
1941 if (!rev.diffopt.flags.text && !no_binary_diff)
1942 rev.diffopt.flags.binary = 1;
1945 load_display_notes(&rev.notes_opt);
1947 if (use_stdout + rev.diffopt.close_file + !!output_directory > 1)
1948 die(_("--stdout, --output, and --output-directory are mutually exclusive"));
1952 } else if (rev.diffopt.close_file) {
1954 * The diff code parsed --output; it has already opened the
1955 * file, but but we must instruct it not to close after each
1958 rev.diffopt.close_file = 0;
1962 if (!output_directory)
1963 output_directory = config_output_directory;
1964 output_directory = set_outdir(prefix, output_directory);
1966 if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
1967 rev.diffopt.use_color = GIT_COLOR_NEVER;
1969 * We consider <outdir> as 'outside of gitdir', therefore avoid
1970 * applying adjust_shared_perm in s-c-l-d.
1972 saved = get_shared_repository();
1973 set_shared_repository(0);
1974 switch (safe_create_leading_directories_const(output_directory)) {
1979 die(_("could not create leading directories "
1980 "of '%s'"), output_directory);
1982 set_shared_repository(saved);
1983 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1984 die_errno(_("could not create directory '%s'"),
1988 if (rev.pending.nr == 1) {
1991 if (rev.max_count < 0 && !rev.show_root_diff) {
1993 * This is traditional behaviour of "git format-patch
1994 * origin" that prepares what the origin side still
1997 rev.pending.objects[0].item->flags |= UNINTERESTING;
1998 add_head_to_pending(&rev);
2002 * Otherwise, it is "format-patch -22 HEAD", and/or
2003 * "format-patch --root HEAD". The user wants
2004 * get_revision() to do the usual traversal.
2007 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
2011 const char *ref, *v;
2012 ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
2014 if (ref && skip_prefix(ref, "refs/heads/", &v))
2015 branch_name = xstrdup(v);
2017 branch_name = xstrdup(""); /* no branch */
2022 * We cannot move this anywhere earlier because we do want to
2023 * know if --root was given explicitly from the command line.
2025 rev.show_root_diff = 1;
2027 if (ignore_if_in_upstream) {
2028 /* Don't say anything if head and upstream are the same. */
2029 if (rev.pending.nr == 2) {
2030 struct object_array_entry *o = rev.pending.objects;
2031 if (oideq(&o[0].item->oid, &o[1].item->oid))
2034 get_patch_ids(&rev, &ids);
2037 if (prepare_revision_walk(&rev))
2038 die(_("revision walk setup failed"));
2040 while ((commit = get_revision(&rev)) != NULL) {
2041 if (commit->object.flags & BOUNDARY) {
2043 origin = (boundary_count == 1) ? commit : NULL;
2047 if (ignore_if_in_upstream && has_commit_patch_id(commit, &ids))
2051 REALLOC_ARRAY(list, nr);
2052 list[nr - 1] = commit;
2058 if (cover_letter == -1) {
2059 if (config_cover_letter == COVER_AUTO)
2060 cover_letter = (total > 1);
2062 cover_letter = (config_cover_letter == COVER_ON);
2064 if (!keep_subject && auto_number && (total > 1 || cover_letter))
2067 rev.total = total + start_number - 1;
2069 if (idiff_prev.nr) {
2070 if (!cover_letter && total != 1)
2071 die(_("--interdiff requires --cover-letter or single patch"));
2072 rev.idiff_oid1 = &idiff_prev.oid[idiff_prev.nr - 1];
2073 rev.idiff_oid2 = get_commit_tree_oid(list[0]);
2074 rev.idiff_title = diff_title(&idiff_title, reroll_count,
2076 _("Interdiff against v%d:"));
2079 if (creation_factor < 0)
2080 creation_factor = RANGE_DIFF_CREATION_FACTOR_DEFAULT;
2081 else if (!rdiff_prev)
2082 die(_("--creation-factor requires --range-diff"));
2085 if (!cover_letter && total != 1)
2086 die(_("--range-diff requires --cover-letter or single patch"));
2088 infer_range_diff_ranges(&rdiff1, &rdiff2, rdiff_prev,
2090 rev.rdiff1 = rdiff1.buf;
2091 rev.rdiff2 = rdiff2.buf;
2092 rev.creation_factor = creation_factor;
2093 rev.rdiff_title = diff_title(&rdiff_title, reroll_count,
2095 _("Range-diff against v%d:"));
2099 ; /* --no-signature inhibits all signatures */
2100 } else if (signature && signature != git_version_string) {
2101 ; /* non-default signature already set */
2102 } else if (signature_file) {
2103 struct strbuf buf = STRBUF_INIT;
2105 if (strbuf_read_file(&buf, signature_file, 128) < 0)
2106 die_errno(_("unable to read signature file '%s'"), signature_file);
2107 signature = strbuf_detach(&buf, NULL);
2110 memset(&bases, 0, sizeof(bases));
2111 base = get_base_commit(base_commit, list, nr);
2113 reset_revision_walk();
2114 clear_object_flags(UNINTERESTING);
2115 prepare_bases(&bases, base, list, nr);
2118 if (in_reply_to || thread || cover_letter)
2119 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
2121 const char *msgid = clean_message_id(in_reply_to);
2122 string_list_append(rev.ref_message_ids, msgid);
2124 rev.numbered_files = just_numbers;
2125 rev.patch_suffix = fmt_patch_suffix;
2128 gen_message_id(&rev, "cover");
2129 make_cover_letter(&rev, !!output_directory,
2130 origin, nr, list, branch_name, quiet);
2131 print_bases(&bases, rev.diffopt.file);
2132 print_signature(rev.diffopt.file);
2135 /* interdiff/range-diff in cover-letter; omit from patches */
2136 rev.idiff_oid1 = NULL;
2139 rev.add_signoff = do_signoff;
2142 progress = start_delayed_progress(_("Generating patches"), total);
2145 display_progress(progress, total - nr);
2147 rev.nr = total - nr + (start_number - 1);
2148 /* Make the second and subsequent mails replies to the first */
2150 /* Have we already had a message ID? */
2151 if (rev.message_id) {
2153 * For deep threading: make every mail
2154 * a reply to the previous one, no
2155 * matter what other options are set.
2157 * For shallow threading:
2159 * Without --cover-letter and
2160 * --in-reply-to, make every mail a
2161 * reply to the one before.
2163 * With --in-reply-to but no
2164 * --cover-letter, make every mail a
2165 * reply to the <reply-to>.
2167 * With --cover-letter, make every
2168 * mail but the cover letter a reply
2169 * to the cover letter. The cover
2170 * letter is a reply to the
2171 * --in-reply-to, if specified.
2173 if (thread == THREAD_SHALLOW
2174 && rev.ref_message_ids->nr > 0
2175 && (!cover_letter || rev.nr > 1))
2176 free(rev.message_id);
2178 string_list_append(rev.ref_message_ids,
2181 gen_message_id(&rev, oid_to_hex(&commit->object.oid));
2184 if (output_directory &&
2185 open_next_file(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
2186 die(_("failed to create output files"));
2187 shown = log_tree_commit(&rev, commit);
2188 free_commit_buffer(the_repository->parsed_objects,
2191 /* We put one extra blank line between formatted
2192 * patches and this flag is used by log-tree code
2193 * to see if it needs to emit a LF before showing
2194 * the log; when using one file per patch, we do
2195 * not want the extra blank line.
2197 if (output_directory)
2200 print_bases(&bases, rev.diffopt.file);
2201 if (rev.mime_boundary)
2202 fprintf(rev.diffopt.file, "\n--%s%s--\n\n\n",
2203 mime_boundary_leader,
2206 print_signature(rev.diffopt.file);
2208 if (output_directory)
2209 fclose(rev.diffopt.file);
2211 stop_progress(&progress);
2214 string_list_clear(&extra_to, 0);
2215 string_list_clear(&extra_cc, 0);
2216 string_list_clear(&extra_hdr, 0);
2217 if (ignore_if_in_upstream)
2218 free_patch_ids(&ids);
2221 oid_array_clear(&idiff_prev);
2222 strbuf_release(&idiff_title);
2223 strbuf_release(&rdiff1);
2224 strbuf_release(&rdiff2);
2225 strbuf_release(&rdiff_title);
2229 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
2231 struct object_id oid;
2232 if (get_oid(arg, &oid) == 0) {
2233 struct commit *commit = lookup_commit_reference(the_repository,
2236 commit->object.flags |= flags;
2237 add_pending_object(revs, &commit->object, arg);
2244 static const char * const cherry_usage[] = {
2245 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
2249 static void print_commit(char sign, struct commit *commit, int verbose,
2250 int abbrev, FILE *file)
2253 fprintf(file, "%c %s\n", sign,
2254 find_unique_abbrev(&commit->object.oid, abbrev));
2256 struct strbuf buf = STRBUF_INIT;
2257 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
2258 fprintf(file, "%c %s %s\n", sign,
2259 find_unique_abbrev(&commit->object.oid, abbrev),
2261 strbuf_release(&buf);
2265 int cmd_cherry(int argc, const char **argv, const char *prefix)
2267 struct rev_info revs;
2268 struct patch_ids ids;
2269 struct commit *commit;
2270 struct commit_list *list = NULL;
2271 struct branch *current_branch;
2272 const char *upstream;
2273 const char *head = "HEAD";
2274 const char *limit = NULL;
2275 int verbose = 0, abbrev = 0;
2277 struct option options[] = {
2278 OPT__ABBREV(&abbrev),
2279 OPT__VERBOSE(&verbose, N_("be verbose")),
2283 argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
2296 current_branch = branch_get(NULL);
2297 upstream = branch_get_upstream(current_branch, NULL);
2299 fprintf(stderr, _("Could not find a tracked"
2300 " remote branch, please"
2301 " specify <upstream> manually.\n"));
2302 usage_with_options(cherry_usage, options);
2306 repo_init_revisions(the_repository, &revs, prefix);
2307 revs.max_parents = 1;
2309 if (add_pending_commit(head, &revs, 0))
2310 die(_("unknown commit %s"), head);
2311 if (add_pending_commit(upstream, &revs, UNINTERESTING))
2312 die(_("unknown commit %s"), upstream);
2314 /* Don't say anything if head and upstream are the same. */
2315 if (revs.pending.nr == 2) {
2316 struct object_array_entry *o = revs.pending.objects;
2317 if (oideq(&o[0].item->oid, &o[1].item->oid))
2321 get_patch_ids(&revs, &ids);
2323 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
2324 die(_("unknown commit %s"), limit);
2326 /* reverse the list of commits */
2327 if (prepare_revision_walk(&revs))
2328 die(_("revision walk setup failed"));
2329 while ((commit = get_revision(&revs)) != NULL) {
2330 commit_list_insert(commit, &list);
2336 commit = list->item;
2337 if (has_commit_patch_id(commit, &ids))
2339 print_commit(sign, commit, verbose, abbrev, revs.diffopt.file);
2343 free_patch_ids(&ids);