2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
17 #include "reflog-walk.h"
18 #include "patch-ids.h"
19 #include "run-command.h"
22 #include "string-list.h"
23 #include "parse-options.h"
26 #include "streaming.h"
29 #include "gpg-interface.h"
32 /* Set a default date-time format for git log ("log.date" config variable) */
33 static const char *default_date_mode
= NULL
;
35 static int default_abbrev_commit
;
36 static int default_show_root
= 1;
37 static int default_follow
;
38 static int default_show_signature
;
39 static int decoration_style
;
40 static int decoration_given
;
41 static int use_mailmap_config
;
42 static const char *fmt_patch_subject_prefix
= "PATCH";
43 static const char *fmt_pretty
;
45 static const char * const builtin_log_usage
[] = {
46 N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
47 N_("git show [<options>] <object>..."),
51 struct line_opt_callback_data
{
54 struct string_list args
;
57 static int auto_decoration_style(void)
59 return (isatty(1) || pager_in_use()) ? DECORATE_SHORT_REFS
: 0;
62 static int parse_decoration_style(const char *value
)
64 switch (git_parse_maybe_bool(value
)) {
66 return DECORATE_SHORT_REFS
;
72 if (!strcmp(value
, "full"))
73 return DECORATE_FULL_REFS
;
74 else if (!strcmp(value
, "short"))
75 return DECORATE_SHORT_REFS
;
76 else if (!strcmp(value
, "auto"))
77 return auto_decoration_style();
81 static int decorate_callback(const struct option
*opt
, const char *arg
, int unset
)
86 decoration_style
= parse_decoration_style(arg
);
88 decoration_style
= DECORATE_SHORT_REFS
;
90 if (decoration_style
< 0)
91 die(_("invalid --decorate option: %s"), arg
);
98 static int log_line_range_callback(const struct option
*option
, const char *arg
, int unset
)
100 struct line_opt_callback_data
*data
= option
->value
;
105 data
->rev
->line_level_traverse
= 1;
106 string_list_append(&data
->args
, arg
);
111 static void init_log_defaults(void)
113 init_grep_defaults();
114 init_diff_ui_defaults();
116 decoration_style
= auto_decoration_style();
119 static void cmd_log_init_defaults(struct rev_info
*rev
)
122 get_commit_format(fmt_pretty
, rev
);
124 rev
->diffopt
.flags
.default_follow_renames
= 1;
125 rev
->verbose_header
= 1;
126 rev
->diffopt
.flags
.recursive
= 1;
127 rev
->diffopt
.stat_width
= -1; /* use full terminal width */
128 rev
->diffopt
.stat_graph_width
= -1; /* respect statGraphWidth config */
129 rev
->abbrev_commit
= default_abbrev_commit
;
130 rev
->show_root_diff
= default_show_root
;
131 rev
->subject_prefix
= fmt_patch_subject_prefix
;
132 rev
->show_signature
= default_show_signature
;
133 rev
->diffopt
.flags
.allow_textconv
= 1;
135 if (default_date_mode
)
136 parse_date_format(default_date_mode
, &rev
->date_mode
);
139 static void cmd_log_init_finish(int argc
, const char **argv
, const char *prefix
,
140 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
142 struct userformat_want w
;
143 int quiet
= 0, source
= 0, mailmap
= 0;
144 static struct line_opt_callback_data line_cb
= {NULL
, NULL
, STRING_LIST_INIT_DUP
};
145 static struct string_list decorate_refs_exclude
= STRING_LIST_INIT_NODUP
;
146 static struct string_list decorate_refs_include
= STRING_LIST_INIT_NODUP
;
147 struct decoration_filter decoration_filter
= {&decorate_refs_include
,
148 &decorate_refs_exclude
};
150 const struct option builtin_log_options
[] = {
151 OPT__QUIET(&quiet
, N_("suppress diff output")),
152 OPT_BOOL(0, "source", &source
, N_("show source")),
153 OPT_BOOL(0, "use-mailmap", &mailmap
, N_("Use mail map file")),
154 OPT_STRING_LIST(0, "decorate-refs", &decorate_refs_include
,
155 N_("pattern"), N_("only decorate refs that match <pattern>")),
156 OPT_STRING_LIST(0, "decorate-refs-exclude", &decorate_refs_exclude
,
157 N_("pattern"), N_("do not decorate refs that match <pattern>")),
158 { OPTION_CALLBACK
, 0, "decorate", NULL
, NULL
, N_("decorate options"),
159 PARSE_OPT_OPTARG
, decorate_callback
},
160 OPT_CALLBACK('L', NULL
, &line_cb
, "n,m:file",
161 N_("Process line range n,m in file, counting from 1"),
162 log_line_range_callback
),
167 line_cb
.prefix
= prefix
;
169 mailmap
= use_mailmap_config
;
170 argc
= parse_options(argc
, argv
, prefix
,
171 builtin_log_options
, builtin_log_usage
,
172 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
173 PARSE_OPT_KEEP_DASHDASH
);
176 rev
->diffopt
.output_format
|= DIFF_FORMAT_NO_OUTPUT
;
177 argc
= setup_revisions(argc
, argv
, rev
, opt
);
179 /* Any arguments at this point are not recognized */
181 die(_("unrecognized argument: %s"), argv
[1]);
183 memset(&w
, 0, sizeof(w
));
184 userformat_find_requirements(NULL
, &w
);
186 if (!rev
->show_notes_given
&& (!rev
->pretty_given
|| w
.notes
))
189 init_display_notes(&rev
->notes_opt
);
191 if (rev
->diffopt
.pickaxe
|| rev
->diffopt
.filter
||
192 rev
->diffopt
.flags
.follow_renames
)
193 rev
->always_show_header
= 0;
196 rev
->show_source
= 1;
199 rev
->mailmap
= xcalloc(1, sizeof(struct string_list
));
200 read_mailmap(rev
->mailmap
, NULL
);
203 if (rev
->pretty_given
&& rev
->commit_format
== CMIT_FMT_RAW
) {
205 * "log --pretty=raw" is special; ignore UI oriented
206 * configuration variables such as decoration.
208 if (!decoration_given
)
209 decoration_style
= 0;
210 if (!rev
->abbrev_commit_given
)
211 rev
->abbrev_commit
= 0;
214 if (decoration_style
) {
215 rev
->show_decorations
= 1;
216 load_ref_decorations(&decoration_filter
, decoration_style
);
219 if (rev
->line_level_traverse
)
220 line_log_init(rev
, line_cb
.prefix
, &line_cb
.args
);
225 static void cmd_log_init(int argc
, const char **argv
, const char *prefix
,
226 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
228 cmd_log_init_defaults(rev
);
229 cmd_log_init_finish(argc
, argv
, prefix
, rev
, opt
);
233 * This gives a rough estimate for how many commits we
234 * will print out in the list.
236 static int estimate_commit_count(struct rev_info
*rev
, struct commit_list
*list
)
241 struct commit
*commit
= list
->item
;
242 unsigned int flags
= commit
->object
.flags
;
244 if (!(flags
& (TREESAME
| UNINTERESTING
)))
250 static void show_early_header(struct rev_info
*rev
, const char *stage
, int nr
)
252 if (rev
->shown_one
) {
254 if (rev
->commit_format
!= CMIT_FMT_ONELINE
)
255 putchar(rev
->diffopt
.line_termination
);
257 fprintf(rev
->diffopt
.file
, _("Final output: %d %s\n"), nr
, stage
);
260 static struct itimerval early_output_timer
;
262 static void log_show_early(struct rev_info
*revs
, struct commit_list
*list
)
264 int i
= revs
->early_output
, close_file
= revs
->diffopt
.close_file
;
267 revs
->diffopt
.close_file
= 0;
268 sort_in_topological_order(&list
, revs
->sort_order
);
270 struct commit
*commit
= list
->item
;
271 switch (simplify_commit(revs
, commit
)) {
274 int n
= estimate_commit_count(revs
, list
);
275 show_early_header(revs
, "incomplete", n
);
278 log_tree_commit(revs
, commit
);
285 fclose(revs
->diffopt
.file
);
291 /* Did we already get enough commits for the early output? */
294 fclose(revs
->diffopt
.file
);
299 * ..if no, then repeat it twice a second until we
302 * NOTE! We don't use "it_interval", because if the
303 * reader isn't listening, we want our output to be
304 * throttled by the writing, and not have the timer
305 * trigger every second even if we're blocked on a
308 early_output_timer
.it_value
.tv_sec
= 0;
309 early_output_timer
.it_value
.tv_usec
= 500000;
310 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
313 static void early_output(int signal
)
315 show_early_output
= log_show_early
;
318 static void setup_early_output(struct rev_info
*rev
)
323 * Set up the signal handler, minimally intrusively:
324 * we only set a single volatile integer word (not
325 * using sigatomic_t - trying to avoid unnecessary
326 * system dependencies and headers), and using
329 memset(&sa
, 0, sizeof(sa
));
330 sa
.sa_handler
= early_output
;
331 sigemptyset(&sa
.sa_mask
);
332 sa
.sa_flags
= SA_RESTART
;
333 sigaction(SIGALRM
, &sa
, NULL
);
336 * If we can get the whole output in less than a
337 * tenth of a second, don't even bother doing the
338 * early-output thing..
340 * This is a one-time-only trigger.
342 early_output_timer
.it_value
.tv_sec
= 0;
343 early_output_timer
.it_value
.tv_usec
= 100000;
344 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
347 static void finish_early_output(struct rev_info
*rev
)
349 int n
= estimate_commit_count(rev
, rev
->commits
);
350 signal(SIGALRM
, SIG_IGN
);
351 show_early_header(rev
, "done", n
);
354 static int cmd_log_walk(struct rev_info
*rev
)
356 struct commit
*commit
;
358 int saved_dcctc
= 0, close_file
= rev
->diffopt
.close_file
;
360 if (rev
->early_output
)
361 setup_early_output(rev
);
363 if (prepare_revision_walk(rev
))
364 die(_("revision walk setup failed"));
366 if (rev
->early_output
)
367 finish_early_output(rev
);
370 * For --check and --exit-code, the exit code is based on CHECK_FAILED
371 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
372 * retain that state information if replacing rev->diffopt in this loop
374 rev
->diffopt
.close_file
= 0;
375 while ((commit
= get_revision(rev
)) != NULL
) {
376 if (!log_tree_commit(rev
, commit
) && rev
->max_count
>= 0)
378 * We decremented max_count in get_revision,
379 * but we didn't actually show the commit.
382 if (!rev
->reflog_info
) {
384 * We may show a given commit multiple times when
385 * walking the reflogs.
387 free_commit_buffer(commit
);
388 free_commit_list(commit
->parents
);
389 commit
->parents
= NULL
;
391 if (saved_nrl
< rev
->diffopt
.needed_rename_limit
)
392 saved_nrl
= rev
->diffopt
.needed_rename_limit
;
393 if (rev
->diffopt
.degraded_cc_to_c
)
396 rev
->diffopt
.degraded_cc_to_c
= saved_dcctc
;
397 rev
->diffopt
.needed_rename_limit
= saved_nrl
;
399 fclose(rev
->diffopt
.file
);
401 if (rev
->diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
&&
402 rev
->diffopt
.flags
.check_failed
) {
405 return diff_result_code(&rev
->diffopt
, 0);
408 static int git_log_config(const char *var
, const char *value
, void *cb
)
410 const char *slot_name
;
412 if (!strcmp(var
, "format.pretty"))
413 return git_config_string(&fmt_pretty
, var
, value
);
414 if (!strcmp(var
, "format.subjectprefix"))
415 return git_config_string(&fmt_patch_subject_prefix
, var
, value
);
416 if (!strcmp(var
, "log.abbrevcommit")) {
417 default_abbrev_commit
= git_config_bool(var
, value
);
420 if (!strcmp(var
, "log.date"))
421 return git_config_string(&default_date_mode
, var
, value
);
422 if (!strcmp(var
, "log.decorate")) {
423 decoration_style
= parse_decoration_style(value
);
424 if (decoration_style
< 0)
425 decoration_style
= 0; /* maybe warn? */
428 if (!strcmp(var
, "log.showroot")) {
429 default_show_root
= git_config_bool(var
, value
);
432 if (!strcmp(var
, "log.follow")) {
433 default_follow
= git_config_bool(var
, value
);
436 if (skip_prefix(var
, "color.decorate.", &slot_name
))
437 return parse_decorate_color_config(var
, slot_name
, value
);
438 if (!strcmp(var
, "log.mailmap")) {
439 use_mailmap_config
= git_config_bool(var
, value
);
442 if (!strcmp(var
, "log.showsignature")) {
443 default_show_signature
= git_config_bool(var
, value
);
447 if (grep_config(var
, value
, cb
) < 0)
449 if (git_gpg_config(var
, value
, cb
) < 0)
451 return git_diff_ui_config(var
, value
, cb
);
454 int cmd_whatchanged(int argc
, const char **argv
, const char *prefix
)
457 struct setup_revision_opt opt
;
460 git_config(git_log_config
, NULL
);
462 init_revisions(&rev
, prefix
);
464 rev
.simplify_history
= 0;
465 memset(&opt
, 0, sizeof(opt
));
467 opt
.revarg_opt
= REVARG_COMMITTISH
;
468 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
469 if (!rev
.diffopt
.output_format
)
470 rev
.diffopt
.output_format
= DIFF_FORMAT_RAW
;
471 return cmd_log_walk(&rev
);
474 static void show_tagger(char *buf
, int len
, struct rev_info
*rev
)
476 struct strbuf out
= STRBUF_INIT
;
477 struct pretty_print_context pp
= {0};
479 pp
.fmt
= rev
->commit_format
;
480 pp
.date_mode
= rev
->date_mode
;
481 pp_user_info(&pp
, "Tagger", &out
, buf
, get_log_output_encoding());
482 fprintf(rev
->diffopt
.file
, "%s", out
.buf
);
483 strbuf_release(&out
);
486 static int show_blob_object(const struct object_id
*oid
, struct rev_info
*rev
, const char *obj_name
)
488 struct object_id oidc
;
489 struct object_context obj_context
;
493 fflush(rev
->diffopt
.file
);
494 if (!rev
->diffopt
.flags
.textconv_set_via_cmdline
||
495 !rev
->diffopt
.flags
.allow_textconv
)
496 return stream_blob_to_fd(1, oid
, NULL
, 0);
498 if (get_oid_with_context(obj_name
, GET_OID_RECORD_PATH
,
499 &oidc
, &obj_context
))
500 die(_("Not a valid object name %s"), obj_name
);
501 if (!obj_context
.path
||
502 !textconv_object(obj_context
.path
, obj_context
.mode
, &oidc
, 1, &buf
, &size
)) {
503 free(obj_context
.path
);
504 return stream_blob_to_fd(1, oid
, NULL
, 0);
508 die(_("git show %s: bad file"), obj_name
);
510 write_or_die(1, buf
, size
);
511 free(obj_context
.path
);
515 static int show_tag_object(const struct object_id
*oid
, struct rev_info
*rev
)
518 enum object_type type
;
519 char *buf
= read_sha1_file(oid
->hash
, &type
, &size
);
523 return error(_("Could not read object %s"), oid_to_hex(oid
));
525 assert(type
== OBJ_TAG
);
526 while (offset
< size
&& buf
[offset
] != '\n') {
527 int new_offset
= offset
+ 1;
528 while (new_offset
< size
&& buf
[new_offset
++] != '\n')
530 if (starts_with(buf
+ offset
, "tagger "))
531 show_tagger(buf
+ offset
+ 7,
532 new_offset
- offset
- 7, rev
);
537 fwrite(buf
+ offset
, size
- offset
, 1, rev
->diffopt
.file
);
542 static int show_tree_object(const unsigned char *sha1
,
544 const char *pathname
, unsigned mode
, int stage
, void *context
)
546 FILE *file
= context
;
547 fprintf(file
, "%s%s\n", pathname
, S_ISDIR(mode
) ? "/" : "");
551 static void show_setup_revisions_tweak(struct rev_info
*rev
,
552 struct setup_revision_opt
*opt
)
554 if (rev
->ignore_merges
) {
555 /* There was no "-m" on the command line */
556 rev
->ignore_merges
= 0;
557 if (!rev
->first_parent_only
&& !rev
->combine_merges
) {
558 /* No "--first-parent", "-c", or "--cc" */
559 rev
->combine_merges
= 1;
560 rev
->dense_combined_merges
= 1;
563 if (!rev
->diffopt
.output_format
)
564 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
567 int cmd_show(int argc
, const char **argv
, const char *prefix
)
570 struct object_array_entry
*objects
;
571 struct setup_revision_opt opt
;
572 struct pathspec match_all
;
573 int i
, count
, ret
= 0;
576 git_config(git_log_config
, NULL
);
578 memset(&match_all
, 0, sizeof(match_all
));
579 init_revisions(&rev
, prefix
);
581 rev
.always_show_header
= 1;
582 rev
.no_walk
= REVISION_WALK_NO_WALK_SORTED
;
583 rev
.diffopt
.stat_width
= -1; /* Scale to real terminal size */
585 memset(&opt
, 0, sizeof(opt
));
587 opt
.tweak
= show_setup_revisions_tweak
;
588 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
591 return cmd_log_walk(&rev
);
593 count
= rev
.pending
.nr
;
594 objects
= rev
.pending
.objects
;
595 for (i
= 0; i
< count
&& !ret
; i
++) {
596 struct object
*o
= objects
[i
].item
;
597 const char *name
= objects
[i
].name
;
600 ret
= show_blob_object(&o
->oid
, &rev
, name
);
603 struct tag
*t
= (struct tag
*)o
;
607 fprintf(rev
.diffopt
.file
, "%stag %s%s\n",
608 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
610 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
611 ret
= show_tag_object(&o
->oid
, &rev
);
615 o
= parse_object(&t
->tagged
->oid
);
617 ret
= error(_("Could not read object %s"),
618 oid_to_hex(&t
->tagged
->oid
));
626 fprintf(rev
.diffopt
.file
, "%stree %s%s\n\n",
627 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
629 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
630 read_tree_recursive((struct tree
*)o
, "", 0, 0, &match_all
,
631 show_tree_object
, rev
.diffopt
.file
);
635 rev
.pending
.nr
= rev
.pending
.alloc
= 0;
636 rev
.pending
.objects
= NULL
;
637 add_object_array(o
, name
, &rev
.pending
);
638 ret
= cmd_log_walk(&rev
);
641 ret
= error(_("Unknown type: %d"), o
->type
);
649 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
651 int cmd_log_reflog(int argc
, const char **argv
, const char *prefix
)
654 struct setup_revision_opt opt
;
657 git_config(git_log_config
, NULL
);
659 init_revisions(&rev
, prefix
);
660 init_reflog_walk(&rev
.reflog_info
);
661 rev
.verbose_header
= 1;
662 memset(&opt
, 0, sizeof(opt
));
664 cmd_log_init_defaults(&rev
);
665 rev
.abbrev_commit
= 1;
666 rev
.commit_format
= CMIT_FMT_ONELINE
;
667 rev
.use_terminator
= 1;
668 rev
.always_show_header
= 1;
669 cmd_log_init_finish(argc
, argv
, prefix
, &rev
, &opt
);
671 return cmd_log_walk(&rev
);
674 static void log_setup_revisions_tweak(struct rev_info
*rev
,
675 struct setup_revision_opt
*opt
)
677 if (rev
->diffopt
.flags
.default_follow_renames
&&
678 rev
->prune_data
.nr
== 1)
679 rev
->diffopt
.flags
.follow_renames
= 1;
681 /* Turn --cc/-c into -p --cc/-c when -p was not given */
682 if (!rev
->diffopt
.output_format
&& rev
->combine_merges
)
683 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
685 /* Turn -m on when --cc/-c was given */
686 if (rev
->combine_merges
)
687 rev
->ignore_merges
= 0;
690 int cmd_log(int argc
, const char **argv
, const char *prefix
)
693 struct setup_revision_opt opt
;
696 git_config(git_log_config
, NULL
);
698 init_revisions(&rev
, prefix
);
699 rev
.always_show_header
= 1;
700 memset(&opt
, 0, sizeof(opt
));
702 opt
.revarg_opt
= REVARG_COMMITTISH
;
703 opt
.tweak
= log_setup_revisions_tweak
;
704 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
705 return cmd_log_walk(&rev
);
710 static const char *fmt_patch_suffix
= ".patch";
711 static int numbered
= 0;
712 static int auto_number
= 1;
714 static char *default_attach
= NULL
;
716 static struct string_list extra_hdr
= STRING_LIST_INIT_NODUP
;
717 static struct string_list extra_to
= STRING_LIST_INIT_NODUP
;
718 static struct string_list extra_cc
= STRING_LIST_INIT_NODUP
;
720 static void add_header(const char *value
)
722 struct string_list_item
*item
;
723 int len
= strlen(value
);
724 while (len
&& value
[len
- 1] == '\n')
727 if (!strncasecmp(value
, "to: ", 4)) {
728 item
= string_list_append(&extra_to
, value
+ 4);
730 } else if (!strncasecmp(value
, "cc: ", 4)) {
731 item
= string_list_append(&extra_cc
, value
+ 4);
734 item
= string_list_append(&extra_hdr
, value
);
737 item
->string
[len
] = '\0';
740 #define THREAD_SHALLOW 1
741 #define THREAD_DEEP 2
743 static int do_signoff
;
744 static int base_auto
;
746 static const char *signature
= git_version_string
;
747 static const char *signature_file
;
748 static int config_cover_letter
;
749 static const char *config_output_directory
;
758 static int git_format_config(const char *var
, const char *value
, void *cb
)
760 if (!strcmp(var
, "format.headers")) {
762 die(_("format.headers without value"));
766 if (!strcmp(var
, "format.suffix"))
767 return git_config_string(&fmt_patch_suffix
, var
, value
);
768 if (!strcmp(var
, "format.to")) {
770 return config_error_nonbool(var
);
771 string_list_append(&extra_to
, value
);
774 if (!strcmp(var
, "format.cc")) {
776 return config_error_nonbool(var
);
777 string_list_append(&extra_cc
, value
);
780 if (!strcmp(var
, "diff.color") || !strcmp(var
, "color.diff") ||
781 !strcmp(var
, "color.ui") || !strcmp(var
, "diff.submodule")) {
784 if (!strcmp(var
, "format.numbered")) {
785 if (value
&& !strcasecmp(value
, "auto")) {
789 numbered
= git_config_bool(var
, value
);
790 auto_number
= auto_number
&& numbered
;
793 if (!strcmp(var
, "format.attach")) {
795 default_attach
= xstrdup(value
);
797 default_attach
= xstrdup(git_version_string
);
800 if (!strcmp(var
, "format.thread")) {
801 if (value
&& !strcasecmp(value
, "deep")) {
802 thread
= THREAD_DEEP
;
805 if (value
&& !strcasecmp(value
, "shallow")) {
806 thread
= THREAD_SHALLOW
;
809 thread
= git_config_bool(var
, value
) && THREAD_SHALLOW
;
812 if (!strcmp(var
, "format.signoff")) {
813 do_signoff
= git_config_bool(var
, value
);
816 if (!strcmp(var
, "format.signature"))
817 return git_config_string(&signature
, var
, value
);
818 if (!strcmp(var
, "format.signaturefile"))
819 return git_config_pathname(&signature_file
, var
, value
);
820 if (!strcmp(var
, "format.coverletter")) {
821 if (value
&& !strcasecmp(value
, "auto")) {
822 config_cover_letter
= COVER_AUTO
;
825 config_cover_letter
= git_config_bool(var
, value
) ? COVER_ON
: COVER_OFF
;
828 if (!strcmp(var
, "format.outputdirectory"))
829 return git_config_string(&config_output_directory
, var
, value
);
830 if (!strcmp(var
, "format.useautobase")) {
831 base_auto
= git_config_bool(var
, value
);
834 if (!strcmp(var
, "format.from")) {
835 int b
= git_parse_maybe_bool(value
);
838 from
= xstrdup(value
);
840 from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
846 return git_log_config(var
, value
, cb
);
849 static const char *output_directory
= NULL
;
850 static int outdir_offset
;
852 static int open_next_file(struct commit
*commit
, const char *subject
,
853 struct rev_info
*rev
, int quiet
)
855 struct strbuf filename
= STRBUF_INIT
;
856 int suffix_len
= strlen(rev
->patch_suffix
) + 1;
858 if (output_directory
) {
859 strbuf_addstr(&filename
, output_directory
);
861 PATH_MAX
- FORMAT_PATCH_NAME_MAX
- suffix_len
) {
862 strbuf_release(&filename
);
863 return error(_("name of output directory is too long"));
865 strbuf_complete(&filename
, '/');
868 if (rev
->numbered_files
)
869 strbuf_addf(&filename
, "%d", rev
->nr
);
871 fmt_output_commit(&filename
, commit
, rev
);
873 fmt_output_subject(&filename
, subject
, rev
);
876 printf("%s\n", filename
.buf
+ outdir_offset
);
878 if ((rev
->diffopt
.file
= fopen(filename
.buf
, "w")) == NULL
) {
879 error_errno(_("Cannot open patch file %s"), filename
.buf
);
880 strbuf_release(&filename
);
884 strbuf_release(&filename
);
888 static void get_patch_ids(struct rev_info
*rev
, struct patch_ids
*ids
)
890 struct rev_info check_rev
;
891 struct commit
*commit
, *c1
, *c2
;
892 struct object
*o1
, *o2
;
893 unsigned flags1
, flags2
;
895 if (rev
->pending
.nr
!= 2)
896 die(_("Need exactly one range."));
898 o1
= rev
->pending
.objects
[0].item
;
899 o2
= rev
->pending
.objects
[1].item
;
902 c1
= lookup_commit_reference(&o1
->oid
);
903 c2
= lookup_commit_reference(&o2
->oid
);
905 if ((flags1
& UNINTERESTING
) == (flags2
& UNINTERESTING
))
906 die(_("Not a range."));
910 /* given a range a..b get all patch ids for b..a */
911 init_revisions(&check_rev
, rev
->prefix
);
912 check_rev
.max_parents
= 1;
913 o1
->flags
^= UNINTERESTING
;
914 o2
->flags
^= UNINTERESTING
;
915 add_pending_object(&check_rev
, o1
, "o1");
916 add_pending_object(&check_rev
, o2
, "o2");
917 if (prepare_revision_walk(&check_rev
))
918 die(_("revision walk setup failed"));
920 while ((commit
= get_revision(&check_rev
)) != NULL
) {
921 add_commit_patch_id(commit
, ids
);
924 /* reset for next revision walk */
925 clear_commit_marks(c1
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
926 clear_commit_marks(c2
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
931 static void gen_message_id(struct rev_info
*info
, char *base
)
933 struct strbuf buf
= STRBUF_INIT
;
934 strbuf_addf(&buf
, "%s.%"PRItime
".git.%s", base
,
935 (timestamp_t
) time(NULL
),
936 git_committer_info(IDENT_NO_NAME
|IDENT_NO_DATE
|IDENT_STRICT
));
937 info
->message_id
= strbuf_detach(&buf
, NULL
);
940 static void print_signature(FILE *file
)
942 if (!signature
|| !*signature
)
945 fprintf(file
, "-- \n%s", signature
);
946 if (signature
[strlen(signature
)-1] != '\n')
951 static void add_branch_description(struct strbuf
*buf
, const char *branch_name
)
953 struct strbuf desc
= STRBUF_INIT
;
954 if (!branch_name
|| !*branch_name
)
956 read_branch_desc(&desc
, branch_name
);
958 strbuf_addch(buf
, '\n');
959 strbuf_addbuf(buf
, &desc
);
960 strbuf_addch(buf
, '\n');
962 strbuf_release(&desc
);
965 static char *find_branch_name(struct rev_info
*rev
)
967 int i
, positive
= -1;
968 struct object_id branch_oid
;
969 const struct object_id
*tip_oid
;
971 char *full_ref
, *branch
= NULL
;
973 for (i
= 0; i
< rev
->cmdline
.nr
; i
++) {
974 if (rev
->cmdline
.rev
[i
].flags
& UNINTERESTING
)
983 ref
= rev
->cmdline
.rev
[positive
].name
;
984 tip_oid
= &rev
->cmdline
.rev
[positive
].item
->oid
;
985 if (dwim_ref(ref
, strlen(ref
), &branch_oid
, &full_ref
) &&
986 skip_prefix(full_ref
, "refs/heads/", &v
) &&
987 !oidcmp(tip_oid
, &branch_oid
))
993 static void make_cover_letter(struct rev_info
*rev
, int use_stdout
,
994 struct commit
*origin
,
995 int nr
, struct commit
**list
,
996 const char *branch_name
,
999 const char *committer
;
1000 const char *body
= "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
1002 struct shortlog log
;
1003 struct strbuf sb
= STRBUF_INIT
;
1005 const char *encoding
= "UTF-8";
1006 struct diff_options opts
;
1007 int need_8bit_cte
= 0;
1008 struct pretty_print_context pp
= {0};
1009 struct commit
*head
= list
[0];
1011 if (!cmit_fmt_is_mail(rev
->commit_format
))
1012 die(_("Cover letter needs email format"));
1014 committer
= git_committer_info(0);
1017 open_next_file(NULL
, rev
->numbered_files
? NULL
: "cover-letter", rev
, quiet
))
1020 log_write_email_headers(rev
, head
, &pp
.after_subject
, &need_8bit_cte
);
1022 for (i
= 0; !need_8bit_cte
&& i
< nr
; i
++) {
1023 const char *buf
= get_commit_buffer(list
[i
], NULL
);
1024 if (has_non_ascii(buf
))
1026 unuse_commit_buffer(list
[i
], buf
);
1030 branch_name
= find_branch_name(rev
);
1033 pp
.fmt
= CMIT_FMT_EMAIL
;
1034 pp
.date_mode
.type
= DATE_RFC2822
;
1036 pp
.print_email_subject
= 1;
1037 pp_user_info(&pp
, NULL
, &sb
, committer
, encoding
);
1038 pp_title_line(&pp
, &msg
, &sb
, encoding
, need_8bit_cte
);
1039 pp_remainder(&pp
, &msg
, &sb
, 0);
1040 add_branch_description(&sb
, branch_name
);
1041 fprintf(rev
->diffopt
.file
, "%s\n", sb
.buf
);
1043 strbuf_release(&sb
);
1045 shortlog_init(&log
);
1050 log
.file
= rev
->diffopt
.file
;
1051 for (i
= 0; i
< nr
; i
++)
1052 shortlog_add_commit(&log
, list
[i
]);
1054 shortlog_output(&log
);
1057 * We can only do diffstat with a unique reference point
1062 memcpy(&opts
, &rev
->diffopt
, sizeof(opts
));
1063 opts
.output_format
= DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
1065 diff_setup_done(&opts
);
1067 diff_tree_oid(&origin
->tree
->object
.oid
,
1068 &head
->tree
->object
.oid
,
1070 diffcore_std(&opts
);
1073 fprintf(rev
->diffopt
.file
, "\n");
1076 static const char *clean_message_id(const char *msg_id
)
1079 const char *a
, *z
, *m
;
1082 while ((ch
= *m
) && (isspace(ch
) || (ch
== '<')))
1087 if (!isspace(ch
) && (ch
!= '>'))
1092 die(_("insane in-reply-to: %s"), msg_id
);
1095 return xmemdupz(a
, z
- a
);
1098 static const char *set_outdir(const char *prefix
, const char *output_directory
)
1100 if (output_directory
&& is_absolute_path(output_directory
))
1101 return output_directory
;
1103 if (!prefix
|| !*prefix
) {
1104 if (output_directory
)
1105 return output_directory
;
1106 /* The user did not explicitly ask for "./" */
1111 outdir_offset
= strlen(prefix
);
1112 if (!output_directory
)
1115 return prefix_filename(prefix
, output_directory
);
1118 static const char * const builtin_format_patch_usage
[] = {
1119 N_("git format-patch [<options>] [<since> | <revision-range>]"),
1123 static int keep_subject
= 0;
1125 static int keep_callback(const struct option
*opt
, const char *arg
, int unset
)
1127 ((struct rev_info
*)opt
->value
)->total
= -1;
1132 static int subject_prefix
= 0;
1134 static int subject_prefix_callback(const struct option
*opt
, const char *arg
,
1138 ((struct rev_info
*)opt
->value
)->subject_prefix
= arg
;
1142 static int rfc_callback(const struct option
*opt
, const char *arg
, int unset
)
1144 return subject_prefix_callback(opt
, "RFC PATCH", unset
);
1147 static int numbered_cmdline_opt
= 0;
1149 static int numbered_callback(const struct option
*opt
, const char *arg
,
1152 *(int *)opt
->value
= numbered_cmdline_opt
= unset
? 0 : 1;
1158 static int no_numbered_callback(const struct option
*opt
, const char *arg
,
1161 return numbered_callback(opt
, arg
, 1);
1164 static int output_directory_callback(const struct option
*opt
, const char *arg
,
1167 const char **dir
= (const char **)opt
->value
;
1169 die(_("Two output directories?"));
1174 static int thread_callback(const struct option
*opt
, const char *arg
, int unset
)
1176 int *thread
= (int *)opt
->value
;
1179 else if (!arg
|| !strcmp(arg
, "shallow"))
1180 *thread
= THREAD_SHALLOW
;
1181 else if (!strcmp(arg
, "deep"))
1182 *thread
= THREAD_DEEP
;
1188 static int attach_callback(const struct option
*opt
, const char *arg
, int unset
)
1190 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1192 rev
->mime_boundary
= NULL
;
1194 rev
->mime_boundary
= arg
;
1196 rev
->mime_boundary
= git_version_string
;
1197 rev
->no_inline
= unset
? 0 : 1;
1201 static int inline_callback(const struct option
*opt
, const char *arg
, int unset
)
1203 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1205 rev
->mime_boundary
= NULL
;
1207 rev
->mime_boundary
= arg
;
1209 rev
->mime_boundary
= git_version_string
;
1214 static int header_callback(const struct option
*opt
, const char *arg
, int unset
)
1217 string_list_clear(&extra_hdr
, 0);
1218 string_list_clear(&extra_to
, 0);
1219 string_list_clear(&extra_cc
, 0);
1226 static int to_callback(const struct option
*opt
, const char *arg
, int unset
)
1229 string_list_clear(&extra_to
, 0);
1231 string_list_append(&extra_to
, arg
);
1235 static int cc_callback(const struct option
*opt
, const char *arg
, int unset
)
1238 string_list_clear(&extra_cc
, 0);
1240 string_list_append(&extra_cc
, arg
);
1244 static int from_callback(const struct option
*opt
, const char *arg
, int unset
)
1246 char **from
= opt
->value
;
1253 *from
= xstrdup(arg
);
1255 *from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
1259 struct base_tree_info
{
1260 struct object_id base_commit
;
1261 int nr_patch_id
, alloc_patch_id
;
1262 struct object_id
*patch_id
;
1265 static struct commit
*get_base_commit(const char *base_commit
,
1266 struct commit
**list
,
1269 struct commit
*base
= NULL
;
1270 struct commit
**rev
;
1271 int i
= 0, rev_nr
= 0;
1273 if (base_commit
&& strcmp(base_commit
, "auto")) {
1274 base
= lookup_commit_reference_by_name(base_commit
);
1276 die(_("Unknown commit %s"), base_commit
);
1277 } else if ((base_commit
&& !strcmp(base_commit
, "auto")) || base_auto
) {
1278 struct branch
*curr_branch
= branch_get(NULL
);
1279 const char *upstream
= branch_get_upstream(curr_branch
, NULL
);
1281 struct commit_list
*base_list
;
1282 struct commit
*commit
;
1283 struct object_id oid
;
1285 if (get_oid(upstream
, &oid
))
1286 die(_("Failed to resolve '%s' as a valid ref."), upstream
);
1287 commit
= lookup_commit_or_die(&oid
, "upstream base");
1288 base_list
= get_merge_bases_many(commit
, total
, list
);
1289 /* There should be one and only one merge base. */
1290 if (!base_list
|| base_list
->next
)
1291 die(_("Could not find exact merge base."));
1292 base
= base_list
->item
;
1293 free_commit_list(base_list
);
1295 die(_("Failed to get upstream, if you want to record base commit automatically,\n"
1296 "please use git branch --set-upstream-to to track a remote branch.\n"
1297 "Or you could specify base commit by --base=<base-commit-id> manually."));
1301 ALLOC_ARRAY(rev
, total
);
1302 for (i
= 0; i
< total
; i
++)
1307 * Get merge base through pair-wise computations
1308 * and store it in rev[0].
1310 while (rev_nr
> 1) {
1311 for (i
= 0; i
< rev_nr
/ 2; i
++) {
1312 struct commit_list
*merge_base
;
1313 merge_base
= get_merge_bases(rev
[2 * i
], rev
[2 * i
+ 1]);
1314 if (!merge_base
|| merge_base
->next
)
1315 die(_("Failed to find exact merge base"));
1317 rev
[i
] = merge_base
->item
;
1321 rev
[i
] = rev
[2 * i
];
1322 rev_nr
= DIV_ROUND_UP(rev_nr
, 2);
1325 if (!in_merge_bases(base
, rev
[0]))
1326 die(_("base commit should be the ancestor of revision list"));
1328 for (i
= 0; i
< total
; i
++) {
1329 if (base
== list
[i
])
1330 die(_("base commit shouldn't be in revision list"));
1337 static void prepare_bases(struct base_tree_info
*bases
,
1338 struct commit
*base
,
1339 struct commit
**list
,
1342 struct commit
*commit
;
1343 struct rev_info revs
;
1344 struct diff_options diffopt
;
1350 diff_setup(&diffopt
);
1351 diffopt
.flags
.recursive
= 1;
1352 diff_setup_done(&diffopt
);
1354 oidcpy(&bases
->base_commit
, &base
->object
.oid
);
1356 init_revisions(&revs
, NULL
);
1357 revs
.max_parents
= 1;
1358 revs
.topo_order
= 1;
1359 for (i
= 0; i
< total
; i
++) {
1360 list
[i
]->object
.flags
&= ~UNINTERESTING
;
1361 add_pending_object(&revs
, &list
[i
]->object
, "rev_list");
1362 list
[i
]->util
= (void *)1;
1364 base
->object
.flags
|= UNINTERESTING
;
1365 add_pending_object(&revs
, &base
->object
, "base");
1367 if (prepare_revision_walk(&revs
))
1368 die(_("revision walk setup failed"));
1370 * Traverse the commits list, get prerequisite patch ids
1371 * and stuff them in bases structure.
1373 while ((commit
= get_revision(&revs
)) != NULL
) {
1374 struct object_id oid
;
1375 struct object_id
*patch_id
;
1378 if (commit_patch_id(commit
, &diffopt
, &oid
, 0))
1379 die(_("cannot get patch id"));
1380 ALLOC_GROW(bases
->patch_id
, bases
->nr_patch_id
+ 1, bases
->alloc_patch_id
);
1381 patch_id
= bases
->patch_id
+ bases
->nr_patch_id
;
1382 oidcpy(patch_id
, &oid
);
1383 bases
->nr_patch_id
++;
1387 static void print_bases(struct base_tree_info
*bases
, FILE *file
)
1391 /* Only do this once, either for the cover or for the first one */
1392 if (is_null_oid(&bases
->base_commit
))
1395 /* Show the base commit */
1396 fprintf(file
, "\nbase-commit: %s\n", oid_to_hex(&bases
->base_commit
));
1398 /* Show the prerequisite patches */
1399 for (i
= bases
->nr_patch_id
- 1; i
>= 0; i
--)
1400 fprintf(file
, "prerequisite-patch-id: %s\n", oid_to_hex(&bases
->patch_id
[i
]));
1402 free(bases
->patch_id
);
1403 bases
->nr_patch_id
= 0;
1404 bases
->alloc_patch_id
= 0;
1405 oidclr(&bases
->base_commit
);
1408 int cmd_format_patch(int argc
, const char **argv
, const char *prefix
)
1410 struct commit
*commit
;
1411 struct commit
**list
= NULL
;
1412 struct rev_info rev
;
1413 struct setup_revision_opt s_r_opt
;
1414 int nr
= 0, total
, i
;
1416 int start_number
= -1;
1417 int just_numbers
= 0;
1418 int ignore_if_in_upstream
= 0;
1419 int cover_letter
= -1;
1420 int boundary_count
= 0;
1421 int no_binary_diff
= 0;
1422 int zero_commit
= 0;
1423 struct commit
*origin
= NULL
;
1424 const char *in_reply_to
= NULL
;
1425 struct patch_ids ids
;
1426 struct strbuf buf
= STRBUF_INIT
;
1427 int use_patch_format
= 0;
1429 int reroll_count
= -1;
1430 char *branch_name
= NULL
;
1431 char *base_commit
= NULL
;
1432 struct base_tree_info bases
;
1433 int show_progress
= 0;
1434 struct progress
*progress
= NULL
;
1436 const struct option builtin_format_patch_options
[] = {
1437 { OPTION_CALLBACK
, 'n', "numbered", &numbered
, NULL
,
1438 N_("use [PATCH n/m] even with a single patch"),
1439 PARSE_OPT_NOARG
, numbered_callback
},
1440 { OPTION_CALLBACK
, 'N', "no-numbered", &numbered
, NULL
,
1441 N_("use [PATCH] even with multiple patches"),
1442 PARSE_OPT_NOARG
, no_numbered_callback
},
1443 OPT_BOOL('s', "signoff", &do_signoff
, N_("add Signed-off-by:")),
1444 OPT_BOOL(0, "stdout", &use_stdout
,
1445 N_("print patches to standard out")),
1446 OPT_BOOL(0, "cover-letter", &cover_letter
,
1447 N_("generate a cover letter")),
1448 OPT_BOOL(0, "numbered-files", &just_numbers
,
1449 N_("use simple number sequence for output file names")),
1450 OPT_STRING(0, "suffix", &fmt_patch_suffix
, N_("sfx"),
1451 N_("use <sfx> instead of '.patch'")),
1452 OPT_INTEGER(0, "start-number", &start_number
,
1453 N_("start numbering patches at <n> instead of 1")),
1454 OPT_INTEGER('v', "reroll-count", &reroll_count
,
1455 N_("mark the series as Nth re-roll")),
1456 { OPTION_CALLBACK
, 0, "rfc", &rev
, NULL
,
1457 N_("Use [RFC PATCH] instead of [PATCH]"),
1458 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, rfc_callback
},
1459 { OPTION_CALLBACK
, 0, "subject-prefix", &rev
, N_("prefix"),
1460 N_("Use [<prefix>] instead of [PATCH]"),
1461 PARSE_OPT_NONEG
, subject_prefix_callback
},
1462 { OPTION_CALLBACK
, 'o', "output-directory", &output_directory
,
1463 N_("dir"), N_("store resulting files in <dir>"),
1464 PARSE_OPT_NONEG
, output_directory_callback
},
1465 { OPTION_CALLBACK
, 'k', "keep-subject", &rev
, NULL
,
1466 N_("don't strip/add [PATCH]"),
1467 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, keep_callback
},
1468 OPT_BOOL(0, "no-binary", &no_binary_diff
,
1469 N_("don't output binary diffs")),
1470 OPT_BOOL(0, "zero-commit", &zero_commit
,
1471 N_("output all-zero hash in From header")),
1472 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream
,
1473 N_("don't include a patch matching a commit upstream")),
1474 { OPTION_SET_INT
, 'p', "no-stat", &use_patch_format
, NULL
,
1475 N_("show patch format instead of default (patch + stat)"),
1476 PARSE_OPT_NONEG
| PARSE_OPT_NOARG
, NULL
, 1},
1477 OPT_GROUP(N_("Messaging")),
1478 { OPTION_CALLBACK
, 0, "add-header", NULL
, N_("header"),
1479 N_("add email header"), 0, header_callback
},
1480 { OPTION_CALLBACK
, 0, "to", NULL
, N_("email"), N_("add To: header"),
1482 { OPTION_CALLBACK
, 0, "cc", NULL
, N_("email"), N_("add Cc: header"),
1484 { OPTION_CALLBACK
, 0, "from", &from
, N_("ident"),
1485 N_("set From address to <ident> (or committer ident if absent)"),
1486 PARSE_OPT_OPTARG
, from_callback
},
1487 OPT_STRING(0, "in-reply-to", &in_reply_to
, N_("message-id"),
1488 N_("make first mail a reply to <message-id>")),
1489 { OPTION_CALLBACK
, 0, "attach", &rev
, N_("boundary"),
1490 N_("attach the patch"), PARSE_OPT_OPTARG
,
1492 { OPTION_CALLBACK
, 0, "inline", &rev
, N_("boundary"),
1493 N_("inline the patch"),
1494 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
1496 { OPTION_CALLBACK
, 0, "thread", &thread
, N_("style"),
1497 N_("enable message threading, styles: shallow, deep"),
1498 PARSE_OPT_OPTARG
, thread_callback
},
1499 OPT_STRING(0, "signature", &signature
, N_("signature"),
1500 N_("add a signature")),
1501 OPT_STRING(0, "base", &base_commit
, N_("base-commit"),
1502 N_("add prerequisite tree info to the patch series")),
1503 OPT_FILENAME(0, "signature-file", &signature_file
,
1504 N_("add a signature from a file")),
1505 OPT__QUIET(&quiet
, N_("don't print the patch filenames")),
1506 OPT_BOOL(0, "progress", &show_progress
,
1507 N_("show progress while generating patches")),
1511 extra_hdr
.strdup_strings
= 1;
1512 extra_to
.strdup_strings
= 1;
1513 extra_cc
.strdup_strings
= 1;
1514 init_log_defaults();
1515 git_config(git_format_config
, NULL
);
1516 init_revisions(&rev
, prefix
);
1517 rev
.commit_format
= CMIT_FMT_EMAIL
;
1518 rev
.expand_tabs_in_log_default
= 0;
1519 rev
.verbose_header
= 1;
1521 rev
.max_parents
= 1;
1522 rev
.diffopt
.flags
.recursive
= 1;
1523 rev
.subject_prefix
= fmt_patch_subject_prefix
;
1524 memset(&s_r_opt
, 0, sizeof(s_r_opt
));
1525 s_r_opt
.def
= "HEAD";
1526 s_r_opt
.revarg_opt
= REVARG_COMMITTISH
;
1528 if (default_attach
) {
1529 rev
.mime_boundary
= default_attach
;
1534 * Parse the arguments before setup_revisions(), or something
1535 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1536 * possibly a valid SHA1.
1538 argc
= parse_options(argc
, argv
, prefix
, builtin_format_patch_options
,
1539 builtin_format_patch_usage
,
1540 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
1541 PARSE_OPT_KEEP_DASHDASH
);
1543 if (0 < reroll_count
) {
1544 struct strbuf sprefix
= STRBUF_INIT
;
1545 strbuf_addf(&sprefix
, "%s v%d",
1546 rev
.subject_prefix
, reroll_count
);
1547 rev
.reroll_count
= reroll_count
;
1548 rev
.subject_prefix
= strbuf_detach(&sprefix
, NULL
);
1551 for (i
= 0; i
< extra_hdr
.nr
; i
++) {
1552 strbuf_addstr(&buf
, extra_hdr
.items
[i
].string
);
1553 strbuf_addch(&buf
, '\n');
1557 strbuf_addstr(&buf
, "To: ");
1558 for (i
= 0; i
< extra_to
.nr
; i
++) {
1560 strbuf_addstr(&buf
, " ");
1561 strbuf_addstr(&buf
, extra_to
.items
[i
].string
);
1562 if (i
+ 1 < extra_to
.nr
)
1563 strbuf_addch(&buf
, ',');
1564 strbuf_addch(&buf
, '\n');
1568 strbuf_addstr(&buf
, "Cc: ");
1569 for (i
= 0; i
< extra_cc
.nr
; i
++) {
1571 strbuf_addstr(&buf
, " ");
1572 strbuf_addstr(&buf
, extra_cc
.items
[i
].string
);
1573 if (i
+ 1 < extra_cc
.nr
)
1574 strbuf_addch(&buf
, ',');
1575 strbuf_addch(&buf
, '\n');
1578 rev
.extra_headers
= strbuf_detach(&buf
, NULL
);
1581 if (split_ident_line(&rev
.from_ident
, from
, strlen(from
)))
1582 die(_("invalid ident line: %s"), from
);
1585 if (start_number
< 0)
1589 * If numbered is set solely due to format.numbered in config,
1590 * and it would conflict with --keep-subject (-k) from the
1591 * command line, reset "numbered".
1593 if (numbered
&& keep_subject
&& !numbered_cmdline_opt
)
1596 if (numbered
&& keep_subject
)
1597 die (_("-n and -k are mutually exclusive."));
1598 if (keep_subject
&& subject_prefix
)
1599 die (_("--subject-prefix/--rfc and -k are mutually exclusive."));
1600 rev
.preserve_subject
= keep_subject
;
1602 argc
= setup_revisions(argc
, argv
, &rev
, &s_r_opt
);
1604 die (_("unrecognized argument: %s"), argv
[1]);
1606 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME
)
1607 die(_("--name-only does not make sense"));
1608 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME_STATUS
)
1609 die(_("--name-status does not make sense"));
1610 if (rev
.diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
)
1611 die(_("--check does not make sense"));
1613 if (!use_patch_format
&&
1614 (!rev
.diffopt
.output_format
||
1615 rev
.diffopt
.output_format
== DIFF_FORMAT_PATCH
))
1616 rev
.diffopt
.output_format
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_SUMMARY
;
1618 /* Always generate a patch */
1619 rev
.diffopt
.output_format
|= DIFF_FORMAT_PATCH
;
1621 rev
.zero_commit
= zero_commit
;
1623 if (!rev
.diffopt
.flags
.text
&& !no_binary_diff
)
1624 rev
.diffopt
.flags
.binary
= 1;
1627 init_display_notes(&rev
.notes_opt
);
1629 if (!output_directory
&& !use_stdout
)
1630 output_directory
= config_output_directory
;
1633 output_directory
= set_outdir(prefix
, output_directory
);
1637 if (output_directory
) {
1638 if (rev
.diffopt
.use_color
!= GIT_COLOR_ALWAYS
)
1639 rev
.diffopt
.use_color
= GIT_COLOR_NEVER
;
1641 die(_("standard output, or directory, which one?"));
1642 if (mkdir(output_directory
, 0777) < 0 && errno
!= EEXIST
)
1643 die_errno(_("Could not create directory '%s'"),
1647 if (rev
.pending
.nr
== 1) {
1650 if (rev
.max_count
< 0 && !rev
.show_root_diff
) {
1652 * This is traditional behaviour of "git format-patch
1653 * origin" that prepares what the origin side still
1656 rev
.pending
.objects
[0].item
->flags
|= UNINTERESTING
;
1657 add_head_to_pending(&rev
);
1661 * Otherwise, it is "format-patch -22 HEAD", and/or
1662 * "format-patch --root HEAD". The user wants
1663 * get_revision() to do the usual traversal.
1666 if (!strcmp(rev
.pending
.objects
[0].name
, "HEAD"))
1670 const char *ref
, *v
;
1671 ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
1673 if (ref
&& skip_prefix(ref
, "refs/heads/", &v
))
1674 branch_name
= xstrdup(v
);
1676 branch_name
= xstrdup(""); /* no branch */
1681 * We cannot move this anywhere earlier because we do want to
1682 * know if --root was given explicitly from the command line.
1684 rev
.show_root_diff
= 1;
1686 if (ignore_if_in_upstream
) {
1687 /* Don't say anything if head and upstream are the same. */
1688 if (rev
.pending
.nr
== 2) {
1689 struct object_array_entry
*o
= rev
.pending
.objects
;
1690 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1693 get_patch_ids(&rev
, &ids
);
1696 if (prepare_revision_walk(&rev
))
1697 die(_("revision walk setup failed"));
1699 while ((commit
= get_revision(&rev
)) != NULL
) {
1700 if (commit
->object
.flags
& BOUNDARY
) {
1702 origin
= (boundary_count
== 1) ? commit
: NULL
;
1706 if (ignore_if_in_upstream
&& has_commit_patch_id(commit
, &ids
))
1710 REALLOC_ARRAY(list
, nr
);
1711 list
[nr
- 1] = commit
;
1717 if (cover_letter
== -1) {
1718 if (config_cover_letter
== COVER_AUTO
)
1719 cover_letter
= (total
> 1);
1721 cover_letter
= (config_cover_letter
== COVER_ON
);
1723 if (!keep_subject
&& auto_number
&& (total
> 1 || cover_letter
))
1726 rev
.total
= total
+ start_number
- 1;
1729 ; /* --no-signature inhibits all signatures */
1730 } else if (signature
&& signature
!= git_version_string
) {
1731 ; /* non-default signature already set */
1732 } else if (signature_file
) {
1733 struct strbuf buf
= STRBUF_INIT
;
1735 if (strbuf_read_file(&buf
, signature_file
, 128) < 0)
1736 die_errno(_("unable to read signature file '%s'"), signature_file
);
1737 signature
= strbuf_detach(&buf
, NULL
);
1740 memset(&bases
, 0, sizeof(bases
));
1741 if (base_commit
|| base_auto
) {
1742 struct commit
*base
= get_base_commit(base_commit
, list
, nr
);
1743 reset_revision_walk();
1744 prepare_bases(&bases
, base
, list
, nr
);
1747 if (in_reply_to
|| thread
|| cover_letter
)
1748 rev
.ref_message_ids
= xcalloc(1, sizeof(struct string_list
));
1750 const char *msgid
= clean_message_id(in_reply_to
);
1751 string_list_append(rev
.ref_message_ids
, msgid
);
1753 rev
.numbered_files
= just_numbers
;
1754 rev
.patch_suffix
= fmt_patch_suffix
;
1757 gen_message_id(&rev
, "cover");
1758 make_cover_letter(&rev
, use_stdout
,
1759 origin
, nr
, list
, branch_name
, quiet
);
1760 print_bases(&bases
, rev
.diffopt
.file
);
1761 print_signature(rev
.diffopt
.file
);
1765 rev
.add_signoff
= do_signoff
;
1768 progress
= start_delayed_progress(_("Generating patches"), total
);
1771 display_progress(progress
, total
- nr
);
1773 rev
.nr
= total
- nr
+ (start_number
- 1);
1774 /* Make the second and subsequent mails replies to the first */
1776 /* Have we already had a message ID? */
1777 if (rev
.message_id
) {
1779 * For deep threading: make every mail
1780 * a reply to the previous one, no
1781 * matter what other options are set.
1783 * For shallow threading:
1785 * Without --cover-letter and
1786 * --in-reply-to, make every mail a
1787 * reply to the one before.
1789 * With --in-reply-to but no
1790 * --cover-letter, make every mail a
1791 * reply to the <reply-to>.
1793 * With --cover-letter, make every
1794 * mail but the cover letter a reply
1795 * to the cover letter. The cover
1796 * letter is a reply to the
1797 * --in-reply-to, if specified.
1799 if (thread
== THREAD_SHALLOW
1800 && rev
.ref_message_ids
->nr
> 0
1801 && (!cover_letter
|| rev
.nr
> 1))
1802 free(rev
.message_id
);
1804 string_list_append(rev
.ref_message_ids
,
1807 gen_message_id(&rev
, oid_to_hex(&commit
->object
.oid
));
1811 open_next_file(rev
.numbered_files
? NULL
: commit
, NULL
, &rev
, quiet
))
1812 die(_("Failed to create output files"));
1813 shown
= log_tree_commit(&rev
, commit
);
1814 free_commit_buffer(commit
);
1816 /* We put one extra blank line between formatted
1817 * patches and this flag is used by log-tree code
1818 * to see if it needs to emit a LF before showing
1819 * the log; when using one file per patch, we do
1820 * not want the extra blank line.
1825 print_bases(&bases
, rev
.diffopt
.file
);
1826 if (rev
.mime_boundary
)
1827 fprintf(rev
.diffopt
.file
, "\n--%s%s--\n\n\n",
1828 mime_boundary_leader
,
1831 print_signature(rev
.diffopt
.file
);
1834 fclose(rev
.diffopt
.file
);
1836 stop_progress(&progress
);
1839 string_list_clear(&extra_to
, 0);
1840 string_list_clear(&extra_cc
, 0);
1841 string_list_clear(&extra_hdr
, 0);
1842 if (ignore_if_in_upstream
)
1843 free_patch_ids(&ids
);
1847 static int add_pending_commit(const char *arg
, struct rev_info
*revs
, int flags
)
1849 struct object_id oid
;
1850 if (get_oid(arg
, &oid
) == 0) {
1851 struct commit
*commit
= lookup_commit_reference(&oid
);
1853 commit
->object
.flags
|= flags
;
1854 add_pending_object(revs
, &commit
->object
, arg
);
1861 static const char * const cherry_usage
[] = {
1862 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1866 static void print_commit(char sign
, struct commit
*commit
, int verbose
,
1867 int abbrev
, FILE *file
)
1870 fprintf(file
, "%c %s\n", sign
,
1871 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
));
1873 struct strbuf buf
= STRBUF_INIT
;
1874 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &buf
);
1875 fprintf(file
, "%c %s %s\n", sign
,
1876 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
),
1878 strbuf_release(&buf
);
1882 int cmd_cherry(int argc
, const char **argv
, const char *prefix
)
1884 struct rev_info revs
;
1885 struct patch_ids ids
;
1886 struct commit
*commit
;
1887 struct commit_list
*list
= NULL
;
1888 struct branch
*current_branch
;
1889 const char *upstream
;
1890 const char *head
= "HEAD";
1891 const char *limit
= NULL
;
1892 int verbose
= 0, abbrev
= 0;
1894 struct option options
[] = {
1895 OPT__ABBREV(&abbrev
),
1896 OPT__VERBOSE(&verbose
, N_("be verbose")),
1900 argc
= parse_options(argc
, argv
, prefix
, options
, cherry_usage
, 0);
1913 current_branch
= branch_get(NULL
);
1914 upstream
= branch_get_upstream(current_branch
, NULL
);
1916 fprintf(stderr
, _("Could not find a tracked"
1917 " remote branch, please"
1918 " specify <upstream> manually.\n"));
1919 usage_with_options(cherry_usage
, options
);
1923 init_revisions(&revs
, prefix
);
1924 revs
.max_parents
= 1;
1926 if (add_pending_commit(head
, &revs
, 0))
1927 die(_("Unknown commit %s"), head
);
1928 if (add_pending_commit(upstream
, &revs
, UNINTERESTING
))
1929 die(_("Unknown commit %s"), upstream
);
1931 /* Don't say anything if head and upstream are the same. */
1932 if (revs
.pending
.nr
== 2) {
1933 struct object_array_entry
*o
= revs
.pending
.objects
;
1934 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1938 get_patch_ids(&revs
, &ids
);
1940 if (limit
&& add_pending_commit(limit
, &revs
, UNINTERESTING
))
1941 die(_("Unknown commit %s"), limit
);
1943 /* reverse the list of commits */
1944 if (prepare_revision_walk(&revs
))
1945 die(_("revision walk setup failed"));
1946 while ((commit
= get_revision(&revs
)) != NULL
) {
1947 commit_list_insert(commit
, &list
);
1953 commit
= list
->item
;
1954 if (has_commit_patch_id(commit
, &ids
))
1956 print_commit(sign
, commit
, verbose
, abbrev
, revs
.diffopt
.file
);
1960 free_patch_ids(&ids
);