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"
19 #include "reflog-walk.h"
20 #include "patch-ids.h"
21 #include "run-command.h"
24 #include "string-list.h"
25 #include "parse-options.h"
28 #include "streaming.h"
31 #include "gpg-interface.h"
33 #include "commit-slab.h"
34 #include "repository.h"
35 #include "commit-reach.h"
36 #include "range-diff.h"
38 #define MAIL_DEFAULT_WRAP 72
39 #define COVER_FROM_AUTO_MAX_SUBJECT_LEN 100
41 /* Set a default date-time format for git log ("log.date" config variable) */
42 static const char *default_date_mode = NULL;
44 static int default_abbrev_commit;
45 static int default_show_root = 1;
46 static int default_follow;
47 static int default_show_signature;
48 static int default_encode_email_headers = 1;
49 static int decoration_style;
50 static int decoration_given;
51 static int use_mailmap_config = 1;
52 static const char *fmt_patch_subject_prefix = "PATCH";
53 static const char *fmt_pretty;
55 static const char * const builtin_log_usage[] = {
56 N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
57 N_("git show [<options>] <object>..."),
61 struct line_opt_callback_data {
64 struct string_list args;
67 static int session_is_interactive(void)
69 return isatty(1) || pager_in_use();
72 static int auto_decoration_style(void)
74 return session_is_interactive() ? DECORATE_SHORT_REFS : 0;
77 static int parse_decoration_style(const char *value)
79 switch (git_parse_maybe_bool(value)) {
81 return DECORATE_SHORT_REFS;
87 if (!strcmp(value, "full"))
88 return DECORATE_FULL_REFS;
89 else if (!strcmp(value, "short"))
90 return DECORATE_SHORT_REFS;
91 else if (!strcmp(value, "auto"))
92 return auto_decoration_style();
94 * Please update _git_log() in git-completion.bash when you
95 * add new decoration styles.
100 static int decorate_callback(const struct option *opt, const char *arg, int unset)
103 decoration_style = 0;
105 decoration_style = parse_decoration_style(arg);
107 decoration_style = DECORATE_SHORT_REFS;
109 if (decoration_style < 0)
110 die(_("invalid --decorate option: %s"), arg);
112 decoration_given = 1;
117 static int log_line_range_callback(const struct option *option, const char *arg, int unset)
119 struct line_opt_callback_data *data = option->value;
121 BUG_ON_OPT_NEG(unset);
126 data->rev->line_level_traverse = 1;
127 string_list_append(&data->args, arg);
132 static void init_log_defaults(void)
134 init_grep_defaults(the_repository);
135 init_diff_ui_defaults();
137 decoration_style = auto_decoration_style();
140 static void cmd_log_init_defaults(struct rev_info *rev)
143 get_commit_format(fmt_pretty, rev);
145 rev->diffopt.flags.default_follow_renames = 1;
146 rev->verbose_header = 1;
147 rev->diffopt.flags.recursive = 1;
148 rev->diffopt.stat_width = -1; /* use full terminal width */
149 rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
150 rev->abbrev_commit = default_abbrev_commit;
151 rev->show_root_diff = default_show_root;
152 rev->subject_prefix = fmt_patch_subject_prefix;
153 rev->show_signature = default_show_signature;
154 rev->encode_email_headers = default_encode_email_headers;
155 rev->diffopt.flags.allow_textconv = 1;
157 if (default_date_mode)
158 parse_date_format(default_date_mode, &rev->date_mode);
161 static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
162 struct rev_info *rev, struct setup_revision_opt *opt)
164 struct userformat_want w;
165 int quiet = 0, source = 0, mailmap;
166 static struct line_opt_callback_data line_cb = {NULL, NULL, STRING_LIST_INIT_DUP};
167 static struct string_list decorate_refs_exclude = STRING_LIST_INIT_NODUP;
168 static struct string_list decorate_refs_exclude_config = STRING_LIST_INIT_NODUP;
169 static struct string_list decorate_refs_include = STRING_LIST_INIT_NODUP;
170 struct decoration_filter decoration_filter = {&decorate_refs_include,
171 &decorate_refs_exclude,
172 &decorate_refs_exclude_config};
173 static struct revision_sources revision_sources;
175 const struct option builtin_log_options[] = {
176 OPT__QUIET(&quiet, N_("suppress diff output")),
177 OPT_BOOL(0, "source", &source, N_("show source")),
178 OPT_BOOL(0, "use-mailmap", &mailmap, N_("Use mail map file")),
179 OPT_ALIAS(0, "mailmap", "use-mailmap"),
180 OPT_STRING_LIST(0, "decorate-refs", &decorate_refs_include,
181 N_("pattern"), N_("only decorate refs that match <pattern>")),
182 OPT_STRING_LIST(0, "decorate-refs-exclude", &decorate_refs_exclude,
183 N_("pattern"), N_("do not decorate refs that match <pattern>")),
184 OPT_CALLBACK_F(0, "decorate", NULL, NULL, N_("decorate options"),
185 PARSE_OPT_OPTARG, decorate_callback),
186 OPT_CALLBACK('L', NULL, &line_cb, "range:file",
187 N_("Trace the evolution of line range <start>,<end> or function :<funcname> in <file>"),
188 log_line_range_callback),
193 line_cb.prefix = prefix;
195 mailmap = use_mailmap_config;
196 argc = parse_options(argc, argv, prefix,
197 builtin_log_options, builtin_log_usage,
198 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
199 PARSE_OPT_KEEP_DASHDASH);
202 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
203 argc = setup_revisions(argc, argv, rev, opt);
205 /* Any arguments at this point are not recognized */
207 die(_("unrecognized argument: %s"), argv[1]);
209 if (rev->line_level_traverse && rev->prune_data.nr)
210 die(_("-L<range>:<file> cannot be used with pathspec"));
212 memset(&w, 0, sizeof(w));
213 userformat_find_requirements(NULL, &w);
215 if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
218 load_display_notes(&rev->notes_opt);
220 if ((rev->diffopt.pickaxe_opts & DIFF_PICKAXE_KINDS_MASK) ||
221 rev->diffopt.filter || rev->diffopt.flags.follow_renames)
222 rev->always_show_header = 0;
224 if (source || w.source) {
225 init_revision_sources(&revision_sources);
226 rev->sources = &revision_sources;
230 rev->mailmap = xcalloc(1, sizeof(struct string_list));
231 read_mailmap(rev->mailmap, NULL);
234 if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
236 * "log --pretty=raw" is special; ignore UI oriented
237 * configuration variables such as decoration.
239 if (!decoration_given)
240 decoration_style = 0;
241 if (!rev->abbrev_commit_given)
242 rev->abbrev_commit = 0;
245 if (decoration_style) {
246 const struct string_list *config_exclude =
247 repo_config_get_value_multi(the_repository,
248 "log.excludeDecoration");
250 if (config_exclude) {
251 struct string_list_item *item;
252 for_each_string_list_item(item, config_exclude)
253 string_list_append(&decorate_refs_exclude_config,
257 rev->show_decorations = 1;
259 load_ref_decorations(&decoration_filter, decoration_style);
262 if (rev->line_level_traverse)
263 line_log_init(rev, line_cb.prefix, &line_cb.args);
268 static void cmd_log_init(int argc, const char **argv, const char *prefix,
269 struct rev_info *rev, struct setup_revision_opt *opt)
271 cmd_log_init_defaults(rev);
272 cmd_log_init_finish(argc, argv, prefix, rev, opt);
276 * This gives a rough estimate for how many commits we
277 * will print out in the list.
279 static int estimate_commit_count(struct commit_list *list)
284 struct commit *commit = list->item;
285 unsigned int flags = commit->object.flags;
287 if (!(flags & (TREESAME | UNINTERESTING)))
293 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
295 if (rev->shown_one) {
297 if (rev->commit_format != CMIT_FMT_ONELINE)
298 putchar(rev->diffopt.line_termination);
300 fprintf(rev->diffopt.file, _("Final output: %d %s\n"), nr, stage);
303 static struct itimerval early_output_timer;
305 static void log_show_early(struct rev_info *revs, struct commit_list *list)
307 int i = revs->early_output, close_file = revs->diffopt.close_file;
310 revs->diffopt.close_file = 0;
311 sort_in_topological_order(&list, revs->sort_order);
313 struct commit *commit = list->item;
314 switch (simplify_commit(revs, commit)) {
317 int n = estimate_commit_count(list);
318 show_early_header(revs, "incomplete", n);
321 log_tree_commit(revs, commit);
328 fclose(revs->diffopt.file);
334 /* Did we already get enough commits for the early output? */
337 fclose(revs->diffopt.file);
342 * ..if no, then repeat it twice a second until we
345 * NOTE! We don't use "it_interval", because if the
346 * reader isn't listening, we want our output to be
347 * throttled by the writing, and not have the timer
348 * trigger every second even if we're blocked on a
351 early_output_timer.it_value.tv_sec = 0;
352 early_output_timer.it_value.tv_usec = 500000;
353 setitimer(ITIMER_REAL, &early_output_timer, NULL);
356 static void early_output(int signal)
358 show_early_output = log_show_early;
361 static void setup_early_output(void)
366 * Set up the signal handler, minimally intrusively:
367 * we only set a single volatile integer word (not
368 * using sigatomic_t - trying to avoid unnecessary
369 * system dependencies and headers), and using
372 memset(&sa, 0, sizeof(sa));
373 sa.sa_handler = early_output;
374 sigemptyset(&sa.sa_mask);
375 sa.sa_flags = SA_RESTART;
376 sigaction(SIGALRM, &sa, NULL);
379 * If we can get the whole output in less than a
380 * tenth of a second, don't even bother doing the
381 * early-output thing..
383 * This is a one-time-only trigger.
385 early_output_timer.it_value.tv_sec = 0;
386 early_output_timer.it_value.tv_usec = 100000;
387 setitimer(ITIMER_REAL, &early_output_timer, NULL);
390 static void finish_early_output(struct rev_info *rev)
392 int n = estimate_commit_count(rev->commits);
393 signal(SIGALRM, SIG_IGN);
394 show_early_header(rev, "done", n);
397 static int cmd_log_walk(struct rev_info *rev)
399 struct commit *commit;
401 int saved_dcctc = 0, close_file = rev->diffopt.close_file;
403 if (rev->early_output)
404 setup_early_output();
406 if (prepare_revision_walk(rev))
407 die(_("revision walk setup failed"));
409 if (rev->early_output)
410 finish_early_output(rev);
413 * For --check and --exit-code, the exit code is based on CHECK_FAILED
414 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
415 * retain that state information if replacing rev->diffopt in this loop
417 rev->diffopt.close_file = 0;
418 while ((commit = get_revision(rev)) != NULL) {
419 if (!log_tree_commit(rev, commit) && rev->max_count >= 0)
421 * We decremented max_count in get_revision,
422 * but we didn't actually show the commit.
425 if (!rev->reflog_info) {
427 * We may show a given commit multiple times when
428 * walking the reflogs.
430 free_commit_buffer(the_repository->parsed_objects,
432 free_commit_list(commit->parents);
433 commit->parents = NULL;
435 if (saved_nrl < rev->diffopt.needed_rename_limit)
436 saved_nrl = rev->diffopt.needed_rename_limit;
437 if (rev->diffopt.degraded_cc_to_c)
440 rev->diffopt.degraded_cc_to_c = saved_dcctc;
441 rev->diffopt.needed_rename_limit = saved_nrl;
443 fclose(rev->diffopt.file);
445 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
446 rev->diffopt.flags.check_failed) {
449 return diff_result_code(&rev->diffopt, 0);
452 static int git_log_config(const char *var, const char *value, void *cb)
454 const char *slot_name;
456 if (!strcmp(var, "format.pretty"))
457 return git_config_string(&fmt_pretty, var, value);
458 if (!strcmp(var, "format.subjectprefix"))
459 return git_config_string(&fmt_patch_subject_prefix, var, value);
460 if (!strcmp(var, "format.encodeemailheaders")) {
461 default_encode_email_headers = git_config_bool(var, value);
464 if (!strcmp(var, "log.abbrevcommit")) {
465 default_abbrev_commit = git_config_bool(var, value);
468 if (!strcmp(var, "log.date"))
469 return git_config_string(&default_date_mode, var, value);
470 if (!strcmp(var, "log.decorate")) {
471 decoration_style = parse_decoration_style(value);
472 if (decoration_style < 0)
473 decoration_style = 0; /* maybe warn? */
476 if (!strcmp(var, "log.showroot")) {
477 default_show_root = git_config_bool(var, value);
480 if (!strcmp(var, "log.follow")) {
481 default_follow = git_config_bool(var, value);
484 if (skip_prefix(var, "color.decorate.", &slot_name))
485 return parse_decorate_color_config(var, slot_name, value);
486 if (!strcmp(var, "log.mailmap")) {
487 use_mailmap_config = git_config_bool(var, value);
490 if (!strcmp(var, "log.showsignature")) {
491 default_show_signature = git_config_bool(var, value);
495 if (grep_config(var, value, cb) < 0)
497 if (git_gpg_config(var, value, cb) < 0)
499 return git_diff_ui_config(var, value, cb);
502 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
505 struct setup_revision_opt opt;
508 git_config(git_log_config, NULL);
510 repo_init_revisions(the_repository, &rev, prefix);
512 rev.simplify_history = 0;
513 memset(&opt, 0, sizeof(opt));
515 opt.revarg_opt = REVARG_COMMITTISH;
516 cmd_log_init(argc, argv, prefix, &rev, &opt);
517 if (!rev.diffopt.output_format)
518 rev.diffopt.output_format = DIFF_FORMAT_RAW;
519 return cmd_log_walk(&rev);
522 static void show_tagger(const char *buf, struct rev_info *rev)
524 struct strbuf out = STRBUF_INIT;
525 struct pretty_print_context pp = {0};
527 pp.fmt = rev->commit_format;
528 pp.date_mode = rev->date_mode;
529 pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
530 fprintf(rev->diffopt.file, "%s", out.buf);
531 strbuf_release(&out);
534 static int show_blob_object(const struct object_id *oid, struct rev_info *rev, const char *obj_name)
536 struct object_id oidc;
537 struct object_context obj_context;
541 fflush(rev->diffopt.file);
542 if (!rev->diffopt.flags.textconv_set_via_cmdline ||
543 !rev->diffopt.flags.allow_textconv)
544 return stream_blob_to_fd(1, oid, NULL, 0);
546 if (get_oid_with_context(the_repository, obj_name,
548 &oidc, &obj_context))
549 die(_("not a valid object name %s"), obj_name);
550 if (!obj_context.path ||
551 !textconv_object(the_repository, obj_context.path,
552 obj_context.mode, &oidc, 1, &buf, &size)) {
553 free(obj_context.path);
554 return stream_blob_to_fd(1, oid, NULL, 0);
558 die(_("git show %s: bad file"), obj_name);
560 write_or_die(1, buf, size);
561 free(obj_context.path);
565 static int show_tag_object(const struct object_id *oid, struct rev_info *rev)
568 enum object_type type;
569 char *buf = read_object_file(oid, &type, &size);
573 return error(_("could not read object %s"), oid_to_hex(oid));
575 assert(type == OBJ_TAG);
576 while (offset < size && buf[offset] != '\n') {
577 int new_offset = offset + 1;
579 while (new_offset < size && buf[new_offset++] != '\n')
581 if (skip_prefix(buf + offset, "tagger ", &ident))
582 show_tagger(ident, rev);
587 fwrite(buf + offset, size - offset, 1, rev->diffopt.file);
592 static int show_tree_object(const struct object_id *oid,
594 const char *pathname, unsigned mode, int stage, void *context)
596 FILE *file = context;
597 fprintf(file, "%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
601 static void show_setup_revisions_tweak(struct rev_info *rev,
602 struct setup_revision_opt *opt)
604 if (rev->ignore_merges < 0) {
605 /* There was no "-m" variant on the command line */
606 rev->ignore_merges = 0;
607 if (!rev->first_parent_only && !rev->combine_merges) {
608 /* No "--first-parent", "-c", or "--cc" */
609 rev->combine_merges = 1;
610 rev->dense_combined_merges = 1;
613 if (!rev->diffopt.output_format)
614 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
617 int cmd_show(int argc, const char **argv, const char *prefix)
620 struct object_array_entry *objects;
621 struct setup_revision_opt opt;
622 struct pathspec match_all;
623 int i, count, ret = 0;
626 git_config(git_log_config, NULL);
628 memset(&match_all, 0, sizeof(match_all));
629 repo_init_revisions(the_repository, &rev, prefix);
631 rev.always_show_header = 1;
632 rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
633 rev.diffopt.stat_width = -1; /* Scale to real terminal size */
635 memset(&opt, 0, sizeof(opt));
637 opt.tweak = show_setup_revisions_tweak;
638 cmd_log_init(argc, argv, prefix, &rev, &opt);
641 return cmd_log_walk(&rev);
643 count = rev.pending.nr;
644 objects = rev.pending.objects;
645 for (i = 0; i < count && !ret; i++) {
646 struct object *o = objects[i].item;
647 const char *name = objects[i].name;
650 ret = show_blob_object(&o->oid, &rev, name);
653 struct tag *t = (struct tag *)o;
654 struct object_id *oid = get_tagged_oid(t);
658 fprintf(rev.diffopt.file, "%stag %s%s\n",
659 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
661 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
662 ret = show_tag_object(&o->oid, &rev);
666 o = parse_object(the_repository, oid);
668 ret = error(_("could not read object %s"),
677 fprintf(rev.diffopt.file, "%stree %s%s\n\n",
678 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
680 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
681 read_tree_recursive(the_repository, (struct tree *)o, "",
682 0, 0, &match_all, show_tree_object,
687 rev.pending.nr = rev.pending.alloc = 0;
688 rev.pending.objects = NULL;
689 add_object_array(o, name, &rev.pending);
690 ret = cmd_log_walk(&rev);
693 ret = error(_("unknown type: %d"), o->type);
701 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
703 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
706 struct setup_revision_opt opt;
709 git_config(git_log_config, NULL);
711 repo_init_revisions(the_repository, &rev, prefix);
712 init_reflog_walk(&rev.reflog_info);
713 rev.verbose_header = 1;
714 memset(&opt, 0, sizeof(opt));
716 cmd_log_init_defaults(&rev);
717 rev.abbrev_commit = 1;
718 rev.commit_format = CMIT_FMT_ONELINE;
719 rev.use_terminator = 1;
720 rev.always_show_header = 1;
721 cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
723 return cmd_log_walk(&rev);
726 static void log_setup_revisions_tweak(struct rev_info *rev,
727 struct setup_revision_opt *opt)
729 if (rev->diffopt.flags.default_follow_renames &&
730 rev->prune_data.nr == 1)
731 rev->diffopt.flags.follow_renames = 1;
733 /* Turn --cc/-c into -p --cc/-c when -p was not given */
734 if (!rev->diffopt.output_format && rev->combine_merges)
735 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
737 if (rev->first_parent_only && rev->ignore_merges < 0)
738 rev->ignore_merges = 0;
741 int cmd_log(int argc, const char **argv, const char *prefix)
744 struct setup_revision_opt opt;
747 git_config(git_log_config, NULL);
749 repo_init_revisions(the_repository, &rev, prefix);
750 rev.always_show_header = 1;
751 memset(&opt, 0, sizeof(opt));
753 opt.revarg_opt = REVARG_COMMITTISH;
754 opt.tweak = log_setup_revisions_tweak;
755 cmd_log_init(argc, argv, prefix, &rev, &opt);
756 return cmd_log_walk(&rev);
761 static const char *fmt_patch_suffix = ".patch";
762 static int numbered = 0;
763 static int auto_number = 1;
765 static char *default_attach = NULL;
767 static struct string_list extra_hdr = STRING_LIST_INIT_NODUP;
768 static struct string_list extra_to = STRING_LIST_INIT_NODUP;
769 static struct string_list extra_cc = STRING_LIST_INIT_NODUP;
771 static void add_header(const char *value)
773 struct string_list_item *item;
774 int len = strlen(value);
775 while (len && value[len - 1] == '\n')
778 if (!strncasecmp(value, "to: ", 4)) {
779 item = string_list_append(&extra_to, value + 4);
781 } else if (!strncasecmp(value, "cc: ", 4)) {
782 item = string_list_append(&extra_cc, value + 4);
785 item = string_list_append(&extra_hdr, value);
788 item->string[len] = '\0';
804 enum cover_from_description {
811 enum auto_base_setting {
817 static enum thread_level thread;
818 static int do_signoff;
819 static enum auto_base_setting auto_base;
821 static const char *signature = git_version_string;
822 static const char *signature_file;
823 static enum cover_setting config_cover_letter;
824 static const char *config_output_directory;
825 static enum cover_from_description cover_from_description_mode = COVER_FROM_MESSAGE;
826 static int show_notes;
827 static struct display_notes_opt notes_opt;
829 static enum cover_from_description parse_cover_from_description(const char *arg)
831 if (!arg || !strcmp(arg, "default"))
832 return COVER_FROM_MESSAGE;
833 else if (!strcmp(arg, "none"))
834 return COVER_FROM_NONE;
835 else if (!strcmp(arg, "message"))
836 return COVER_FROM_MESSAGE;
837 else if (!strcmp(arg, "subject"))
838 return COVER_FROM_SUBJECT;
839 else if (!strcmp(arg, "auto"))
840 return COVER_FROM_AUTO;
842 die(_("%s: invalid cover from description mode"), arg);
845 static int git_format_config(const char *var, const char *value, void *cb)
847 if (!strcmp(var, "format.headers")) {
849 die(_("format.headers without value"));
853 if (!strcmp(var, "format.suffix"))
854 return git_config_string(&fmt_patch_suffix, var, value);
855 if (!strcmp(var, "format.to")) {
857 return config_error_nonbool(var);
858 string_list_append(&extra_to, value);
861 if (!strcmp(var, "format.cc")) {
863 return config_error_nonbool(var);
864 string_list_append(&extra_cc, value);
867 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
868 !strcmp(var, "color.ui") || !strcmp(var, "diff.submodule")) {
871 if (!strcmp(var, "format.numbered")) {
872 if (value && !strcasecmp(value, "auto")) {
876 numbered = git_config_bool(var, value);
877 auto_number = auto_number && numbered;
880 if (!strcmp(var, "format.attach")) {
882 default_attach = xstrdup(value);
884 default_attach = xstrdup(git_version_string);
887 if (!strcmp(var, "format.thread")) {
888 if (value && !strcasecmp(value, "deep")) {
889 thread = THREAD_DEEP;
892 if (value && !strcasecmp(value, "shallow")) {
893 thread = THREAD_SHALLOW;
896 thread = git_config_bool(var, value) ? THREAD_SHALLOW : THREAD_UNSET;
899 if (!strcmp(var, "format.signoff")) {
900 do_signoff = git_config_bool(var, value);
903 if (!strcmp(var, "format.signature"))
904 return git_config_string(&signature, var, value);
905 if (!strcmp(var, "format.signaturefile"))
906 return git_config_pathname(&signature_file, var, value);
907 if (!strcmp(var, "format.coverletter")) {
908 if (value && !strcasecmp(value, "auto")) {
909 config_cover_letter = COVER_AUTO;
912 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
915 if (!strcmp(var, "format.outputdirectory"))
916 return git_config_string(&config_output_directory, var, value);
917 if (!strcmp(var, "format.useautobase")) {
918 if (value && !strcasecmp(value, "whenAble")) {
919 auto_base = AUTO_BASE_WHEN_ABLE;
922 auto_base = git_config_bool(var, value) ? AUTO_BASE_ALWAYS : AUTO_BASE_NEVER;
925 if (!strcmp(var, "format.from")) {
926 int b = git_parse_maybe_bool(value);
929 from = xstrdup(value);
931 from = xstrdup(git_committer_info(IDENT_NO_DATE));
936 if (!strcmp(var, "format.notes")) {
937 int b = git_parse_maybe_bool(value);
939 enable_ref_display_notes(¬es_opt, &show_notes, value);
941 enable_default_display_notes(¬es_opt, &show_notes);
943 disable_display_notes(¬es_opt, &show_notes);
946 if (!strcmp(var, "format.coverfromdescription")) {
947 cover_from_description_mode = parse_cover_from_description(value);
951 return git_log_config(var, value, cb);
954 static const char *output_directory = NULL;
955 static int outdir_offset;
957 static int open_next_file(struct commit *commit, const char *subject,
958 struct rev_info *rev, int quiet)
960 struct strbuf filename = STRBUF_INIT;
961 int suffix_len = strlen(rev->patch_suffix) + 1;
963 if (output_directory) {
964 strbuf_addstr(&filename, output_directory);
966 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len) {
967 strbuf_release(&filename);
968 return error(_("name of output directory is too long"));
970 strbuf_complete(&filename, '/');
973 if (rev->numbered_files)
974 strbuf_addf(&filename, "%d", rev->nr);
976 fmt_output_commit(&filename, commit, rev);
978 fmt_output_subject(&filename, subject, rev);
981 printf("%s\n", filename.buf + outdir_offset);
983 if ((rev->diffopt.file = fopen(filename.buf, "w")) == NULL) {
984 error_errno(_("cannot open patch file %s"), filename.buf);
985 strbuf_release(&filename);
989 strbuf_release(&filename);
993 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
995 struct rev_info check_rev;
996 struct commit *commit, *c1, *c2;
997 struct object *o1, *o2;
998 unsigned flags1, flags2;
1000 if (rev->pending.nr != 2)
1001 die(_("need exactly one range"));
1003 o1 = rev->pending.objects[0].item;
1004 o2 = rev->pending.objects[1].item;
1007 c1 = lookup_commit_reference(the_repository, &o1->oid);
1008 c2 = lookup_commit_reference(the_repository, &o2->oid);
1010 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
1011 die(_("not a range"));
1013 init_patch_ids(the_repository, ids);
1015 /* given a range a..b get all patch ids for b..a */
1016 repo_init_revisions(the_repository, &check_rev, rev->prefix);
1017 check_rev.max_parents = 1;
1018 o1->flags ^= UNINTERESTING;
1019 o2->flags ^= UNINTERESTING;
1020 add_pending_object(&check_rev, o1, "o1");
1021 add_pending_object(&check_rev, o2, "o2");
1022 if (prepare_revision_walk(&check_rev))
1023 die(_("revision walk setup failed"));
1025 while ((commit = get_revision(&check_rev)) != NULL) {
1026 add_commit_patch_id(commit, ids);
1029 /* reset for next revision walk */
1030 clear_commit_marks(c1, SEEN | UNINTERESTING | SHOWN | ADDED);
1031 clear_commit_marks(c2, SEEN | UNINTERESTING | SHOWN | ADDED);
1036 static void gen_message_id(struct rev_info *info, char *base)
1038 struct strbuf buf = STRBUF_INIT;
1039 strbuf_addf(&buf, "%s.%"PRItime".git.%s", base,
1040 (timestamp_t) time(NULL),
1041 git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
1042 info->message_id = strbuf_detach(&buf, NULL);
1045 static void print_signature(FILE *file)
1047 if (!signature || !*signature)
1050 fprintf(file, "-- \n%s", signature);
1051 if (signature[strlen(signature)-1] != '\n')
1056 static char *find_branch_name(struct rev_info *rev)
1058 int i, positive = -1;
1059 struct object_id branch_oid;
1060 const struct object_id *tip_oid;
1061 const char *ref, *v;
1062 char *full_ref, *branch = NULL;
1064 for (i = 0; i < rev->cmdline.nr; i++) {
1065 if (rev->cmdline.rev[i].flags & UNINTERESTING)
1074 ref = rev->cmdline.rev[positive].name;
1075 tip_oid = &rev->cmdline.rev[positive].item->oid;
1076 if (dwim_ref(ref, strlen(ref), &branch_oid, &full_ref, 0) &&
1077 skip_prefix(full_ref, "refs/heads/", &v) &&
1078 oideq(tip_oid, &branch_oid))
1079 branch = xstrdup(v);
1084 static void show_diffstat(struct rev_info *rev,
1085 struct commit *origin, struct commit *head)
1087 struct diff_options opts;
1089 memcpy(&opts, &rev->diffopt, sizeof(opts));
1090 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1091 diff_setup_done(&opts);
1093 diff_tree_oid(get_commit_tree_oid(origin),
1094 get_commit_tree_oid(head),
1096 diffcore_std(&opts);
1099 fprintf(rev->diffopt.file, "\n");
1102 static void prepare_cover_text(struct pretty_print_context *pp,
1103 const char *branch_name,
1105 const char *encoding,
1108 const char *subject = "*** SUBJECT HERE ***";
1109 const char *body = "*** BLURB HERE ***";
1110 struct strbuf description_sb = STRBUF_INIT;
1111 struct strbuf subject_sb = STRBUF_INIT;
1113 if (cover_from_description_mode == COVER_FROM_NONE)
1116 if (branch_name && *branch_name)
1117 read_branch_desc(&description_sb, branch_name);
1118 if (!description_sb.len)
1121 if (cover_from_description_mode == COVER_FROM_SUBJECT ||
1122 cover_from_description_mode == COVER_FROM_AUTO)
1123 body = format_subject(&subject_sb, description_sb.buf, " ");
1125 if (cover_from_description_mode == COVER_FROM_MESSAGE ||
1126 (cover_from_description_mode == COVER_FROM_AUTO &&
1127 subject_sb.len > COVER_FROM_AUTO_MAX_SUBJECT_LEN))
1128 body = description_sb.buf;
1130 subject = subject_sb.buf;
1133 pp_title_line(pp, &subject, sb, encoding, need_8bit_cte);
1134 pp_remainder(pp, &body, sb, 0);
1136 strbuf_release(&description_sb);
1137 strbuf_release(&subject_sb);
1140 static int get_notes_refs(struct string_list_item *item, void *arg)
1142 strvec_pushf(arg, "--notes=%s", item->string);
1146 static void get_notes_args(struct strvec *arg, struct rev_info *rev)
1148 if (!rev->show_notes) {
1149 strvec_push(arg, "--no-notes");
1150 } else if (rev->notes_opt.use_default_notes > 0 ||
1151 (rev->notes_opt.use_default_notes == -1 &&
1152 !rev->notes_opt.extra_notes_refs.nr)) {
1153 strvec_push(arg, "--notes");
1155 for_each_string_list(&rev->notes_opt.extra_notes_refs, get_notes_refs, arg);
1159 static void make_cover_letter(struct rev_info *rev, int use_separate_file,
1160 struct commit *origin,
1161 int nr, struct commit **list,
1162 const char *branch_name,
1165 const char *committer;
1166 struct shortlog log;
1167 struct strbuf sb = STRBUF_INIT;
1169 const char *encoding = "UTF-8";
1170 int need_8bit_cte = 0;
1171 struct pretty_print_context pp = {0};
1172 struct commit *head = list[0];
1174 if (!cmit_fmt_is_mail(rev->commit_format))
1175 die(_("cover letter needs email format"));
1177 committer = git_committer_info(0);
1179 if (use_separate_file &&
1180 open_next_file(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
1181 die(_("failed to create cover-letter file"));
1183 log_write_email_headers(rev, head, &pp.after_subject, &need_8bit_cte, 0);
1185 for (i = 0; !need_8bit_cte && i < nr; i++) {
1186 const char *buf = get_commit_buffer(list[i], NULL);
1187 if (has_non_ascii(buf))
1189 unuse_commit_buffer(list[i], buf);
1193 branch_name = find_branch_name(rev);
1195 pp.fmt = CMIT_FMT_EMAIL;
1196 pp.date_mode.type = DATE_RFC2822;
1198 pp.print_email_subject = 1;
1199 pp_user_info(&pp, NULL, &sb, committer, encoding);
1200 prepare_cover_text(&pp, branch_name, &sb, encoding, need_8bit_cte);
1201 fprintf(rev->diffopt.file, "%s\n", sb.buf);
1203 strbuf_release(&sb);
1205 shortlog_init(&log);
1207 log.wrap = MAIL_DEFAULT_WRAP;
1210 log.file = rev->diffopt.file;
1211 log.groups = SHORTLOG_GROUP_AUTHOR;
1212 for (i = 0; i < nr; i++)
1213 shortlog_add_commit(&log, list[i]);
1215 shortlog_output(&log);
1217 /* We can only do diffstat with a unique reference point */
1219 show_diffstat(rev, origin, head);
1221 if (rev->idiff_oid1) {
1222 fprintf_ln(rev->diffopt.file, "%s", rev->idiff_title);
1223 show_interdiff(rev->idiff_oid1, rev->idiff_oid2, 0,
1229 * Pass minimum required diff-options to range-diff; others
1230 * can be added later if deemed desirable.
1232 struct diff_options opts;
1233 struct strvec other_arg = STRVEC_INIT;
1235 opts.file = rev->diffopt.file;
1236 opts.use_color = rev->diffopt.use_color;
1237 diff_setup_done(&opts);
1238 fprintf_ln(rev->diffopt.file, "%s", rev->rdiff_title);
1239 get_notes_args(&other_arg, rev);
1240 show_range_diff(rev->rdiff1, rev->rdiff2,
1241 rev->creation_factor, 1, &opts, &other_arg);
1242 strvec_clear(&other_arg);
1246 static const char *clean_message_id(const char *msg_id)
1249 const char *a, *z, *m;
1252 while ((ch = *m) && (isspace(ch) || (ch == '<')))
1257 if (!isspace(ch) && (ch != '>'))
1262 die(_("insane in-reply-to: %s"), msg_id);
1265 return xmemdupz(a, z - a);
1268 static const char *set_outdir(const char *prefix, const char *output_directory)
1270 if (output_directory && is_absolute_path(output_directory))
1271 return output_directory;
1273 if (!prefix || !*prefix) {
1274 if (output_directory)
1275 return output_directory;
1276 /* The user did not explicitly ask for "./" */
1281 outdir_offset = strlen(prefix);
1282 if (!output_directory)
1285 return prefix_filename(prefix, output_directory);
1288 static const char * const builtin_format_patch_usage[] = {
1289 N_("git format-patch [<options>] [<since> | <revision-range>]"),
1293 static int keep_subject = 0;
1295 static int keep_callback(const struct option *opt, const char *arg, int unset)
1297 BUG_ON_OPT_NEG(unset);
1298 BUG_ON_OPT_ARG(arg);
1299 ((struct rev_info *)opt->value)->total = -1;
1304 static int subject_prefix = 0;
1306 static int subject_prefix_callback(const struct option *opt, const char *arg,
1309 BUG_ON_OPT_NEG(unset);
1311 ((struct rev_info *)opt->value)->subject_prefix = arg;
1315 static int rfc_callback(const struct option *opt, const char *arg, int unset)
1317 BUG_ON_OPT_NEG(unset);
1318 BUG_ON_OPT_ARG(arg);
1319 return subject_prefix_callback(opt, "RFC PATCH", unset);
1322 static int numbered_cmdline_opt = 0;
1324 static int numbered_callback(const struct option *opt, const char *arg,
1327 BUG_ON_OPT_ARG(arg);
1328 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
1334 static int no_numbered_callback(const struct option *opt, const char *arg,
1337 BUG_ON_OPT_NEG(unset);
1338 return numbered_callback(opt, arg, 1);
1341 static int output_directory_callback(const struct option *opt, const char *arg,
1344 const char **dir = (const char **)opt->value;
1345 BUG_ON_OPT_NEG(unset);
1347 die(_("two output directories?"));
1352 static int thread_callback(const struct option *opt, const char *arg, int unset)
1354 enum thread_level *thread = (enum thread_level *)opt->value;
1356 *thread = THREAD_UNSET;
1357 else if (!arg || !strcmp(arg, "shallow"))
1358 *thread = THREAD_SHALLOW;
1359 else if (!strcmp(arg, "deep"))
1360 *thread = THREAD_DEEP;
1362 * Please update _git_formatpatch() in git-completion.bash
1363 * when you add new options.
1370 static int attach_callback(const struct option *opt, const char *arg, int unset)
1372 struct rev_info *rev = (struct rev_info *)opt->value;
1374 rev->mime_boundary = NULL;
1376 rev->mime_boundary = arg;
1378 rev->mime_boundary = git_version_string;
1379 rev->no_inline = unset ? 0 : 1;
1383 static int inline_callback(const struct option *opt, const char *arg, int unset)
1385 struct rev_info *rev = (struct rev_info *)opt->value;
1387 rev->mime_boundary = NULL;
1389 rev->mime_boundary = arg;
1391 rev->mime_boundary = git_version_string;
1396 static int header_callback(const struct option *opt, const char *arg, int unset)
1399 string_list_clear(&extra_hdr, 0);
1400 string_list_clear(&extra_to, 0);
1401 string_list_clear(&extra_cc, 0);
1408 static int to_callback(const struct option *opt, const char *arg, int unset)
1411 string_list_clear(&extra_to, 0);
1413 string_list_append(&extra_to, arg);
1417 static int cc_callback(const struct option *opt, const char *arg, int unset)
1420 string_list_clear(&extra_cc, 0);
1422 string_list_append(&extra_cc, arg);
1426 static int from_callback(const struct option *opt, const char *arg, int unset)
1428 char **from = opt->value;
1435 *from = xstrdup(arg);
1437 *from = xstrdup(git_committer_info(IDENT_NO_DATE));
1441 static int base_callback(const struct option *opt, const char *arg, int unset)
1443 const char **base_commit = opt->value;
1446 auto_base = AUTO_BASE_NEVER;
1447 *base_commit = NULL;
1448 } else if (!strcmp(arg, "auto")) {
1449 auto_base = AUTO_BASE_ALWAYS;
1450 *base_commit = NULL;
1452 auto_base = AUTO_BASE_NEVER;
1458 struct base_tree_info {
1459 struct object_id base_commit;
1460 int nr_patch_id, alloc_patch_id;
1461 struct object_id *patch_id;
1464 static struct commit *get_base_commit(const char *base_commit,
1465 struct commit **list,
1468 struct commit *base = NULL;
1469 struct commit **rev;
1470 int i = 0, rev_nr = 0, auto_select, die_on_failure;
1472 switch (auto_base) {
1473 case AUTO_BASE_NEVER:
1478 /* no base information is requested */
1482 case AUTO_BASE_ALWAYS:
1483 case AUTO_BASE_WHEN_ABLE:
1485 BUG("requested automatic base selection but a commit was provided");
1488 die_on_failure = auto_base == AUTO_BASE_ALWAYS;
1492 BUG("unexpected automatic base selection method");
1496 base = lookup_commit_reference_by_name(base_commit);
1498 die(_("unknown commit %s"), base_commit);
1500 struct branch *curr_branch = branch_get(NULL);
1501 const char *upstream = branch_get_upstream(curr_branch, NULL);
1503 struct commit_list *base_list;
1504 struct commit *commit;
1505 struct object_id oid;
1507 if (get_oid(upstream, &oid)) {
1509 die(_("failed to resolve '%s' as a valid ref"), upstream);
1513 commit = lookup_commit_or_die(&oid, "upstream base");
1514 base_list = get_merge_bases_many(commit, total, list);
1515 /* There should be one and only one merge base. */
1516 if (!base_list || base_list->next) {
1517 if (die_on_failure) {
1518 die(_("could not find exact merge base"));
1520 free_commit_list(base_list);
1524 base = base_list->item;
1525 free_commit_list(base_list);
1528 die(_("failed to get upstream, if you want to record base commit automatically,\n"
1529 "please use git branch --set-upstream-to to track a remote branch.\n"
1530 "Or you could specify base commit by --base=<base-commit-id> manually"));
1536 ALLOC_ARRAY(rev, total);
1537 for (i = 0; i < total; i++)
1542 * Get merge base through pair-wise computations
1543 * and store it in rev[0].
1545 while (rev_nr > 1) {
1546 for (i = 0; i < rev_nr / 2; i++) {
1547 struct commit_list *merge_base;
1548 merge_base = get_merge_bases(rev[2 * i], rev[2 * i + 1]);
1549 if (!merge_base || merge_base->next) {
1550 if (die_on_failure) {
1551 die(_("failed to find exact merge base"));
1558 rev[i] = merge_base->item;
1562 rev[i] = rev[2 * i];
1563 rev_nr = DIV_ROUND_UP(rev_nr, 2);
1566 if (!in_merge_bases(base, rev[0])) {
1567 if (die_on_failure) {
1568 die(_("base commit should be the ancestor of revision list"));
1575 for (i = 0; i < total; i++) {
1576 if (base == list[i]) {
1577 if (die_on_failure) {
1578 die(_("base commit shouldn't be in revision list"));
1590 define_commit_slab(commit_base, int);
1592 static void prepare_bases(struct base_tree_info *bases,
1593 struct commit *base,
1594 struct commit **list,
1597 struct commit *commit;
1598 struct rev_info revs;
1599 struct diff_options diffopt;
1600 struct commit_base commit_base;
1606 init_commit_base(&commit_base);
1607 repo_diff_setup(the_repository, &diffopt);
1608 diffopt.flags.recursive = 1;
1609 diff_setup_done(&diffopt);
1611 oidcpy(&bases->base_commit, &base->object.oid);
1613 repo_init_revisions(the_repository, &revs, NULL);
1614 revs.max_parents = 1;
1615 revs.topo_order = 1;
1616 for (i = 0; i < total; i++) {
1617 list[i]->object.flags &= ~UNINTERESTING;
1618 add_pending_object(&revs, &list[i]->object, "rev_list");
1619 *commit_base_at(&commit_base, list[i]) = 1;
1621 base->object.flags |= UNINTERESTING;
1622 add_pending_object(&revs, &base->object, "base");
1624 if (prepare_revision_walk(&revs))
1625 die(_("revision walk setup failed"));
1627 * Traverse the commits list, get prerequisite patch ids
1628 * and stuff them in bases structure.
1630 while ((commit = get_revision(&revs)) != NULL) {
1631 struct object_id oid;
1632 struct object_id *patch_id;
1633 if (*commit_base_at(&commit_base, commit))
1635 if (commit_patch_id(commit, &diffopt, &oid, 0, 1))
1636 die(_("cannot get patch id"));
1637 ALLOC_GROW(bases->patch_id, bases->nr_patch_id + 1, bases->alloc_patch_id);
1638 patch_id = bases->patch_id + bases->nr_patch_id;
1639 oidcpy(patch_id, &oid);
1640 bases->nr_patch_id++;
1642 clear_commit_base(&commit_base);
1645 static void print_bases(struct base_tree_info *bases, FILE *file)
1649 /* Only do this once, either for the cover or for the first one */
1650 if (is_null_oid(&bases->base_commit))
1653 /* Show the base commit */
1654 fprintf(file, "\nbase-commit: %s\n", oid_to_hex(&bases->base_commit));
1656 /* Show the prerequisite patches */
1657 for (i = bases->nr_patch_id - 1; i >= 0; i--)
1658 fprintf(file, "prerequisite-patch-id: %s\n", oid_to_hex(&bases->patch_id[i]));
1660 free(bases->patch_id);
1661 bases->nr_patch_id = 0;
1662 bases->alloc_patch_id = 0;
1663 oidclr(&bases->base_commit);
1666 static const char *diff_title(struct strbuf *sb, int reroll_count,
1667 const char *generic, const char *rerolled)
1669 if (reroll_count <= 0)
1670 strbuf_addstr(sb, generic);
1671 else /* RFC may be v0, so allow -v1 to diff against v0 */
1672 strbuf_addf(sb, rerolled, reroll_count - 1);
1676 static void infer_range_diff_ranges(struct strbuf *r1,
1679 struct commit *origin,
1680 struct commit *head)
1682 const char *head_oid = oid_to_hex(&head->object.oid);
1683 int prev_is_range = !!strstr(prev, "..");
1686 strbuf_addstr(r1, prev);
1688 strbuf_addf(r1, "%s..%s", head_oid, prev);
1691 strbuf_addf(r2, "%s..%s", oid_to_hex(&origin->object.oid), head_oid);
1692 else if (prev_is_range)
1693 die(_("failed to infer range-diff origin of current series"));
1695 warning(_("using '%s' as range-diff origin of current series"), prev);
1696 strbuf_addf(r2, "%s..%s", prev, head_oid);
1700 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1702 struct commit *commit;
1703 struct commit **list = NULL;
1704 struct rev_info rev;
1705 struct setup_revision_opt s_r_opt;
1706 int nr = 0, total, i;
1708 int start_number = -1;
1709 int just_numbers = 0;
1710 int ignore_if_in_upstream = 0;
1711 int cover_letter = -1;
1712 int boundary_count = 0;
1713 int no_binary_diff = 0;
1714 int zero_commit = 0;
1715 struct commit *origin = NULL;
1716 const char *in_reply_to = NULL;
1717 struct patch_ids ids;
1718 struct strbuf buf = STRBUF_INIT;
1719 int use_patch_format = 0;
1721 int reroll_count = -1;
1722 char *cover_from_description_arg = NULL;
1723 char *branch_name = NULL;
1724 char *base_commit = NULL;
1725 struct base_tree_info bases;
1726 struct commit *base;
1727 int show_progress = 0;
1728 struct progress *progress = NULL;
1729 struct oid_array idiff_prev = OID_ARRAY_INIT;
1730 struct strbuf idiff_title = STRBUF_INIT;
1731 const char *rdiff_prev = NULL;
1732 struct strbuf rdiff1 = STRBUF_INIT;
1733 struct strbuf rdiff2 = STRBUF_INIT;
1734 struct strbuf rdiff_title = STRBUF_INIT;
1735 int creation_factor = -1;
1737 const struct option builtin_format_patch_options[] = {
1738 OPT_CALLBACK_F('n', "numbered", &numbered, NULL,
1739 N_("use [PATCH n/m] even with a single patch"),
1740 PARSE_OPT_NOARG, numbered_callback),
1741 OPT_CALLBACK_F('N', "no-numbered", &numbered, NULL,
1742 N_("use [PATCH] even with multiple patches"),
1743 PARSE_OPT_NOARG | PARSE_OPT_NONEG, no_numbered_callback),
1744 OPT_BOOL('s', "signoff", &do_signoff, N_("add a Signed-off-by trailer")),
1745 OPT_BOOL(0, "stdout", &use_stdout,
1746 N_("print patches to standard out")),
1747 OPT_BOOL(0, "cover-letter", &cover_letter,
1748 N_("generate a cover letter")),
1749 OPT_BOOL(0, "numbered-files", &just_numbers,
1750 N_("use simple number sequence for output file names")),
1751 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1752 N_("use <sfx> instead of '.patch'")),
1753 OPT_INTEGER(0, "start-number", &start_number,
1754 N_("start numbering patches at <n> instead of 1")),
1755 OPT_INTEGER('v', "reroll-count", &reroll_count,
1756 N_("mark the series as Nth re-roll")),
1757 OPT_CALLBACK_F(0, "rfc", &rev, NULL,
1758 N_("Use [RFC PATCH] instead of [PATCH]"),
1759 PARSE_OPT_NOARG | PARSE_OPT_NONEG, rfc_callback),
1760 OPT_STRING(0, "cover-from-description", &cover_from_description_arg,
1761 N_("cover-from-description-mode"),
1762 N_("generate parts of a cover letter based on a branch's description")),
1763 OPT_CALLBACK_F(0, "subject-prefix", &rev, N_("prefix"),
1764 N_("Use [<prefix>] instead of [PATCH]"),
1765 PARSE_OPT_NONEG, subject_prefix_callback),
1766 OPT_CALLBACK_F('o', "output-directory", &output_directory,
1767 N_("dir"), N_("store resulting files in <dir>"),
1768 PARSE_OPT_NONEG, output_directory_callback),
1769 OPT_CALLBACK_F('k', "keep-subject", &rev, NULL,
1770 N_("don't strip/add [PATCH]"),
1771 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback),
1772 OPT_BOOL(0, "no-binary", &no_binary_diff,
1773 N_("don't output binary diffs")),
1774 OPT_BOOL(0, "zero-commit", &zero_commit,
1775 N_("output all-zero hash in From header")),
1776 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1777 N_("don't include a patch matching a commit upstream")),
1778 OPT_SET_INT_F('p', "no-stat", &use_patch_format,
1779 N_("show patch format instead of default (patch + stat)"),
1780 1, PARSE_OPT_NONEG),
1781 OPT_GROUP(N_("Messaging")),
1782 OPT_CALLBACK(0, "add-header", NULL, N_("header"),
1783 N_("add email header"), header_callback),
1784 OPT_CALLBACK(0, "to", NULL, N_("email"), N_("add To: header"), to_callback),
1785 OPT_CALLBACK(0, "cc", NULL, N_("email"), N_("add Cc: header"), cc_callback),
1786 OPT_CALLBACK_F(0, "from", &from, N_("ident"),
1787 N_("set From address to <ident> (or committer ident if absent)"),
1788 PARSE_OPT_OPTARG, from_callback),
1789 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1790 N_("make first mail a reply to <message-id>")),
1791 OPT_CALLBACK_F(0, "attach", &rev, N_("boundary"),
1792 N_("attach the patch"), PARSE_OPT_OPTARG,
1794 OPT_CALLBACK_F(0, "inline", &rev, N_("boundary"),
1795 N_("inline the patch"),
1796 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1798 OPT_CALLBACK_F(0, "thread", &thread, N_("style"),
1799 N_("enable message threading, styles: shallow, deep"),
1800 PARSE_OPT_OPTARG, thread_callback),
1801 OPT_STRING(0, "signature", &signature, N_("signature"),
1802 N_("add a signature")),
1803 OPT_CALLBACK_F(0, "base", &base_commit, N_("base-commit"),
1804 N_("add prerequisite tree info to the patch series"),
1806 OPT_FILENAME(0, "signature-file", &signature_file,
1807 N_("add a signature from a file")),
1808 OPT__QUIET(&quiet, N_("don't print the patch filenames")),
1809 OPT_BOOL(0, "progress", &show_progress,
1810 N_("show progress while generating patches")),
1811 OPT_CALLBACK(0, "interdiff", &idiff_prev, N_("rev"),
1812 N_("show changes against <rev> in cover letter or single patch"),
1813 parse_opt_object_name),
1814 OPT_STRING(0, "range-diff", &rdiff_prev, N_("refspec"),
1815 N_("show changes against <refspec> in cover letter or single patch")),
1816 OPT_INTEGER(0, "creation-factor", &creation_factor,
1817 N_("percentage by which creation is weighted")),
1821 extra_hdr.strdup_strings = 1;
1822 extra_to.strdup_strings = 1;
1823 extra_cc.strdup_strings = 1;
1824 init_log_defaults();
1825 init_display_notes(¬es_opt);
1826 git_config(git_format_config, NULL);
1827 repo_init_revisions(the_repository, &rev, prefix);
1828 rev.show_notes = show_notes;
1829 memcpy(&rev.notes_opt, ¬es_opt, sizeof(notes_opt));
1830 rev.commit_format = CMIT_FMT_EMAIL;
1831 rev.encode_email_headers = default_encode_email_headers;
1832 rev.expand_tabs_in_log_default = 0;
1833 rev.verbose_header = 1;
1835 rev.max_parents = 1;
1836 rev.diffopt.flags.recursive = 1;
1837 rev.subject_prefix = fmt_patch_subject_prefix;
1838 memset(&s_r_opt, 0, sizeof(s_r_opt));
1839 s_r_opt.def = "HEAD";
1840 s_r_opt.revarg_opt = REVARG_COMMITTISH;
1842 if (default_attach) {
1843 rev.mime_boundary = default_attach;
1848 * Parse the arguments before setup_revisions(), or something
1849 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1850 * possibly a valid SHA1.
1852 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1853 builtin_format_patch_usage,
1854 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1855 PARSE_OPT_KEEP_DASHDASH);
1857 if (cover_from_description_arg)
1858 cover_from_description_mode = parse_cover_from_description(cover_from_description_arg);
1860 if (0 < reroll_count) {
1861 struct strbuf sprefix = STRBUF_INIT;
1862 strbuf_addf(&sprefix, "%s v%d",
1863 rev.subject_prefix, reroll_count);
1864 rev.reroll_count = reroll_count;
1865 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1868 for (i = 0; i < extra_hdr.nr; i++) {
1869 strbuf_addstr(&buf, extra_hdr.items[i].string);
1870 strbuf_addch(&buf, '\n');
1874 strbuf_addstr(&buf, "To: ");
1875 for (i = 0; i < extra_to.nr; i++) {
1877 strbuf_addstr(&buf, " ");
1878 strbuf_addstr(&buf, extra_to.items[i].string);
1879 if (i + 1 < extra_to.nr)
1880 strbuf_addch(&buf, ',');
1881 strbuf_addch(&buf, '\n');
1885 strbuf_addstr(&buf, "Cc: ");
1886 for (i = 0; i < extra_cc.nr; i++) {
1888 strbuf_addstr(&buf, " ");
1889 strbuf_addstr(&buf, extra_cc.items[i].string);
1890 if (i + 1 < extra_cc.nr)
1891 strbuf_addch(&buf, ',');
1892 strbuf_addch(&buf, '\n');
1895 rev.extra_headers = strbuf_detach(&buf, NULL);
1898 if (split_ident_line(&rev.from_ident, from, strlen(from)))
1899 die(_("invalid ident line: %s"), from);
1902 if (start_number < 0)
1906 * If numbered is set solely due to format.numbered in config,
1907 * and it would conflict with --keep-subject (-k) from the
1908 * command line, reset "numbered".
1910 if (numbered && keep_subject && !numbered_cmdline_opt)
1913 if (numbered && keep_subject)
1914 die(_("-n and -k are mutually exclusive"));
1915 if (keep_subject && subject_prefix)
1916 die(_("--subject-prefix/--rfc and -k are mutually exclusive"));
1917 rev.preserve_subject = keep_subject;
1919 argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1921 die(_("unrecognized argument: %s"), argv[1]);
1923 if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1924 die(_("--name-only does not make sense"));
1925 if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1926 die(_("--name-status does not make sense"));
1927 if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1928 die(_("--check does not make sense"));
1930 if (!use_patch_format &&
1931 (!rev.diffopt.output_format ||
1932 rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1933 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1934 if (!rev.diffopt.stat_width)
1935 rev.diffopt.stat_width = MAIL_DEFAULT_WRAP;
1937 /* Always generate a patch */
1938 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1940 rev.zero_commit = zero_commit;
1942 if (!rev.diffopt.flags.text && !no_binary_diff)
1943 rev.diffopt.flags.binary = 1;
1946 load_display_notes(&rev.notes_opt);
1948 if (use_stdout + rev.diffopt.close_file + !!output_directory > 1)
1949 die(_("--stdout, --output, and --output-directory are mutually exclusive"));
1953 } else if (rev.diffopt.close_file) {
1955 * The diff code parsed --output; it has already opened the
1956 * file, but but we must instruct it not to close after each
1959 rev.diffopt.close_file = 0;
1963 if (!output_directory)
1964 output_directory = config_output_directory;
1965 output_directory = set_outdir(prefix, output_directory);
1967 if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
1968 rev.diffopt.use_color = GIT_COLOR_NEVER;
1970 * We consider <outdir> as 'outside of gitdir', therefore avoid
1971 * applying adjust_shared_perm in s-c-l-d.
1973 saved = get_shared_repository();
1974 set_shared_repository(0);
1975 switch (safe_create_leading_directories_const(output_directory)) {
1980 die(_("could not create leading directories "
1981 "of '%s'"), output_directory);
1983 set_shared_repository(saved);
1984 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1985 die_errno(_("could not create directory '%s'"),
1989 if (rev.pending.nr == 1) {
1992 if (rev.max_count < 0 && !rev.show_root_diff) {
1994 * This is traditional behaviour of "git format-patch
1995 * origin" that prepares what the origin side still
1998 rev.pending.objects[0].item->flags |= UNINTERESTING;
1999 add_head_to_pending(&rev);
2003 * Otherwise, it is "format-patch -22 HEAD", and/or
2004 * "format-patch --root HEAD". The user wants
2005 * get_revision() to do the usual traversal.
2008 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
2012 const char *ref, *v;
2013 ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
2015 if (ref && skip_prefix(ref, "refs/heads/", &v))
2016 branch_name = xstrdup(v);
2018 branch_name = xstrdup(""); /* no branch */
2023 * We cannot move this anywhere earlier because we do want to
2024 * know if --root was given explicitly from the command line.
2026 rev.show_root_diff = 1;
2028 if (ignore_if_in_upstream) {
2029 /* Don't say anything if head and upstream are the same. */
2030 if (rev.pending.nr == 2) {
2031 struct object_array_entry *o = rev.pending.objects;
2032 if (oideq(&o[0].item->oid, &o[1].item->oid))
2035 get_patch_ids(&rev, &ids);
2038 if (prepare_revision_walk(&rev))
2039 die(_("revision walk setup failed"));
2041 while ((commit = get_revision(&rev)) != NULL) {
2042 if (commit->object.flags & BOUNDARY) {
2044 origin = (boundary_count == 1) ? commit : NULL;
2048 if (ignore_if_in_upstream && has_commit_patch_id(commit, &ids))
2052 REALLOC_ARRAY(list, nr);
2053 list[nr - 1] = commit;
2059 if (cover_letter == -1) {
2060 if (config_cover_letter == COVER_AUTO)
2061 cover_letter = (total > 1);
2063 cover_letter = (config_cover_letter == COVER_ON);
2065 if (!keep_subject && auto_number && (total > 1 || cover_letter))
2068 rev.total = total + start_number - 1;
2070 if (idiff_prev.nr) {
2071 if (!cover_letter && total != 1)
2072 die(_("--interdiff requires --cover-letter or single patch"));
2073 rev.idiff_oid1 = &idiff_prev.oid[idiff_prev.nr - 1];
2074 rev.idiff_oid2 = get_commit_tree_oid(list[0]);
2075 rev.idiff_title = diff_title(&idiff_title, reroll_count,
2077 _("Interdiff against v%d:"));
2080 if (creation_factor < 0)
2081 creation_factor = RANGE_DIFF_CREATION_FACTOR_DEFAULT;
2082 else if (!rdiff_prev)
2083 die(_("--creation-factor requires --range-diff"));
2086 if (!cover_letter && total != 1)
2087 die(_("--range-diff requires --cover-letter or single patch"));
2089 infer_range_diff_ranges(&rdiff1, &rdiff2, rdiff_prev,
2091 rev.rdiff1 = rdiff1.buf;
2092 rev.rdiff2 = rdiff2.buf;
2093 rev.creation_factor = creation_factor;
2094 rev.rdiff_title = diff_title(&rdiff_title, reroll_count,
2096 _("Range-diff against v%d:"));
2100 ; /* --no-signature inhibits all signatures */
2101 } else if (signature && signature != git_version_string) {
2102 ; /* non-default signature already set */
2103 } else if (signature_file) {
2104 struct strbuf buf = STRBUF_INIT;
2106 if (strbuf_read_file(&buf, signature_file, 128) < 0)
2107 die_errno(_("unable to read signature file '%s'"), signature_file);
2108 signature = strbuf_detach(&buf, NULL);
2111 memset(&bases, 0, sizeof(bases));
2112 base = get_base_commit(base_commit, list, nr);
2114 reset_revision_walk();
2115 clear_object_flags(UNINTERESTING);
2116 prepare_bases(&bases, base, list, nr);
2119 if (in_reply_to || thread || cover_letter)
2120 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
2122 const char *msgid = clean_message_id(in_reply_to);
2123 string_list_append(rev.ref_message_ids, msgid);
2125 rev.numbered_files = just_numbers;
2126 rev.patch_suffix = fmt_patch_suffix;
2129 gen_message_id(&rev, "cover");
2130 make_cover_letter(&rev, !!output_directory,
2131 origin, nr, list, branch_name, quiet);
2132 print_bases(&bases, rev.diffopt.file);
2133 print_signature(rev.diffopt.file);
2136 /* interdiff/range-diff in cover-letter; omit from patches */
2137 rev.idiff_oid1 = NULL;
2140 rev.add_signoff = do_signoff;
2143 progress = start_delayed_progress(_("Generating patches"), total);
2146 display_progress(progress, total - nr);
2148 rev.nr = total - nr + (start_number - 1);
2149 /* Make the second and subsequent mails replies to the first */
2151 /* Have we already had a message ID? */
2152 if (rev.message_id) {
2154 * For deep threading: make every mail
2155 * a reply to the previous one, no
2156 * matter what other options are set.
2158 * For shallow threading:
2160 * Without --cover-letter and
2161 * --in-reply-to, make every mail a
2162 * reply to the one before.
2164 * With --in-reply-to but no
2165 * --cover-letter, make every mail a
2166 * reply to the <reply-to>.
2168 * With --cover-letter, make every
2169 * mail but the cover letter a reply
2170 * to the cover letter. The cover
2171 * letter is a reply to the
2172 * --in-reply-to, if specified.
2174 if (thread == THREAD_SHALLOW
2175 && rev.ref_message_ids->nr > 0
2176 && (!cover_letter || rev.nr > 1))
2177 free(rev.message_id);
2179 string_list_append(rev.ref_message_ids,
2182 gen_message_id(&rev, oid_to_hex(&commit->object.oid));
2185 if (output_directory &&
2186 open_next_file(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
2187 die(_("failed to create output files"));
2188 shown = log_tree_commit(&rev, commit);
2189 free_commit_buffer(the_repository->parsed_objects,
2192 /* We put one extra blank line between formatted
2193 * patches and this flag is used by log-tree code
2194 * to see if it needs to emit a LF before showing
2195 * the log; when using one file per patch, we do
2196 * not want the extra blank line.
2198 if (output_directory)
2201 print_bases(&bases, rev.diffopt.file);
2202 if (rev.mime_boundary)
2203 fprintf(rev.diffopt.file, "\n--%s%s--\n\n\n",
2204 mime_boundary_leader,
2207 print_signature(rev.diffopt.file);
2209 if (output_directory)
2210 fclose(rev.diffopt.file);
2212 stop_progress(&progress);
2215 string_list_clear(&extra_to, 0);
2216 string_list_clear(&extra_cc, 0);
2217 string_list_clear(&extra_hdr, 0);
2218 if (ignore_if_in_upstream)
2219 free_patch_ids(&ids);
2222 oid_array_clear(&idiff_prev);
2223 strbuf_release(&idiff_title);
2224 strbuf_release(&rdiff1);
2225 strbuf_release(&rdiff2);
2226 strbuf_release(&rdiff_title);
2230 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
2232 struct object_id oid;
2233 if (get_oid(arg, &oid) == 0) {
2234 struct commit *commit = lookup_commit_reference(the_repository,
2237 commit->object.flags |= flags;
2238 add_pending_object(revs, &commit->object, arg);
2245 static const char * const cherry_usage[] = {
2246 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
2250 static void print_commit(char sign, struct commit *commit, int verbose,
2251 int abbrev, FILE *file)
2254 fprintf(file, "%c %s\n", sign,
2255 find_unique_abbrev(&commit->object.oid, abbrev));
2257 struct strbuf buf = STRBUF_INIT;
2258 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
2259 fprintf(file, "%c %s %s\n", sign,
2260 find_unique_abbrev(&commit->object.oid, abbrev),
2262 strbuf_release(&buf);
2266 int cmd_cherry(int argc, const char **argv, const char *prefix)
2268 struct rev_info revs;
2269 struct patch_ids ids;
2270 struct commit *commit;
2271 struct commit_list *list = NULL;
2272 struct branch *current_branch;
2273 const char *upstream;
2274 const char *head = "HEAD";
2275 const char *limit = NULL;
2276 int verbose = 0, abbrev = 0;
2278 struct option options[] = {
2279 OPT__ABBREV(&abbrev),
2280 OPT__VERBOSE(&verbose, N_("be verbose")),
2284 argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
2297 current_branch = branch_get(NULL);
2298 upstream = branch_get_upstream(current_branch, NULL);
2300 fprintf(stderr, _("Could not find a tracked"
2301 " remote branch, please"
2302 " specify <upstream> manually.\n"));
2303 usage_with_options(cherry_usage, options);
2307 repo_init_revisions(the_repository, &revs, prefix);
2308 revs.max_parents = 1;
2310 if (add_pending_commit(head, &revs, 0))
2311 die(_("unknown commit %s"), head);
2312 if (add_pending_commit(upstream, &revs, UNINTERESTING))
2313 die(_("unknown commit %s"), upstream);
2315 /* Don't say anything if head and upstream are the same. */
2316 if (revs.pending.nr == 2) {
2317 struct object_array_entry *o = revs.pending.objects;
2318 if (oideq(&o[0].item->oid, &o[1].item->oid))
2322 get_patch_ids(&revs, &ids);
2324 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
2325 die(_("unknown commit %s"), limit);
2327 /* reverse the list of commits */
2328 if (prepare_revision_walk(&revs))
2329 die(_("revision walk setup failed"));
2330 while ((commit = get_revision(&revs)) != NULL) {
2331 commit_list_insert(commit, &list);
2337 commit = list->item;
2338 if (has_commit_patch_id(commit, &ids))
2340 print_commit(sign, commit, verbose, abbrev, revs.diffopt.file);
2344 free_patch_ids(&ids);