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();
115 static void cmd_log_init_defaults(struct rev_info
*rev
)
118 get_commit_format(fmt_pretty
, rev
);
120 DIFF_OPT_SET(&rev
->diffopt
, DEFAULT_FOLLOW_RENAMES
);
121 rev
->verbose_header
= 1;
122 DIFF_OPT_SET(&rev
->diffopt
, RECURSIVE
);
123 rev
->diffopt
.stat_width
= -1; /* use full terminal width */
124 rev
->diffopt
.stat_graph_width
= -1; /* respect statGraphWidth config */
125 rev
->abbrev_commit
= default_abbrev_commit
;
126 rev
->show_root_diff
= default_show_root
;
127 rev
->subject_prefix
= fmt_patch_subject_prefix
;
128 rev
->show_signature
= default_show_signature
;
129 DIFF_OPT_SET(&rev
->diffopt
, ALLOW_TEXTCONV
);
131 if (default_date_mode
)
132 parse_date_format(default_date_mode
, &rev
->date_mode
);
133 rev
->diffopt
.touched_flags
= 0;
136 static void cmd_log_init_finish(int argc
, const char **argv
, const char *prefix
,
137 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
139 struct userformat_want w
;
140 int quiet
= 0, source
= 0, mailmap
= 0;
141 static struct line_opt_callback_data line_cb
= {NULL
, NULL
, STRING_LIST_INIT_DUP
};
143 const struct option builtin_log_options
[] = {
144 OPT__QUIET(&quiet
, N_("suppress diff output")),
145 OPT_BOOL(0, "source", &source
, N_("show source")),
146 OPT_BOOL(0, "use-mailmap", &mailmap
, N_("Use mail map file")),
147 { OPTION_CALLBACK
, 0, "decorate", NULL
, NULL
, N_("decorate options"),
148 PARSE_OPT_OPTARG
, decorate_callback
},
149 OPT_CALLBACK('L', NULL
, &line_cb
, "n,m:file",
150 N_("Process line range n,m in file, counting from 1"),
151 log_line_range_callback
),
156 line_cb
.prefix
= prefix
;
158 mailmap
= use_mailmap_config
;
159 argc
= parse_options(argc
, argv
, prefix
,
160 builtin_log_options
, builtin_log_usage
,
161 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
162 PARSE_OPT_KEEP_DASHDASH
);
165 rev
->diffopt
.output_format
|= DIFF_FORMAT_NO_OUTPUT
;
166 argc
= setup_revisions(argc
, argv
, rev
, opt
);
168 /* Any arguments at this point are not recognized */
170 die(_("unrecognized argument: %s"), argv
[1]);
172 memset(&w
, 0, sizeof(w
));
173 userformat_find_requirements(NULL
, &w
);
175 if (!rev
->show_notes_given
&& (!rev
->pretty_given
|| w
.notes
))
178 init_display_notes(&rev
->notes_opt
);
180 if (rev
->diffopt
.pickaxe
|| rev
->diffopt
.filter
||
181 DIFF_OPT_TST(&rev
->diffopt
, FOLLOW_RENAMES
))
182 rev
->always_show_header
= 0;
185 rev
->show_source
= 1;
188 rev
->mailmap
= xcalloc(1, sizeof(struct string_list
));
189 read_mailmap(rev
->mailmap
, NULL
);
192 if (rev
->pretty_given
&& rev
->commit_format
== CMIT_FMT_RAW
) {
194 * "log --pretty=raw" is special; ignore UI oriented
195 * configuration variables such as decoration.
197 if (!decoration_given
)
198 decoration_style
= 0;
199 if (!rev
->abbrev_commit_given
)
200 rev
->abbrev_commit
= 0;
203 if (decoration_style
) {
204 rev
->show_decorations
= 1;
205 load_ref_decorations(decoration_style
);
208 if (rev
->line_level_traverse
)
209 line_log_init(rev
, line_cb
.prefix
, &line_cb
.args
);
214 static void cmd_log_init(int argc
, const char **argv
, const char *prefix
,
215 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
217 cmd_log_init_defaults(rev
);
218 cmd_log_init_finish(argc
, argv
, prefix
, rev
, opt
);
222 * This gives a rough estimate for how many commits we
223 * will print out in the list.
225 static int estimate_commit_count(struct rev_info
*rev
, struct commit_list
*list
)
230 struct commit
*commit
= list
->item
;
231 unsigned int flags
= commit
->object
.flags
;
233 if (!(flags
& (TREESAME
| UNINTERESTING
)))
239 static void show_early_header(struct rev_info
*rev
, const char *stage
, int nr
)
241 if (rev
->shown_one
) {
243 if (rev
->commit_format
!= CMIT_FMT_ONELINE
)
244 putchar(rev
->diffopt
.line_termination
);
246 fprintf(rev
->diffopt
.file
, _("Final output: %d %s\n"), nr
, stage
);
249 static struct itimerval early_output_timer
;
251 static void log_show_early(struct rev_info
*revs
, struct commit_list
*list
)
253 int i
= revs
->early_output
, close_file
= revs
->diffopt
.close_file
;
256 revs
->diffopt
.close_file
= 0;
257 sort_in_topological_order(&list
, revs
->sort_order
);
259 struct commit
*commit
= list
->item
;
260 switch (simplify_commit(revs
, commit
)) {
263 int n
= estimate_commit_count(revs
, list
);
264 show_early_header(revs
, "incomplete", n
);
267 log_tree_commit(revs
, commit
);
274 fclose(revs
->diffopt
.file
);
280 /* Did we already get enough commits for the early output? */
283 fclose(revs
->diffopt
.file
);
288 * ..if no, then repeat it twice a second until we
291 * NOTE! We don't use "it_interval", because if the
292 * reader isn't listening, we want our output to be
293 * throttled by the writing, and not have the timer
294 * trigger every second even if we're blocked on a
297 early_output_timer
.it_value
.tv_sec
= 0;
298 early_output_timer
.it_value
.tv_usec
= 500000;
299 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
302 static void early_output(int signal
)
304 show_early_output
= log_show_early
;
307 static void setup_early_output(struct rev_info
*rev
)
312 * Set up the signal handler, minimally intrusively:
313 * we only set a single volatile integer word (not
314 * using sigatomic_t - trying to avoid unnecessary
315 * system dependencies and headers), and using
318 memset(&sa
, 0, sizeof(sa
));
319 sa
.sa_handler
= early_output
;
320 sigemptyset(&sa
.sa_mask
);
321 sa
.sa_flags
= SA_RESTART
;
322 sigaction(SIGALRM
, &sa
, NULL
);
325 * If we can get the whole output in less than a
326 * tenth of a second, don't even bother doing the
327 * early-output thing..
329 * This is a one-time-only trigger.
331 early_output_timer
.it_value
.tv_sec
= 0;
332 early_output_timer
.it_value
.tv_usec
= 100000;
333 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
336 static void finish_early_output(struct rev_info
*rev
)
338 int n
= estimate_commit_count(rev
, rev
->commits
);
339 signal(SIGALRM
, SIG_IGN
);
340 show_early_header(rev
, "done", n
);
343 static int cmd_log_walk(struct rev_info
*rev
)
345 struct commit
*commit
;
347 int saved_dcctc
= 0, close_file
= rev
->diffopt
.close_file
;
349 if (rev
->early_output
)
350 setup_early_output(rev
);
352 if (prepare_revision_walk(rev
))
353 die(_("revision walk setup failed"));
355 if (rev
->early_output
)
356 finish_early_output(rev
);
359 * For --check and --exit-code, the exit code is based on CHECK_FAILED
360 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
361 * retain that state information if replacing rev->diffopt in this loop
363 rev
->diffopt
.close_file
= 0;
364 while ((commit
= get_revision(rev
)) != NULL
) {
365 if (!log_tree_commit(rev
, commit
) && rev
->max_count
>= 0)
367 * We decremented max_count in get_revision,
368 * but we didn't actually show the commit.
371 if (!rev
->reflog_info
) {
372 /* we allow cycles in reflog ancestry */
373 free_commit_buffer(commit
);
375 free_commit_list(commit
->parents
);
376 commit
->parents
= NULL
;
377 if (saved_nrl
< rev
->diffopt
.needed_rename_limit
)
378 saved_nrl
= rev
->diffopt
.needed_rename_limit
;
379 if (rev
->diffopt
.degraded_cc_to_c
)
382 rev
->diffopt
.degraded_cc_to_c
= saved_dcctc
;
383 rev
->diffopt
.needed_rename_limit
= saved_nrl
;
385 fclose(rev
->diffopt
.file
);
387 if (rev
->diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
&&
388 DIFF_OPT_TST(&rev
->diffopt
, CHECK_FAILED
)) {
391 return diff_result_code(&rev
->diffopt
, 0);
394 static int git_log_config(const char *var
, const char *value
, void *cb
)
396 const char *slot_name
;
398 if (!strcmp(var
, "format.pretty"))
399 return git_config_string(&fmt_pretty
, var
, value
);
400 if (!strcmp(var
, "format.subjectprefix"))
401 return git_config_string(&fmt_patch_subject_prefix
, var
, value
);
402 if (!strcmp(var
, "log.abbrevcommit")) {
403 default_abbrev_commit
= git_config_bool(var
, value
);
406 if (!strcmp(var
, "log.date"))
407 return git_config_string(&default_date_mode
, var
, value
);
408 if (!strcmp(var
, "log.decorate")) {
409 decoration_style
= parse_decoration_style(var
, value
);
410 if (decoration_style
< 0)
411 decoration_style
= 0; /* maybe warn? */
414 decoration_style
= auto_decoration_style();
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
.hash
);
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 return error(_("name of output directory is too long"));
851 strbuf_complete(&filename
, '/');
854 if (rev
->numbered_files
)
855 strbuf_addf(&filename
, "%d", rev
->nr
);
857 fmt_output_commit(&filename
, commit
, rev
);
859 fmt_output_subject(&filename
, subject
, rev
);
862 printf("%s\n", filename
.buf
+ outdir_offset
);
864 if ((rev
->diffopt
.file
= fopen(filename
.buf
, "w")) == NULL
)
865 return error(_("Cannot open patch file %s"), filename
.buf
);
867 strbuf_release(&filename
);
871 static void get_patch_ids(struct rev_info
*rev
, struct patch_ids
*ids
)
873 struct rev_info check_rev
;
874 struct commit
*commit
, *c1
, *c2
;
875 struct object
*o1
, *o2
;
876 unsigned flags1
, flags2
;
878 if (rev
->pending
.nr
!= 2)
879 die(_("Need exactly one range."));
881 o1
= rev
->pending
.objects
[0].item
;
882 o2
= rev
->pending
.objects
[1].item
;
885 c1
= lookup_commit_reference(o1
->oid
.hash
);
886 c2
= lookup_commit_reference(o2
->oid
.hash
);
888 if ((flags1
& UNINTERESTING
) == (flags2
& UNINTERESTING
))
889 die(_("Not a range."));
893 /* given a range a..b get all patch ids for b..a */
894 init_revisions(&check_rev
, rev
->prefix
);
895 check_rev
.max_parents
= 1;
896 o1
->flags
^= UNINTERESTING
;
897 o2
->flags
^= UNINTERESTING
;
898 add_pending_object(&check_rev
, o1
, "o1");
899 add_pending_object(&check_rev
, o2
, "o2");
900 if (prepare_revision_walk(&check_rev
))
901 die(_("revision walk setup failed"));
903 while ((commit
= get_revision(&check_rev
)) != NULL
) {
904 add_commit_patch_id(commit
, ids
);
907 /* reset for next revision walk */
908 clear_commit_marks(c1
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
909 clear_commit_marks(c2
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
914 static void gen_message_id(struct rev_info
*info
, char *base
)
916 struct strbuf buf
= STRBUF_INIT
;
917 strbuf_addf(&buf
, "%s.%lu.git.%s", base
,
918 (unsigned long) time(NULL
),
919 git_committer_info(IDENT_NO_NAME
|IDENT_NO_DATE
|IDENT_STRICT
));
920 info
->message_id
= strbuf_detach(&buf
, NULL
);
923 static void print_signature(FILE *file
)
925 if (!signature
|| !*signature
)
928 fprintf(file
, "-- \n%s", signature
);
929 if (signature
[strlen(signature
)-1] != '\n')
934 static void add_branch_description(struct strbuf
*buf
, const char *branch_name
)
936 struct strbuf desc
= STRBUF_INIT
;
937 if (!branch_name
|| !*branch_name
)
939 read_branch_desc(&desc
, branch_name
);
941 strbuf_addch(buf
, '\n');
942 strbuf_addbuf(buf
, &desc
);
943 strbuf_addch(buf
, '\n');
945 strbuf_release(&desc
);
948 static char *find_branch_name(struct rev_info
*rev
)
950 int i
, positive
= -1;
951 struct object_id branch_oid
;
952 const struct object_id
*tip_oid
;
954 char *full_ref
, *branch
= NULL
;
956 for (i
= 0; i
< rev
->cmdline
.nr
; i
++) {
957 if (rev
->cmdline
.rev
[i
].flags
& UNINTERESTING
)
966 ref
= rev
->cmdline
.rev
[positive
].name
;
967 tip_oid
= &rev
->cmdline
.rev
[positive
].item
->oid
;
968 if (dwim_ref(ref
, strlen(ref
), branch_oid
.hash
, &full_ref
) &&
969 skip_prefix(full_ref
, "refs/heads/", &v
) &&
970 !oidcmp(tip_oid
, &branch_oid
))
976 static void make_cover_letter(struct rev_info
*rev
, int use_stdout
,
977 struct commit
*origin
,
978 int nr
, struct commit
**list
,
979 const char *branch_name
,
982 const char *committer
;
983 const char *body
= "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
986 struct strbuf sb
= STRBUF_INIT
;
988 const char *encoding
= "UTF-8";
989 struct diff_options opts
;
990 int need_8bit_cte
= 0;
991 struct pretty_print_context pp
= {0};
992 struct commit
*head
= list
[0];
994 if (!cmit_fmt_is_mail(rev
->commit_format
))
995 die(_("Cover letter needs email format"));
997 committer
= git_committer_info(0);
1000 open_next_file(NULL
, rev
->numbered_files
? NULL
: "cover-letter", rev
, quiet
))
1003 log_write_email_headers(rev
, head
, &pp
.after_subject
, &need_8bit_cte
);
1005 for (i
= 0; !need_8bit_cte
&& i
< nr
; i
++) {
1006 const char *buf
= get_commit_buffer(list
[i
], NULL
);
1007 if (has_non_ascii(buf
))
1009 unuse_commit_buffer(list
[i
], buf
);
1013 branch_name
= find_branch_name(rev
);
1016 pp
.fmt
= CMIT_FMT_EMAIL
;
1017 pp
.date_mode
.type
= DATE_RFC2822
;
1019 pp
.print_email_subject
= 1;
1020 pp_user_info(&pp
, NULL
, &sb
, committer
, encoding
);
1021 pp_title_line(&pp
, &msg
, &sb
, encoding
, need_8bit_cte
);
1022 pp_remainder(&pp
, &msg
, &sb
, 0);
1023 add_branch_description(&sb
, branch_name
);
1024 fprintf(rev
->diffopt
.file
, "%s\n", sb
.buf
);
1026 strbuf_release(&sb
);
1028 shortlog_init(&log
);
1033 log
.file
= rev
->diffopt
.file
;
1034 for (i
= 0; i
< nr
; i
++)
1035 shortlog_add_commit(&log
, list
[i
]);
1037 shortlog_output(&log
);
1040 * We can only do diffstat with a unique reference point
1045 memcpy(&opts
, &rev
->diffopt
, sizeof(opts
));
1046 opts
.output_format
= DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
1048 diff_setup_done(&opts
);
1050 diff_tree_sha1(origin
->tree
->object
.oid
.hash
,
1051 head
->tree
->object
.oid
.hash
,
1053 diffcore_std(&opts
);
1056 fprintf(rev
->diffopt
.file
, "\n");
1059 static const char *clean_message_id(const char *msg_id
)
1062 const char *a
, *z
, *m
;
1065 while ((ch
= *m
) && (isspace(ch
) || (ch
== '<')))
1070 if (!isspace(ch
) && (ch
!= '>'))
1075 die(_("insane in-reply-to: %s"), msg_id
);
1078 return xmemdupz(a
, z
- a
);
1081 static const char *set_outdir(const char *prefix
, const char *output_directory
)
1083 if (output_directory
&& is_absolute_path(output_directory
))
1084 return output_directory
;
1086 if (!prefix
|| !*prefix
) {
1087 if (output_directory
)
1088 return output_directory
;
1089 /* The user did not explicitly ask for "./" */
1094 outdir_offset
= strlen(prefix
);
1095 if (!output_directory
)
1098 return prefix_filename(prefix
, output_directory
);
1101 static const char * const builtin_format_patch_usage
[] = {
1102 N_("git format-patch [<options>] [<since> | <revision-range>]"),
1106 static int keep_subject
= 0;
1108 static int keep_callback(const struct option
*opt
, const char *arg
, int unset
)
1110 ((struct rev_info
*)opt
->value
)->total
= -1;
1115 static int subject_prefix
= 0;
1117 static int subject_prefix_callback(const struct option
*opt
, const char *arg
,
1121 ((struct rev_info
*)opt
->value
)->subject_prefix
= arg
;
1125 static int rfc_callback(const struct option
*opt
, const char *arg
, int unset
)
1127 return subject_prefix_callback(opt
, "RFC PATCH", unset
);
1130 static int numbered_cmdline_opt
= 0;
1132 static int numbered_callback(const struct option
*opt
, const char *arg
,
1135 *(int *)opt
->value
= numbered_cmdline_opt
= unset
? 0 : 1;
1141 static int no_numbered_callback(const struct option
*opt
, const char *arg
,
1144 return numbered_callback(opt
, arg
, 1);
1147 static int output_directory_callback(const struct option
*opt
, const char *arg
,
1150 const char **dir
= (const char **)opt
->value
;
1152 die(_("Two output directories?"));
1157 static int thread_callback(const struct option
*opt
, const char *arg
, int unset
)
1159 int *thread
= (int *)opt
->value
;
1162 else if (!arg
|| !strcmp(arg
, "shallow"))
1163 *thread
= THREAD_SHALLOW
;
1164 else if (!strcmp(arg
, "deep"))
1165 *thread
= THREAD_DEEP
;
1171 static int attach_callback(const struct option
*opt
, const char *arg
, int unset
)
1173 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1175 rev
->mime_boundary
= NULL
;
1177 rev
->mime_boundary
= arg
;
1179 rev
->mime_boundary
= git_version_string
;
1180 rev
->no_inline
= unset
? 0 : 1;
1184 static int inline_callback(const struct option
*opt
, const char *arg
, int unset
)
1186 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1188 rev
->mime_boundary
= NULL
;
1190 rev
->mime_boundary
= arg
;
1192 rev
->mime_boundary
= git_version_string
;
1197 static int header_callback(const struct option
*opt
, const char *arg
, int unset
)
1200 string_list_clear(&extra_hdr
, 0);
1201 string_list_clear(&extra_to
, 0);
1202 string_list_clear(&extra_cc
, 0);
1209 static int to_callback(const struct option
*opt
, const char *arg
, int unset
)
1212 string_list_clear(&extra_to
, 0);
1214 string_list_append(&extra_to
, arg
);
1218 static int cc_callback(const struct option
*opt
, const char *arg
, int unset
)
1221 string_list_clear(&extra_cc
, 0);
1223 string_list_append(&extra_cc
, arg
);
1227 static int from_callback(const struct option
*opt
, const char *arg
, int unset
)
1229 char **from
= opt
->value
;
1236 *from
= xstrdup(arg
);
1238 *from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
1242 struct base_tree_info
{
1243 struct object_id base_commit
;
1244 int nr_patch_id
, alloc_patch_id
;
1245 struct object_id
*patch_id
;
1248 static struct commit
*get_base_commit(const char *base_commit
,
1249 struct commit
**list
,
1252 struct commit
*base
= NULL
;
1253 struct commit
**rev
;
1254 int i
= 0, rev_nr
= 0;
1256 if (base_commit
&& strcmp(base_commit
, "auto")) {
1257 base
= lookup_commit_reference_by_name(base_commit
);
1259 die(_("Unknown commit %s"), base_commit
);
1260 } else if ((base_commit
&& !strcmp(base_commit
, "auto")) || base_auto
) {
1261 struct branch
*curr_branch
= branch_get(NULL
);
1262 const char *upstream
= branch_get_upstream(curr_branch
, NULL
);
1264 struct commit_list
*base_list
;
1265 struct commit
*commit
;
1266 struct object_id oid
;
1268 if (get_oid(upstream
, &oid
))
1269 die(_("Failed to resolve '%s' as a valid ref."), upstream
);
1270 commit
= lookup_commit_or_die(oid
.hash
, "upstream base");
1271 base_list
= get_merge_bases_many(commit
, total
, list
);
1272 /* There should be one and only one merge base. */
1273 if (!base_list
|| base_list
->next
)
1274 die(_("Could not find exact merge base."));
1275 base
= base_list
->item
;
1276 free_commit_list(base_list
);
1278 die(_("Failed to get upstream, if you want to record base commit automatically,\n"
1279 "please use git branch --set-upstream-to to track a remote branch.\n"
1280 "Or you could specify base commit by --base=<base-commit-id> manually."));
1284 ALLOC_ARRAY(rev
, total
);
1285 for (i
= 0; i
< total
; i
++)
1290 * Get merge base through pair-wise computations
1291 * and store it in rev[0].
1293 while (rev_nr
> 1) {
1294 for (i
= 0; i
< rev_nr
/ 2; i
++) {
1295 struct commit_list
*merge_base
;
1296 merge_base
= get_merge_bases(rev
[2 * i
], rev
[2 * i
+ 1]);
1297 if (!merge_base
|| merge_base
->next
)
1298 die(_("Failed to find exact merge base"));
1300 rev
[i
] = merge_base
->item
;
1304 rev
[i
] = rev
[2 * i
];
1305 rev_nr
= (rev_nr
+ 1) / 2;
1308 if (!in_merge_bases(base
, rev
[0]))
1309 die(_("base commit should be the ancestor of revision list"));
1311 for (i
= 0; i
< total
; i
++) {
1312 if (base
== list
[i
])
1313 die(_("base commit shouldn't be in revision list"));
1320 static void prepare_bases(struct base_tree_info
*bases
,
1321 struct commit
*base
,
1322 struct commit
**list
,
1325 struct commit
*commit
;
1326 struct rev_info revs
;
1327 struct diff_options diffopt
;
1333 diff_setup(&diffopt
);
1334 DIFF_OPT_SET(&diffopt
, RECURSIVE
);
1335 diff_setup_done(&diffopt
);
1337 oidcpy(&bases
->base_commit
, &base
->object
.oid
);
1339 init_revisions(&revs
, NULL
);
1340 revs
.max_parents
= 1;
1341 revs
.topo_order
= 1;
1342 for (i
= 0; i
< total
; i
++) {
1343 list
[i
]->object
.flags
&= ~UNINTERESTING
;
1344 add_pending_object(&revs
, &list
[i
]->object
, "rev_list");
1345 list
[i
]->util
= (void *)1;
1347 base
->object
.flags
|= UNINTERESTING
;
1348 add_pending_object(&revs
, &base
->object
, "base");
1350 if (prepare_revision_walk(&revs
))
1351 die(_("revision walk setup failed"));
1353 * Traverse the commits list, get prerequisite patch ids
1354 * and stuff them in bases structure.
1356 while ((commit
= get_revision(&revs
)) != NULL
) {
1357 struct object_id oid
;
1358 struct object_id
*patch_id
;
1361 if (commit_patch_id(commit
, &diffopt
, oid
.hash
, 0))
1362 die(_("cannot get patch id"));
1363 ALLOC_GROW(bases
->patch_id
, bases
->nr_patch_id
+ 1, bases
->alloc_patch_id
);
1364 patch_id
= bases
->patch_id
+ bases
->nr_patch_id
;
1365 oidcpy(patch_id
, &oid
);
1366 bases
->nr_patch_id
++;
1370 static void print_bases(struct base_tree_info
*bases
, FILE *file
)
1374 /* Only do this once, either for the cover or for the first one */
1375 if (is_null_oid(&bases
->base_commit
))
1378 /* Show the base commit */
1379 fprintf(file
, "\nbase-commit: %s\n", oid_to_hex(&bases
->base_commit
));
1381 /* Show the prerequisite patches */
1382 for (i
= bases
->nr_patch_id
- 1; i
>= 0; i
--)
1383 fprintf(file
, "prerequisite-patch-id: %s\n", oid_to_hex(&bases
->patch_id
[i
]));
1385 free(bases
->patch_id
);
1386 bases
->nr_patch_id
= 0;
1387 bases
->alloc_patch_id
= 0;
1388 oidclr(&bases
->base_commit
);
1391 int cmd_format_patch(int argc
, const char **argv
, const char *prefix
)
1393 struct commit
*commit
;
1394 struct commit
**list
= NULL
;
1395 struct rev_info rev
;
1396 struct setup_revision_opt s_r_opt
;
1397 int nr
= 0, total
, i
;
1399 int start_number
= -1;
1400 int just_numbers
= 0;
1401 int ignore_if_in_upstream
= 0;
1402 int cover_letter
= -1;
1403 int boundary_count
= 0;
1404 int no_binary_diff
= 0;
1405 int zero_commit
= 0;
1406 struct commit
*origin
= NULL
;
1407 const char *in_reply_to
= NULL
;
1408 struct patch_ids ids
;
1409 struct strbuf buf
= STRBUF_INIT
;
1410 int use_patch_format
= 0;
1412 int reroll_count
= -1;
1413 char *branch_name
= NULL
;
1414 char *base_commit
= NULL
;
1415 struct base_tree_info bases
;
1417 const struct option builtin_format_patch_options
[] = {
1418 { OPTION_CALLBACK
, 'n', "numbered", &numbered
, NULL
,
1419 N_("use [PATCH n/m] even with a single patch"),
1420 PARSE_OPT_NOARG
, numbered_callback
},
1421 { OPTION_CALLBACK
, 'N', "no-numbered", &numbered
, NULL
,
1422 N_("use [PATCH] even with multiple patches"),
1423 PARSE_OPT_NOARG
, no_numbered_callback
},
1424 OPT_BOOL('s', "signoff", &do_signoff
, N_("add Signed-off-by:")),
1425 OPT_BOOL(0, "stdout", &use_stdout
,
1426 N_("print patches to standard out")),
1427 OPT_BOOL(0, "cover-letter", &cover_letter
,
1428 N_("generate a cover letter")),
1429 OPT_BOOL(0, "numbered-files", &just_numbers
,
1430 N_("use simple number sequence for output file names")),
1431 OPT_STRING(0, "suffix", &fmt_patch_suffix
, N_("sfx"),
1432 N_("use <sfx> instead of '.patch'")),
1433 OPT_INTEGER(0, "start-number", &start_number
,
1434 N_("start numbering patches at <n> instead of 1")),
1435 OPT_INTEGER('v', "reroll-count", &reroll_count
,
1436 N_("mark the series as Nth re-roll")),
1437 { OPTION_CALLBACK
, 0, "rfc", &rev
, NULL
,
1438 N_("Use [RFC PATCH] instead of [PATCH]"),
1439 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, rfc_callback
},
1440 { OPTION_CALLBACK
, 0, "subject-prefix", &rev
, N_("prefix"),
1441 N_("Use [<prefix>] instead of [PATCH]"),
1442 PARSE_OPT_NONEG
, subject_prefix_callback
},
1443 { OPTION_CALLBACK
, 'o', "output-directory", &output_directory
,
1444 N_("dir"), N_("store resulting files in <dir>"),
1445 PARSE_OPT_NONEG
, output_directory_callback
},
1446 { OPTION_CALLBACK
, 'k', "keep-subject", &rev
, NULL
,
1447 N_("don't strip/add [PATCH]"),
1448 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, keep_callback
},
1449 OPT_BOOL(0, "no-binary", &no_binary_diff
,
1450 N_("don't output binary diffs")),
1451 OPT_BOOL(0, "zero-commit", &zero_commit
,
1452 N_("output all-zero hash in From header")),
1453 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream
,
1454 N_("don't include a patch matching a commit upstream")),
1455 { OPTION_SET_INT
, 'p', "no-stat", &use_patch_format
, NULL
,
1456 N_("show patch format instead of default (patch + stat)"),
1457 PARSE_OPT_NONEG
| PARSE_OPT_NOARG
, NULL
, 1},
1458 OPT_GROUP(N_("Messaging")),
1459 { OPTION_CALLBACK
, 0, "add-header", NULL
, N_("header"),
1460 N_("add email header"), 0, header_callback
},
1461 { OPTION_CALLBACK
, 0, "to", NULL
, N_("email"), N_("add To: header"),
1463 { OPTION_CALLBACK
, 0, "cc", NULL
, N_("email"), N_("add Cc: header"),
1465 { OPTION_CALLBACK
, 0, "from", &from
, N_("ident"),
1466 N_("set From address to <ident> (or committer ident if absent)"),
1467 PARSE_OPT_OPTARG
, from_callback
},
1468 OPT_STRING(0, "in-reply-to", &in_reply_to
, N_("message-id"),
1469 N_("make first mail a reply to <message-id>")),
1470 { OPTION_CALLBACK
, 0, "attach", &rev
, N_("boundary"),
1471 N_("attach the patch"), PARSE_OPT_OPTARG
,
1473 { OPTION_CALLBACK
, 0, "inline", &rev
, N_("boundary"),
1474 N_("inline the patch"),
1475 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
1477 { OPTION_CALLBACK
, 0, "thread", &thread
, N_("style"),
1478 N_("enable message threading, styles: shallow, deep"),
1479 PARSE_OPT_OPTARG
, thread_callback
},
1480 OPT_STRING(0, "signature", &signature
, N_("signature"),
1481 N_("add a signature")),
1482 OPT_STRING(0, "base", &base_commit
, N_("base-commit"),
1483 N_("add prerequisite tree info to the patch series")),
1484 OPT_FILENAME(0, "signature-file", &signature_file
,
1485 N_("add a signature from a file")),
1486 OPT__QUIET(&quiet
, N_("don't print the patch filenames")),
1490 extra_hdr
.strdup_strings
= 1;
1491 extra_to
.strdup_strings
= 1;
1492 extra_cc
.strdup_strings
= 1;
1493 init_log_defaults();
1494 git_config(git_format_config
, NULL
);
1495 init_revisions(&rev
, prefix
);
1496 rev
.commit_format
= CMIT_FMT_EMAIL
;
1497 rev
.expand_tabs_in_log_default
= 0;
1498 rev
.verbose_header
= 1;
1500 rev
.max_parents
= 1;
1501 DIFF_OPT_SET(&rev
.diffopt
, RECURSIVE
);
1502 rev
.subject_prefix
= fmt_patch_subject_prefix
;
1503 memset(&s_r_opt
, 0, sizeof(s_r_opt
));
1504 s_r_opt
.def
= "HEAD";
1505 s_r_opt
.revarg_opt
= REVARG_COMMITTISH
;
1507 if (default_attach
) {
1508 rev
.mime_boundary
= default_attach
;
1513 * Parse the arguments before setup_revisions(), or something
1514 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1515 * possibly a valid SHA1.
1517 argc
= parse_options(argc
, argv
, prefix
, builtin_format_patch_options
,
1518 builtin_format_patch_usage
,
1519 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
1520 PARSE_OPT_KEEP_DASHDASH
);
1522 if (0 < reroll_count
) {
1523 struct strbuf sprefix
= STRBUF_INIT
;
1524 strbuf_addf(&sprefix
, "%s v%d",
1525 rev
.subject_prefix
, reroll_count
);
1526 rev
.reroll_count
= reroll_count
;
1527 rev
.subject_prefix
= strbuf_detach(&sprefix
, NULL
);
1530 for (i
= 0; i
< extra_hdr
.nr
; i
++) {
1531 strbuf_addstr(&buf
, extra_hdr
.items
[i
].string
);
1532 strbuf_addch(&buf
, '\n');
1536 strbuf_addstr(&buf
, "To: ");
1537 for (i
= 0; i
< extra_to
.nr
; i
++) {
1539 strbuf_addstr(&buf
, " ");
1540 strbuf_addstr(&buf
, extra_to
.items
[i
].string
);
1541 if (i
+ 1 < extra_to
.nr
)
1542 strbuf_addch(&buf
, ',');
1543 strbuf_addch(&buf
, '\n');
1547 strbuf_addstr(&buf
, "Cc: ");
1548 for (i
= 0; i
< extra_cc
.nr
; i
++) {
1550 strbuf_addstr(&buf
, " ");
1551 strbuf_addstr(&buf
, extra_cc
.items
[i
].string
);
1552 if (i
+ 1 < extra_cc
.nr
)
1553 strbuf_addch(&buf
, ',');
1554 strbuf_addch(&buf
, '\n');
1557 rev
.extra_headers
= strbuf_detach(&buf
, NULL
);
1560 if (split_ident_line(&rev
.from_ident
, from
, strlen(from
)))
1561 die(_("invalid ident line: %s"), from
);
1564 if (start_number
< 0)
1568 * If numbered is set solely due to format.numbered in config,
1569 * and it would conflict with --keep-subject (-k) from the
1570 * command line, reset "numbered".
1572 if (numbered
&& keep_subject
&& !numbered_cmdline_opt
)
1575 if (numbered
&& keep_subject
)
1576 die (_("-n and -k are mutually exclusive."));
1577 if (keep_subject
&& subject_prefix
)
1578 die (_("--subject-prefix/--rfc and -k are mutually exclusive."));
1579 rev
.preserve_subject
= keep_subject
;
1581 argc
= setup_revisions(argc
, argv
, &rev
, &s_r_opt
);
1583 die (_("unrecognized argument: %s"), argv
[1]);
1585 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME
)
1586 die(_("--name-only does not make sense"));
1587 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME_STATUS
)
1588 die(_("--name-status does not make sense"));
1589 if (rev
.diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
)
1590 die(_("--check does not make sense"));
1592 if (!use_patch_format
&&
1593 (!rev
.diffopt
.output_format
||
1594 rev
.diffopt
.output_format
== DIFF_FORMAT_PATCH
))
1595 rev
.diffopt
.output_format
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_SUMMARY
;
1597 /* Always generate a patch */
1598 rev
.diffopt
.output_format
|= DIFF_FORMAT_PATCH
;
1600 rev
.zero_commit
= zero_commit
;
1602 if (!DIFF_OPT_TST(&rev
.diffopt
, TEXT
) && !no_binary_diff
)
1603 DIFF_OPT_SET(&rev
.diffopt
, BINARY
);
1606 init_display_notes(&rev
.notes_opt
);
1608 if (!output_directory
&& !use_stdout
)
1609 output_directory
= config_output_directory
;
1612 output_directory
= set_outdir(prefix
, output_directory
);
1616 if (output_directory
) {
1617 if (rev
.diffopt
.use_color
!= GIT_COLOR_ALWAYS
)
1618 rev
.diffopt
.use_color
= GIT_COLOR_NEVER
;
1620 die(_("standard output, or directory, which one?"));
1621 if (mkdir(output_directory
, 0777) < 0 && errno
!= EEXIST
)
1622 die_errno(_("Could not create directory '%s'"),
1626 if (rev
.pending
.nr
== 1) {
1629 if (rev
.max_count
< 0 && !rev
.show_root_diff
) {
1631 * This is traditional behaviour of "git format-patch
1632 * origin" that prepares what the origin side still
1635 rev
.pending
.objects
[0].item
->flags
|= UNINTERESTING
;
1636 add_head_to_pending(&rev
);
1640 * Otherwise, it is "format-patch -22 HEAD", and/or
1641 * "format-patch --root HEAD". The user wants
1642 * get_revision() to do the usual traversal.
1645 if (!strcmp(rev
.pending
.objects
[0].name
, "HEAD"))
1649 struct object_id oid
;
1650 const char *ref
, *v
;
1651 ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
1653 if (ref
&& skip_prefix(ref
, "refs/heads/", &v
))
1654 branch_name
= xstrdup(v
);
1656 branch_name
= xstrdup(""); /* no branch */
1661 * We cannot move this anywhere earlier because we do want to
1662 * know if --root was given explicitly from the command line.
1664 rev
.show_root_diff
= 1;
1666 if (ignore_if_in_upstream
) {
1667 /* Don't say anything if head and upstream are the same. */
1668 if (rev
.pending
.nr
== 2) {
1669 struct object_array_entry
*o
= rev
.pending
.objects
;
1670 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1673 get_patch_ids(&rev
, &ids
);
1676 if (prepare_revision_walk(&rev
))
1677 die(_("revision walk setup failed"));
1679 while ((commit
= get_revision(&rev
)) != NULL
) {
1680 if (commit
->object
.flags
& BOUNDARY
) {
1682 origin
= (boundary_count
== 1) ? commit
: NULL
;
1686 if (ignore_if_in_upstream
&& has_commit_patch_id(commit
, &ids
))
1690 REALLOC_ARRAY(list
, nr
);
1691 list
[nr
- 1] = commit
;
1697 if (cover_letter
== -1) {
1698 if (config_cover_letter
== COVER_AUTO
)
1699 cover_letter
= (total
> 1);
1701 cover_letter
= (config_cover_letter
== COVER_ON
);
1703 if (!keep_subject
&& auto_number
&& (total
> 1 || cover_letter
))
1706 rev
.total
= total
+ start_number
- 1;
1709 ; /* --no-signature inhibits all signatures */
1710 } else if (signature
&& signature
!= git_version_string
) {
1711 ; /* non-default signature already set */
1712 } else if (signature_file
) {
1713 struct strbuf buf
= STRBUF_INIT
;
1715 if (strbuf_read_file(&buf
, signature_file
, 128) < 0)
1716 die_errno(_("unable to read signature file '%s'"), signature_file
);
1717 signature
= strbuf_detach(&buf
, NULL
);
1720 memset(&bases
, 0, sizeof(bases
));
1721 if (base_commit
|| base_auto
) {
1722 struct commit
*base
= get_base_commit(base_commit
, list
, nr
);
1723 reset_revision_walk();
1724 prepare_bases(&bases
, base
, list
, nr
);
1727 if (in_reply_to
|| thread
|| cover_letter
)
1728 rev
.ref_message_ids
= xcalloc(1, sizeof(struct string_list
));
1730 const char *msgid
= clean_message_id(in_reply_to
);
1731 string_list_append(rev
.ref_message_ids
, msgid
);
1733 rev
.numbered_files
= just_numbers
;
1734 rev
.patch_suffix
= fmt_patch_suffix
;
1737 gen_message_id(&rev
, "cover");
1738 make_cover_letter(&rev
, use_stdout
,
1739 origin
, nr
, list
, branch_name
, quiet
);
1740 print_bases(&bases
, rev
.diffopt
.file
);
1741 print_signature(rev
.diffopt
.file
);
1745 rev
.add_signoff
= do_signoff
;
1749 rev
.nr
= total
- nr
+ (start_number
- 1);
1750 /* Make the second and subsequent mails replies to the first */
1752 /* Have we already had a message ID? */
1753 if (rev
.message_id
) {
1755 * For deep threading: make every mail
1756 * a reply to the previous one, no
1757 * matter what other options are set.
1759 * For shallow threading:
1761 * Without --cover-letter and
1762 * --in-reply-to, make every mail a
1763 * reply to the one before.
1765 * With --in-reply-to but no
1766 * --cover-letter, make every mail a
1767 * reply to the <reply-to>.
1769 * With --cover-letter, make every
1770 * mail but the cover letter a reply
1771 * to the cover letter. The cover
1772 * letter is a reply to the
1773 * --in-reply-to, if specified.
1775 if (thread
== THREAD_SHALLOW
1776 && rev
.ref_message_ids
->nr
> 0
1777 && (!cover_letter
|| rev
.nr
> 1))
1778 free(rev
.message_id
);
1780 string_list_append(rev
.ref_message_ids
,
1783 gen_message_id(&rev
, oid_to_hex(&commit
->object
.oid
));
1787 open_next_file(rev
.numbered_files
? NULL
: commit
, NULL
, &rev
, quiet
))
1788 die(_("Failed to create output files"));
1789 shown
= log_tree_commit(&rev
, commit
);
1790 free_commit_buffer(commit
);
1792 /* We put one extra blank line between formatted
1793 * patches and this flag is used by log-tree code
1794 * to see if it needs to emit a LF before showing
1795 * the log; when using one file per patch, we do
1796 * not want the extra blank line.
1801 print_bases(&bases
, rev
.diffopt
.file
);
1802 if (rev
.mime_boundary
)
1803 fprintf(rev
.diffopt
.file
, "\n--%s%s--\n\n\n",
1804 mime_boundary_leader
,
1807 print_signature(rev
.diffopt
.file
);
1810 fclose(rev
.diffopt
.file
);
1814 string_list_clear(&extra_to
, 0);
1815 string_list_clear(&extra_cc
, 0);
1816 string_list_clear(&extra_hdr
, 0);
1817 if (ignore_if_in_upstream
)
1818 free_patch_ids(&ids
);
1822 static int add_pending_commit(const char *arg
, struct rev_info
*revs
, int flags
)
1824 struct object_id oid
;
1825 if (get_oid(arg
, &oid
) == 0) {
1826 struct commit
*commit
= lookup_commit_reference(oid
.hash
);
1828 commit
->object
.flags
|= flags
;
1829 add_pending_object(revs
, &commit
->object
, arg
);
1836 static const char * const cherry_usage
[] = {
1837 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1841 static void print_commit(char sign
, struct commit
*commit
, int verbose
,
1842 int abbrev
, FILE *file
)
1845 fprintf(file
, "%c %s\n", sign
,
1846 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
));
1848 struct strbuf buf
= STRBUF_INIT
;
1849 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &buf
);
1850 fprintf(file
, "%c %s %s\n", sign
,
1851 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
),
1853 strbuf_release(&buf
);
1857 int cmd_cherry(int argc
, const char **argv
, const char *prefix
)
1859 struct rev_info revs
;
1860 struct patch_ids ids
;
1861 struct commit
*commit
;
1862 struct commit_list
*list
= NULL
;
1863 struct branch
*current_branch
;
1864 const char *upstream
;
1865 const char *head
= "HEAD";
1866 const char *limit
= NULL
;
1867 int verbose
= 0, abbrev
= 0;
1869 struct option options
[] = {
1870 OPT__ABBREV(&abbrev
),
1871 OPT__VERBOSE(&verbose
, N_("be verbose")),
1875 argc
= parse_options(argc
, argv
, prefix
, options
, cherry_usage
, 0);
1888 current_branch
= branch_get(NULL
);
1889 upstream
= branch_get_upstream(current_branch
, NULL
);
1891 fprintf(stderr
, _("Could not find a tracked"
1892 " remote branch, please"
1893 " specify <upstream> manually.\n"));
1894 usage_with_options(cherry_usage
, options
);
1898 init_revisions(&revs
, prefix
);
1899 revs
.max_parents
= 1;
1901 if (add_pending_commit(head
, &revs
, 0))
1902 die(_("Unknown commit %s"), head
);
1903 if (add_pending_commit(upstream
, &revs
, UNINTERESTING
))
1904 die(_("Unknown commit %s"), upstream
);
1906 /* Don't say anything if head and upstream are the same. */
1907 if (revs
.pending
.nr
== 2) {
1908 struct object_array_entry
*o
= revs
.pending
.objects
;
1909 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1913 get_patch_ids(&revs
, &ids
);
1915 if (limit
&& add_pending_commit(limit
, &revs
, UNINTERESTING
))
1916 die(_("Unknown commit %s"), limit
);
1918 /* reverse the list of commits */
1919 if (prepare_revision_walk(&revs
))
1920 die(_("revision walk setup failed"));
1921 while ((commit
= get_revision(&revs
)) != NULL
) {
1922 commit_list_insert(commit
, &list
);
1928 commit
= list
->item
;
1929 if (has_commit_patch_id(commit
, &ids
))
1931 print_commit(sign
, commit
, verbose
, abbrev
, revs
.diffopt
.file
);
1935 free_patch_ids(&ids
);