2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
15 #include "reflog-walk.h"
16 #include "patch-ids.h"
17 #include "run-command.h"
20 #include "string-list.h"
21 #include "parse-options.h"
23 #include "streaming.h"
27 /* Set a default date-time format for git log ("log.date" config variable) */
28 static const char *default_date_mode = NULL;
30 static int default_abbrev_commit;
31 static int default_show_root = 1;
32 static int decoration_style;
33 static int decoration_given;
34 static int use_mailmap_config;
35 static const char *fmt_patch_subject_prefix = "PATCH";
36 static const char *fmt_pretty;
38 static const char * const builtin_log_usage[] = {
39 N_("git log [<options>] [<since>..<until>] [[--] <path>...]\n")
40 N_(" or: git show [options] <object>..."),
44 static int parse_decoration_style(const char *var, const char *value)
46 switch (git_config_maybe_bool(var, value)) {
48 return DECORATE_SHORT_REFS;
54 if (!strcmp(value, "full"))
55 return DECORATE_FULL_REFS;
56 else if (!strcmp(value, "short"))
57 return DECORATE_SHORT_REFS;
61 static int decorate_callback(const struct option *opt, const char *arg, int unset)
66 decoration_style = parse_decoration_style("command line", arg);
68 decoration_style = DECORATE_SHORT_REFS;
70 if (decoration_style < 0)
71 die("invalid --decorate option: %s", arg);
78 static void cmd_log_init_defaults(struct rev_info *rev)
81 get_commit_format(fmt_pretty, rev);
82 rev->verbose_header = 1;
83 DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
84 rev->diffopt.stat_width = -1; /* use full terminal width */
85 rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
86 rev->abbrev_commit = default_abbrev_commit;
87 rev->show_root_diff = default_show_root;
88 rev->subject_prefix = fmt_patch_subject_prefix;
89 DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
91 if (default_date_mode)
92 rev->date_mode = parse_date_format(default_date_mode);
95 static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
96 struct rev_info *rev, struct setup_revision_opt *opt)
98 struct userformat_want w;
99 int quiet = 0, source = 0, mailmap = 0;
101 const struct option builtin_log_options[] = {
102 OPT_BOOLEAN(0, "quiet", &quiet, N_("suppress diff output")),
103 OPT_BOOLEAN(0, "source", &source, N_("show source")),
104 OPT_BOOLEAN(0, "use-mailmap", &mailmap, N_("Use mail map file")),
105 { OPTION_CALLBACK, 0, "decorate", NULL, NULL, N_("decorate options"),
106 PARSE_OPT_OPTARG, decorate_callback},
110 mailmap = use_mailmap_config;
111 argc = parse_options(argc, argv, prefix,
112 builtin_log_options, builtin_log_usage,
113 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
114 PARSE_OPT_KEEP_DASHDASH);
117 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
118 argc = setup_revisions(argc, argv, rev, opt);
120 /* Any arguments at this point are not recognized */
122 die("unrecognized argument: %s", argv[1]);
124 memset(&w, 0, sizeof(w));
125 userformat_find_requirements(NULL, &w);
127 if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
130 init_display_notes(&rev->notes_opt);
132 if (rev->diffopt.pickaxe || rev->diffopt.filter)
133 rev->always_show_header = 0;
134 if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
135 rev->always_show_header = 0;
136 if (rev->diffopt.pathspec.nr != 1)
137 usage("git logs can only follow renames on one pathname at a time");
141 rev->show_source = 1;
144 rev->mailmap = xcalloc(1, sizeof(struct string_list));
145 read_mailmap(rev->mailmap, NULL);
148 if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
150 * "log --pretty=raw" is special; ignore UI oriented
151 * configuration variables such as decoration.
153 if (!decoration_given)
154 decoration_style = 0;
155 if (!rev->abbrev_commit_given)
156 rev->abbrev_commit = 0;
159 if (decoration_style) {
160 rev->show_decorations = 1;
161 load_ref_decorations(decoration_style);
166 static void cmd_log_init(int argc, const char **argv, const char *prefix,
167 struct rev_info *rev, struct setup_revision_opt *opt)
169 cmd_log_init_defaults(rev);
170 cmd_log_init_finish(argc, argv, prefix, rev, opt);
174 * This gives a rough estimate for how many commits we
175 * will print out in the list.
177 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
182 struct commit *commit = list->item;
183 unsigned int flags = commit->object.flags;
185 if (!(flags & (TREESAME | UNINTERESTING)))
191 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
193 if (rev->shown_one) {
195 if (rev->commit_format != CMIT_FMT_ONELINE)
196 putchar(rev->diffopt.line_termination);
198 printf(_("Final output: %d %s\n"), nr, stage);
201 static struct itimerval early_output_timer;
203 static void log_show_early(struct rev_info *revs, struct commit_list *list)
205 int i = revs->early_output;
208 sort_in_topological_order(&list, revs->lifo);
210 struct commit *commit = list->item;
211 switch (simplify_commit(revs, commit)) {
214 int n = estimate_commit_count(revs, list);
215 show_early_header(revs, "incomplete", n);
218 log_tree_commit(revs, commit);
229 /* Did we already get enough commits for the early output? */
234 * ..if no, then repeat it twice a second until we
237 * NOTE! We don't use "it_interval", because if the
238 * reader isn't listening, we want our output to be
239 * throttled by the writing, and not have the timer
240 * trigger every second even if we're blocked on a
243 early_output_timer.it_value.tv_sec = 0;
244 early_output_timer.it_value.tv_usec = 500000;
245 setitimer(ITIMER_REAL, &early_output_timer, NULL);
248 static void early_output(int signal)
250 show_early_output = log_show_early;
253 static void setup_early_output(struct rev_info *rev)
258 * Set up the signal handler, minimally intrusively:
259 * we only set a single volatile integer word (not
260 * using sigatomic_t - trying to avoid unnecessary
261 * system dependencies and headers), and using
264 memset(&sa, 0, sizeof(sa));
265 sa.sa_handler = early_output;
266 sigemptyset(&sa.sa_mask);
267 sa.sa_flags = SA_RESTART;
268 sigaction(SIGALRM, &sa, NULL);
271 * If we can get the whole output in less than a
272 * tenth of a second, don't even bother doing the
273 * early-output thing..
275 * This is a one-time-only trigger.
277 early_output_timer.it_value.tv_sec = 0;
278 early_output_timer.it_value.tv_usec = 100000;
279 setitimer(ITIMER_REAL, &early_output_timer, NULL);
282 static void finish_early_output(struct rev_info *rev)
284 int n = estimate_commit_count(rev, rev->commits);
285 signal(SIGALRM, SIG_IGN);
286 show_early_header(rev, "done", n);
289 static int cmd_log_walk(struct rev_info *rev)
291 struct commit *commit;
295 if (rev->early_output)
296 setup_early_output(rev);
298 if (prepare_revision_walk(rev))
299 die(_("revision walk setup failed"));
301 if (rev->early_output)
302 finish_early_output(rev);
305 * For --check and --exit-code, the exit code is based on CHECK_FAILED
306 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
307 * retain that state information if replacing rev->diffopt in this loop
309 while ((commit = get_revision(rev)) != NULL) {
310 if (!log_tree_commit(rev, commit) &&
313 * We decremented max_count in get_revision,
314 * but we didn't actually show the commit.
317 if (!rev->reflog_info) {
318 /* we allow cycles in reflog ancestry */
319 free(commit->buffer);
320 commit->buffer = NULL;
322 free_commit_list(commit->parents);
323 commit->parents = NULL;
324 if (saved_nrl < rev->diffopt.needed_rename_limit)
325 saved_nrl = rev->diffopt.needed_rename_limit;
326 if (rev->diffopt.degraded_cc_to_c)
329 rev->diffopt.degraded_cc_to_c = saved_dcctc;
330 rev->diffopt.needed_rename_limit = saved_nrl;
332 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
333 DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
336 return diff_result_code(&rev->diffopt, 0);
339 static int git_log_config(const char *var, const char *value, void *cb)
341 if (!strcmp(var, "format.pretty"))
342 return git_config_string(&fmt_pretty, var, value);
343 if (!strcmp(var, "format.subjectprefix"))
344 return git_config_string(&fmt_patch_subject_prefix, var, value);
345 if (!strcmp(var, "log.abbrevcommit")) {
346 default_abbrev_commit = git_config_bool(var, value);
349 if (!strcmp(var, "log.date"))
350 return git_config_string(&default_date_mode, var, value);
351 if (!strcmp(var, "log.decorate")) {
352 decoration_style = parse_decoration_style(var, value);
353 if (decoration_style < 0)
354 decoration_style = 0; /* maybe warn? */
357 if (!strcmp(var, "log.showroot")) {
358 default_show_root = git_config_bool(var, value);
361 if (!prefixcmp(var, "color.decorate."))
362 return parse_decorate_color_config(var, 15, value);
363 if (!strcmp(var, "log.mailmap")) {
364 use_mailmap_config = git_config_bool(var, value);
368 if (grep_config(var, value, cb) < 0)
370 return git_diff_ui_config(var, value, cb);
373 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
376 struct setup_revision_opt opt;
378 init_grep_defaults();
379 git_config(git_log_config, NULL);
381 init_revisions(&rev, prefix);
383 rev.simplify_history = 0;
384 memset(&opt, 0, sizeof(opt));
386 opt.revarg_opt = REVARG_COMMITTISH;
387 cmd_log_init(argc, argv, prefix, &rev, &opt);
388 if (!rev.diffopt.output_format)
389 rev.diffopt.output_format = DIFF_FORMAT_RAW;
390 return cmd_log_walk(&rev);
393 static void show_tagger(char *buf, int len, struct rev_info *rev)
395 struct strbuf out = STRBUF_INIT;
396 struct pretty_print_context pp = {0};
398 pp.fmt = rev->commit_format;
399 pp.date_mode = rev->date_mode;
400 pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
401 printf("%s", out.buf);
402 strbuf_release(&out);
405 static int show_blob_object(const unsigned char *sha1, struct rev_info *rev)
408 return stream_blob_to_fd(1, sha1, NULL, 0);
411 static int show_tag_object(const unsigned char *sha1, struct rev_info *rev)
414 enum object_type type;
415 char *buf = read_sha1_file(sha1, &type, &size);
419 return error(_("Could not read object %s"), sha1_to_hex(sha1));
421 assert(type == OBJ_TAG);
422 while (offset < size && buf[offset] != '\n') {
423 int new_offset = offset + 1;
424 while (new_offset < size && buf[new_offset++] != '\n')
426 if (!prefixcmp(buf + offset, "tagger "))
427 show_tagger(buf + offset + 7,
428 new_offset - offset - 7, rev);
433 fwrite(buf + offset, size - offset, 1, stdout);
438 static int show_tree_object(const unsigned char *sha1,
439 const char *base, int baselen,
440 const char *pathname, unsigned mode, int stage, void *context)
442 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
446 static void show_rev_tweak_rev(struct rev_info *rev, struct setup_revision_opt *opt)
448 if (rev->ignore_merges) {
449 /* There was no "-m" on the command line */
450 rev->ignore_merges = 0;
451 if (!rev->first_parent_only && !rev->combine_merges) {
452 /* No "--first-parent", "-c", nor "--cc" */
453 rev->combine_merges = 1;
454 rev->dense_combined_merges = 1;
457 if (!rev->diffopt.output_format)
458 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
461 int cmd_show(int argc, const char **argv, const char *prefix)
464 struct object_array_entry *objects;
465 struct setup_revision_opt opt;
466 struct pathspec match_all;
467 int i, count, ret = 0;
469 init_grep_defaults();
470 git_config(git_log_config, NULL);
472 init_pathspec(&match_all, NULL);
473 init_revisions(&rev, prefix);
475 rev.always_show_header = 1;
476 rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
477 rev.diffopt.stat_width = -1; /* Scale to real terminal size */
479 memset(&opt, 0, sizeof(opt));
481 opt.tweak = show_rev_tweak_rev;
482 cmd_log_init(argc, argv, prefix, &rev, &opt);
485 return cmd_log_walk(&rev);
487 count = rev.pending.nr;
488 objects = rev.pending.objects;
489 for (i = 0; i < count && !ret; i++) {
490 struct object *o = objects[i].item;
491 const char *name = objects[i].name;
494 ret = show_blob_object(o->sha1, NULL);
497 struct tag *t = (struct tag *)o;
501 printf("%stag %s%s\n",
502 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
504 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
505 ret = show_tag_object(o->sha1, &rev);
509 o = parse_object(t->tagged->sha1);
511 ret = error(_("Could not read object %s"),
512 sha1_to_hex(t->tagged->sha1));
520 printf("%stree %s%s\n\n",
521 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
523 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
524 read_tree_recursive((struct tree *)o, "", 0, 0, &match_all,
525 show_tree_object, NULL);
529 rev.pending.nr = rev.pending.alloc = 0;
530 rev.pending.objects = NULL;
531 add_object_array(o, name, &rev.pending);
532 ret = cmd_log_walk(&rev);
535 ret = error(_("Unknown type: %d"), o->type);
543 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
545 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
548 struct setup_revision_opt opt;
550 init_grep_defaults();
551 git_config(git_log_config, NULL);
553 init_revisions(&rev, prefix);
554 init_reflog_walk(&rev.reflog_info);
555 rev.verbose_header = 1;
556 memset(&opt, 0, sizeof(opt));
558 cmd_log_init_defaults(&rev);
559 rev.abbrev_commit = 1;
560 rev.commit_format = CMIT_FMT_ONELINE;
561 rev.use_terminator = 1;
562 rev.always_show_header = 1;
563 cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
565 return cmd_log_walk(&rev);
568 int cmd_log(int argc, const char **argv, const char *prefix)
571 struct setup_revision_opt opt;
573 init_grep_defaults();
574 git_config(git_log_config, NULL);
576 init_revisions(&rev, prefix);
577 rev.always_show_header = 1;
578 memset(&opt, 0, sizeof(opt));
580 opt.revarg_opt = REVARG_COMMITTISH;
581 cmd_log_init(argc, argv, prefix, &rev, &opt);
582 return cmd_log_walk(&rev);
587 static const char *fmt_patch_suffix = ".patch";
588 static int numbered = 0;
589 static int auto_number = 1;
591 static char *default_attach = NULL;
593 static struct string_list extra_hdr;
594 static struct string_list extra_to;
595 static struct string_list extra_cc;
597 static void add_header(const char *value)
599 struct string_list_item *item;
600 int len = strlen(value);
601 while (len && value[len - 1] == '\n')
604 if (!strncasecmp(value, "to: ", 4)) {
605 item = string_list_append(&extra_to, value + 4);
607 } else if (!strncasecmp(value, "cc: ", 4)) {
608 item = string_list_append(&extra_cc, value + 4);
611 item = string_list_append(&extra_hdr, value);
614 item->string[len] = '\0';
617 #define THREAD_SHALLOW 1
618 #define THREAD_DEEP 2
620 static int do_signoff;
621 static const char *signature = git_version_string;
623 static int git_format_config(const char *var, const char *value, void *cb)
625 if (!strcmp(var, "format.headers")) {
627 die(_("format.headers without value"));
631 if (!strcmp(var, "format.suffix"))
632 return git_config_string(&fmt_patch_suffix, var, value);
633 if (!strcmp(var, "format.to")) {
635 return config_error_nonbool(var);
636 string_list_append(&extra_to, value);
639 if (!strcmp(var, "format.cc")) {
641 return config_error_nonbool(var);
642 string_list_append(&extra_cc, value);
645 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
646 !strcmp(var, "color.ui")) {
649 if (!strcmp(var, "format.numbered")) {
650 if (value && !strcasecmp(value, "auto")) {
654 numbered = git_config_bool(var, value);
655 auto_number = auto_number && numbered;
658 if (!strcmp(var, "format.attach")) {
660 default_attach = xstrdup(value);
662 default_attach = xstrdup(git_version_string);
665 if (!strcmp(var, "format.thread")) {
666 if (value && !strcasecmp(value, "deep")) {
667 thread = THREAD_DEEP;
670 if (value && !strcasecmp(value, "shallow")) {
671 thread = THREAD_SHALLOW;
674 thread = git_config_bool(var, value) && THREAD_SHALLOW;
677 if (!strcmp(var, "format.signoff")) {
678 do_signoff = git_config_bool(var, value);
681 if (!strcmp(var, "format.signature"))
682 return git_config_string(&signature, var, value);
684 return git_log_config(var, value, cb);
687 static FILE *realstdout = NULL;
688 static const char *output_directory = NULL;
689 static int outdir_offset;
691 static int reopen_stdout(struct commit *commit, const char *subject,
692 struct rev_info *rev, int quiet)
694 struct strbuf filename = STRBUF_INIT;
695 int suffix_len = strlen(rev->patch_suffix) + 1;
697 if (output_directory) {
698 strbuf_addstr(&filename, output_directory);
700 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
701 return error(_("name of output directory is too long"));
702 if (filename.buf[filename.len - 1] != '/')
703 strbuf_addch(&filename, '/');
706 if (rev->numbered_files)
707 strbuf_addf(&filename, "%d", rev->nr);
709 fmt_output_commit(&filename, commit, rev);
711 fmt_output_subject(&filename, subject, rev);
714 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
716 if (freopen(filename.buf, "w", stdout) == NULL)
717 return error(_("Cannot open patch file %s"), filename.buf);
719 strbuf_release(&filename);
723 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
725 struct rev_info check_rev;
726 struct commit *commit;
727 struct object *o1, *o2;
728 unsigned flags1, flags2;
730 if (rev->pending.nr != 2)
731 die(_("Need exactly one range."));
733 o1 = rev->pending.objects[0].item;
735 o2 = rev->pending.objects[1].item;
738 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
739 die(_("Not a range."));
743 /* given a range a..b get all patch ids for b..a */
744 init_revisions(&check_rev, rev->prefix);
745 check_rev.max_parents = 1;
746 o1->flags ^= UNINTERESTING;
747 o2->flags ^= UNINTERESTING;
748 add_pending_object(&check_rev, o1, "o1");
749 add_pending_object(&check_rev, o2, "o2");
750 if (prepare_revision_walk(&check_rev))
751 die(_("revision walk setup failed"));
753 while ((commit = get_revision(&check_rev)) != NULL) {
754 add_commit_patch_id(commit, ids);
757 /* reset for next revision walk */
758 clear_commit_marks((struct commit *)o1,
759 SEEN | UNINTERESTING | SHOWN | ADDED);
760 clear_commit_marks((struct commit *)o2,
761 SEEN | UNINTERESTING | SHOWN | ADDED);
766 static void gen_message_id(struct rev_info *info, char *base)
768 struct strbuf buf = STRBUF_INIT;
769 strbuf_addf(&buf, "%s.%lu.git.%s", base,
770 (unsigned long) time(NULL),
771 git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
772 info->message_id = strbuf_detach(&buf, NULL);
775 static void print_signature(void)
777 if (signature && *signature)
778 printf("-- \n%s\n\n", signature);
781 static void add_branch_description(struct strbuf *buf, const char *branch_name)
783 struct strbuf desc = STRBUF_INIT;
784 if (!branch_name || !*branch_name)
786 read_branch_desc(&desc, branch_name);
788 strbuf_addch(buf, '\n');
789 strbuf_add(buf, desc.buf, desc.len);
790 strbuf_addch(buf, '\n');
794 static void make_cover_letter(struct rev_info *rev, int use_stdout,
795 struct commit *origin,
796 int nr, struct commit **list, struct commit *head,
797 const char *branch_name,
800 const char *committer;
801 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
804 struct strbuf sb = STRBUF_INIT;
806 const char *encoding = "UTF-8";
807 struct diff_options opts;
808 int need_8bit_cte = 0;
809 struct pretty_print_context pp = {0};
811 if (rev->commit_format != CMIT_FMT_EMAIL)
812 die(_("Cover letter needs email format"));
814 committer = git_committer_info(0);
817 reopen_stdout(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
820 log_write_email_headers(rev, head, &pp.subject, &pp.after_subject,
823 for (i = 0; !need_8bit_cte && i < nr; i++)
824 if (has_non_ascii(list[i]->buffer))
828 pp.fmt = CMIT_FMT_EMAIL;
829 pp.date_mode = DATE_RFC2822;
830 pp_user_info(&pp, NULL, &sb, committer, encoding);
831 pp_title_line(&pp, &msg, &sb, encoding, need_8bit_cte);
832 pp_remainder(&pp, &msg, &sb, 0);
833 add_branch_description(&sb, branch_name);
834 printf("%s\n", sb.buf);
843 for (i = 0; i < nr; i++)
844 shortlog_add_commit(&log, list[i]);
846 shortlog_output(&log);
849 * We can only do diffstat with a unique reference point
854 memcpy(&opts, &rev->diffopt, sizeof(opts));
855 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
857 diff_setup_done(&opts);
859 diff_tree_sha1(origin->tree->object.sha1,
860 head->tree->object.sha1,
869 static const char *clean_message_id(const char *msg_id)
872 const char *a, *z, *m;
875 while ((ch = *m) && (isspace(ch) || (ch == '<')))
880 if (!isspace(ch) && (ch != '>'))
885 die(_("insane in-reply-to: %s"), msg_id);
888 return xmemdupz(a, z - a);
891 static const char *set_outdir(const char *prefix, const char *output_directory)
893 if (output_directory && is_absolute_path(output_directory))
894 return output_directory;
896 if (!prefix || !*prefix) {
897 if (output_directory)
898 return output_directory;
899 /* The user did not explicitly ask for "./" */
904 outdir_offset = strlen(prefix);
905 if (!output_directory)
908 return xstrdup(prefix_filename(prefix, outdir_offset,
912 static const char * const builtin_format_patch_usage[] = {
913 N_("git format-patch [options] [<since> | <revision range>]"),
917 static int keep_subject = 0;
919 static int keep_callback(const struct option *opt, const char *arg, int unset)
921 ((struct rev_info *)opt->value)->total = -1;
926 static int subject_prefix = 0;
928 static int subject_prefix_callback(const struct option *opt, const char *arg,
932 ((struct rev_info *)opt->value)->subject_prefix = arg;
936 static int numbered_cmdline_opt = 0;
938 static int numbered_callback(const struct option *opt, const char *arg,
941 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
947 static int no_numbered_callback(const struct option *opt, const char *arg,
950 return numbered_callback(opt, arg, 1);
953 static int output_directory_callback(const struct option *opt, const char *arg,
956 const char **dir = (const char **)opt->value;
958 die(_("Two output directories?"));
963 static int thread_callback(const struct option *opt, const char *arg, int unset)
965 int *thread = (int *)opt->value;
968 else if (!arg || !strcmp(arg, "shallow"))
969 *thread = THREAD_SHALLOW;
970 else if (!strcmp(arg, "deep"))
971 *thread = THREAD_DEEP;
977 static int attach_callback(const struct option *opt, const char *arg, int unset)
979 struct rev_info *rev = (struct rev_info *)opt->value;
981 rev->mime_boundary = NULL;
983 rev->mime_boundary = arg;
985 rev->mime_boundary = git_version_string;
986 rev->no_inline = unset ? 0 : 1;
990 static int inline_callback(const struct option *opt, const char *arg, int unset)
992 struct rev_info *rev = (struct rev_info *)opt->value;
994 rev->mime_boundary = NULL;
996 rev->mime_boundary = arg;
998 rev->mime_boundary = git_version_string;
1003 static int header_callback(const struct option *opt, const char *arg, int unset)
1006 string_list_clear(&extra_hdr, 0);
1007 string_list_clear(&extra_to, 0);
1008 string_list_clear(&extra_cc, 0);
1015 static int to_callback(const struct option *opt, const char *arg, int unset)
1018 string_list_clear(&extra_to, 0);
1020 string_list_append(&extra_to, arg);
1024 static int cc_callback(const struct option *opt, const char *arg, int unset)
1027 string_list_clear(&extra_cc, 0);
1029 string_list_append(&extra_cc, arg);
1033 static char *find_branch_name(struct rev_info *rev)
1035 int i, positive = -1;
1036 unsigned char branch_sha1[20];
1037 const unsigned char *tip_sha1;
1039 char *full_ref, *branch = NULL;
1041 for (i = 0; i < rev->cmdline.nr; i++) {
1042 if (rev->cmdline.rev[i].flags & UNINTERESTING)
1049 if (0 <= positive) {
1050 ref = rev->cmdline.rev[positive].name;
1051 tip_sha1 = rev->cmdline.rev[positive].item->sha1;
1052 } else if (!rev->cmdline.nr && rev->pending.nr == 1 &&
1053 !strcmp(rev->pending.objects[0].name, "HEAD")) {
1055 * No actual ref from command line, but "HEAD" from
1056 * rev->def was added in setup_revisions()
1057 * e.g. format-patch --cover-letter -12
1060 tip_sha1 = rev->pending.objects[0].item->sha1;
1064 if (dwim_ref(ref, strlen(ref), branch_sha1, &full_ref) &&
1065 !prefixcmp(full_ref, "refs/heads/") &&
1066 !hashcmp(tip_sha1, branch_sha1))
1067 branch = xstrdup(full_ref + strlen("refs/heads/"));
1072 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1074 struct commit *commit;
1075 struct commit **list = NULL;
1076 struct rev_info rev;
1077 struct setup_revision_opt s_r_opt;
1078 int nr = 0, total, i;
1080 int start_number = -1;
1081 int just_numbers = 0;
1082 int ignore_if_in_upstream = 0;
1083 int cover_letter = 0;
1084 int boundary_count = 0;
1085 int no_binary_diff = 0;
1086 struct commit *origin = NULL, *head = NULL;
1087 const char *in_reply_to = NULL;
1088 struct patch_ids ids;
1089 struct strbuf buf = STRBUF_INIT;
1090 int use_patch_format = 0;
1092 int reroll_count = -1;
1093 char *branch_name = NULL;
1094 const struct option builtin_format_patch_options[] = {
1095 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
1096 N_("use [PATCH n/m] even with a single patch"),
1097 PARSE_OPT_NOARG, numbered_callback },
1098 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
1099 N_("use [PATCH] even with multiple patches"),
1100 PARSE_OPT_NOARG, no_numbered_callback },
1101 OPT_BOOLEAN('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
1102 OPT_BOOLEAN(0, "stdout", &use_stdout,
1103 N_("print patches to standard out")),
1104 OPT_BOOLEAN(0, "cover-letter", &cover_letter,
1105 N_("generate a cover letter")),
1106 OPT_BOOLEAN(0, "numbered-files", &just_numbers,
1107 N_("use simple number sequence for output file names")),
1108 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1109 N_("use <sfx> instead of '.patch'")),
1110 OPT_INTEGER(0, "start-number", &start_number,
1111 N_("start numbering patches at <n> instead of 1")),
1112 OPT_INTEGER('v', "reroll-count", &reroll_count,
1113 N_("mark the series as Nth re-roll")),
1114 { OPTION_CALLBACK, 0, "subject-prefix", &rev, N_("prefix"),
1115 N_("Use [<prefix>] instead of [PATCH]"),
1116 PARSE_OPT_NONEG, subject_prefix_callback },
1117 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
1118 N_("dir"), N_("store resulting files in <dir>"),
1119 PARSE_OPT_NONEG, output_directory_callback },
1120 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
1121 N_("don't strip/add [PATCH]"),
1122 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
1123 OPT_BOOLEAN(0, "no-binary", &no_binary_diff,
1124 N_("don't output binary diffs")),
1125 OPT_BOOLEAN(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1126 N_("don't include a patch matching a commit upstream")),
1127 { OPTION_BOOLEAN, 'p', "no-stat", &use_patch_format, NULL,
1128 N_("show patch format instead of default (patch + stat)"),
1129 PARSE_OPT_NONEG | PARSE_OPT_NOARG },
1130 OPT_GROUP(N_("Messaging")),
1131 { OPTION_CALLBACK, 0, "add-header", NULL, N_("header"),
1132 N_("add email header"), 0, header_callback },
1133 { OPTION_CALLBACK, 0, "to", NULL, N_("email"), N_("add To: header"),
1135 { OPTION_CALLBACK, 0, "cc", NULL, N_("email"), N_("add Cc: header"),
1137 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1138 N_("make first mail a reply to <message-id>")),
1139 { OPTION_CALLBACK, 0, "attach", &rev, N_("boundary"),
1140 N_("attach the patch"), PARSE_OPT_OPTARG,
1142 { OPTION_CALLBACK, 0, "inline", &rev, N_("boundary"),
1143 N_("inline the patch"),
1144 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1146 { OPTION_CALLBACK, 0, "thread", &thread, N_("style"),
1147 N_("enable message threading, styles: shallow, deep"),
1148 PARSE_OPT_OPTARG, thread_callback },
1149 OPT_STRING(0, "signature", &signature, N_("signature"),
1150 N_("add a signature")),
1151 OPT_BOOLEAN(0, "quiet", &quiet,
1152 N_("don't print the patch filenames")),
1156 extra_hdr.strdup_strings = 1;
1157 extra_to.strdup_strings = 1;
1158 extra_cc.strdup_strings = 1;
1159 init_grep_defaults();
1160 git_config(git_format_config, NULL);
1161 init_revisions(&rev, prefix);
1162 rev.commit_format = CMIT_FMT_EMAIL;
1163 rev.verbose_header = 1;
1165 rev.max_parents = 1;
1166 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
1167 rev.subject_prefix = fmt_patch_subject_prefix;
1168 memset(&s_r_opt, 0, sizeof(s_r_opt));
1169 s_r_opt.def = "HEAD";
1170 s_r_opt.revarg_opt = REVARG_COMMITTISH;
1172 if (default_attach) {
1173 rev.mime_boundary = default_attach;
1178 * Parse the arguments before setup_revisions(), or something
1179 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1180 * possibly a valid SHA1.
1182 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1183 builtin_format_patch_usage,
1184 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1185 PARSE_OPT_KEEP_DASHDASH);
1187 if (0 < reroll_count) {
1188 struct strbuf sprefix = STRBUF_INIT;
1189 strbuf_addf(&sprefix, "%s v%d",
1190 rev.subject_prefix, reroll_count);
1191 rev.reroll_count = reroll_count;
1192 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1195 for (i = 0; i < extra_hdr.nr; i++) {
1196 strbuf_addstr(&buf, extra_hdr.items[i].string);
1197 strbuf_addch(&buf, '\n');
1201 strbuf_addstr(&buf, "To: ");
1202 for (i = 0; i < extra_to.nr; i++) {
1204 strbuf_addstr(&buf, " ");
1205 strbuf_addstr(&buf, extra_to.items[i].string);
1206 if (i + 1 < extra_to.nr)
1207 strbuf_addch(&buf, ',');
1208 strbuf_addch(&buf, '\n');
1212 strbuf_addstr(&buf, "Cc: ");
1213 for (i = 0; i < extra_cc.nr; i++) {
1215 strbuf_addstr(&buf, " ");
1216 strbuf_addstr(&buf, extra_cc.items[i].string);
1217 if (i + 1 < extra_cc.nr)
1218 strbuf_addch(&buf, ',');
1219 strbuf_addch(&buf, '\n');
1222 rev.extra_headers = strbuf_detach(&buf, NULL);
1224 if (start_number < 0)
1228 * If numbered is set solely due to format.numbered in config,
1229 * and it would conflict with --keep-subject (-k) from the
1230 * command line, reset "numbered".
1232 if (numbered && keep_subject && !numbered_cmdline_opt)
1235 if (numbered && keep_subject)
1236 die (_("-n and -k are mutually exclusive."));
1237 if (keep_subject && subject_prefix)
1238 die (_("--subject-prefix and -k are mutually exclusive."));
1239 rev.preserve_subject = keep_subject;
1241 argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1243 die (_("unrecognized argument: %s"), argv[1]);
1245 if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1246 die(_("--name-only does not make sense"));
1247 if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1248 die(_("--name-status does not make sense"));
1249 if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1250 die(_("--check does not make sense"));
1252 if (!use_patch_format &&
1253 (!rev.diffopt.output_format ||
1254 rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1255 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1257 /* Always generate a patch */
1258 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1260 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
1261 DIFF_OPT_SET(&rev.diffopt, BINARY);
1264 init_display_notes(&rev.notes_opt);
1267 output_directory = set_outdir(prefix, output_directory);
1271 if (output_directory) {
1273 die(_("standard output, or directory, which one?"));
1274 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1275 die_errno(_("Could not create directory '%s'"),
1279 if (rev.pending.nr == 1) {
1280 if (rev.max_count < 0 && !rev.show_root_diff) {
1282 * This is traditional behaviour of "git format-patch
1283 * origin" that prepares what the origin side still
1286 unsigned char sha1[20];
1289 rev.pending.objects[0].item->flags |= UNINTERESTING;
1290 add_head_to_pending(&rev);
1291 ref = resolve_ref_unsafe("HEAD", sha1, 1, NULL);
1292 if (ref && !prefixcmp(ref, "refs/heads/"))
1293 branch_name = xstrdup(ref + strlen("refs/heads/"));
1295 branch_name = xstrdup(""); /* no branch */
1298 * Otherwise, it is "format-patch -22 HEAD", and/or
1299 * "format-patch --root HEAD". The user wants
1300 * get_revision() to do the usual traversal.
1305 * We cannot move this anywhere earlier because we do want to
1306 * know if --root was given explicitly from the command line.
1308 rev.show_root_diff = 1;
1312 * NEEDSWORK:randomly pick one positive commit to show
1313 * diffstat; this is often the tip and the command
1314 * happens to do the right thing in most cases, but a
1315 * complex command like "--cover-letter a b c ^bottom"
1316 * picks "c" and shows diffstat between bottom..c
1317 * which may not match what the series represents at
1318 * all and totally broken.
1321 for (i = 0; i < rev.pending.nr; i++) {
1322 struct object *o = rev.pending.objects[i].item;
1323 if (!(o->flags & UNINTERESTING))
1324 head = (struct commit *)o;
1326 /* There is nothing to show; it is not an error, though. */
1330 branch_name = find_branch_name(&rev);
1333 if (ignore_if_in_upstream) {
1334 /* Don't say anything if head and upstream are the same. */
1335 if (rev.pending.nr == 2) {
1336 struct object_array_entry *o = rev.pending.objects;
1337 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1340 get_patch_ids(&rev, &ids);
1344 realstdout = xfdopen(xdup(1), "w");
1346 if (prepare_revision_walk(&rev))
1347 die(_("revision walk setup failed"));
1349 while ((commit = get_revision(&rev)) != NULL) {
1350 if (commit->object.flags & BOUNDARY) {
1352 origin = (boundary_count == 1) ? commit : NULL;
1356 if (ignore_if_in_upstream &&
1357 has_commit_patch_id(commit, &ids))
1361 list = xrealloc(list, nr * sizeof(list[0]));
1362 list[nr - 1] = commit;
1365 if (!keep_subject && auto_number && total > 1)
1368 rev.total = total + start_number - 1;
1369 if (in_reply_to || thread || cover_letter)
1370 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1372 const char *msgid = clean_message_id(in_reply_to);
1373 string_list_append(rev.ref_message_ids, msgid);
1375 rev.numbered_files = just_numbers;
1376 rev.patch_suffix = fmt_patch_suffix;
1379 gen_message_id(&rev, "cover");
1380 make_cover_letter(&rev, use_stdout,
1381 origin, nr, list, head, branch_name, quiet);
1385 rev.add_signoff = do_signoff;
1389 rev.nr = total - nr + (start_number - 1);
1390 /* Make the second and subsequent mails replies to the first */
1392 /* Have we already had a message ID? */
1393 if (rev.message_id) {
1395 * For deep threading: make every mail
1396 * a reply to the previous one, no
1397 * matter what other options are set.
1399 * For shallow threading:
1401 * Without --cover-letter and
1402 * --in-reply-to, make every mail a
1403 * reply to the one before.
1405 * With --in-reply-to but no
1406 * --cover-letter, make every mail a
1407 * reply to the <reply-to>.
1409 * With --cover-letter, make every
1410 * mail but the cover letter a reply
1411 * to the cover letter. The cover
1412 * letter is a reply to the
1413 * --in-reply-to, if specified.
1415 if (thread == THREAD_SHALLOW
1416 && rev.ref_message_ids->nr > 0
1417 && (!cover_letter || rev.nr > 1))
1418 free(rev.message_id);
1420 string_list_append(rev.ref_message_ids,
1423 gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1427 reopen_stdout(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
1428 die(_("Failed to create output files"));
1429 shown = log_tree_commit(&rev, commit);
1430 free(commit->buffer);
1431 commit->buffer = NULL;
1433 /* We put one extra blank line between formatted
1434 * patches and this flag is used by log-tree code
1435 * to see if it needs to emit a LF before showing
1436 * the log; when using one file per patch, we do
1437 * not want the extra blank line.
1442 if (rev.mime_boundary)
1443 printf("\n--%s%s--\n\n\n",
1444 mime_boundary_leader,
1454 string_list_clear(&extra_to, 0);
1455 string_list_clear(&extra_cc, 0);
1456 string_list_clear(&extra_hdr, 0);
1457 if (ignore_if_in_upstream)
1458 free_patch_ids(&ids);
1462 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1464 unsigned char sha1[20];
1465 if (get_sha1(arg, sha1) == 0) {
1466 struct commit *commit = lookup_commit_reference(sha1);
1468 commit->object.flags |= flags;
1469 add_pending_object(revs, &commit->object, arg);
1476 static const char * const cherry_usage[] = {
1477 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1481 static void print_commit(char sign, struct commit *commit, int verbose,
1485 printf("%c %s\n", sign,
1486 find_unique_abbrev(commit->object.sha1, abbrev));
1488 struct strbuf buf = STRBUF_INIT;
1489 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
1490 printf("%c %s %s\n", sign,
1491 find_unique_abbrev(commit->object.sha1, abbrev),
1493 strbuf_release(&buf);
1497 int cmd_cherry(int argc, const char **argv, const char *prefix)
1499 struct rev_info revs;
1500 struct patch_ids ids;
1501 struct commit *commit;
1502 struct commit_list *list = NULL;
1503 struct branch *current_branch;
1504 const char *upstream;
1505 const char *head = "HEAD";
1506 const char *limit = NULL;
1507 int verbose = 0, abbrev = 0;
1509 struct option options[] = {
1510 OPT__ABBREV(&abbrev),
1511 OPT__VERBOSE(&verbose, N_("be verbose")),
1515 argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
1528 current_branch = branch_get(NULL);
1529 if (!current_branch || !current_branch->merge
1530 || !current_branch->merge[0]
1531 || !current_branch->merge[0]->dst) {
1532 fprintf(stderr, _("Could not find a tracked"
1533 " remote branch, please"
1534 " specify <upstream> manually.\n"));
1535 usage_with_options(cherry_usage, options);
1538 upstream = current_branch->merge[0]->dst;
1541 init_revisions(&revs, prefix);
1542 revs.max_parents = 1;
1544 if (add_pending_commit(head, &revs, 0))
1545 die(_("Unknown commit %s"), head);
1546 if (add_pending_commit(upstream, &revs, UNINTERESTING))
1547 die(_("Unknown commit %s"), upstream);
1549 /* Don't say anything if head and upstream are the same. */
1550 if (revs.pending.nr == 2) {
1551 struct object_array_entry *o = revs.pending.objects;
1552 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1556 get_patch_ids(&revs, &ids);
1558 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1559 die(_("Unknown commit %s"), limit);
1561 /* reverse the list of commits */
1562 if (prepare_revision_walk(&revs))
1563 die(_("revision walk setup failed"));
1564 while ((commit = get_revision(&revs)) != NULL) {
1565 commit_list_insert(commit, &list);
1571 commit = list->item;
1572 if (has_commit_patch_id(commit, &ids))
1574 print_commit(sign, commit, verbose, abbrev);
1578 free_patch_ids(&ids);