2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
16 #include "reflog-walk.h"
17 #include "patch-ids.h"
18 #include "run-command.h"
21 #include "string-list.h"
22 #include "parse-options.h"
25 #include "streaming.h"
28 #include "gpg-interface.h"
30 /* Set a default date-time format for git log ("log.date" config variable) */
31 static const char *default_date_mode
= NULL
;
33 static int default_abbrev_commit
;
34 static int default_show_root
= 1;
35 static int default_follow
;
36 static int default_show_signature
;
37 static int decoration_style
;
38 static int decoration_given
;
39 static int use_mailmap_config
;
40 static const char *fmt_patch_subject_prefix
= "PATCH";
41 static const char *fmt_pretty
;
43 static const char * const builtin_log_usage
[] = {
44 N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
45 N_("git show [<options>] <object>..."),
49 struct line_opt_callback_data
{
52 struct string_list args
;
55 static int auto_decoration_style(void)
57 return (isatty(1) || pager_in_use()) ? DECORATE_SHORT_REFS
: 0;
60 static int parse_decoration_style(const char *var
, const char *value
)
62 switch (git_config_maybe_bool(var
, value
)) {
64 return DECORATE_SHORT_REFS
;
70 if (!strcmp(value
, "full"))
71 return DECORATE_FULL_REFS
;
72 else if (!strcmp(value
, "short"))
73 return DECORATE_SHORT_REFS
;
74 else if (!strcmp(value
, "auto"))
75 return auto_decoration_style();
79 static int decorate_callback(const struct option
*opt
, const char *arg
, int unset
)
84 decoration_style
= parse_decoration_style("command line", arg
);
86 decoration_style
= DECORATE_SHORT_REFS
;
88 if (decoration_style
< 0)
89 die(_("invalid --decorate option: %s"), arg
);
96 static int log_line_range_callback(const struct option
*option
, const char *arg
, int unset
)
98 struct line_opt_callback_data
*data
= option
->value
;
103 data
->rev
->line_level_traverse
= 1;
104 string_list_append(&data
->args
, arg
);
109 static void init_log_defaults(void)
111 init_grep_defaults();
112 init_diff_ui_defaults();
114 decoration_style
= auto_decoration_style();
117 static void cmd_log_init_defaults(struct rev_info
*rev
)
120 get_commit_format(fmt_pretty
, rev
);
122 DIFF_OPT_SET(&rev
->diffopt
, DEFAULT_FOLLOW_RENAMES
);
123 rev
->verbose_header
= 1;
124 DIFF_OPT_SET(&rev
->diffopt
, RECURSIVE
);
125 rev
->diffopt
.stat_width
= -1; /* use full terminal width */
126 rev
->diffopt
.stat_graph_width
= -1; /* respect statGraphWidth config */
127 rev
->abbrev_commit
= default_abbrev_commit
;
128 rev
->show_root_diff
= default_show_root
;
129 rev
->subject_prefix
= fmt_patch_subject_prefix
;
130 rev
->show_signature
= default_show_signature
;
131 DIFF_OPT_SET(&rev
->diffopt
, ALLOW_TEXTCONV
);
133 if (default_date_mode
)
134 parse_date_format(default_date_mode
, &rev
->date_mode
);
135 rev
->diffopt
.touched_flags
= 0;
138 static void cmd_log_init_finish(int argc
, const char **argv
, const char *prefix
,
139 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
141 struct userformat_want w
;
142 int quiet
= 0, source
= 0, mailmap
= 0;
143 static struct line_opt_callback_data line_cb
= {NULL
, NULL
, STRING_LIST_INIT_DUP
};
145 const struct option builtin_log_options
[] = {
146 OPT__QUIET(&quiet
, N_("suppress diff output")),
147 OPT_BOOL(0, "source", &source
, N_("show source")),
148 OPT_BOOL(0, "use-mailmap", &mailmap
, N_("Use mail map file")),
149 { OPTION_CALLBACK
, 0, "decorate", NULL
, NULL
, N_("decorate options"),
150 PARSE_OPT_OPTARG
, decorate_callback
},
151 OPT_CALLBACK('L', NULL
, &line_cb
, "n,m:file",
152 N_("Process line range n,m in file, counting from 1"),
153 log_line_range_callback
),
158 line_cb
.prefix
= prefix
;
160 mailmap
= use_mailmap_config
;
161 argc
= parse_options(argc
, argv
, prefix
,
162 builtin_log_options
, builtin_log_usage
,
163 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
164 PARSE_OPT_KEEP_DASHDASH
);
167 rev
->diffopt
.output_format
|= DIFF_FORMAT_NO_OUTPUT
;
168 argc
= setup_revisions(argc
, argv
, rev
, opt
);
170 /* Any arguments at this point are not recognized */
172 die(_("unrecognized argument: %s"), argv
[1]);
174 memset(&w
, 0, sizeof(w
));
175 userformat_find_requirements(NULL
, &w
);
177 if (!rev
->show_notes_given
&& (!rev
->pretty_given
|| w
.notes
))
180 init_display_notes(&rev
->notes_opt
);
182 if (rev
->diffopt
.pickaxe
|| rev
->diffopt
.filter
||
183 DIFF_OPT_TST(&rev
->diffopt
, FOLLOW_RENAMES
))
184 rev
->always_show_header
= 0;
187 rev
->show_source
= 1;
190 rev
->mailmap
= xcalloc(1, sizeof(struct string_list
));
191 read_mailmap(rev
->mailmap
, NULL
);
194 if (rev
->pretty_given
&& rev
->commit_format
== CMIT_FMT_RAW
) {
196 * "log --pretty=raw" is special; ignore UI oriented
197 * configuration variables such as decoration.
199 if (!decoration_given
)
200 decoration_style
= 0;
201 if (!rev
->abbrev_commit_given
)
202 rev
->abbrev_commit
= 0;
205 if (decoration_style
) {
206 rev
->show_decorations
= 1;
207 load_ref_decorations(decoration_style
);
210 if (rev
->line_level_traverse
)
211 line_log_init(rev
, line_cb
.prefix
, &line_cb
.args
);
216 static void cmd_log_init(int argc
, const char **argv
, const char *prefix
,
217 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
219 cmd_log_init_defaults(rev
);
220 cmd_log_init_finish(argc
, argv
, prefix
, rev
, opt
);
224 * This gives a rough estimate for how many commits we
225 * will print out in the list.
227 static int estimate_commit_count(struct rev_info
*rev
, struct commit_list
*list
)
232 struct commit
*commit
= list
->item
;
233 unsigned int flags
= commit
->object
.flags
;
235 if (!(flags
& (TREESAME
| UNINTERESTING
)))
241 static void show_early_header(struct rev_info
*rev
, const char *stage
, int nr
)
243 if (rev
->shown_one
) {
245 if (rev
->commit_format
!= CMIT_FMT_ONELINE
)
246 putchar(rev
->diffopt
.line_termination
);
248 fprintf(rev
->diffopt
.file
, _("Final output: %d %s\n"), nr
, stage
);
251 static struct itimerval early_output_timer
;
253 static void log_show_early(struct rev_info
*revs
, struct commit_list
*list
)
255 int i
= revs
->early_output
, close_file
= revs
->diffopt
.close_file
;
258 revs
->diffopt
.close_file
= 0;
259 sort_in_topological_order(&list
, revs
->sort_order
);
261 struct commit
*commit
= list
->item
;
262 switch (simplify_commit(revs
, commit
)) {
265 int n
= estimate_commit_count(revs
, list
);
266 show_early_header(revs
, "incomplete", n
);
269 log_tree_commit(revs
, commit
);
276 fclose(revs
->diffopt
.file
);
282 /* Did we already get enough commits for the early output? */
285 fclose(revs
->diffopt
.file
);
290 * ..if no, then repeat it twice a second until we
293 * NOTE! We don't use "it_interval", because if the
294 * reader isn't listening, we want our output to be
295 * throttled by the writing, and not have the timer
296 * trigger every second even if we're blocked on a
299 early_output_timer
.it_value
.tv_sec
= 0;
300 early_output_timer
.it_value
.tv_usec
= 500000;
301 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
304 static void early_output(int signal
)
306 show_early_output
= log_show_early
;
309 static void setup_early_output(struct rev_info
*rev
)
314 * Set up the signal handler, minimally intrusively:
315 * we only set a single volatile integer word (not
316 * using sigatomic_t - trying to avoid unnecessary
317 * system dependencies and headers), and using
320 memset(&sa
, 0, sizeof(sa
));
321 sa
.sa_handler
= early_output
;
322 sigemptyset(&sa
.sa_mask
);
323 sa
.sa_flags
= SA_RESTART
;
324 sigaction(SIGALRM
, &sa
, NULL
);
327 * If we can get the whole output in less than a
328 * tenth of a second, don't even bother doing the
329 * early-output thing..
331 * This is a one-time-only trigger.
333 early_output_timer
.it_value
.tv_sec
= 0;
334 early_output_timer
.it_value
.tv_usec
= 100000;
335 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
338 static void finish_early_output(struct rev_info
*rev
)
340 int n
= estimate_commit_count(rev
, rev
->commits
);
341 signal(SIGALRM
, SIG_IGN
);
342 show_early_header(rev
, "done", n
);
345 static int cmd_log_walk(struct rev_info
*rev
)
347 struct commit
*commit
;
349 int saved_dcctc
= 0, close_file
= rev
->diffopt
.close_file
;
351 if (rev
->early_output
)
352 setup_early_output(rev
);
354 if (prepare_revision_walk(rev
))
355 die(_("revision walk setup failed"));
357 if (rev
->early_output
)
358 finish_early_output(rev
);
361 * For --check and --exit-code, the exit code is based on CHECK_FAILED
362 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
363 * retain that state information if replacing rev->diffopt in this loop
365 rev
->diffopt
.close_file
= 0;
366 while ((commit
= get_revision(rev
)) != NULL
) {
367 if (!log_tree_commit(rev
, commit
) && rev
->max_count
>= 0)
369 * We decremented max_count in get_revision,
370 * but we didn't actually show the commit.
373 if (!rev
->reflog_info
) {
374 /* we allow cycles in reflog ancestry */
375 free_commit_buffer(commit
);
377 free_commit_list(commit
->parents
);
378 commit
->parents
= NULL
;
379 if (saved_nrl
< rev
->diffopt
.needed_rename_limit
)
380 saved_nrl
= rev
->diffopt
.needed_rename_limit
;
381 if (rev
->diffopt
.degraded_cc_to_c
)
384 rev
->diffopt
.degraded_cc_to_c
= saved_dcctc
;
385 rev
->diffopt
.needed_rename_limit
= saved_nrl
;
387 fclose(rev
->diffopt
.file
);
389 if (rev
->diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
&&
390 DIFF_OPT_TST(&rev
->diffopt
, CHECK_FAILED
)) {
393 return diff_result_code(&rev
->diffopt
, 0);
396 static int git_log_config(const char *var
, const char *value
, void *cb
)
398 const char *slot_name
;
400 if (!strcmp(var
, "format.pretty"))
401 return git_config_string(&fmt_pretty
, var
, value
);
402 if (!strcmp(var
, "format.subjectprefix"))
403 return git_config_string(&fmt_patch_subject_prefix
, var
, value
);
404 if (!strcmp(var
, "log.abbrevcommit")) {
405 default_abbrev_commit
= git_config_bool(var
, value
);
408 if (!strcmp(var
, "log.date"))
409 return git_config_string(&default_date_mode
, var
, value
);
410 if (!strcmp(var
, "log.decorate")) {
411 decoration_style
= parse_decoration_style(var
, value
);
412 if (decoration_style
< 0)
413 decoration_style
= 0; /* maybe warn? */
416 if (!strcmp(var
, "log.showroot")) {
417 default_show_root
= git_config_bool(var
, value
);
420 if (!strcmp(var
, "log.follow")) {
421 default_follow
= git_config_bool(var
, value
);
424 if (skip_prefix(var
, "color.decorate.", &slot_name
))
425 return parse_decorate_color_config(var
, slot_name
, value
);
426 if (!strcmp(var
, "log.mailmap")) {
427 use_mailmap_config
= git_config_bool(var
, value
);
430 if (!strcmp(var
, "log.showsignature")) {
431 default_show_signature
= git_config_bool(var
, value
);
435 if (grep_config(var
, value
, cb
) < 0)
437 if (git_gpg_config(var
, value
, cb
) < 0)
439 return git_diff_ui_config(var
, value
, cb
);
442 int cmd_whatchanged(int argc
, const char **argv
, const char *prefix
)
445 struct setup_revision_opt opt
;
448 git_config(git_log_config
, NULL
);
450 init_revisions(&rev
, prefix
);
452 rev
.simplify_history
= 0;
453 memset(&opt
, 0, sizeof(opt
));
455 opt
.revarg_opt
= REVARG_COMMITTISH
;
456 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
457 if (!rev
.diffopt
.output_format
)
458 rev
.diffopt
.output_format
= DIFF_FORMAT_RAW
;
459 return cmd_log_walk(&rev
);
462 static void show_tagger(char *buf
, int len
, struct rev_info
*rev
)
464 struct strbuf out
= STRBUF_INIT
;
465 struct pretty_print_context pp
= {0};
467 pp
.fmt
= rev
->commit_format
;
468 pp
.date_mode
= rev
->date_mode
;
469 pp_user_info(&pp
, "Tagger", &out
, buf
, get_log_output_encoding());
470 fprintf(rev
->diffopt
.file
, "%s", out
.buf
);
471 strbuf_release(&out
);
474 static int show_blob_object(const struct object_id
*oid
, struct rev_info
*rev
, const char *obj_name
)
476 struct object_id oidc
;
477 struct object_context obj_context
;
481 fflush(rev
->diffopt
.file
);
482 if (!DIFF_OPT_TOUCHED(&rev
->diffopt
, ALLOW_TEXTCONV
) ||
483 !DIFF_OPT_TST(&rev
->diffopt
, ALLOW_TEXTCONV
))
484 return stream_blob_to_fd(1, oid
, NULL
, 0);
486 if (get_sha1_with_context(obj_name
, GET_SHA1_RECORD_PATH
,
487 oidc
.hash
, &obj_context
))
488 die(_("Not a valid object name %s"), obj_name
);
489 if (!obj_context
.path
||
490 !textconv_object(obj_context
.path
, obj_context
.mode
, &oidc
, 1, &buf
, &size
)) {
491 free(obj_context
.path
);
492 return stream_blob_to_fd(1, oid
, NULL
, 0);
496 die(_("git show %s: bad file"), obj_name
);
498 write_or_die(1, buf
, size
);
499 free(obj_context
.path
);
503 static int show_tag_object(const struct object_id
*oid
, struct rev_info
*rev
)
506 enum object_type type
;
507 char *buf
= read_sha1_file(oid
->hash
, &type
, &size
);
511 return error(_("Could not read object %s"), oid_to_hex(oid
));
513 assert(type
== OBJ_TAG
);
514 while (offset
< size
&& buf
[offset
] != '\n') {
515 int new_offset
= offset
+ 1;
516 while (new_offset
< size
&& buf
[new_offset
++] != '\n')
518 if (starts_with(buf
+ offset
, "tagger "))
519 show_tagger(buf
+ offset
+ 7,
520 new_offset
- offset
- 7, rev
);
525 fwrite(buf
+ offset
, size
- offset
, 1, rev
->diffopt
.file
);
530 static int show_tree_object(const unsigned char *sha1
,
532 const char *pathname
, unsigned mode
, int stage
, void *context
)
534 FILE *file
= context
;
535 fprintf(file
, "%s%s\n", pathname
, S_ISDIR(mode
) ? "/" : "");
539 static void show_setup_revisions_tweak(struct rev_info
*rev
,
540 struct setup_revision_opt
*opt
)
542 if (rev
->ignore_merges
) {
543 /* There was no "-m" on the command line */
544 rev
->ignore_merges
= 0;
545 if (!rev
->first_parent_only
&& !rev
->combine_merges
) {
546 /* No "--first-parent", "-c", or "--cc" */
547 rev
->combine_merges
= 1;
548 rev
->dense_combined_merges
= 1;
551 if (!rev
->diffopt
.output_format
)
552 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
555 int cmd_show(int argc
, const char **argv
, const char *prefix
)
558 struct object_array_entry
*objects
;
559 struct setup_revision_opt opt
;
560 struct pathspec match_all
;
561 int i
, count
, ret
= 0;
564 git_config(git_log_config
, NULL
);
566 memset(&match_all
, 0, sizeof(match_all
));
567 init_revisions(&rev
, prefix
);
569 rev
.always_show_header
= 1;
570 rev
.no_walk
= REVISION_WALK_NO_WALK_SORTED
;
571 rev
.diffopt
.stat_width
= -1; /* Scale to real terminal size */
573 memset(&opt
, 0, sizeof(opt
));
575 opt
.tweak
= show_setup_revisions_tweak
;
576 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
579 return cmd_log_walk(&rev
);
581 count
= rev
.pending
.nr
;
582 objects
= rev
.pending
.objects
;
583 for (i
= 0; i
< count
&& !ret
; i
++) {
584 struct object
*o
= objects
[i
].item
;
585 const char *name
= objects
[i
].name
;
588 ret
= show_blob_object(&o
->oid
, &rev
, name
);
591 struct tag
*t
= (struct tag
*)o
;
595 fprintf(rev
.diffopt
.file
, "%stag %s%s\n",
596 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
598 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
599 ret
= show_tag_object(&o
->oid
, &rev
);
603 o
= parse_object(&t
->tagged
->oid
);
605 ret
= error(_("Could not read object %s"),
606 oid_to_hex(&t
->tagged
->oid
));
614 fprintf(rev
.diffopt
.file
, "%stree %s%s\n\n",
615 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
617 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
618 read_tree_recursive((struct tree
*)o
, "", 0, 0, &match_all
,
619 show_tree_object
, rev
.diffopt
.file
);
623 rev
.pending
.nr
= rev
.pending
.alloc
= 0;
624 rev
.pending
.objects
= NULL
;
625 add_object_array(o
, name
, &rev
.pending
);
626 ret
= cmd_log_walk(&rev
);
629 ret
= error(_("Unknown type: %d"), o
->type
);
637 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
639 int cmd_log_reflog(int argc
, const char **argv
, const char *prefix
)
642 struct setup_revision_opt opt
;
645 git_config(git_log_config
, NULL
);
647 init_revisions(&rev
, prefix
);
648 init_reflog_walk(&rev
.reflog_info
);
649 rev
.verbose_header
= 1;
650 memset(&opt
, 0, sizeof(opt
));
652 cmd_log_init_defaults(&rev
);
653 rev
.abbrev_commit
= 1;
654 rev
.commit_format
= CMIT_FMT_ONELINE
;
655 rev
.use_terminator
= 1;
656 rev
.always_show_header
= 1;
657 cmd_log_init_finish(argc
, argv
, prefix
, &rev
, &opt
);
659 return cmd_log_walk(&rev
);
662 static void log_setup_revisions_tweak(struct rev_info
*rev
,
663 struct setup_revision_opt
*opt
)
665 if (DIFF_OPT_TST(&rev
->diffopt
, DEFAULT_FOLLOW_RENAMES
) &&
666 rev
->prune_data
.nr
== 1)
667 DIFF_OPT_SET(&rev
->diffopt
, FOLLOW_RENAMES
);
669 /* Turn --cc/-c into -p --cc/-c when -p was not given */
670 if (!rev
->diffopt
.output_format
&& rev
->combine_merges
)
671 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
673 /* Turn -m on when --cc/-c was given */
674 if (rev
->combine_merges
)
675 rev
->ignore_merges
= 0;
678 int cmd_log(int argc
, const char **argv
, const char *prefix
)
681 struct setup_revision_opt opt
;
684 git_config(git_log_config
, NULL
);
686 init_revisions(&rev
, prefix
);
687 rev
.always_show_header
= 1;
688 memset(&opt
, 0, sizeof(opt
));
690 opt
.revarg_opt
= REVARG_COMMITTISH
;
691 opt
.tweak
= log_setup_revisions_tweak
;
692 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
693 return cmd_log_walk(&rev
);
698 static const char *fmt_patch_suffix
= ".patch";
699 static int numbered
= 0;
700 static int auto_number
= 1;
702 static char *default_attach
= NULL
;
704 static struct string_list extra_hdr
= STRING_LIST_INIT_NODUP
;
705 static struct string_list extra_to
= STRING_LIST_INIT_NODUP
;
706 static struct string_list extra_cc
= STRING_LIST_INIT_NODUP
;
708 static void add_header(const char *value
)
710 struct string_list_item
*item
;
711 int len
= strlen(value
);
712 while (len
&& value
[len
- 1] == '\n')
715 if (!strncasecmp(value
, "to: ", 4)) {
716 item
= string_list_append(&extra_to
, value
+ 4);
718 } else if (!strncasecmp(value
, "cc: ", 4)) {
719 item
= string_list_append(&extra_cc
, value
+ 4);
722 item
= string_list_append(&extra_hdr
, value
);
725 item
->string
[len
] = '\0';
728 #define THREAD_SHALLOW 1
729 #define THREAD_DEEP 2
731 static int do_signoff
;
732 static int base_auto
;
734 static const char *signature
= git_version_string
;
735 static const char *signature_file
;
736 static int config_cover_letter
;
737 static const char *config_output_directory
;
746 static int git_format_config(const char *var
, const char *value
, void *cb
)
748 if (!strcmp(var
, "format.headers")) {
750 die(_("format.headers without value"));
754 if (!strcmp(var
, "format.suffix"))
755 return git_config_string(&fmt_patch_suffix
, var
, value
);
756 if (!strcmp(var
, "format.to")) {
758 return config_error_nonbool(var
);
759 string_list_append(&extra_to
, value
);
762 if (!strcmp(var
, "format.cc")) {
764 return config_error_nonbool(var
);
765 string_list_append(&extra_cc
, value
);
768 if (!strcmp(var
, "diff.color") || !strcmp(var
, "color.diff") ||
769 !strcmp(var
, "color.ui") || !strcmp(var
, "diff.submodule")) {
772 if (!strcmp(var
, "format.numbered")) {
773 if (value
&& !strcasecmp(value
, "auto")) {
777 numbered
= git_config_bool(var
, value
);
778 auto_number
= auto_number
&& numbered
;
781 if (!strcmp(var
, "format.attach")) {
783 default_attach
= xstrdup(value
);
785 default_attach
= xstrdup(git_version_string
);
788 if (!strcmp(var
, "format.thread")) {
789 if (value
&& !strcasecmp(value
, "deep")) {
790 thread
= THREAD_DEEP
;
793 if (value
&& !strcasecmp(value
, "shallow")) {
794 thread
= THREAD_SHALLOW
;
797 thread
= git_config_bool(var
, value
) && THREAD_SHALLOW
;
800 if (!strcmp(var
, "format.signoff")) {
801 do_signoff
= git_config_bool(var
, value
);
804 if (!strcmp(var
, "format.signature"))
805 return git_config_string(&signature
, var
, value
);
806 if (!strcmp(var
, "format.signaturefile"))
807 return git_config_pathname(&signature_file
, var
, value
);
808 if (!strcmp(var
, "format.coverletter")) {
809 if (value
&& !strcasecmp(value
, "auto")) {
810 config_cover_letter
= COVER_AUTO
;
813 config_cover_letter
= git_config_bool(var
, value
) ? COVER_ON
: COVER_OFF
;
816 if (!strcmp(var
, "format.outputdirectory"))
817 return git_config_string(&config_output_directory
, var
, value
);
818 if (!strcmp(var
, "format.useautobase")) {
819 base_auto
= git_config_bool(var
, value
);
822 if (!strcmp(var
, "format.from")) {
823 int b
= git_config_maybe_bool(var
, value
);
826 from
= xstrdup(value
);
828 from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
834 return git_log_config(var
, value
, cb
);
837 static const char *output_directory
= NULL
;
838 static int outdir_offset
;
840 static int open_next_file(struct commit
*commit
, const char *subject
,
841 struct rev_info
*rev
, int quiet
)
843 struct strbuf filename
= STRBUF_INIT
;
844 int suffix_len
= strlen(rev
->patch_suffix
) + 1;
846 if (output_directory
) {
847 strbuf_addstr(&filename
, output_directory
);
849 PATH_MAX
- FORMAT_PATCH_NAME_MAX
- suffix_len
) {
850 strbuf_release(&filename
);
851 return error(_("name of output directory is too long"));
853 strbuf_complete(&filename
, '/');
856 if (rev
->numbered_files
)
857 strbuf_addf(&filename
, "%d", rev
->nr
);
859 fmt_output_commit(&filename
, commit
, rev
);
861 fmt_output_subject(&filename
, subject
, rev
);
864 printf("%s\n", filename
.buf
+ outdir_offset
);
866 if ((rev
->diffopt
.file
= fopen(filename
.buf
, "w")) == NULL
) {
867 error_errno(_("Cannot open patch file %s"), filename
.buf
);
868 strbuf_release(&filename
);
872 strbuf_release(&filename
);
876 static void get_patch_ids(struct rev_info
*rev
, struct patch_ids
*ids
)
878 struct rev_info check_rev
;
879 struct commit
*commit
, *c1
, *c2
;
880 struct object
*o1
, *o2
;
881 unsigned flags1
, flags2
;
883 if (rev
->pending
.nr
!= 2)
884 die(_("Need exactly one range."));
886 o1
= rev
->pending
.objects
[0].item
;
887 o2
= rev
->pending
.objects
[1].item
;
890 c1
= lookup_commit_reference(&o1
->oid
);
891 c2
= lookup_commit_reference(&o2
->oid
);
893 if ((flags1
& UNINTERESTING
) == (flags2
& UNINTERESTING
))
894 die(_("Not a range."));
898 /* given a range a..b get all patch ids for b..a */
899 init_revisions(&check_rev
, rev
->prefix
);
900 check_rev
.max_parents
= 1;
901 o1
->flags
^= UNINTERESTING
;
902 o2
->flags
^= UNINTERESTING
;
903 add_pending_object(&check_rev
, o1
, "o1");
904 add_pending_object(&check_rev
, o2
, "o2");
905 if (prepare_revision_walk(&check_rev
))
906 die(_("revision walk setup failed"));
908 while ((commit
= get_revision(&check_rev
)) != NULL
) {
909 add_commit_patch_id(commit
, ids
);
912 /* reset for next revision walk */
913 clear_commit_marks(c1
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
914 clear_commit_marks(c2
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
919 static void gen_message_id(struct rev_info
*info
, char *base
)
921 struct strbuf buf
= STRBUF_INIT
;
922 strbuf_addf(&buf
, "%s.%"PRItime
".git.%s", base
,
923 (timestamp_t
) time(NULL
),
924 git_committer_info(IDENT_NO_NAME
|IDENT_NO_DATE
|IDENT_STRICT
));
925 info
->message_id
= strbuf_detach(&buf
, NULL
);
928 static void print_signature(FILE *file
)
930 if (!signature
|| !*signature
)
933 fprintf(file
, "-- \n%s", signature
);
934 if (signature
[strlen(signature
)-1] != '\n')
939 static void add_branch_description(struct strbuf
*buf
, const char *branch_name
)
941 struct strbuf desc
= STRBUF_INIT
;
942 if (!branch_name
|| !*branch_name
)
944 read_branch_desc(&desc
, branch_name
);
946 strbuf_addch(buf
, '\n');
947 strbuf_addbuf(buf
, &desc
);
948 strbuf_addch(buf
, '\n');
950 strbuf_release(&desc
);
953 static char *find_branch_name(struct rev_info
*rev
)
955 int i
, positive
= -1;
956 struct object_id branch_oid
;
957 const struct object_id
*tip_oid
;
959 char *full_ref
, *branch
= NULL
;
961 for (i
= 0; i
< rev
->cmdline
.nr
; i
++) {
962 if (rev
->cmdline
.rev
[i
].flags
& UNINTERESTING
)
971 ref
= rev
->cmdline
.rev
[positive
].name
;
972 tip_oid
= &rev
->cmdline
.rev
[positive
].item
->oid
;
973 if (dwim_ref(ref
, strlen(ref
), branch_oid
.hash
, &full_ref
) &&
974 skip_prefix(full_ref
, "refs/heads/", &v
) &&
975 !oidcmp(tip_oid
, &branch_oid
))
981 static void make_cover_letter(struct rev_info
*rev
, int use_stdout
,
982 struct commit
*origin
,
983 int nr
, struct commit
**list
,
984 const char *branch_name
,
987 const char *committer
;
988 const char *body
= "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
991 struct strbuf sb
= STRBUF_INIT
;
993 const char *encoding
= "UTF-8";
994 struct diff_options opts
;
995 int need_8bit_cte
= 0;
996 struct pretty_print_context pp
= {0};
997 struct commit
*head
= list
[0];
999 if (!cmit_fmt_is_mail(rev
->commit_format
))
1000 die(_("Cover letter needs email format"));
1002 committer
= git_committer_info(0);
1005 open_next_file(NULL
, rev
->numbered_files
? NULL
: "cover-letter", rev
, quiet
))
1008 log_write_email_headers(rev
, head
, &pp
.after_subject
, &need_8bit_cte
);
1010 for (i
= 0; !need_8bit_cte
&& i
< nr
; i
++) {
1011 const char *buf
= get_commit_buffer(list
[i
], NULL
);
1012 if (has_non_ascii(buf
))
1014 unuse_commit_buffer(list
[i
], buf
);
1018 branch_name
= find_branch_name(rev
);
1021 pp
.fmt
= CMIT_FMT_EMAIL
;
1022 pp
.date_mode
.type
= DATE_RFC2822
;
1024 pp
.print_email_subject
= 1;
1025 pp_user_info(&pp
, NULL
, &sb
, committer
, encoding
);
1026 pp_title_line(&pp
, &msg
, &sb
, encoding
, need_8bit_cte
);
1027 pp_remainder(&pp
, &msg
, &sb
, 0);
1028 add_branch_description(&sb
, branch_name
);
1029 fprintf(rev
->diffopt
.file
, "%s\n", sb
.buf
);
1031 strbuf_release(&sb
);
1033 shortlog_init(&log
);
1038 log
.file
= rev
->diffopt
.file
;
1039 for (i
= 0; i
< nr
; i
++)
1040 shortlog_add_commit(&log
, list
[i
]);
1042 shortlog_output(&log
);
1045 * We can only do diffstat with a unique reference point
1050 memcpy(&opts
, &rev
->diffopt
, sizeof(opts
));
1051 opts
.output_format
= DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
1053 diff_setup_done(&opts
);
1055 diff_tree_sha1(origin
->tree
->object
.oid
.hash
,
1056 head
->tree
->object
.oid
.hash
,
1058 diffcore_std(&opts
);
1061 fprintf(rev
->diffopt
.file
, "\n");
1064 static const char *clean_message_id(const char *msg_id
)
1067 const char *a
, *z
, *m
;
1070 while ((ch
= *m
) && (isspace(ch
) || (ch
== '<')))
1075 if (!isspace(ch
) && (ch
!= '>'))
1080 die(_("insane in-reply-to: %s"), msg_id
);
1083 return xmemdupz(a
, z
- a
);
1086 static const char *set_outdir(const char *prefix
, const char *output_directory
)
1088 if (output_directory
&& is_absolute_path(output_directory
))
1089 return output_directory
;
1091 if (!prefix
|| !*prefix
) {
1092 if (output_directory
)
1093 return output_directory
;
1094 /* The user did not explicitly ask for "./" */
1099 outdir_offset
= strlen(prefix
);
1100 if (!output_directory
)
1103 return prefix_filename(prefix
, output_directory
);
1106 static const char * const builtin_format_patch_usage
[] = {
1107 N_("git format-patch [<options>] [<since> | <revision-range>]"),
1111 static int keep_subject
= 0;
1113 static int keep_callback(const struct option
*opt
, const char *arg
, int unset
)
1115 ((struct rev_info
*)opt
->value
)->total
= -1;
1120 static int subject_prefix
= 0;
1122 static int subject_prefix_callback(const struct option
*opt
, const char *arg
,
1126 ((struct rev_info
*)opt
->value
)->subject_prefix
= arg
;
1130 static int rfc_callback(const struct option
*opt
, const char *arg
, int unset
)
1132 return subject_prefix_callback(opt
, "RFC PATCH", unset
);
1135 static int numbered_cmdline_opt
= 0;
1137 static int numbered_callback(const struct option
*opt
, const char *arg
,
1140 *(int *)opt
->value
= numbered_cmdline_opt
= unset
? 0 : 1;
1146 static int no_numbered_callback(const struct option
*opt
, const char *arg
,
1149 return numbered_callback(opt
, arg
, 1);
1152 static int output_directory_callback(const struct option
*opt
, const char *arg
,
1155 const char **dir
= (const char **)opt
->value
;
1157 die(_("Two output directories?"));
1162 static int thread_callback(const struct option
*opt
, const char *arg
, int unset
)
1164 int *thread
= (int *)opt
->value
;
1167 else if (!arg
|| !strcmp(arg
, "shallow"))
1168 *thread
= THREAD_SHALLOW
;
1169 else if (!strcmp(arg
, "deep"))
1170 *thread
= THREAD_DEEP
;
1176 static int attach_callback(const struct option
*opt
, const char *arg
, int unset
)
1178 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1180 rev
->mime_boundary
= NULL
;
1182 rev
->mime_boundary
= arg
;
1184 rev
->mime_boundary
= git_version_string
;
1185 rev
->no_inline
= unset
? 0 : 1;
1189 static int inline_callback(const struct option
*opt
, const char *arg
, int unset
)
1191 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1193 rev
->mime_boundary
= NULL
;
1195 rev
->mime_boundary
= arg
;
1197 rev
->mime_boundary
= git_version_string
;
1202 static int header_callback(const struct option
*opt
, const char *arg
, int unset
)
1205 string_list_clear(&extra_hdr
, 0);
1206 string_list_clear(&extra_to
, 0);
1207 string_list_clear(&extra_cc
, 0);
1214 static int to_callback(const struct option
*opt
, const char *arg
, int unset
)
1217 string_list_clear(&extra_to
, 0);
1219 string_list_append(&extra_to
, arg
);
1223 static int cc_callback(const struct option
*opt
, const char *arg
, int unset
)
1226 string_list_clear(&extra_cc
, 0);
1228 string_list_append(&extra_cc
, arg
);
1232 static int from_callback(const struct option
*opt
, const char *arg
, int unset
)
1234 char **from
= opt
->value
;
1241 *from
= xstrdup(arg
);
1243 *from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
1247 struct base_tree_info
{
1248 struct object_id base_commit
;
1249 int nr_patch_id
, alloc_patch_id
;
1250 struct object_id
*patch_id
;
1253 static struct commit
*get_base_commit(const char *base_commit
,
1254 struct commit
**list
,
1257 struct commit
*base
= NULL
;
1258 struct commit
**rev
;
1259 int i
= 0, rev_nr
= 0;
1261 if (base_commit
&& strcmp(base_commit
, "auto")) {
1262 base
= lookup_commit_reference_by_name(base_commit
);
1264 die(_("Unknown commit %s"), base_commit
);
1265 } else if ((base_commit
&& !strcmp(base_commit
, "auto")) || base_auto
) {
1266 struct branch
*curr_branch
= branch_get(NULL
);
1267 const char *upstream
= branch_get_upstream(curr_branch
, NULL
);
1269 struct commit_list
*base_list
;
1270 struct commit
*commit
;
1271 struct object_id oid
;
1273 if (get_oid(upstream
, &oid
))
1274 die(_("Failed to resolve '%s' as a valid ref."), upstream
);
1275 commit
= lookup_commit_or_die(&oid
, "upstream base");
1276 base_list
= get_merge_bases_many(commit
, total
, list
);
1277 /* There should be one and only one merge base. */
1278 if (!base_list
|| base_list
->next
)
1279 die(_("Could not find exact merge base."));
1280 base
= base_list
->item
;
1281 free_commit_list(base_list
);
1283 die(_("Failed to get upstream, if you want to record base commit automatically,\n"
1284 "please use git branch --set-upstream-to to track a remote branch.\n"
1285 "Or you could specify base commit by --base=<base-commit-id> manually."));
1289 ALLOC_ARRAY(rev
, total
);
1290 for (i
= 0; i
< total
; i
++)
1295 * Get merge base through pair-wise computations
1296 * and store it in rev[0].
1298 while (rev_nr
> 1) {
1299 for (i
= 0; i
< rev_nr
/ 2; i
++) {
1300 struct commit_list
*merge_base
;
1301 merge_base
= get_merge_bases(rev
[2 * i
], rev
[2 * i
+ 1]);
1302 if (!merge_base
|| merge_base
->next
)
1303 die(_("Failed to find exact merge base"));
1305 rev
[i
] = merge_base
->item
;
1309 rev
[i
] = rev
[2 * i
];
1310 rev_nr
= (rev_nr
+ 1) / 2;
1313 if (!in_merge_bases(base
, rev
[0]))
1314 die(_("base commit should be the ancestor of revision list"));
1316 for (i
= 0; i
< total
; i
++) {
1317 if (base
== list
[i
])
1318 die(_("base commit shouldn't be in revision list"));
1325 static void prepare_bases(struct base_tree_info
*bases
,
1326 struct commit
*base
,
1327 struct commit
**list
,
1330 struct commit
*commit
;
1331 struct rev_info revs
;
1332 struct diff_options diffopt
;
1338 diff_setup(&diffopt
);
1339 DIFF_OPT_SET(&diffopt
, RECURSIVE
);
1340 diff_setup_done(&diffopt
);
1342 oidcpy(&bases
->base_commit
, &base
->object
.oid
);
1344 init_revisions(&revs
, NULL
);
1345 revs
.max_parents
= 1;
1346 revs
.topo_order
= 1;
1347 for (i
= 0; i
< total
; i
++) {
1348 list
[i
]->object
.flags
&= ~UNINTERESTING
;
1349 add_pending_object(&revs
, &list
[i
]->object
, "rev_list");
1350 list
[i
]->util
= (void *)1;
1352 base
->object
.flags
|= UNINTERESTING
;
1353 add_pending_object(&revs
, &base
->object
, "base");
1355 if (prepare_revision_walk(&revs
))
1356 die(_("revision walk setup failed"));
1358 * Traverse the commits list, get prerequisite patch ids
1359 * and stuff them in bases structure.
1361 while ((commit
= get_revision(&revs
)) != NULL
) {
1362 struct object_id oid
;
1363 struct object_id
*patch_id
;
1366 if (commit_patch_id(commit
, &diffopt
, oid
.hash
, 0))
1367 die(_("cannot get patch id"));
1368 ALLOC_GROW(bases
->patch_id
, bases
->nr_patch_id
+ 1, bases
->alloc_patch_id
);
1369 patch_id
= bases
->patch_id
+ bases
->nr_patch_id
;
1370 oidcpy(patch_id
, &oid
);
1371 bases
->nr_patch_id
++;
1375 static void print_bases(struct base_tree_info
*bases
, FILE *file
)
1379 /* Only do this once, either for the cover or for the first one */
1380 if (is_null_oid(&bases
->base_commit
))
1383 /* Show the base commit */
1384 fprintf(file
, "\nbase-commit: %s\n", oid_to_hex(&bases
->base_commit
));
1386 /* Show the prerequisite patches */
1387 for (i
= bases
->nr_patch_id
- 1; i
>= 0; i
--)
1388 fprintf(file
, "prerequisite-patch-id: %s\n", oid_to_hex(&bases
->patch_id
[i
]));
1390 free(bases
->patch_id
);
1391 bases
->nr_patch_id
= 0;
1392 bases
->alloc_patch_id
= 0;
1393 oidclr(&bases
->base_commit
);
1396 int cmd_format_patch(int argc
, const char **argv
, const char *prefix
)
1398 struct commit
*commit
;
1399 struct commit
**list
= NULL
;
1400 struct rev_info rev
;
1401 struct setup_revision_opt s_r_opt
;
1402 int nr
= 0, total
, i
;
1404 int start_number
= -1;
1405 int just_numbers
= 0;
1406 int ignore_if_in_upstream
= 0;
1407 int cover_letter
= -1;
1408 int boundary_count
= 0;
1409 int no_binary_diff
= 0;
1410 int zero_commit
= 0;
1411 struct commit
*origin
= NULL
;
1412 const char *in_reply_to
= NULL
;
1413 struct patch_ids ids
;
1414 struct strbuf buf
= STRBUF_INIT
;
1415 int use_patch_format
= 0;
1417 int reroll_count
= -1;
1418 char *branch_name
= NULL
;
1419 char *base_commit
= NULL
;
1420 struct base_tree_info bases
;
1422 const struct option builtin_format_patch_options
[] = {
1423 { OPTION_CALLBACK
, 'n', "numbered", &numbered
, NULL
,
1424 N_("use [PATCH n/m] even with a single patch"),
1425 PARSE_OPT_NOARG
, numbered_callback
},
1426 { OPTION_CALLBACK
, 'N', "no-numbered", &numbered
, NULL
,
1427 N_("use [PATCH] even with multiple patches"),
1428 PARSE_OPT_NOARG
, no_numbered_callback
},
1429 OPT_BOOL('s', "signoff", &do_signoff
, N_("add Signed-off-by:")),
1430 OPT_BOOL(0, "stdout", &use_stdout
,
1431 N_("print patches to standard out")),
1432 OPT_BOOL(0, "cover-letter", &cover_letter
,
1433 N_("generate a cover letter")),
1434 OPT_BOOL(0, "numbered-files", &just_numbers
,
1435 N_("use simple number sequence for output file names")),
1436 OPT_STRING(0, "suffix", &fmt_patch_suffix
, N_("sfx"),
1437 N_("use <sfx> instead of '.patch'")),
1438 OPT_INTEGER(0, "start-number", &start_number
,
1439 N_("start numbering patches at <n> instead of 1")),
1440 OPT_INTEGER('v', "reroll-count", &reroll_count
,
1441 N_("mark the series as Nth re-roll")),
1442 { OPTION_CALLBACK
, 0, "rfc", &rev
, NULL
,
1443 N_("Use [RFC PATCH] instead of [PATCH]"),
1444 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, rfc_callback
},
1445 { OPTION_CALLBACK
, 0, "subject-prefix", &rev
, N_("prefix"),
1446 N_("Use [<prefix>] instead of [PATCH]"),
1447 PARSE_OPT_NONEG
, subject_prefix_callback
},
1448 { OPTION_CALLBACK
, 'o', "output-directory", &output_directory
,
1449 N_("dir"), N_("store resulting files in <dir>"),
1450 PARSE_OPT_NONEG
, output_directory_callback
},
1451 { OPTION_CALLBACK
, 'k', "keep-subject", &rev
, NULL
,
1452 N_("don't strip/add [PATCH]"),
1453 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, keep_callback
},
1454 OPT_BOOL(0, "no-binary", &no_binary_diff
,
1455 N_("don't output binary diffs")),
1456 OPT_BOOL(0, "zero-commit", &zero_commit
,
1457 N_("output all-zero hash in From header")),
1458 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream
,
1459 N_("don't include a patch matching a commit upstream")),
1460 { OPTION_SET_INT
, 'p', "no-stat", &use_patch_format
, NULL
,
1461 N_("show patch format instead of default (patch + stat)"),
1462 PARSE_OPT_NONEG
| PARSE_OPT_NOARG
, NULL
, 1},
1463 OPT_GROUP(N_("Messaging")),
1464 { OPTION_CALLBACK
, 0, "add-header", NULL
, N_("header"),
1465 N_("add email header"), 0, header_callback
},
1466 { OPTION_CALLBACK
, 0, "to", NULL
, N_("email"), N_("add To: header"),
1468 { OPTION_CALLBACK
, 0, "cc", NULL
, N_("email"), N_("add Cc: header"),
1470 { OPTION_CALLBACK
, 0, "from", &from
, N_("ident"),
1471 N_("set From address to <ident> (or committer ident if absent)"),
1472 PARSE_OPT_OPTARG
, from_callback
},
1473 OPT_STRING(0, "in-reply-to", &in_reply_to
, N_("message-id"),
1474 N_("make first mail a reply to <message-id>")),
1475 { OPTION_CALLBACK
, 0, "attach", &rev
, N_("boundary"),
1476 N_("attach the patch"), PARSE_OPT_OPTARG
,
1478 { OPTION_CALLBACK
, 0, "inline", &rev
, N_("boundary"),
1479 N_("inline the patch"),
1480 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
1482 { OPTION_CALLBACK
, 0, "thread", &thread
, N_("style"),
1483 N_("enable message threading, styles: shallow, deep"),
1484 PARSE_OPT_OPTARG
, thread_callback
},
1485 OPT_STRING(0, "signature", &signature
, N_("signature"),
1486 N_("add a signature")),
1487 OPT_STRING(0, "base", &base_commit
, N_("base-commit"),
1488 N_("add prerequisite tree info to the patch series")),
1489 OPT_FILENAME(0, "signature-file", &signature_file
,
1490 N_("add a signature from a file")),
1491 OPT__QUIET(&quiet
, N_("don't print the patch filenames")),
1495 extra_hdr
.strdup_strings
= 1;
1496 extra_to
.strdup_strings
= 1;
1497 extra_cc
.strdup_strings
= 1;
1498 init_log_defaults();
1499 git_config(git_format_config
, NULL
);
1500 init_revisions(&rev
, prefix
);
1501 rev
.commit_format
= CMIT_FMT_EMAIL
;
1502 rev
.expand_tabs_in_log_default
= 0;
1503 rev
.verbose_header
= 1;
1505 rev
.max_parents
= 1;
1506 DIFF_OPT_SET(&rev
.diffopt
, RECURSIVE
);
1507 rev
.subject_prefix
= fmt_patch_subject_prefix
;
1508 memset(&s_r_opt
, 0, sizeof(s_r_opt
));
1509 s_r_opt
.def
= "HEAD";
1510 s_r_opt
.revarg_opt
= REVARG_COMMITTISH
;
1512 if (default_attach
) {
1513 rev
.mime_boundary
= default_attach
;
1518 * Parse the arguments before setup_revisions(), or something
1519 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1520 * possibly a valid SHA1.
1522 argc
= parse_options(argc
, argv
, prefix
, builtin_format_patch_options
,
1523 builtin_format_patch_usage
,
1524 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
1525 PARSE_OPT_KEEP_DASHDASH
);
1527 if (0 < reroll_count
) {
1528 struct strbuf sprefix
= STRBUF_INIT
;
1529 strbuf_addf(&sprefix
, "%s v%d",
1530 rev
.subject_prefix
, reroll_count
);
1531 rev
.reroll_count
= reroll_count
;
1532 rev
.subject_prefix
= strbuf_detach(&sprefix
, NULL
);
1535 for (i
= 0; i
< extra_hdr
.nr
; i
++) {
1536 strbuf_addstr(&buf
, extra_hdr
.items
[i
].string
);
1537 strbuf_addch(&buf
, '\n');
1541 strbuf_addstr(&buf
, "To: ");
1542 for (i
= 0; i
< extra_to
.nr
; i
++) {
1544 strbuf_addstr(&buf
, " ");
1545 strbuf_addstr(&buf
, extra_to
.items
[i
].string
);
1546 if (i
+ 1 < extra_to
.nr
)
1547 strbuf_addch(&buf
, ',');
1548 strbuf_addch(&buf
, '\n');
1552 strbuf_addstr(&buf
, "Cc: ");
1553 for (i
= 0; i
< extra_cc
.nr
; i
++) {
1555 strbuf_addstr(&buf
, " ");
1556 strbuf_addstr(&buf
, extra_cc
.items
[i
].string
);
1557 if (i
+ 1 < extra_cc
.nr
)
1558 strbuf_addch(&buf
, ',');
1559 strbuf_addch(&buf
, '\n');
1562 rev
.extra_headers
= strbuf_detach(&buf
, NULL
);
1565 if (split_ident_line(&rev
.from_ident
, from
, strlen(from
)))
1566 die(_("invalid ident line: %s"), from
);
1569 if (start_number
< 0)
1573 * If numbered is set solely due to format.numbered in config,
1574 * and it would conflict with --keep-subject (-k) from the
1575 * command line, reset "numbered".
1577 if (numbered
&& keep_subject
&& !numbered_cmdline_opt
)
1580 if (numbered
&& keep_subject
)
1581 die (_("-n and -k are mutually exclusive."));
1582 if (keep_subject
&& subject_prefix
)
1583 die (_("--subject-prefix/--rfc and -k are mutually exclusive."));
1584 rev
.preserve_subject
= keep_subject
;
1586 argc
= setup_revisions(argc
, argv
, &rev
, &s_r_opt
);
1588 die (_("unrecognized argument: %s"), argv
[1]);
1590 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME
)
1591 die(_("--name-only does not make sense"));
1592 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME_STATUS
)
1593 die(_("--name-status does not make sense"));
1594 if (rev
.diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
)
1595 die(_("--check does not make sense"));
1597 if (!use_patch_format
&&
1598 (!rev
.diffopt
.output_format
||
1599 rev
.diffopt
.output_format
== DIFF_FORMAT_PATCH
))
1600 rev
.diffopt
.output_format
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_SUMMARY
;
1602 /* Always generate a patch */
1603 rev
.diffopt
.output_format
|= DIFF_FORMAT_PATCH
;
1605 rev
.zero_commit
= zero_commit
;
1607 if (!DIFF_OPT_TST(&rev
.diffopt
, TEXT
) && !no_binary_diff
)
1608 DIFF_OPT_SET(&rev
.diffopt
, BINARY
);
1611 init_display_notes(&rev
.notes_opt
);
1613 if (!output_directory
&& !use_stdout
)
1614 output_directory
= config_output_directory
;
1617 output_directory
= set_outdir(prefix
, output_directory
);
1621 if (output_directory
) {
1622 if (rev
.diffopt
.use_color
!= GIT_COLOR_ALWAYS
)
1623 rev
.diffopt
.use_color
= GIT_COLOR_NEVER
;
1625 die(_("standard output, or directory, which one?"));
1626 if (mkdir(output_directory
, 0777) < 0 && errno
!= EEXIST
)
1627 die_errno(_("Could not create directory '%s'"),
1631 if (rev
.pending
.nr
== 1) {
1634 if (rev
.max_count
< 0 && !rev
.show_root_diff
) {
1636 * This is traditional behaviour of "git format-patch
1637 * origin" that prepares what the origin side still
1640 rev
.pending
.objects
[0].item
->flags
|= UNINTERESTING
;
1641 add_head_to_pending(&rev
);
1645 * Otherwise, it is "format-patch -22 HEAD", and/or
1646 * "format-patch --root HEAD". The user wants
1647 * get_revision() to do the usual traversal.
1650 if (!strcmp(rev
.pending
.objects
[0].name
, "HEAD"))
1654 struct object_id oid
;
1655 const char *ref
, *v
;
1656 ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
1658 if (ref
&& skip_prefix(ref
, "refs/heads/", &v
))
1659 branch_name
= xstrdup(v
);
1661 branch_name
= xstrdup(""); /* no branch */
1666 * We cannot move this anywhere earlier because we do want to
1667 * know if --root was given explicitly from the command line.
1669 rev
.show_root_diff
= 1;
1671 if (ignore_if_in_upstream
) {
1672 /* Don't say anything if head and upstream are the same. */
1673 if (rev
.pending
.nr
== 2) {
1674 struct object_array_entry
*o
= rev
.pending
.objects
;
1675 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1678 get_patch_ids(&rev
, &ids
);
1681 if (prepare_revision_walk(&rev
))
1682 die(_("revision walk setup failed"));
1684 while ((commit
= get_revision(&rev
)) != NULL
) {
1685 if (commit
->object
.flags
& BOUNDARY
) {
1687 origin
= (boundary_count
== 1) ? commit
: NULL
;
1691 if (ignore_if_in_upstream
&& has_commit_patch_id(commit
, &ids
))
1695 REALLOC_ARRAY(list
, nr
);
1696 list
[nr
- 1] = commit
;
1702 if (cover_letter
== -1) {
1703 if (config_cover_letter
== COVER_AUTO
)
1704 cover_letter
= (total
> 1);
1706 cover_letter
= (config_cover_letter
== COVER_ON
);
1708 if (!keep_subject
&& auto_number
&& (total
> 1 || cover_letter
))
1711 rev
.total
= total
+ start_number
- 1;
1714 ; /* --no-signature inhibits all signatures */
1715 } else if (signature
&& signature
!= git_version_string
) {
1716 ; /* non-default signature already set */
1717 } else if (signature_file
) {
1718 struct strbuf buf
= STRBUF_INIT
;
1720 if (strbuf_read_file(&buf
, signature_file
, 128) < 0)
1721 die_errno(_("unable to read signature file '%s'"), signature_file
);
1722 signature
= strbuf_detach(&buf
, NULL
);
1725 memset(&bases
, 0, sizeof(bases
));
1726 if (base_commit
|| base_auto
) {
1727 struct commit
*base
= get_base_commit(base_commit
, list
, nr
);
1728 reset_revision_walk();
1729 prepare_bases(&bases
, base
, list
, nr
);
1732 if (in_reply_to
|| thread
|| cover_letter
)
1733 rev
.ref_message_ids
= xcalloc(1, sizeof(struct string_list
));
1735 const char *msgid
= clean_message_id(in_reply_to
);
1736 string_list_append(rev
.ref_message_ids
, msgid
);
1738 rev
.numbered_files
= just_numbers
;
1739 rev
.patch_suffix
= fmt_patch_suffix
;
1742 gen_message_id(&rev
, "cover");
1743 make_cover_letter(&rev
, use_stdout
,
1744 origin
, nr
, list
, branch_name
, quiet
);
1745 print_bases(&bases
, rev
.diffopt
.file
);
1746 print_signature(rev
.diffopt
.file
);
1750 rev
.add_signoff
= do_signoff
;
1754 rev
.nr
= total
- nr
+ (start_number
- 1);
1755 /* Make the second and subsequent mails replies to the first */
1757 /* Have we already had a message ID? */
1758 if (rev
.message_id
) {
1760 * For deep threading: make every mail
1761 * a reply to the previous one, no
1762 * matter what other options are set.
1764 * For shallow threading:
1766 * Without --cover-letter and
1767 * --in-reply-to, make every mail a
1768 * reply to the one before.
1770 * With --in-reply-to but no
1771 * --cover-letter, make every mail a
1772 * reply to the <reply-to>.
1774 * With --cover-letter, make every
1775 * mail but the cover letter a reply
1776 * to the cover letter. The cover
1777 * letter is a reply to the
1778 * --in-reply-to, if specified.
1780 if (thread
== THREAD_SHALLOW
1781 && rev
.ref_message_ids
->nr
> 0
1782 && (!cover_letter
|| rev
.nr
> 1))
1783 free(rev
.message_id
);
1785 string_list_append(rev
.ref_message_ids
,
1788 gen_message_id(&rev
, oid_to_hex(&commit
->object
.oid
));
1792 open_next_file(rev
.numbered_files
? NULL
: commit
, NULL
, &rev
, quiet
))
1793 die(_("Failed to create output files"));
1794 shown
= log_tree_commit(&rev
, commit
);
1795 free_commit_buffer(commit
);
1797 /* We put one extra blank line between formatted
1798 * patches and this flag is used by log-tree code
1799 * to see if it needs to emit a LF before showing
1800 * the log; when using one file per patch, we do
1801 * not want the extra blank line.
1806 print_bases(&bases
, rev
.diffopt
.file
);
1807 if (rev
.mime_boundary
)
1808 fprintf(rev
.diffopt
.file
, "\n--%s%s--\n\n\n",
1809 mime_boundary_leader
,
1812 print_signature(rev
.diffopt
.file
);
1815 fclose(rev
.diffopt
.file
);
1819 string_list_clear(&extra_to
, 0);
1820 string_list_clear(&extra_cc
, 0);
1821 string_list_clear(&extra_hdr
, 0);
1822 if (ignore_if_in_upstream
)
1823 free_patch_ids(&ids
);
1827 static int add_pending_commit(const char *arg
, struct rev_info
*revs
, int flags
)
1829 struct object_id oid
;
1830 if (get_oid(arg
, &oid
) == 0) {
1831 struct commit
*commit
= lookup_commit_reference(&oid
);
1833 commit
->object
.flags
|= flags
;
1834 add_pending_object(revs
, &commit
->object
, arg
);
1841 static const char * const cherry_usage
[] = {
1842 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1846 static void print_commit(char sign
, struct commit
*commit
, int verbose
,
1847 int abbrev
, FILE *file
)
1850 fprintf(file
, "%c %s\n", sign
,
1851 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
));
1853 struct strbuf buf
= STRBUF_INIT
;
1854 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &buf
);
1855 fprintf(file
, "%c %s %s\n", sign
,
1856 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
),
1858 strbuf_release(&buf
);
1862 int cmd_cherry(int argc
, const char **argv
, const char *prefix
)
1864 struct rev_info revs
;
1865 struct patch_ids ids
;
1866 struct commit
*commit
;
1867 struct commit_list
*list
= NULL
;
1868 struct branch
*current_branch
;
1869 const char *upstream
;
1870 const char *head
= "HEAD";
1871 const char *limit
= NULL
;
1872 int verbose
= 0, abbrev
= 0;
1874 struct option options
[] = {
1875 OPT__ABBREV(&abbrev
),
1876 OPT__VERBOSE(&verbose
, N_("be verbose")),
1880 argc
= parse_options(argc
, argv
, prefix
, options
, cherry_usage
, 0);
1893 current_branch
= branch_get(NULL
);
1894 upstream
= branch_get_upstream(current_branch
, NULL
);
1896 fprintf(stderr
, _("Could not find a tracked"
1897 " remote branch, please"
1898 " specify <upstream> manually.\n"));
1899 usage_with_options(cherry_usage
, options
);
1903 init_revisions(&revs
, prefix
);
1904 revs
.max_parents
= 1;
1906 if (add_pending_commit(head
, &revs
, 0))
1907 die(_("Unknown commit %s"), head
);
1908 if (add_pending_commit(upstream
, &revs
, UNINTERESTING
))
1909 die(_("Unknown commit %s"), upstream
);
1911 /* Don't say anything if head and upstream are the same. */
1912 if (revs
.pending
.nr
== 2) {
1913 struct object_array_entry
*o
= revs
.pending
.objects
;
1914 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1918 get_patch_ids(&revs
, &ids
);
1920 if (limit
&& add_pending_commit(limit
, &revs
, UNINTERESTING
))
1921 die(_("Unknown commit %s"), limit
);
1923 /* reverse the list of commits */
1924 if (prepare_revision_walk(&revs
))
1925 die(_("revision walk setup failed"));
1926 while ((commit
= get_revision(&revs
)) != NULL
) {
1927 commit_list_insert(commit
, &list
);
1933 commit
= list
->item
;
1934 if (has_commit_patch_id(commit
, &ids
))
1936 print_commit(sign
, commit
, verbose
, abbrev
, revs
.diffopt
.file
);
1940 free_patch_ids(&ids
);