2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
17 #include "reflog-walk.h"
18 #include "patch-ids.h"
19 #include "run-command.h"
22 #include "string-list.h"
23 #include "parse-options.h"
26 #include "streaming.h"
29 #include "gpg-interface.h"
32 /* Set a default date-time format for git log ("log.date" config variable) */
33 static const char *default_date_mode
= NULL
;
35 static int default_abbrev_commit
;
36 static int default_show_root
= 1;
37 static int default_follow
;
38 static int default_show_signature
;
39 static int decoration_style
;
40 static int decoration_given
;
41 static int use_mailmap_config
;
42 static const char *fmt_patch_subject_prefix
= "PATCH";
43 static const char *fmt_pretty
;
45 static const char * const builtin_log_usage
[] = {
46 N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
47 N_("git show [<options>] <object>..."),
51 struct line_opt_callback_data
{
54 struct string_list args
;
57 static int auto_decoration_style(void)
59 return (isatty(1) || pager_in_use()) ? DECORATE_SHORT_REFS
: 0;
62 static int parse_decoration_style(const char *var
, const char *value
)
64 switch (git_config_maybe_bool(var
, value
)) {
66 return DECORATE_SHORT_REFS
;
72 if (!strcmp(value
, "full"))
73 return DECORATE_FULL_REFS
;
74 else if (!strcmp(value
, "short"))
75 return DECORATE_SHORT_REFS
;
76 else if (!strcmp(value
, "auto"))
77 return auto_decoration_style();
81 static int decorate_callback(const struct option
*opt
, const char *arg
, int unset
)
86 decoration_style
= parse_decoration_style("command line", arg
);
88 decoration_style
= DECORATE_SHORT_REFS
;
90 if (decoration_style
< 0)
91 die(_("invalid --decorate option: %s"), arg
);
98 static int log_line_range_callback(const struct option
*option
, const char *arg
, int unset
)
100 struct line_opt_callback_data
*data
= option
->value
;
105 data
->rev
->line_level_traverse
= 1;
106 string_list_append(&data
->args
, arg
);
111 static void init_log_defaults(void)
113 init_grep_defaults();
114 init_diff_ui_defaults();
116 decoration_style
= auto_decoration_style();
119 static void cmd_log_init_defaults(struct rev_info
*rev
)
122 get_commit_format(fmt_pretty
, rev
);
124 DIFF_OPT_SET(&rev
->diffopt
, DEFAULT_FOLLOW_RENAMES
);
125 rev
->verbose_header
= 1;
126 DIFF_OPT_SET(&rev
->diffopt
, RECURSIVE
);
127 rev
->diffopt
.stat_width
= -1; /* use full terminal width */
128 rev
->diffopt
.stat_graph_width
= -1; /* respect statGraphWidth config */
129 rev
->abbrev_commit
= default_abbrev_commit
;
130 rev
->show_root_diff
= default_show_root
;
131 rev
->subject_prefix
= fmt_patch_subject_prefix
;
132 rev
->show_signature
= default_show_signature
;
133 DIFF_OPT_SET(&rev
->diffopt
, ALLOW_TEXTCONV
);
135 if (default_date_mode
)
136 parse_date_format(default_date_mode
, &rev
->date_mode
);
137 rev
->diffopt
.touched_flags
= 0;
140 static void cmd_log_init_finish(int argc
, const char **argv
, const char *prefix
,
141 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
143 struct userformat_want w
;
144 int quiet
= 0, source
= 0, mailmap
= 0;
145 static struct line_opt_callback_data line_cb
= {NULL
, NULL
, STRING_LIST_INIT_DUP
};
147 const struct option builtin_log_options
[] = {
148 OPT__QUIET(&quiet
, N_("suppress diff output")),
149 OPT_BOOL(0, "source", &source
, N_("show source")),
150 OPT_BOOL(0, "use-mailmap", &mailmap
, N_("Use mail map file")),
151 { OPTION_CALLBACK
, 0, "decorate", NULL
, NULL
, N_("decorate options"),
152 PARSE_OPT_OPTARG
, decorate_callback
},
153 OPT_CALLBACK('L', NULL
, &line_cb
, "n,m:file",
154 N_("Process line range n,m in file, counting from 1"),
155 log_line_range_callback
),
160 line_cb
.prefix
= prefix
;
162 mailmap
= use_mailmap_config
;
163 argc
= parse_options(argc
, argv
, prefix
,
164 builtin_log_options
, builtin_log_usage
,
165 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
166 PARSE_OPT_KEEP_DASHDASH
);
169 rev
->diffopt
.output_format
|= DIFF_FORMAT_NO_OUTPUT
;
170 argc
= setup_revisions(argc
, argv
, rev
, opt
);
172 /* Any arguments at this point are not recognized */
174 die(_("unrecognized argument: %s"), argv
[1]);
176 memset(&w
, 0, sizeof(w
));
177 userformat_find_requirements(NULL
, &w
);
179 if (!rev
->show_notes_given
&& (!rev
->pretty_given
|| w
.notes
))
182 init_display_notes(&rev
->notes_opt
);
184 if (rev
->diffopt
.pickaxe
|| rev
->diffopt
.filter
||
185 DIFF_OPT_TST(&rev
->diffopt
, FOLLOW_RENAMES
))
186 rev
->always_show_header
= 0;
189 rev
->show_source
= 1;
192 rev
->mailmap
= xcalloc(1, sizeof(struct string_list
));
193 read_mailmap(rev
->mailmap
, NULL
);
196 if (rev
->pretty_given
&& rev
->commit_format
== CMIT_FMT_RAW
) {
198 * "log --pretty=raw" is special; ignore UI oriented
199 * configuration variables such as decoration.
201 if (!decoration_given
)
202 decoration_style
= 0;
203 if (!rev
->abbrev_commit_given
)
204 rev
->abbrev_commit
= 0;
207 if (decoration_style
) {
208 rev
->show_decorations
= 1;
209 load_ref_decorations(decoration_style
);
212 if (rev
->line_level_traverse
)
213 line_log_init(rev
, line_cb
.prefix
, &line_cb
.args
);
218 static void cmd_log_init(int argc
, const char **argv
, const char *prefix
,
219 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
221 cmd_log_init_defaults(rev
);
222 cmd_log_init_finish(argc
, argv
, prefix
, rev
, opt
);
226 * This gives a rough estimate for how many commits we
227 * will print out in the list.
229 static int estimate_commit_count(struct rev_info
*rev
, struct commit_list
*list
)
234 struct commit
*commit
= list
->item
;
235 unsigned int flags
= commit
->object
.flags
;
237 if (!(flags
& (TREESAME
| UNINTERESTING
)))
243 static void show_early_header(struct rev_info
*rev
, const char *stage
, int nr
)
245 if (rev
->shown_one
) {
247 if (rev
->commit_format
!= CMIT_FMT_ONELINE
)
248 putchar(rev
->diffopt
.line_termination
);
250 fprintf(rev
->diffopt
.file
, _("Final output: %d %s\n"), nr
, stage
);
253 static struct itimerval early_output_timer
;
255 static void log_show_early(struct rev_info
*revs
, struct commit_list
*list
)
257 int i
= revs
->early_output
, close_file
= revs
->diffopt
.close_file
;
260 revs
->diffopt
.close_file
= 0;
261 sort_in_topological_order(&list
, revs
->sort_order
);
263 struct commit
*commit
= list
->item
;
264 switch (simplify_commit(revs
, commit
)) {
267 int n
= estimate_commit_count(revs
, list
);
268 show_early_header(revs
, "incomplete", n
);
271 log_tree_commit(revs
, commit
);
278 fclose(revs
->diffopt
.file
);
284 /* Did we already get enough commits for the early output? */
287 fclose(revs
->diffopt
.file
);
292 * ..if no, then repeat it twice a second until we
295 * NOTE! We don't use "it_interval", because if the
296 * reader isn't listening, we want our output to be
297 * throttled by the writing, and not have the timer
298 * trigger every second even if we're blocked on a
301 early_output_timer
.it_value
.tv_sec
= 0;
302 early_output_timer
.it_value
.tv_usec
= 500000;
303 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
306 static void early_output(int signal
)
308 show_early_output
= log_show_early
;
311 static void setup_early_output(struct rev_info
*rev
)
316 * Set up the signal handler, minimally intrusively:
317 * we only set a single volatile integer word (not
318 * using sigatomic_t - trying to avoid unnecessary
319 * system dependencies and headers), and using
322 memset(&sa
, 0, sizeof(sa
));
323 sa
.sa_handler
= early_output
;
324 sigemptyset(&sa
.sa_mask
);
325 sa
.sa_flags
= SA_RESTART
;
326 sigaction(SIGALRM
, &sa
, NULL
);
329 * If we can get the whole output in less than a
330 * tenth of a second, don't even bother doing the
331 * early-output thing..
333 * This is a one-time-only trigger.
335 early_output_timer
.it_value
.tv_sec
= 0;
336 early_output_timer
.it_value
.tv_usec
= 100000;
337 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
340 static void finish_early_output(struct rev_info
*rev
)
342 int n
= estimate_commit_count(rev
, rev
->commits
);
343 signal(SIGALRM
, SIG_IGN
);
344 show_early_header(rev
, "done", n
);
347 static int cmd_log_walk(struct rev_info
*rev
)
349 struct commit
*commit
;
351 int saved_dcctc
= 0, close_file
= rev
->diffopt
.close_file
;
353 if (rev
->early_output
)
354 setup_early_output(rev
);
356 if (prepare_revision_walk(rev
))
357 die(_("revision walk setup failed"));
359 if (rev
->early_output
)
360 finish_early_output(rev
);
363 * For --check and --exit-code, the exit code is based on CHECK_FAILED
364 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
365 * retain that state information if replacing rev->diffopt in this loop
367 rev
->diffopt
.close_file
= 0;
368 while ((commit
= get_revision(rev
)) != NULL
) {
369 if (!log_tree_commit(rev
, commit
) && rev
->max_count
>= 0)
371 * We decremented max_count in get_revision,
372 * but we didn't actually show the commit.
375 if (!rev
->reflog_info
) {
376 /* we allow cycles in reflog ancestry */
377 free_commit_buffer(commit
);
379 free_commit_list(commit
->parents
);
380 commit
->parents
= NULL
;
381 if (saved_nrl
< rev
->diffopt
.needed_rename_limit
)
382 saved_nrl
= rev
->diffopt
.needed_rename_limit
;
383 if (rev
->diffopt
.degraded_cc_to_c
)
386 rev
->diffopt
.degraded_cc_to_c
= saved_dcctc
;
387 rev
->diffopt
.needed_rename_limit
= saved_nrl
;
389 fclose(rev
->diffopt
.file
);
391 if (rev
->diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
&&
392 DIFF_OPT_TST(&rev
->diffopt
, CHECK_FAILED
)) {
395 return diff_result_code(&rev
->diffopt
, 0);
398 static int git_log_config(const char *var
, const char *value
, void *cb
)
400 const char *slot_name
;
402 if (!strcmp(var
, "format.pretty"))
403 return git_config_string(&fmt_pretty
, var
, value
);
404 if (!strcmp(var
, "format.subjectprefix"))
405 return git_config_string(&fmt_patch_subject_prefix
, var
, value
);
406 if (!strcmp(var
, "log.abbrevcommit")) {
407 default_abbrev_commit
= git_config_bool(var
, value
);
410 if (!strcmp(var
, "log.date"))
411 return git_config_string(&default_date_mode
, var
, value
);
412 if (!strcmp(var
, "log.decorate")) {
413 decoration_style
= parse_decoration_style(var
, value
);
414 if (decoration_style
< 0)
415 decoration_style
= 0; /* maybe warn? */
418 if (!strcmp(var
, "log.showroot")) {
419 default_show_root
= git_config_bool(var
, value
);
422 if (!strcmp(var
, "log.follow")) {
423 default_follow
= git_config_bool(var
, value
);
426 if (skip_prefix(var
, "color.decorate.", &slot_name
))
427 return parse_decorate_color_config(var
, slot_name
, value
);
428 if (!strcmp(var
, "log.mailmap")) {
429 use_mailmap_config
= git_config_bool(var
, value
);
432 if (!strcmp(var
, "log.showsignature")) {
433 default_show_signature
= git_config_bool(var
, value
);
437 if (grep_config(var
, value
, cb
) < 0)
439 if (git_gpg_config(var
, value
, cb
) < 0)
441 return git_diff_ui_config(var
, value
, cb
);
444 int cmd_whatchanged(int argc
, const char **argv
, const char *prefix
)
447 struct setup_revision_opt opt
;
450 git_config(git_log_config
, NULL
);
452 init_revisions(&rev
, prefix
);
454 rev
.simplify_history
= 0;
455 memset(&opt
, 0, sizeof(opt
));
457 opt
.revarg_opt
= REVARG_COMMITTISH
;
458 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
459 if (!rev
.diffopt
.output_format
)
460 rev
.diffopt
.output_format
= DIFF_FORMAT_RAW
;
461 return cmd_log_walk(&rev
);
464 static void show_tagger(char *buf
, int len
, struct rev_info
*rev
)
466 struct strbuf out
= STRBUF_INIT
;
467 struct pretty_print_context pp
= {0};
469 pp
.fmt
= rev
->commit_format
;
470 pp
.date_mode
= rev
->date_mode
;
471 pp_user_info(&pp
, "Tagger", &out
, buf
, get_log_output_encoding());
472 fprintf(rev
->diffopt
.file
, "%s", out
.buf
);
473 strbuf_release(&out
);
476 static int show_blob_object(const struct object_id
*oid
, struct rev_info
*rev
, const char *obj_name
)
478 struct object_id oidc
;
479 struct object_context obj_context
;
483 fflush(rev
->diffopt
.file
);
484 if (!DIFF_OPT_TOUCHED(&rev
->diffopt
, ALLOW_TEXTCONV
) ||
485 !DIFF_OPT_TST(&rev
->diffopt
, ALLOW_TEXTCONV
))
486 return stream_blob_to_fd(1, oid
, NULL
, 0);
488 if (get_sha1_with_context(obj_name
, GET_SHA1_RECORD_PATH
,
489 oidc
.hash
, &obj_context
))
490 die(_("Not a valid object name %s"), obj_name
);
491 if (!obj_context
.path
||
492 !textconv_object(obj_context
.path
, obj_context
.mode
, &oidc
, 1, &buf
, &size
)) {
493 free(obj_context
.path
);
494 return stream_blob_to_fd(1, oid
, NULL
, 0);
498 die(_("git show %s: bad file"), obj_name
);
500 write_or_die(1, buf
, size
);
501 free(obj_context
.path
);
505 static int show_tag_object(const struct object_id
*oid
, struct rev_info
*rev
)
508 enum object_type type
;
509 char *buf
= read_sha1_file(oid
->hash
, &type
, &size
);
513 return error(_("Could not read object %s"), oid_to_hex(oid
));
515 assert(type
== OBJ_TAG
);
516 while (offset
< size
&& buf
[offset
] != '\n') {
517 int new_offset
= offset
+ 1;
518 while (new_offset
< size
&& buf
[new_offset
++] != '\n')
520 if (starts_with(buf
+ offset
, "tagger "))
521 show_tagger(buf
+ offset
+ 7,
522 new_offset
- offset
- 7, rev
);
527 fwrite(buf
+ offset
, size
- offset
, 1, rev
->diffopt
.file
);
532 static int show_tree_object(const unsigned char *sha1
,
534 const char *pathname
, unsigned mode
, int stage
, void *context
)
536 FILE *file
= context
;
537 fprintf(file
, "%s%s\n", pathname
, S_ISDIR(mode
) ? "/" : "");
541 static void show_setup_revisions_tweak(struct rev_info
*rev
,
542 struct setup_revision_opt
*opt
)
544 if (rev
->ignore_merges
) {
545 /* There was no "-m" on the command line */
546 rev
->ignore_merges
= 0;
547 if (!rev
->first_parent_only
&& !rev
->combine_merges
) {
548 /* No "--first-parent", "-c", or "--cc" */
549 rev
->combine_merges
= 1;
550 rev
->dense_combined_merges
= 1;
553 if (!rev
->diffopt
.output_format
)
554 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
557 int cmd_show(int argc
, const char **argv
, const char *prefix
)
560 struct object_array_entry
*objects
;
561 struct setup_revision_opt opt
;
562 struct pathspec match_all
;
563 int i
, count
, ret
= 0;
566 git_config(git_log_config
, NULL
);
568 memset(&match_all
, 0, sizeof(match_all
));
569 init_revisions(&rev
, prefix
);
571 rev
.always_show_header
= 1;
572 rev
.no_walk
= REVISION_WALK_NO_WALK_SORTED
;
573 rev
.diffopt
.stat_width
= -1; /* Scale to real terminal size */
575 memset(&opt
, 0, sizeof(opt
));
577 opt
.tweak
= show_setup_revisions_tweak
;
578 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
581 return cmd_log_walk(&rev
);
583 count
= rev
.pending
.nr
;
584 objects
= rev
.pending
.objects
;
585 for (i
= 0; i
< count
&& !ret
; i
++) {
586 struct object
*o
= objects
[i
].item
;
587 const char *name
= objects
[i
].name
;
590 ret
= show_blob_object(&o
->oid
, &rev
, name
);
593 struct tag
*t
= (struct tag
*)o
;
597 fprintf(rev
.diffopt
.file
, "%stag %s%s\n",
598 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
600 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
601 ret
= show_tag_object(&o
->oid
, &rev
);
605 o
= parse_object(&t
->tagged
->oid
);
607 ret
= error(_("Could not read object %s"),
608 oid_to_hex(&t
->tagged
->oid
));
616 fprintf(rev
.diffopt
.file
, "%stree %s%s\n\n",
617 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
619 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
620 read_tree_recursive((struct tree
*)o
, "", 0, 0, &match_all
,
621 show_tree_object
, rev
.diffopt
.file
);
625 rev
.pending
.nr
= rev
.pending
.alloc
= 0;
626 rev
.pending
.objects
= NULL
;
627 add_object_array(o
, name
, &rev
.pending
);
628 ret
= cmd_log_walk(&rev
);
631 ret
= error(_("Unknown type: %d"), o
->type
);
639 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
641 int cmd_log_reflog(int argc
, const char **argv
, const char *prefix
)
644 struct setup_revision_opt opt
;
647 git_config(git_log_config
, NULL
);
649 init_revisions(&rev
, prefix
);
650 init_reflog_walk(&rev
.reflog_info
);
651 rev
.verbose_header
= 1;
652 memset(&opt
, 0, sizeof(opt
));
654 cmd_log_init_defaults(&rev
);
655 rev
.abbrev_commit
= 1;
656 rev
.commit_format
= CMIT_FMT_ONELINE
;
657 rev
.use_terminator
= 1;
658 rev
.always_show_header
= 1;
659 cmd_log_init_finish(argc
, argv
, prefix
, &rev
, &opt
);
661 return cmd_log_walk(&rev
);
664 static void log_setup_revisions_tweak(struct rev_info
*rev
,
665 struct setup_revision_opt
*opt
)
667 if (DIFF_OPT_TST(&rev
->diffopt
, DEFAULT_FOLLOW_RENAMES
) &&
668 rev
->prune_data
.nr
== 1)
669 DIFF_OPT_SET(&rev
->diffopt
, FOLLOW_RENAMES
);
671 /* Turn --cc/-c into -p --cc/-c when -p was not given */
672 if (!rev
->diffopt
.output_format
&& rev
->combine_merges
)
673 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
675 /* Turn -m on when --cc/-c was given */
676 if (rev
->combine_merges
)
677 rev
->ignore_merges
= 0;
680 int cmd_log(int argc
, const char **argv
, const char *prefix
)
683 struct setup_revision_opt opt
;
686 git_config(git_log_config
, NULL
);
688 init_revisions(&rev
, prefix
);
689 rev
.always_show_header
= 1;
690 memset(&opt
, 0, sizeof(opt
));
692 opt
.revarg_opt
= REVARG_COMMITTISH
;
693 opt
.tweak
= log_setup_revisions_tweak
;
694 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
695 return cmd_log_walk(&rev
);
700 static const char *fmt_patch_suffix
= ".patch";
701 static int numbered
= 0;
702 static int auto_number
= 1;
704 static char *default_attach
= NULL
;
706 static struct string_list extra_hdr
= STRING_LIST_INIT_NODUP
;
707 static struct string_list extra_to
= STRING_LIST_INIT_NODUP
;
708 static struct string_list extra_cc
= STRING_LIST_INIT_NODUP
;
710 static void add_header(const char *value
)
712 struct string_list_item
*item
;
713 int len
= strlen(value
);
714 while (len
&& value
[len
- 1] == '\n')
717 if (!strncasecmp(value
, "to: ", 4)) {
718 item
= string_list_append(&extra_to
, value
+ 4);
720 } else if (!strncasecmp(value
, "cc: ", 4)) {
721 item
= string_list_append(&extra_cc
, value
+ 4);
724 item
= string_list_append(&extra_hdr
, value
);
727 item
->string
[len
] = '\0';
730 #define THREAD_SHALLOW 1
731 #define THREAD_DEEP 2
733 static int do_signoff
;
734 static int base_auto
;
736 static const char *signature
= git_version_string
;
737 static const char *signature_file
;
738 static int config_cover_letter
;
739 static const char *config_output_directory
;
748 static int git_format_config(const char *var
, const char *value
, void *cb
)
750 if (!strcmp(var
, "format.headers")) {
752 die(_("format.headers without value"));
756 if (!strcmp(var
, "format.suffix"))
757 return git_config_string(&fmt_patch_suffix
, var
, value
);
758 if (!strcmp(var
, "format.to")) {
760 return config_error_nonbool(var
);
761 string_list_append(&extra_to
, value
);
764 if (!strcmp(var
, "format.cc")) {
766 return config_error_nonbool(var
);
767 string_list_append(&extra_cc
, value
);
770 if (!strcmp(var
, "diff.color") || !strcmp(var
, "color.diff") ||
771 !strcmp(var
, "color.ui") || !strcmp(var
, "diff.submodule")) {
774 if (!strcmp(var
, "format.numbered")) {
775 if (value
&& !strcasecmp(value
, "auto")) {
779 numbered
= git_config_bool(var
, value
);
780 auto_number
= auto_number
&& numbered
;
783 if (!strcmp(var
, "format.attach")) {
785 default_attach
= xstrdup(value
);
787 default_attach
= xstrdup(git_version_string
);
790 if (!strcmp(var
, "format.thread")) {
791 if (value
&& !strcasecmp(value
, "deep")) {
792 thread
= THREAD_DEEP
;
795 if (value
&& !strcasecmp(value
, "shallow")) {
796 thread
= THREAD_SHALLOW
;
799 thread
= git_config_bool(var
, value
) && THREAD_SHALLOW
;
802 if (!strcmp(var
, "format.signoff")) {
803 do_signoff
= git_config_bool(var
, value
);
806 if (!strcmp(var
, "format.signature"))
807 return git_config_string(&signature
, var
, value
);
808 if (!strcmp(var
, "format.signaturefile"))
809 return git_config_pathname(&signature_file
, var
, value
);
810 if (!strcmp(var
, "format.coverletter")) {
811 if (value
&& !strcasecmp(value
, "auto")) {
812 config_cover_letter
= COVER_AUTO
;
815 config_cover_letter
= git_config_bool(var
, value
) ? COVER_ON
: COVER_OFF
;
818 if (!strcmp(var
, "format.outputdirectory"))
819 return git_config_string(&config_output_directory
, var
, value
);
820 if (!strcmp(var
, "format.useautobase")) {
821 base_auto
= git_config_bool(var
, value
);
824 if (!strcmp(var
, "format.from")) {
825 int b
= git_config_maybe_bool(var
, value
);
828 from
= xstrdup(value
);
830 from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
836 return git_log_config(var
, value
, cb
);
839 static const char *output_directory
= NULL
;
840 static int outdir_offset
;
842 static int open_next_file(struct commit
*commit
, const char *subject
,
843 struct rev_info
*rev
, int quiet
)
845 struct strbuf filename
= STRBUF_INIT
;
846 int suffix_len
= strlen(rev
->patch_suffix
) + 1;
848 if (output_directory
) {
849 strbuf_addstr(&filename
, output_directory
);
851 PATH_MAX
- FORMAT_PATCH_NAME_MAX
- suffix_len
) {
852 strbuf_release(&filename
);
853 return error(_("name of output directory is too long"));
855 strbuf_complete(&filename
, '/');
858 if (rev
->numbered_files
)
859 strbuf_addf(&filename
, "%d", rev
->nr
);
861 fmt_output_commit(&filename
, commit
, rev
);
863 fmt_output_subject(&filename
, subject
, rev
);
866 printf("%s\n", filename
.buf
+ outdir_offset
);
868 if ((rev
->diffopt
.file
= fopen(filename
.buf
, "w")) == NULL
) {
869 error_errno(_("Cannot open patch file %s"), filename
.buf
);
870 strbuf_release(&filename
);
874 strbuf_release(&filename
);
878 static void get_patch_ids(struct rev_info
*rev
, struct patch_ids
*ids
)
880 struct rev_info check_rev
;
881 struct commit
*commit
, *c1
, *c2
;
882 struct object
*o1
, *o2
;
883 unsigned flags1
, flags2
;
885 if (rev
->pending
.nr
!= 2)
886 die(_("Need exactly one range."));
888 o1
= rev
->pending
.objects
[0].item
;
889 o2
= rev
->pending
.objects
[1].item
;
892 c1
= lookup_commit_reference(&o1
->oid
);
893 c2
= lookup_commit_reference(&o2
->oid
);
895 if ((flags1
& UNINTERESTING
) == (flags2
& UNINTERESTING
))
896 die(_("Not a range."));
900 /* given a range a..b get all patch ids for b..a */
901 init_revisions(&check_rev
, rev
->prefix
);
902 check_rev
.max_parents
= 1;
903 o1
->flags
^= UNINTERESTING
;
904 o2
->flags
^= UNINTERESTING
;
905 add_pending_object(&check_rev
, o1
, "o1");
906 add_pending_object(&check_rev
, o2
, "o2");
907 if (prepare_revision_walk(&check_rev
))
908 die(_("revision walk setup failed"));
910 while ((commit
= get_revision(&check_rev
)) != NULL
) {
911 add_commit_patch_id(commit
, ids
);
914 /* reset for next revision walk */
915 clear_commit_marks(c1
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
916 clear_commit_marks(c2
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
921 static void gen_message_id(struct rev_info
*info
, char *base
)
923 struct strbuf buf
= STRBUF_INIT
;
924 strbuf_addf(&buf
, "%s.%"PRItime
".git.%s", base
,
925 (timestamp_t
) time(NULL
),
926 git_committer_info(IDENT_NO_NAME
|IDENT_NO_DATE
|IDENT_STRICT
));
927 info
->message_id
= strbuf_detach(&buf
, NULL
);
930 static void print_signature(FILE *file
)
932 if (!signature
|| !*signature
)
935 fprintf(file
, "-- \n%s", signature
);
936 if (signature
[strlen(signature
)-1] != '\n')
941 static void add_branch_description(struct strbuf
*buf
, const char *branch_name
)
943 struct strbuf desc
= STRBUF_INIT
;
944 if (!branch_name
|| !*branch_name
)
946 read_branch_desc(&desc
, branch_name
);
948 strbuf_addch(buf
, '\n');
949 strbuf_addbuf(buf
, &desc
);
950 strbuf_addch(buf
, '\n');
952 strbuf_release(&desc
);
955 static char *find_branch_name(struct rev_info
*rev
)
957 int i
, positive
= -1;
958 struct object_id branch_oid
;
959 const struct object_id
*tip_oid
;
961 char *full_ref
, *branch
= NULL
;
963 for (i
= 0; i
< rev
->cmdline
.nr
; i
++) {
964 if (rev
->cmdline
.rev
[i
].flags
& UNINTERESTING
)
973 ref
= rev
->cmdline
.rev
[positive
].name
;
974 tip_oid
= &rev
->cmdline
.rev
[positive
].item
->oid
;
975 if (dwim_ref(ref
, strlen(ref
), branch_oid
.hash
, &full_ref
) &&
976 skip_prefix(full_ref
, "refs/heads/", &v
) &&
977 !oidcmp(tip_oid
, &branch_oid
))
983 static void make_cover_letter(struct rev_info
*rev
, int use_stdout
,
984 struct commit
*origin
,
985 int nr
, struct commit
**list
,
986 const char *branch_name
,
989 const char *committer
;
990 const char *body
= "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
993 struct strbuf sb
= STRBUF_INIT
;
995 const char *encoding
= "UTF-8";
996 struct diff_options opts
;
997 int need_8bit_cte
= 0;
998 struct pretty_print_context pp
= {0};
999 struct commit
*head
= list
[0];
1001 if (!cmit_fmt_is_mail(rev
->commit_format
))
1002 die(_("Cover letter needs email format"));
1004 committer
= git_committer_info(0);
1007 open_next_file(NULL
, rev
->numbered_files
? NULL
: "cover-letter", rev
, quiet
))
1010 log_write_email_headers(rev
, head
, &pp
.after_subject
, &need_8bit_cte
);
1012 for (i
= 0; !need_8bit_cte
&& i
< nr
; i
++) {
1013 const char *buf
= get_commit_buffer(list
[i
], NULL
);
1014 if (has_non_ascii(buf
))
1016 unuse_commit_buffer(list
[i
], buf
);
1020 branch_name
= find_branch_name(rev
);
1023 pp
.fmt
= CMIT_FMT_EMAIL
;
1024 pp
.date_mode
.type
= DATE_RFC2822
;
1026 pp
.print_email_subject
= 1;
1027 pp_user_info(&pp
, NULL
, &sb
, committer
, encoding
);
1028 pp_title_line(&pp
, &msg
, &sb
, encoding
, need_8bit_cte
);
1029 pp_remainder(&pp
, &msg
, &sb
, 0);
1030 add_branch_description(&sb
, branch_name
);
1031 fprintf(rev
->diffopt
.file
, "%s\n", sb
.buf
);
1033 strbuf_release(&sb
);
1035 shortlog_init(&log
);
1040 log
.file
= rev
->diffopt
.file
;
1041 for (i
= 0; i
< nr
; i
++)
1042 shortlog_add_commit(&log
, list
[i
]);
1044 shortlog_output(&log
);
1047 * We can only do diffstat with a unique reference point
1052 memcpy(&opts
, &rev
->diffopt
, sizeof(opts
));
1053 opts
.output_format
= DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
1055 diff_setup_done(&opts
);
1057 diff_tree_oid(&origin
->tree
->object
.oid
,
1058 &head
->tree
->object
.oid
,
1060 diffcore_std(&opts
);
1063 fprintf(rev
->diffopt
.file
, "\n");
1066 static const char *clean_message_id(const char *msg_id
)
1069 const char *a
, *z
, *m
;
1072 while ((ch
= *m
) && (isspace(ch
) || (ch
== '<')))
1077 if (!isspace(ch
) && (ch
!= '>'))
1082 die(_("insane in-reply-to: %s"), msg_id
);
1085 return xmemdupz(a
, z
- a
);
1088 static const char *set_outdir(const char *prefix
, const char *output_directory
)
1090 if (output_directory
&& is_absolute_path(output_directory
))
1091 return output_directory
;
1093 if (!prefix
|| !*prefix
) {
1094 if (output_directory
)
1095 return output_directory
;
1096 /* The user did not explicitly ask for "./" */
1101 outdir_offset
= strlen(prefix
);
1102 if (!output_directory
)
1105 return prefix_filename(prefix
, output_directory
);
1108 static const char * const builtin_format_patch_usage
[] = {
1109 N_("git format-patch [<options>] [<since> | <revision-range>]"),
1113 static int keep_subject
= 0;
1115 static int keep_callback(const struct option
*opt
, const char *arg
, int unset
)
1117 ((struct rev_info
*)opt
->value
)->total
= -1;
1122 static int subject_prefix
= 0;
1124 static int subject_prefix_callback(const struct option
*opt
, const char *arg
,
1128 ((struct rev_info
*)opt
->value
)->subject_prefix
= arg
;
1132 static int rfc_callback(const struct option
*opt
, const char *arg
, int unset
)
1134 return subject_prefix_callback(opt
, "RFC PATCH", unset
);
1137 static int numbered_cmdline_opt
= 0;
1139 static int numbered_callback(const struct option
*opt
, const char *arg
,
1142 *(int *)opt
->value
= numbered_cmdline_opt
= unset
? 0 : 1;
1148 static int no_numbered_callback(const struct option
*opt
, const char *arg
,
1151 return numbered_callback(opt
, arg
, 1);
1154 static int output_directory_callback(const struct option
*opt
, const char *arg
,
1157 const char **dir
= (const char **)opt
->value
;
1159 die(_("Two output directories?"));
1164 static int thread_callback(const struct option
*opt
, const char *arg
, int unset
)
1166 int *thread
= (int *)opt
->value
;
1169 else if (!arg
|| !strcmp(arg
, "shallow"))
1170 *thread
= THREAD_SHALLOW
;
1171 else if (!strcmp(arg
, "deep"))
1172 *thread
= THREAD_DEEP
;
1178 static int attach_callback(const struct option
*opt
, const char *arg
, int unset
)
1180 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1182 rev
->mime_boundary
= NULL
;
1184 rev
->mime_boundary
= arg
;
1186 rev
->mime_boundary
= git_version_string
;
1187 rev
->no_inline
= unset
? 0 : 1;
1191 static int inline_callback(const struct option
*opt
, const char *arg
, int unset
)
1193 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1195 rev
->mime_boundary
= NULL
;
1197 rev
->mime_boundary
= arg
;
1199 rev
->mime_boundary
= git_version_string
;
1204 static int header_callback(const struct option
*opt
, const char *arg
, int unset
)
1207 string_list_clear(&extra_hdr
, 0);
1208 string_list_clear(&extra_to
, 0);
1209 string_list_clear(&extra_cc
, 0);
1216 static int to_callback(const struct option
*opt
, const char *arg
, int unset
)
1219 string_list_clear(&extra_to
, 0);
1221 string_list_append(&extra_to
, arg
);
1225 static int cc_callback(const struct option
*opt
, const char *arg
, int unset
)
1228 string_list_clear(&extra_cc
, 0);
1230 string_list_append(&extra_cc
, arg
);
1234 static int from_callback(const struct option
*opt
, const char *arg
, int unset
)
1236 char **from
= opt
->value
;
1243 *from
= xstrdup(arg
);
1245 *from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
1249 struct base_tree_info
{
1250 struct object_id base_commit
;
1251 int nr_patch_id
, alloc_patch_id
;
1252 struct object_id
*patch_id
;
1255 static struct commit
*get_base_commit(const char *base_commit
,
1256 struct commit
**list
,
1259 struct commit
*base
= NULL
;
1260 struct commit
**rev
;
1261 int i
= 0, rev_nr
= 0;
1263 if (base_commit
&& strcmp(base_commit
, "auto")) {
1264 base
= lookup_commit_reference_by_name(base_commit
);
1266 die(_("Unknown commit %s"), base_commit
);
1267 } else if ((base_commit
&& !strcmp(base_commit
, "auto")) || base_auto
) {
1268 struct branch
*curr_branch
= branch_get(NULL
);
1269 const char *upstream
= branch_get_upstream(curr_branch
, NULL
);
1271 struct commit_list
*base_list
;
1272 struct commit
*commit
;
1273 struct object_id oid
;
1275 if (get_oid(upstream
, &oid
))
1276 die(_("Failed to resolve '%s' as a valid ref."), upstream
);
1277 commit
= lookup_commit_or_die(&oid
, "upstream base");
1278 base_list
= get_merge_bases_many(commit
, total
, list
);
1279 /* There should be one and only one merge base. */
1280 if (!base_list
|| base_list
->next
)
1281 die(_("Could not find exact merge base."));
1282 base
= base_list
->item
;
1283 free_commit_list(base_list
);
1285 die(_("Failed to get upstream, if you want to record base commit automatically,\n"
1286 "please use git branch --set-upstream-to to track a remote branch.\n"
1287 "Or you could specify base commit by --base=<base-commit-id> manually."));
1291 ALLOC_ARRAY(rev
, total
);
1292 for (i
= 0; i
< total
; i
++)
1297 * Get merge base through pair-wise computations
1298 * and store it in rev[0].
1300 while (rev_nr
> 1) {
1301 for (i
= 0; i
< rev_nr
/ 2; i
++) {
1302 struct commit_list
*merge_base
;
1303 merge_base
= get_merge_bases(rev
[2 * i
], rev
[2 * i
+ 1]);
1304 if (!merge_base
|| merge_base
->next
)
1305 die(_("Failed to find exact merge base"));
1307 rev
[i
] = merge_base
->item
;
1311 rev
[i
] = rev
[2 * i
];
1312 rev_nr
= DIV_ROUND_UP(rev_nr
, 2);
1315 if (!in_merge_bases(base
, rev
[0]))
1316 die(_("base commit should be the ancestor of revision list"));
1318 for (i
= 0; i
< total
; i
++) {
1319 if (base
== list
[i
])
1320 die(_("base commit shouldn't be in revision list"));
1327 static void prepare_bases(struct base_tree_info
*bases
,
1328 struct commit
*base
,
1329 struct commit
**list
,
1332 struct commit
*commit
;
1333 struct rev_info revs
;
1334 struct diff_options diffopt
;
1340 diff_setup(&diffopt
);
1341 DIFF_OPT_SET(&diffopt
, RECURSIVE
);
1342 diff_setup_done(&diffopt
);
1344 oidcpy(&bases
->base_commit
, &base
->object
.oid
);
1346 init_revisions(&revs
, NULL
);
1347 revs
.max_parents
= 1;
1348 revs
.topo_order
= 1;
1349 for (i
= 0; i
< total
; i
++) {
1350 list
[i
]->object
.flags
&= ~UNINTERESTING
;
1351 add_pending_object(&revs
, &list
[i
]->object
, "rev_list");
1352 list
[i
]->util
= (void *)1;
1354 base
->object
.flags
|= UNINTERESTING
;
1355 add_pending_object(&revs
, &base
->object
, "base");
1357 if (prepare_revision_walk(&revs
))
1358 die(_("revision walk setup failed"));
1360 * Traverse the commits list, get prerequisite patch ids
1361 * and stuff them in bases structure.
1363 while ((commit
= get_revision(&revs
)) != NULL
) {
1364 struct object_id oid
;
1365 struct object_id
*patch_id
;
1368 if (commit_patch_id(commit
, &diffopt
, &oid
, 0))
1369 die(_("cannot get patch id"));
1370 ALLOC_GROW(bases
->patch_id
, bases
->nr_patch_id
+ 1, bases
->alloc_patch_id
);
1371 patch_id
= bases
->patch_id
+ bases
->nr_patch_id
;
1372 oidcpy(patch_id
, &oid
);
1373 bases
->nr_patch_id
++;
1377 static void print_bases(struct base_tree_info
*bases
, FILE *file
)
1381 /* Only do this once, either for the cover or for the first one */
1382 if (is_null_oid(&bases
->base_commit
))
1385 /* Show the base commit */
1386 fprintf(file
, "\nbase-commit: %s\n", oid_to_hex(&bases
->base_commit
));
1388 /* Show the prerequisite patches */
1389 for (i
= bases
->nr_patch_id
- 1; i
>= 0; i
--)
1390 fprintf(file
, "prerequisite-patch-id: %s\n", oid_to_hex(&bases
->patch_id
[i
]));
1392 free(bases
->patch_id
);
1393 bases
->nr_patch_id
= 0;
1394 bases
->alloc_patch_id
= 0;
1395 oidclr(&bases
->base_commit
);
1398 int cmd_format_patch(int argc
, const char **argv
, const char *prefix
)
1400 struct commit
*commit
;
1401 struct commit
**list
= NULL
;
1402 struct rev_info rev
;
1403 struct setup_revision_opt s_r_opt
;
1404 int nr
= 0, total
, i
;
1406 int start_number
= -1;
1407 int just_numbers
= 0;
1408 int ignore_if_in_upstream
= 0;
1409 int cover_letter
= -1;
1410 int boundary_count
= 0;
1411 int no_binary_diff
= 0;
1412 int zero_commit
= 0;
1413 struct commit
*origin
= NULL
;
1414 const char *in_reply_to
= NULL
;
1415 struct patch_ids ids
;
1416 struct strbuf buf
= STRBUF_INIT
;
1417 int use_patch_format
= 0;
1419 int reroll_count
= -1;
1420 char *branch_name
= NULL
;
1421 char *base_commit
= NULL
;
1422 struct base_tree_info bases
;
1423 int show_progress
= 0;
1424 struct progress
*progress
= NULL
;
1426 const struct option builtin_format_patch_options
[] = {
1427 { OPTION_CALLBACK
, 'n', "numbered", &numbered
, NULL
,
1428 N_("use [PATCH n/m] even with a single patch"),
1429 PARSE_OPT_NOARG
, numbered_callback
},
1430 { OPTION_CALLBACK
, 'N', "no-numbered", &numbered
, NULL
,
1431 N_("use [PATCH] even with multiple patches"),
1432 PARSE_OPT_NOARG
, no_numbered_callback
},
1433 OPT_BOOL('s', "signoff", &do_signoff
, N_("add Signed-off-by:")),
1434 OPT_BOOL(0, "stdout", &use_stdout
,
1435 N_("print patches to standard out")),
1436 OPT_BOOL(0, "cover-letter", &cover_letter
,
1437 N_("generate a cover letter")),
1438 OPT_BOOL(0, "numbered-files", &just_numbers
,
1439 N_("use simple number sequence for output file names")),
1440 OPT_STRING(0, "suffix", &fmt_patch_suffix
, N_("sfx"),
1441 N_("use <sfx> instead of '.patch'")),
1442 OPT_INTEGER(0, "start-number", &start_number
,
1443 N_("start numbering patches at <n> instead of 1")),
1444 OPT_INTEGER('v', "reroll-count", &reroll_count
,
1445 N_("mark the series as Nth re-roll")),
1446 { OPTION_CALLBACK
, 0, "rfc", &rev
, NULL
,
1447 N_("Use [RFC PATCH] instead of [PATCH]"),
1448 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, rfc_callback
},
1449 { OPTION_CALLBACK
, 0, "subject-prefix", &rev
, N_("prefix"),
1450 N_("Use [<prefix>] instead of [PATCH]"),
1451 PARSE_OPT_NONEG
, subject_prefix_callback
},
1452 { OPTION_CALLBACK
, 'o', "output-directory", &output_directory
,
1453 N_("dir"), N_("store resulting files in <dir>"),
1454 PARSE_OPT_NONEG
, output_directory_callback
},
1455 { OPTION_CALLBACK
, 'k', "keep-subject", &rev
, NULL
,
1456 N_("don't strip/add [PATCH]"),
1457 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, keep_callback
},
1458 OPT_BOOL(0, "no-binary", &no_binary_diff
,
1459 N_("don't output binary diffs")),
1460 OPT_BOOL(0, "zero-commit", &zero_commit
,
1461 N_("output all-zero hash in From header")),
1462 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream
,
1463 N_("don't include a patch matching a commit upstream")),
1464 { OPTION_SET_INT
, 'p', "no-stat", &use_patch_format
, NULL
,
1465 N_("show patch format instead of default (patch + stat)"),
1466 PARSE_OPT_NONEG
| PARSE_OPT_NOARG
, NULL
, 1},
1467 OPT_GROUP(N_("Messaging")),
1468 { OPTION_CALLBACK
, 0, "add-header", NULL
, N_("header"),
1469 N_("add email header"), 0, header_callback
},
1470 { OPTION_CALLBACK
, 0, "to", NULL
, N_("email"), N_("add To: header"),
1472 { OPTION_CALLBACK
, 0, "cc", NULL
, N_("email"), N_("add Cc: header"),
1474 { OPTION_CALLBACK
, 0, "from", &from
, N_("ident"),
1475 N_("set From address to <ident> (or committer ident if absent)"),
1476 PARSE_OPT_OPTARG
, from_callback
},
1477 OPT_STRING(0, "in-reply-to", &in_reply_to
, N_("message-id"),
1478 N_("make first mail a reply to <message-id>")),
1479 { OPTION_CALLBACK
, 0, "attach", &rev
, N_("boundary"),
1480 N_("attach the patch"), PARSE_OPT_OPTARG
,
1482 { OPTION_CALLBACK
, 0, "inline", &rev
, N_("boundary"),
1483 N_("inline the patch"),
1484 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
1486 { OPTION_CALLBACK
, 0, "thread", &thread
, N_("style"),
1487 N_("enable message threading, styles: shallow, deep"),
1488 PARSE_OPT_OPTARG
, thread_callback
},
1489 OPT_STRING(0, "signature", &signature
, N_("signature"),
1490 N_("add a signature")),
1491 OPT_STRING(0, "base", &base_commit
, N_("base-commit"),
1492 N_("add prerequisite tree info to the patch series")),
1493 OPT_FILENAME(0, "signature-file", &signature_file
,
1494 N_("add a signature from a file")),
1495 OPT__QUIET(&quiet
, N_("don't print the patch filenames")),
1496 OPT_BOOL(0, "progress", &show_progress
,
1497 N_("show progress while generating patches")),
1501 extra_hdr
.strdup_strings
= 1;
1502 extra_to
.strdup_strings
= 1;
1503 extra_cc
.strdup_strings
= 1;
1504 init_log_defaults();
1505 git_config(git_format_config
, NULL
);
1506 init_revisions(&rev
, prefix
);
1507 rev
.commit_format
= CMIT_FMT_EMAIL
;
1508 rev
.expand_tabs_in_log_default
= 0;
1509 rev
.verbose_header
= 1;
1511 rev
.max_parents
= 1;
1512 DIFF_OPT_SET(&rev
.diffopt
, RECURSIVE
);
1513 rev
.subject_prefix
= fmt_patch_subject_prefix
;
1514 memset(&s_r_opt
, 0, sizeof(s_r_opt
));
1515 s_r_opt
.def
= "HEAD";
1516 s_r_opt
.revarg_opt
= REVARG_COMMITTISH
;
1518 if (default_attach
) {
1519 rev
.mime_boundary
= default_attach
;
1524 * Parse the arguments before setup_revisions(), or something
1525 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1526 * possibly a valid SHA1.
1528 argc
= parse_options(argc
, argv
, prefix
, builtin_format_patch_options
,
1529 builtin_format_patch_usage
,
1530 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
1531 PARSE_OPT_KEEP_DASHDASH
);
1533 if (0 < reroll_count
) {
1534 struct strbuf sprefix
= STRBUF_INIT
;
1535 strbuf_addf(&sprefix
, "%s v%d",
1536 rev
.subject_prefix
, reroll_count
);
1537 rev
.reroll_count
= reroll_count
;
1538 rev
.subject_prefix
= strbuf_detach(&sprefix
, NULL
);
1541 for (i
= 0; i
< extra_hdr
.nr
; i
++) {
1542 strbuf_addstr(&buf
, extra_hdr
.items
[i
].string
);
1543 strbuf_addch(&buf
, '\n');
1547 strbuf_addstr(&buf
, "To: ");
1548 for (i
= 0; i
< extra_to
.nr
; i
++) {
1550 strbuf_addstr(&buf
, " ");
1551 strbuf_addstr(&buf
, extra_to
.items
[i
].string
);
1552 if (i
+ 1 < extra_to
.nr
)
1553 strbuf_addch(&buf
, ',');
1554 strbuf_addch(&buf
, '\n');
1558 strbuf_addstr(&buf
, "Cc: ");
1559 for (i
= 0; i
< extra_cc
.nr
; i
++) {
1561 strbuf_addstr(&buf
, " ");
1562 strbuf_addstr(&buf
, extra_cc
.items
[i
].string
);
1563 if (i
+ 1 < extra_cc
.nr
)
1564 strbuf_addch(&buf
, ',');
1565 strbuf_addch(&buf
, '\n');
1568 rev
.extra_headers
= strbuf_detach(&buf
, NULL
);
1571 if (split_ident_line(&rev
.from_ident
, from
, strlen(from
)))
1572 die(_("invalid ident line: %s"), from
);
1575 if (start_number
< 0)
1579 * If numbered is set solely due to format.numbered in config,
1580 * and it would conflict with --keep-subject (-k) from the
1581 * command line, reset "numbered".
1583 if (numbered
&& keep_subject
&& !numbered_cmdline_opt
)
1586 if (numbered
&& keep_subject
)
1587 die (_("-n and -k are mutually exclusive."));
1588 if (keep_subject
&& subject_prefix
)
1589 die (_("--subject-prefix/--rfc and -k are mutually exclusive."));
1590 rev
.preserve_subject
= keep_subject
;
1592 argc
= setup_revisions(argc
, argv
, &rev
, &s_r_opt
);
1594 die (_("unrecognized argument: %s"), argv
[1]);
1596 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME
)
1597 die(_("--name-only does not make sense"));
1598 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME_STATUS
)
1599 die(_("--name-status does not make sense"));
1600 if (rev
.diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
)
1601 die(_("--check does not make sense"));
1603 if (!use_patch_format
&&
1604 (!rev
.diffopt
.output_format
||
1605 rev
.diffopt
.output_format
== DIFF_FORMAT_PATCH
))
1606 rev
.diffopt
.output_format
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_SUMMARY
;
1608 /* Always generate a patch */
1609 rev
.diffopt
.output_format
|= DIFF_FORMAT_PATCH
;
1611 rev
.zero_commit
= zero_commit
;
1613 if (!DIFF_OPT_TST(&rev
.diffopt
, TEXT
) && !no_binary_diff
)
1614 DIFF_OPT_SET(&rev
.diffopt
, BINARY
);
1617 init_display_notes(&rev
.notes_opt
);
1619 if (!output_directory
&& !use_stdout
)
1620 output_directory
= config_output_directory
;
1623 output_directory
= set_outdir(prefix
, output_directory
);
1627 if (output_directory
) {
1628 if (rev
.diffopt
.use_color
!= GIT_COLOR_ALWAYS
)
1629 rev
.diffopt
.use_color
= GIT_COLOR_NEVER
;
1631 die(_("standard output, or directory, which one?"));
1632 if (mkdir(output_directory
, 0777) < 0 && errno
!= EEXIST
)
1633 die_errno(_("Could not create directory '%s'"),
1637 if (rev
.pending
.nr
== 1) {
1640 if (rev
.max_count
< 0 && !rev
.show_root_diff
) {
1642 * This is traditional behaviour of "git format-patch
1643 * origin" that prepares what the origin side still
1646 rev
.pending
.objects
[0].item
->flags
|= UNINTERESTING
;
1647 add_head_to_pending(&rev
);
1651 * Otherwise, it is "format-patch -22 HEAD", and/or
1652 * "format-patch --root HEAD". The user wants
1653 * get_revision() to do the usual traversal.
1656 if (!strcmp(rev
.pending
.objects
[0].name
, "HEAD"))
1660 struct object_id oid
;
1661 const char *ref
, *v
;
1662 ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
1664 if (ref
&& skip_prefix(ref
, "refs/heads/", &v
))
1665 branch_name
= xstrdup(v
);
1667 branch_name
= xstrdup(""); /* no branch */
1672 * We cannot move this anywhere earlier because we do want to
1673 * know if --root was given explicitly from the command line.
1675 rev
.show_root_diff
= 1;
1677 if (ignore_if_in_upstream
) {
1678 /* Don't say anything if head and upstream are the same. */
1679 if (rev
.pending
.nr
== 2) {
1680 struct object_array_entry
*o
= rev
.pending
.objects
;
1681 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1684 get_patch_ids(&rev
, &ids
);
1687 if (prepare_revision_walk(&rev
))
1688 die(_("revision walk setup failed"));
1690 while ((commit
= get_revision(&rev
)) != NULL
) {
1691 if (commit
->object
.flags
& BOUNDARY
) {
1693 origin
= (boundary_count
== 1) ? commit
: NULL
;
1697 if (ignore_if_in_upstream
&& has_commit_patch_id(commit
, &ids
))
1701 REALLOC_ARRAY(list
, nr
);
1702 list
[nr
- 1] = commit
;
1708 if (cover_letter
== -1) {
1709 if (config_cover_letter
== COVER_AUTO
)
1710 cover_letter
= (total
> 1);
1712 cover_letter
= (config_cover_letter
== COVER_ON
);
1714 if (!keep_subject
&& auto_number
&& (total
> 1 || cover_letter
))
1717 rev
.total
= total
+ start_number
- 1;
1720 ; /* --no-signature inhibits all signatures */
1721 } else if (signature
&& signature
!= git_version_string
) {
1722 ; /* non-default signature already set */
1723 } else if (signature_file
) {
1724 struct strbuf buf
= STRBUF_INIT
;
1726 if (strbuf_read_file(&buf
, signature_file
, 128) < 0)
1727 die_errno(_("unable to read signature file '%s'"), signature_file
);
1728 signature
= strbuf_detach(&buf
, NULL
);
1731 memset(&bases
, 0, sizeof(bases
));
1732 if (base_commit
|| base_auto
) {
1733 struct commit
*base
= get_base_commit(base_commit
, list
, nr
);
1734 reset_revision_walk();
1735 prepare_bases(&bases
, base
, list
, nr
);
1738 if (in_reply_to
|| thread
|| cover_letter
)
1739 rev
.ref_message_ids
= xcalloc(1, sizeof(struct string_list
));
1741 const char *msgid
= clean_message_id(in_reply_to
);
1742 string_list_append(rev
.ref_message_ids
, msgid
);
1744 rev
.numbered_files
= just_numbers
;
1745 rev
.patch_suffix
= fmt_patch_suffix
;
1748 gen_message_id(&rev
, "cover");
1749 make_cover_letter(&rev
, use_stdout
,
1750 origin
, nr
, list
, branch_name
, quiet
);
1751 print_bases(&bases
, rev
.diffopt
.file
);
1752 print_signature(rev
.diffopt
.file
);
1756 rev
.add_signoff
= do_signoff
;
1759 progress
= start_progress_delay(_("Generating patches"), total
, 0, 2);
1762 display_progress(progress
, total
- nr
);
1764 rev
.nr
= total
- nr
+ (start_number
- 1);
1765 /* Make the second and subsequent mails replies to the first */
1767 /* Have we already had a message ID? */
1768 if (rev
.message_id
) {
1770 * For deep threading: make every mail
1771 * a reply to the previous one, no
1772 * matter what other options are set.
1774 * For shallow threading:
1776 * Without --cover-letter and
1777 * --in-reply-to, make every mail a
1778 * reply to the one before.
1780 * With --in-reply-to but no
1781 * --cover-letter, make every mail a
1782 * reply to the <reply-to>.
1784 * With --cover-letter, make every
1785 * mail but the cover letter a reply
1786 * to the cover letter. The cover
1787 * letter is a reply to the
1788 * --in-reply-to, if specified.
1790 if (thread
== THREAD_SHALLOW
1791 && rev
.ref_message_ids
->nr
> 0
1792 && (!cover_letter
|| rev
.nr
> 1))
1793 free(rev
.message_id
);
1795 string_list_append(rev
.ref_message_ids
,
1798 gen_message_id(&rev
, oid_to_hex(&commit
->object
.oid
));
1802 open_next_file(rev
.numbered_files
? NULL
: commit
, NULL
, &rev
, quiet
))
1803 die(_("Failed to create output files"));
1804 shown
= log_tree_commit(&rev
, commit
);
1805 free_commit_buffer(commit
);
1807 /* We put one extra blank line between formatted
1808 * patches and this flag is used by log-tree code
1809 * to see if it needs to emit a LF before showing
1810 * the log; when using one file per patch, we do
1811 * not want the extra blank line.
1816 print_bases(&bases
, rev
.diffopt
.file
);
1817 if (rev
.mime_boundary
)
1818 fprintf(rev
.diffopt
.file
, "\n--%s%s--\n\n\n",
1819 mime_boundary_leader
,
1822 print_signature(rev
.diffopt
.file
);
1825 fclose(rev
.diffopt
.file
);
1827 stop_progress(&progress
);
1830 string_list_clear(&extra_to
, 0);
1831 string_list_clear(&extra_cc
, 0);
1832 string_list_clear(&extra_hdr
, 0);
1833 if (ignore_if_in_upstream
)
1834 free_patch_ids(&ids
);
1838 static int add_pending_commit(const char *arg
, struct rev_info
*revs
, int flags
)
1840 struct object_id oid
;
1841 if (get_oid(arg
, &oid
) == 0) {
1842 struct commit
*commit
= lookup_commit_reference(&oid
);
1844 commit
->object
.flags
|= flags
;
1845 add_pending_object(revs
, &commit
->object
, arg
);
1852 static const char * const cherry_usage
[] = {
1853 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1857 static void print_commit(char sign
, struct commit
*commit
, int verbose
,
1858 int abbrev
, FILE *file
)
1861 fprintf(file
, "%c %s\n", sign
,
1862 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
));
1864 struct strbuf buf
= STRBUF_INIT
;
1865 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &buf
);
1866 fprintf(file
, "%c %s %s\n", sign
,
1867 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
),
1869 strbuf_release(&buf
);
1873 int cmd_cherry(int argc
, const char **argv
, const char *prefix
)
1875 struct rev_info revs
;
1876 struct patch_ids ids
;
1877 struct commit
*commit
;
1878 struct commit_list
*list
= NULL
;
1879 struct branch
*current_branch
;
1880 const char *upstream
;
1881 const char *head
= "HEAD";
1882 const char *limit
= NULL
;
1883 int verbose
= 0, abbrev
= 0;
1885 struct option options
[] = {
1886 OPT__ABBREV(&abbrev
),
1887 OPT__VERBOSE(&verbose
, N_("be verbose")),
1891 argc
= parse_options(argc
, argv
, prefix
, options
, cherry_usage
, 0);
1904 current_branch
= branch_get(NULL
);
1905 upstream
= branch_get_upstream(current_branch
, NULL
);
1907 fprintf(stderr
, _("Could not find a tracked"
1908 " remote branch, please"
1909 " specify <upstream> manually.\n"));
1910 usage_with_options(cherry_usage
, options
);
1914 init_revisions(&revs
, prefix
);
1915 revs
.max_parents
= 1;
1917 if (add_pending_commit(head
, &revs
, 0))
1918 die(_("Unknown commit %s"), head
);
1919 if (add_pending_commit(upstream
, &revs
, UNINTERESTING
))
1920 die(_("Unknown commit %s"), upstream
);
1922 /* Don't say anything if head and upstream are the same. */
1923 if (revs
.pending
.nr
== 2) {
1924 struct object_array_entry
*o
= revs
.pending
.objects
;
1925 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1929 get_patch_ids(&revs
, &ids
);
1931 if (limit
&& add_pending_commit(limit
, &revs
, UNINTERESTING
))
1932 die(_("Unknown commit %s"), limit
);
1934 /* reverse the list of commits */
1935 if (prepare_revision_walk(&revs
))
1936 die(_("revision walk setup failed"));
1937 while ((commit
= get_revision(&revs
)) != NULL
) {
1938 commit_list_insert(commit
, &list
);
1944 commit
= list
->item
;
1945 if (has_commit_patch_id(commit
, &ids
))
1947 print_commit(sign
, commit
, verbose
, abbrev
, revs
.diffopt
.file
);
1951 free_patch_ids(&ids
);