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 decoration_style
;
37 static int decoration_given
;
38 static int use_mailmap_config
;
39 static const char *fmt_patch_subject_prefix
= "PATCH";
40 static const char *fmt_pretty
;
42 static const char * const builtin_log_usage
[] = {
43 N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
44 N_("git show [<options>] <object>..."),
48 struct line_opt_callback_data
{
51 struct string_list args
;
54 static int parse_decoration_style(const char *var
, const char *value
)
56 switch (git_config_maybe_bool(var
, value
)) {
58 return DECORATE_SHORT_REFS
;
64 if (!strcmp(value
, "full"))
65 return DECORATE_FULL_REFS
;
66 else if (!strcmp(value
, "short"))
67 return DECORATE_SHORT_REFS
;
68 else if (!strcmp(value
, "auto"))
69 return (isatty(1) || pager_in_use()) ? DECORATE_SHORT_REFS
: 0;
73 static int decorate_callback(const struct option
*opt
, const char *arg
, int unset
)
78 decoration_style
= parse_decoration_style("command line", arg
);
80 decoration_style
= DECORATE_SHORT_REFS
;
82 if (decoration_style
< 0)
83 die(_("invalid --decorate option: %s"), arg
);
90 static int log_line_range_callback(const struct option
*option
, const char *arg
, int unset
)
92 struct line_opt_callback_data
*data
= option
->value
;
97 data
->rev
->line_level_traverse
= 1;
98 string_list_append(&data
->args
, arg
);
103 static void init_log_defaults(void)
105 init_grep_defaults();
106 init_diff_ui_defaults();
109 static void cmd_log_init_defaults(struct rev_info
*rev
)
112 get_commit_format(fmt_pretty
, rev
);
114 DIFF_OPT_SET(&rev
->diffopt
, DEFAULT_FOLLOW_RENAMES
);
115 rev
->verbose_header
= 1;
116 DIFF_OPT_SET(&rev
->diffopt
, RECURSIVE
);
117 rev
->diffopt
.stat_width
= -1; /* use full terminal width */
118 rev
->diffopt
.stat_graph_width
= -1; /* respect statGraphWidth config */
119 rev
->abbrev_commit
= default_abbrev_commit
;
120 rev
->show_root_diff
= default_show_root
;
121 rev
->subject_prefix
= fmt_patch_subject_prefix
;
122 DIFF_OPT_SET(&rev
->diffopt
, ALLOW_TEXTCONV
);
124 if (default_date_mode
)
125 parse_date_format(default_date_mode
, &rev
->date_mode
);
126 rev
->diffopt
.touched_flags
= 0;
129 static void cmd_log_init_finish(int argc
, const char **argv
, const char *prefix
,
130 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
132 struct userformat_want w
;
133 int quiet
= 0, source
= 0, mailmap
= 0;
134 static struct line_opt_callback_data line_cb
= {NULL
, NULL
, STRING_LIST_INIT_DUP
};
136 const struct option builtin_log_options
[] = {
137 OPT__QUIET(&quiet
, N_("suppress diff output")),
138 OPT_BOOL(0, "source", &source
, N_("show source")),
139 OPT_BOOL(0, "use-mailmap", &mailmap
, N_("Use mail map file")),
140 { OPTION_CALLBACK
, 0, "decorate", NULL
, NULL
, N_("decorate options"),
141 PARSE_OPT_OPTARG
, decorate_callback
},
142 OPT_CALLBACK('L', NULL
, &line_cb
, "n,m:file",
143 N_("Process line range n,m in file, counting from 1"),
144 log_line_range_callback
),
149 line_cb
.prefix
= prefix
;
151 mailmap
= use_mailmap_config
;
152 argc
= parse_options(argc
, argv
, prefix
,
153 builtin_log_options
, builtin_log_usage
,
154 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
155 PARSE_OPT_KEEP_DASHDASH
);
158 rev
->diffopt
.output_format
|= DIFF_FORMAT_NO_OUTPUT
;
159 argc
= setup_revisions(argc
, argv
, rev
, opt
);
161 /* Any arguments at this point are not recognized */
163 die(_("unrecognized argument: %s"), argv
[1]);
165 memset(&w
, 0, sizeof(w
));
166 userformat_find_requirements(NULL
, &w
);
168 if (!rev
->show_notes_given
&& (!rev
->pretty_given
|| w
.notes
))
171 init_display_notes(&rev
->notes_opt
);
173 if (rev
->diffopt
.pickaxe
|| rev
->diffopt
.filter
||
174 DIFF_OPT_TST(&rev
->diffopt
, FOLLOW_RENAMES
))
175 rev
->always_show_header
= 0;
178 rev
->show_source
= 1;
181 rev
->mailmap
= xcalloc(1, sizeof(struct string_list
));
182 read_mailmap(rev
->mailmap
, NULL
);
185 if (rev
->pretty_given
&& rev
->commit_format
== CMIT_FMT_RAW
) {
187 * "log --pretty=raw" is special; ignore UI oriented
188 * configuration variables such as decoration.
190 if (!decoration_given
)
191 decoration_style
= 0;
192 if (!rev
->abbrev_commit_given
)
193 rev
->abbrev_commit
= 0;
196 if (decoration_style
) {
197 rev
->show_decorations
= 1;
198 load_ref_decorations(decoration_style
);
201 if (rev
->line_level_traverse
)
202 line_log_init(rev
, line_cb
.prefix
, &line_cb
.args
);
207 static void cmd_log_init(int argc
, const char **argv
, const char *prefix
,
208 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
210 cmd_log_init_defaults(rev
);
211 cmd_log_init_finish(argc
, argv
, prefix
, rev
, opt
);
215 * This gives a rough estimate for how many commits we
216 * will print out in the list.
218 static int estimate_commit_count(struct rev_info
*rev
, struct commit_list
*list
)
223 struct commit
*commit
= list
->item
;
224 unsigned int flags
= commit
->object
.flags
;
226 if (!(flags
& (TREESAME
| UNINTERESTING
)))
232 static void show_early_header(struct rev_info
*rev
, const char *stage
, int nr
)
234 if (rev
->shown_one
) {
236 if (rev
->commit_format
!= CMIT_FMT_ONELINE
)
237 putchar(rev
->diffopt
.line_termination
);
239 printf(_("Final output: %d %s\n"), nr
, stage
);
242 static struct itimerval early_output_timer
;
244 static void log_show_early(struct rev_info
*revs
, struct commit_list
*list
)
246 int i
= revs
->early_output
, close_file
= revs
->diffopt
.close_file
;
249 revs
->diffopt
.close_file
= 0;
250 sort_in_topological_order(&list
, revs
->sort_order
);
252 struct commit
*commit
= list
->item
;
253 switch (simplify_commit(revs
, commit
)) {
256 int n
= estimate_commit_count(revs
, list
);
257 show_early_header(revs
, "incomplete", n
);
260 log_tree_commit(revs
, commit
);
267 fclose(revs
->diffopt
.file
);
273 /* Did we already get enough commits for the early output? */
276 fclose(revs
->diffopt
.file
);
281 * ..if no, then repeat it twice a second until we
284 * NOTE! We don't use "it_interval", because if the
285 * reader isn't listening, we want our output to be
286 * throttled by the writing, and not have the timer
287 * trigger every second even if we're blocked on a
290 early_output_timer
.it_value
.tv_sec
= 0;
291 early_output_timer
.it_value
.tv_usec
= 500000;
292 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
295 static void early_output(int signal
)
297 show_early_output
= log_show_early
;
300 static void setup_early_output(struct rev_info
*rev
)
305 * Set up the signal handler, minimally intrusively:
306 * we only set a single volatile integer word (not
307 * using sigatomic_t - trying to avoid unnecessary
308 * system dependencies and headers), and using
311 memset(&sa
, 0, sizeof(sa
));
312 sa
.sa_handler
= early_output
;
313 sigemptyset(&sa
.sa_mask
);
314 sa
.sa_flags
= SA_RESTART
;
315 sigaction(SIGALRM
, &sa
, NULL
);
318 * If we can get the whole output in less than a
319 * tenth of a second, don't even bother doing the
320 * early-output thing..
322 * This is a one-time-only trigger.
324 early_output_timer
.it_value
.tv_sec
= 0;
325 early_output_timer
.it_value
.tv_usec
= 100000;
326 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
329 static void finish_early_output(struct rev_info
*rev
)
331 int n
= estimate_commit_count(rev
, rev
->commits
);
332 signal(SIGALRM
, SIG_IGN
);
333 show_early_header(rev
, "done", n
);
336 static int cmd_log_walk(struct rev_info
*rev
)
338 struct commit
*commit
;
340 int saved_dcctc
= 0, close_file
= rev
->diffopt
.close_file
;
342 if (rev
->early_output
)
343 setup_early_output(rev
);
345 if (prepare_revision_walk(rev
))
346 die(_("revision walk setup failed"));
348 if (rev
->early_output
)
349 finish_early_output(rev
);
352 * For --check and --exit-code, the exit code is based on CHECK_FAILED
353 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
354 * retain that state information if replacing rev->diffopt in this loop
356 rev
->diffopt
.close_file
= 0;
357 while ((commit
= get_revision(rev
)) != NULL
) {
358 if (!log_tree_commit(rev
, commit
) && rev
->max_count
>= 0)
360 * We decremented max_count in get_revision,
361 * but we didn't actually show the commit.
364 if (!rev
->reflog_info
) {
365 /* we allow cycles in reflog ancestry */
366 free_commit_buffer(commit
);
368 free_commit_list(commit
->parents
);
369 commit
->parents
= NULL
;
370 if (saved_nrl
< rev
->diffopt
.needed_rename_limit
)
371 saved_nrl
= rev
->diffopt
.needed_rename_limit
;
372 if (rev
->diffopt
.degraded_cc_to_c
)
375 rev
->diffopt
.degraded_cc_to_c
= saved_dcctc
;
376 rev
->diffopt
.needed_rename_limit
= saved_nrl
;
378 fclose(rev
->diffopt
.file
);
380 if (rev
->diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
&&
381 DIFF_OPT_TST(&rev
->diffopt
, CHECK_FAILED
)) {
384 return diff_result_code(&rev
->diffopt
, 0);
387 static int git_log_config(const char *var
, const char *value
, void *cb
)
389 const char *slot_name
;
391 if (!strcmp(var
, "format.pretty"))
392 return git_config_string(&fmt_pretty
, var
, value
);
393 if (!strcmp(var
, "format.subjectprefix"))
394 return git_config_string(&fmt_patch_subject_prefix
, var
, value
);
395 if (!strcmp(var
, "log.abbrevcommit")) {
396 default_abbrev_commit
= git_config_bool(var
, value
);
399 if (!strcmp(var
, "log.date"))
400 return git_config_string(&default_date_mode
, var
, value
);
401 if (!strcmp(var
, "log.decorate")) {
402 decoration_style
= parse_decoration_style(var
, value
);
403 if (decoration_style
< 0)
404 decoration_style
= 0; /* maybe warn? */
407 if (!strcmp(var
, "log.showroot")) {
408 default_show_root
= git_config_bool(var
, value
);
411 if (!strcmp(var
, "log.follow")) {
412 default_follow
= git_config_bool(var
, value
);
415 if (skip_prefix(var
, "color.decorate.", &slot_name
))
416 return parse_decorate_color_config(var
, slot_name
, value
);
417 if (!strcmp(var
, "log.mailmap")) {
418 use_mailmap_config
= git_config_bool(var
, value
);
422 if (grep_config(var
, value
, cb
) < 0)
424 if (git_gpg_config(var
, value
, cb
) < 0)
426 return git_diff_ui_config(var
, value
, cb
);
429 int cmd_whatchanged(int argc
, const char **argv
, const char *prefix
)
432 struct setup_revision_opt opt
;
435 git_config(git_log_config
, NULL
);
437 init_revisions(&rev
, prefix
);
439 rev
.simplify_history
= 0;
440 memset(&opt
, 0, sizeof(opt
));
442 opt
.revarg_opt
= REVARG_COMMITTISH
;
443 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
444 if (!rev
.diffopt
.output_format
)
445 rev
.diffopt
.output_format
= DIFF_FORMAT_RAW
;
446 return cmd_log_walk(&rev
);
449 static void show_tagger(char *buf
, int len
, struct rev_info
*rev
)
451 struct strbuf out
= STRBUF_INIT
;
452 struct pretty_print_context pp
= {0};
454 pp
.fmt
= rev
->commit_format
;
455 pp
.date_mode
= rev
->date_mode
;
456 pp_user_info(&pp
, "Tagger", &out
, buf
, get_log_output_encoding());
457 printf("%s", out
.buf
);
458 strbuf_release(&out
);
461 static int show_blob_object(const unsigned char *sha1
, struct rev_info
*rev
, const char *obj_name
)
463 unsigned char sha1c
[20];
464 struct object_context obj_context
;
469 if (!DIFF_OPT_TOUCHED(&rev
->diffopt
, ALLOW_TEXTCONV
) ||
470 !DIFF_OPT_TST(&rev
->diffopt
, ALLOW_TEXTCONV
))
471 return stream_blob_to_fd(1, sha1
, NULL
, 0);
473 if (get_sha1_with_context(obj_name
, 0, sha1c
, &obj_context
))
474 die(_("Not a valid object name %s"), obj_name
);
475 if (!obj_context
.path
[0] ||
476 !textconv_object(obj_context
.path
, obj_context
.mode
, sha1c
, 1, &buf
, &size
))
477 return stream_blob_to_fd(1, sha1
, NULL
, 0);
480 die(_("git show %s: bad file"), obj_name
);
482 write_or_die(1, buf
, size
);
486 static int show_tag_object(const unsigned char *sha1
, struct rev_info
*rev
)
489 enum object_type type
;
490 char *buf
= read_sha1_file(sha1
, &type
, &size
);
494 return error(_("Could not read object %s"), sha1_to_hex(sha1
));
496 assert(type
== OBJ_TAG
);
497 while (offset
< size
&& buf
[offset
] != '\n') {
498 int new_offset
= offset
+ 1;
499 while (new_offset
< size
&& buf
[new_offset
++] != '\n')
501 if (starts_with(buf
+ offset
, "tagger "))
502 show_tagger(buf
+ offset
+ 7,
503 new_offset
- offset
- 7, rev
);
508 fwrite(buf
+ offset
, size
- offset
, 1, stdout
);
513 static int show_tree_object(const unsigned char *sha1
,
515 const char *pathname
, unsigned mode
, int stage
, void *context
)
517 printf("%s%s\n", pathname
, S_ISDIR(mode
) ? "/" : "");
521 static void show_setup_revisions_tweak(struct rev_info
*rev
,
522 struct setup_revision_opt
*opt
)
524 if (rev
->ignore_merges
) {
525 /* There was no "-m" on the command line */
526 rev
->ignore_merges
= 0;
527 if (!rev
->first_parent_only
&& !rev
->combine_merges
) {
528 /* No "--first-parent", "-c", or "--cc" */
529 rev
->combine_merges
= 1;
530 rev
->dense_combined_merges
= 1;
533 if (!rev
->diffopt
.output_format
)
534 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
537 int cmd_show(int argc
, const char **argv
, const char *prefix
)
540 struct object_array_entry
*objects
;
541 struct setup_revision_opt opt
;
542 struct pathspec match_all
;
543 int i
, count
, ret
= 0;
546 git_config(git_log_config
, NULL
);
548 memset(&match_all
, 0, sizeof(match_all
));
549 init_revisions(&rev
, prefix
);
551 rev
.always_show_header
= 1;
552 rev
.no_walk
= REVISION_WALK_NO_WALK_SORTED
;
553 rev
.diffopt
.stat_width
= -1; /* Scale to real terminal size */
555 memset(&opt
, 0, sizeof(opt
));
557 opt
.tweak
= show_setup_revisions_tweak
;
558 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
561 return cmd_log_walk(&rev
);
563 count
= rev
.pending
.nr
;
564 objects
= rev
.pending
.objects
;
565 for (i
= 0; i
< count
&& !ret
; i
++) {
566 struct object
*o
= objects
[i
].item
;
567 const char *name
= objects
[i
].name
;
570 ret
= show_blob_object(o
->oid
.hash
, &rev
, name
);
573 struct tag
*t
= (struct tag
*)o
;
577 printf("%stag %s%s\n",
578 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
580 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
581 ret
= show_tag_object(o
->oid
.hash
, &rev
);
585 o
= parse_object(t
->tagged
->oid
.hash
);
587 ret
= error(_("Could not read object %s"),
588 oid_to_hex(&t
->tagged
->oid
));
596 printf("%stree %s%s\n\n",
597 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
599 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
600 read_tree_recursive((struct tree
*)o
, "", 0, 0, &match_all
,
601 show_tree_object
, NULL
);
605 rev
.pending
.nr
= rev
.pending
.alloc
= 0;
606 rev
.pending
.objects
= NULL
;
607 add_object_array(o
, name
, &rev
.pending
);
608 ret
= cmd_log_walk(&rev
);
611 ret
= error(_("Unknown type: %d"), o
->type
);
619 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
621 int cmd_log_reflog(int argc
, const char **argv
, const char *prefix
)
624 struct setup_revision_opt opt
;
627 git_config(git_log_config
, NULL
);
629 init_revisions(&rev
, prefix
);
630 init_reflog_walk(&rev
.reflog_info
);
631 rev
.verbose_header
= 1;
632 memset(&opt
, 0, sizeof(opt
));
634 cmd_log_init_defaults(&rev
);
635 rev
.abbrev_commit
= 1;
636 rev
.commit_format
= CMIT_FMT_ONELINE
;
637 rev
.use_terminator
= 1;
638 rev
.always_show_header
= 1;
639 cmd_log_init_finish(argc
, argv
, prefix
, &rev
, &opt
);
641 return cmd_log_walk(&rev
);
644 static void log_setup_revisions_tweak(struct rev_info
*rev
,
645 struct setup_revision_opt
*opt
)
647 if (DIFF_OPT_TST(&rev
->diffopt
, DEFAULT_FOLLOW_RENAMES
) &&
648 rev
->prune_data
.nr
== 1)
649 DIFF_OPT_SET(&rev
->diffopt
, FOLLOW_RENAMES
);
651 /* Turn --cc/-c into -p --cc/-c when -p was not given */
652 if (!rev
->diffopt
.output_format
&& rev
->combine_merges
)
653 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
655 /* Turn -m on when --cc/-c was given */
656 if (rev
->combine_merges
)
657 rev
->ignore_merges
= 0;
660 int cmd_log(int argc
, const char **argv
, const char *prefix
)
663 struct setup_revision_opt opt
;
666 git_config(git_log_config
, NULL
);
668 init_revisions(&rev
, prefix
);
669 rev
.always_show_header
= 1;
670 memset(&opt
, 0, sizeof(opt
));
672 opt
.revarg_opt
= REVARG_COMMITTISH
;
673 opt
.tweak
= log_setup_revisions_tweak
;
674 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
675 return cmd_log_walk(&rev
);
680 static const char *fmt_patch_suffix
= ".patch";
681 static int numbered
= 0;
682 static int auto_number
= 1;
684 static char *default_attach
= NULL
;
686 static struct string_list extra_hdr
;
687 static struct string_list extra_to
;
688 static struct string_list extra_cc
;
690 static void add_header(const char *value
)
692 struct string_list_item
*item
;
693 int len
= strlen(value
);
694 while (len
&& value
[len
- 1] == '\n')
697 if (!strncasecmp(value
, "to: ", 4)) {
698 item
= string_list_append(&extra_to
, value
+ 4);
700 } else if (!strncasecmp(value
, "cc: ", 4)) {
701 item
= string_list_append(&extra_cc
, value
+ 4);
704 item
= string_list_append(&extra_hdr
, value
);
707 item
->string
[len
] = '\0';
710 #define THREAD_SHALLOW 1
711 #define THREAD_DEEP 2
713 static int do_signoff
;
714 static int base_auto
;
715 static const char *signature
= git_version_string
;
716 static const char *signature_file
;
717 static int config_cover_letter
;
718 static const char *config_output_directory
;
727 static int git_format_config(const char *var
, const char *value
, void *cb
)
729 if (!strcmp(var
, "format.headers")) {
731 die(_("format.headers without value"));
735 if (!strcmp(var
, "format.suffix"))
736 return git_config_string(&fmt_patch_suffix
, var
, value
);
737 if (!strcmp(var
, "format.to")) {
739 return config_error_nonbool(var
);
740 string_list_append(&extra_to
, value
);
743 if (!strcmp(var
, "format.cc")) {
745 return config_error_nonbool(var
);
746 string_list_append(&extra_cc
, value
);
749 if (!strcmp(var
, "diff.color") || !strcmp(var
, "color.diff") ||
750 !strcmp(var
, "color.ui") || !strcmp(var
, "diff.submodule")) {
753 if (!strcmp(var
, "format.numbered")) {
754 if (value
&& !strcasecmp(value
, "auto")) {
758 numbered
= git_config_bool(var
, value
);
759 auto_number
= auto_number
&& numbered
;
762 if (!strcmp(var
, "format.attach")) {
764 default_attach
= xstrdup(value
);
766 default_attach
= xstrdup(git_version_string
);
769 if (!strcmp(var
, "format.thread")) {
770 if (value
&& !strcasecmp(value
, "deep")) {
771 thread
= THREAD_DEEP
;
774 if (value
&& !strcasecmp(value
, "shallow")) {
775 thread
= THREAD_SHALLOW
;
778 thread
= git_config_bool(var
, value
) && THREAD_SHALLOW
;
781 if (!strcmp(var
, "format.signoff")) {
782 do_signoff
= git_config_bool(var
, value
);
785 if (!strcmp(var
, "format.signature"))
786 return git_config_string(&signature
, var
, value
);
787 if (!strcmp(var
, "format.signaturefile"))
788 return git_config_pathname(&signature_file
, var
, value
);
789 if (!strcmp(var
, "format.coverletter")) {
790 if (value
&& !strcasecmp(value
, "auto")) {
791 config_cover_letter
= COVER_AUTO
;
794 config_cover_letter
= git_config_bool(var
, value
) ? COVER_ON
: COVER_OFF
;
797 if (!strcmp(var
, "format.outputdirectory"))
798 return git_config_string(&config_output_directory
, var
, value
);
799 if (!strcmp(var
, "format.useautobase")) {
800 base_auto
= git_config_bool(var
, value
);
804 return git_log_config(var
, value
, cb
);
807 static FILE *realstdout
= NULL
;
808 static const char *output_directory
= NULL
;
809 static int outdir_offset
;
811 static int reopen_stdout(struct commit
*commit
, const char *subject
,
812 struct rev_info
*rev
, int quiet
)
814 struct strbuf filename
= STRBUF_INIT
;
815 int suffix_len
= strlen(rev
->patch_suffix
) + 1;
817 if (output_directory
) {
818 strbuf_addstr(&filename
, output_directory
);
820 PATH_MAX
- FORMAT_PATCH_NAME_MAX
- suffix_len
)
821 return error(_("name of output directory is too long"));
822 strbuf_complete(&filename
, '/');
825 if (rev
->numbered_files
)
826 strbuf_addf(&filename
, "%d", rev
->nr
);
828 fmt_output_commit(&filename
, commit
, rev
);
830 fmt_output_subject(&filename
, subject
, rev
);
833 fprintf(realstdout
, "%s\n", filename
.buf
+ outdir_offset
);
835 if (freopen(filename
.buf
, "w", stdout
) == NULL
)
836 return error(_("Cannot open patch file %s"), filename
.buf
);
838 strbuf_release(&filename
);
842 static void get_patch_ids(struct rev_info
*rev
, struct patch_ids
*ids
)
844 struct rev_info check_rev
;
845 struct commit
*commit
, *c1
, *c2
;
846 struct object
*o1
, *o2
;
847 unsigned flags1
, flags2
;
849 if (rev
->pending
.nr
!= 2)
850 die(_("Need exactly one range."));
852 o1
= rev
->pending
.objects
[0].item
;
853 o2
= rev
->pending
.objects
[1].item
;
856 c1
= lookup_commit_reference(o1
->oid
.hash
);
857 c2
= lookup_commit_reference(o2
->oid
.hash
);
859 if ((flags1
& UNINTERESTING
) == (flags2
& UNINTERESTING
))
860 die(_("Not a range."));
864 /* given a range a..b get all patch ids for b..a */
865 init_revisions(&check_rev
, rev
->prefix
);
866 check_rev
.max_parents
= 1;
867 o1
->flags
^= UNINTERESTING
;
868 o2
->flags
^= UNINTERESTING
;
869 add_pending_object(&check_rev
, o1
, "o1");
870 add_pending_object(&check_rev
, o2
, "o2");
871 if (prepare_revision_walk(&check_rev
))
872 die(_("revision walk setup failed"));
874 while ((commit
= get_revision(&check_rev
)) != NULL
) {
875 add_commit_patch_id(commit
, ids
);
878 /* reset for next revision walk */
879 clear_commit_marks(c1
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
880 clear_commit_marks(c2
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
885 static void gen_message_id(struct rev_info
*info
, char *base
)
887 struct strbuf buf
= STRBUF_INIT
;
888 strbuf_addf(&buf
, "%s.%lu.git.%s", base
,
889 (unsigned long) time(NULL
),
890 git_committer_info(IDENT_NO_NAME
|IDENT_NO_DATE
|IDENT_STRICT
));
891 info
->message_id
= strbuf_detach(&buf
, NULL
);
894 static void print_signature(void)
896 if (!signature
|| !*signature
)
899 printf("-- \n%s", signature
);
900 if (signature
[strlen(signature
)-1] != '\n')
905 static void add_branch_description(struct strbuf
*buf
, const char *branch_name
)
907 struct strbuf desc
= STRBUF_INIT
;
908 if (!branch_name
|| !*branch_name
)
910 read_branch_desc(&desc
, branch_name
);
912 strbuf_addch(buf
, '\n');
913 strbuf_addbuf(buf
, &desc
);
914 strbuf_addch(buf
, '\n');
916 strbuf_release(&desc
);
919 static char *find_branch_name(struct rev_info
*rev
)
921 int i
, positive
= -1;
922 struct object_id branch_oid
;
923 const struct object_id
*tip_oid
;
925 char *full_ref
, *branch
= NULL
;
927 for (i
= 0; i
< rev
->cmdline
.nr
; i
++) {
928 if (rev
->cmdline
.rev
[i
].flags
& UNINTERESTING
)
937 ref
= rev
->cmdline
.rev
[positive
].name
;
938 tip_oid
= &rev
->cmdline
.rev
[positive
].item
->oid
;
939 if (dwim_ref(ref
, strlen(ref
), branch_oid
.hash
, &full_ref
) &&
940 skip_prefix(full_ref
, "refs/heads/", &v
) &&
941 !oidcmp(tip_oid
, &branch_oid
))
947 static void make_cover_letter(struct rev_info
*rev
, int use_stdout
,
948 struct commit
*origin
,
949 int nr
, struct commit
**list
,
950 const char *branch_name
,
953 const char *committer
;
954 const char *body
= "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
957 struct strbuf sb
= STRBUF_INIT
;
959 const char *encoding
= "UTF-8";
960 struct diff_options opts
;
961 int need_8bit_cte
= 0;
962 struct pretty_print_context pp
= {0};
963 struct commit
*head
= list
[0];
965 if (rev
->commit_format
!= CMIT_FMT_EMAIL
)
966 die(_("Cover letter needs email format"));
968 committer
= git_committer_info(0);
971 reopen_stdout(NULL
, rev
->numbered_files
? NULL
: "cover-letter", rev
, quiet
))
974 log_write_email_headers(rev
, head
, &pp
.subject
, &pp
.after_subject
,
977 for (i
= 0; !need_8bit_cte
&& i
< nr
; i
++) {
978 const char *buf
= get_commit_buffer(list
[i
], NULL
);
979 if (has_non_ascii(buf
))
981 unuse_commit_buffer(list
[i
], buf
);
985 branch_name
= find_branch_name(rev
);
988 pp
.fmt
= CMIT_FMT_EMAIL
;
989 pp
.date_mode
.type
= DATE_RFC2822
;
990 pp_user_info(&pp
, NULL
, &sb
, committer
, encoding
);
991 pp_title_line(&pp
, &msg
, &sb
, encoding
, need_8bit_cte
);
992 pp_remainder(&pp
, &msg
, &sb
, 0);
993 add_branch_description(&sb
, branch_name
);
994 printf("%s\n", sb
.buf
);
1003 for (i
= 0; i
< nr
; i
++)
1004 shortlog_add_commit(&log
, list
[i
]);
1006 shortlog_output(&log
);
1009 * We can only do diffstat with a unique reference point
1014 memcpy(&opts
, &rev
->diffopt
, sizeof(opts
));
1015 opts
.output_format
= DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
1017 diff_setup_done(&opts
);
1019 diff_tree_sha1(origin
->tree
->object
.oid
.hash
,
1020 head
->tree
->object
.oid
.hash
,
1022 diffcore_std(&opts
);
1029 static const char *clean_message_id(const char *msg_id
)
1032 const char *a
, *z
, *m
;
1035 while ((ch
= *m
) && (isspace(ch
) || (ch
== '<')))
1040 if (!isspace(ch
) && (ch
!= '>'))
1045 die(_("insane in-reply-to: %s"), msg_id
);
1048 return xmemdupz(a
, z
- a
);
1051 static const char *set_outdir(const char *prefix
, const char *output_directory
)
1053 if (output_directory
&& is_absolute_path(output_directory
))
1054 return output_directory
;
1056 if (!prefix
|| !*prefix
) {
1057 if (output_directory
)
1058 return output_directory
;
1059 /* The user did not explicitly ask for "./" */
1064 outdir_offset
= strlen(prefix
);
1065 if (!output_directory
)
1068 return xstrdup(prefix_filename(prefix
, outdir_offset
,
1072 static const char * const builtin_format_patch_usage
[] = {
1073 N_("git format-patch [<options>] [<since> | <revision-range>]"),
1077 static int keep_subject
= 0;
1079 static int keep_callback(const struct option
*opt
, const char *arg
, int unset
)
1081 ((struct rev_info
*)opt
->value
)->total
= -1;
1086 static int subject_prefix
= 0;
1088 static int subject_prefix_callback(const struct option
*opt
, const char *arg
,
1092 ((struct rev_info
*)opt
->value
)->subject_prefix
= arg
;
1096 static int numbered_cmdline_opt
= 0;
1098 static int numbered_callback(const struct option
*opt
, const char *arg
,
1101 *(int *)opt
->value
= numbered_cmdline_opt
= unset
? 0 : 1;
1107 static int no_numbered_callback(const struct option
*opt
, const char *arg
,
1110 return numbered_callback(opt
, arg
, 1);
1113 static int output_directory_callback(const struct option
*opt
, const char *arg
,
1116 const char **dir
= (const char **)opt
->value
;
1118 die(_("Two output directories?"));
1123 static int thread_callback(const struct option
*opt
, const char *arg
, int unset
)
1125 int *thread
= (int *)opt
->value
;
1128 else if (!arg
|| !strcmp(arg
, "shallow"))
1129 *thread
= THREAD_SHALLOW
;
1130 else if (!strcmp(arg
, "deep"))
1131 *thread
= THREAD_DEEP
;
1137 static int attach_callback(const struct option
*opt
, const char *arg
, int unset
)
1139 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1141 rev
->mime_boundary
= NULL
;
1143 rev
->mime_boundary
= arg
;
1145 rev
->mime_boundary
= git_version_string
;
1146 rev
->no_inline
= unset
? 0 : 1;
1150 static int inline_callback(const struct option
*opt
, const char *arg
, int unset
)
1152 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1154 rev
->mime_boundary
= NULL
;
1156 rev
->mime_boundary
= arg
;
1158 rev
->mime_boundary
= git_version_string
;
1163 static int header_callback(const struct option
*opt
, const char *arg
, int unset
)
1166 string_list_clear(&extra_hdr
, 0);
1167 string_list_clear(&extra_to
, 0);
1168 string_list_clear(&extra_cc
, 0);
1175 static int to_callback(const struct option
*opt
, const char *arg
, int unset
)
1178 string_list_clear(&extra_to
, 0);
1180 string_list_append(&extra_to
, arg
);
1184 static int cc_callback(const struct option
*opt
, const char *arg
, int unset
)
1187 string_list_clear(&extra_cc
, 0);
1189 string_list_append(&extra_cc
, arg
);
1193 static int from_callback(const struct option
*opt
, const char *arg
, int unset
)
1195 char **from
= opt
->value
;
1202 *from
= xstrdup(arg
);
1204 *from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
1208 struct base_tree_info
{
1209 struct object_id base_commit
;
1210 int nr_patch_id
, alloc_patch_id
;
1211 struct object_id
*patch_id
;
1214 static struct commit
*get_base_commit(const char *base_commit
,
1215 struct commit
**list
,
1218 struct commit
*base
= NULL
;
1219 struct commit
**rev
;
1220 int i
= 0, rev_nr
= 0;
1222 if (base_commit
&& strcmp(base_commit
, "auto")) {
1223 base
= lookup_commit_reference_by_name(base_commit
);
1225 die(_("Unknown commit %s"), base_commit
);
1226 } else if ((base_commit
&& !strcmp(base_commit
, "auto")) || base_auto
) {
1227 struct branch
*curr_branch
= branch_get(NULL
);
1228 const char *upstream
= branch_get_upstream(curr_branch
, NULL
);
1230 struct commit_list
*base_list
;
1231 struct commit
*commit
;
1232 unsigned char sha1
[20];
1234 if (get_sha1(upstream
, sha1
))
1235 die(_("Failed to resolve '%s' as a valid ref."), upstream
);
1236 commit
= lookup_commit_or_die(sha1
, "upstream base");
1237 base_list
= get_merge_bases_many(commit
, total
, list
);
1238 /* There should be one and only one merge base. */
1239 if (!base_list
|| base_list
->next
)
1240 die(_("Could not find exact merge base."));
1241 base
= base_list
->item
;
1242 free_commit_list(base_list
);
1244 die(_("Failed to get upstream, if you want to record base commit automatically,\n"
1245 "please use git branch --set-upstream-to to track a remote branch.\n"
1246 "Or you could specify base commit by --base=<base-commit-id> manually."));
1250 ALLOC_ARRAY(rev
, total
);
1251 for (i
= 0; i
< total
; i
++)
1256 * Get merge base through pair-wise computations
1257 * and store it in rev[0].
1259 while (rev_nr
> 1) {
1260 for (i
= 0; i
< rev_nr
/ 2; i
++) {
1261 struct commit_list
*merge_base
;
1262 merge_base
= get_merge_bases(rev
[2 * i
], rev
[2 * i
+ 1]);
1263 if (!merge_base
|| merge_base
->next
)
1264 die(_("Failed to find exact merge base"));
1266 rev
[i
] = merge_base
->item
;
1270 rev
[i
] = rev
[2 * i
];
1271 rev_nr
= (rev_nr
+ 1) / 2;
1274 if (!in_merge_bases(base
, rev
[0]))
1275 die(_("base commit should be the ancestor of revision list"));
1277 for (i
= 0; i
< total
; i
++) {
1278 if (base
== list
[i
])
1279 die(_("base commit shouldn't be in revision list"));
1286 static void prepare_bases(struct base_tree_info
*bases
,
1287 struct commit
*base
,
1288 struct commit
**list
,
1291 struct commit
*commit
;
1292 struct rev_info revs
;
1293 struct diff_options diffopt
;
1299 diff_setup(&diffopt
);
1300 DIFF_OPT_SET(&diffopt
, RECURSIVE
);
1301 diff_setup_done(&diffopt
);
1303 oidcpy(&bases
->base_commit
, &base
->object
.oid
);
1305 init_revisions(&revs
, NULL
);
1306 revs
.max_parents
= 1;
1307 revs
.topo_order
= 1;
1308 for (i
= 0; i
< total
; i
++) {
1309 list
[i
]->object
.flags
&= ~UNINTERESTING
;
1310 add_pending_object(&revs
, &list
[i
]->object
, "rev_list");
1311 list
[i
]->util
= (void *)1;
1313 base
->object
.flags
|= UNINTERESTING
;
1314 add_pending_object(&revs
, &base
->object
, "base");
1316 if (prepare_revision_walk(&revs
))
1317 die(_("revision walk setup failed"));
1319 * Traverse the commits list, get prerequisite patch ids
1320 * and stuff them in bases structure.
1322 while ((commit
= get_revision(&revs
)) != NULL
) {
1323 unsigned char sha1
[20];
1324 struct object_id
*patch_id
;
1327 if (commit_patch_id(commit
, &diffopt
, sha1
))
1328 die(_("cannot get patch id"));
1329 ALLOC_GROW(bases
->patch_id
, bases
->nr_patch_id
+ 1, bases
->alloc_patch_id
);
1330 patch_id
= bases
->patch_id
+ bases
->nr_patch_id
;
1331 hashcpy(patch_id
->hash
, sha1
);
1332 bases
->nr_patch_id
++;
1336 static void print_bases(struct base_tree_info
*bases
)
1340 /* Only do this once, either for the cover or for the first one */
1341 if (is_null_oid(&bases
->base_commit
))
1344 /* Show the base commit */
1345 printf("base-commit: %s\n", oid_to_hex(&bases
->base_commit
));
1347 /* Show the prerequisite patches */
1348 for (i
= bases
->nr_patch_id
- 1; i
>= 0; i
--)
1349 printf("prerequisite-patch-id: %s\n", oid_to_hex(&bases
->patch_id
[i
]));
1351 free(bases
->patch_id
);
1352 bases
->nr_patch_id
= 0;
1353 bases
->alloc_patch_id
= 0;
1354 oidclr(&bases
->base_commit
);
1357 int cmd_format_patch(int argc
, const char **argv
, const char *prefix
)
1359 struct commit
*commit
;
1360 struct commit
**list
= NULL
;
1361 struct rev_info rev
;
1362 struct setup_revision_opt s_r_opt
;
1363 int nr
= 0, total
, i
;
1365 int start_number
= -1;
1366 int just_numbers
= 0;
1367 int ignore_if_in_upstream
= 0;
1368 int cover_letter
= -1;
1369 int boundary_count
= 0;
1370 int no_binary_diff
= 0;
1371 int zero_commit
= 0;
1372 struct commit
*origin
= NULL
;
1373 const char *in_reply_to
= NULL
;
1374 struct patch_ids ids
;
1375 struct strbuf buf
= STRBUF_INIT
;
1376 int use_patch_format
= 0;
1378 int reroll_count
= -1;
1379 char *branch_name
= NULL
;
1381 char *base_commit
= NULL
;
1382 struct base_tree_info bases
;
1384 const struct option builtin_format_patch_options
[] = {
1385 { OPTION_CALLBACK
, 'n', "numbered", &numbered
, NULL
,
1386 N_("use [PATCH n/m] even with a single patch"),
1387 PARSE_OPT_NOARG
, numbered_callback
},
1388 { OPTION_CALLBACK
, 'N', "no-numbered", &numbered
, NULL
,
1389 N_("use [PATCH] even with multiple patches"),
1390 PARSE_OPT_NOARG
, no_numbered_callback
},
1391 OPT_BOOL('s', "signoff", &do_signoff
, N_("add Signed-off-by:")),
1392 OPT_BOOL(0, "stdout", &use_stdout
,
1393 N_("print patches to standard out")),
1394 OPT_BOOL(0, "cover-letter", &cover_letter
,
1395 N_("generate a cover letter")),
1396 OPT_BOOL(0, "numbered-files", &just_numbers
,
1397 N_("use simple number sequence for output file names")),
1398 OPT_STRING(0, "suffix", &fmt_patch_suffix
, N_("sfx"),
1399 N_("use <sfx> instead of '.patch'")),
1400 OPT_INTEGER(0, "start-number", &start_number
,
1401 N_("start numbering patches at <n> instead of 1")),
1402 OPT_INTEGER('v', "reroll-count", &reroll_count
,
1403 N_("mark the series as Nth re-roll")),
1404 { OPTION_CALLBACK
, 0, "subject-prefix", &rev
, N_("prefix"),
1405 N_("Use [<prefix>] instead of [PATCH]"),
1406 PARSE_OPT_NONEG
, subject_prefix_callback
},
1407 { OPTION_CALLBACK
, 'o', "output-directory", &output_directory
,
1408 N_("dir"), N_("store resulting files in <dir>"),
1409 PARSE_OPT_NONEG
, output_directory_callback
},
1410 { OPTION_CALLBACK
, 'k', "keep-subject", &rev
, NULL
,
1411 N_("don't strip/add [PATCH]"),
1412 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, keep_callback
},
1413 OPT_BOOL(0, "no-binary", &no_binary_diff
,
1414 N_("don't output binary diffs")),
1415 OPT_BOOL(0, "zero-commit", &zero_commit
,
1416 N_("output all-zero hash in From header")),
1417 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream
,
1418 N_("don't include a patch matching a commit upstream")),
1419 { OPTION_SET_INT
, 'p', "no-stat", &use_patch_format
, NULL
,
1420 N_("show patch format instead of default (patch + stat)"),
1421 PARSE_OPT_NONEG
| PARSE_OPT_NOARG
, NULL
, 1},
1422 OPT_GROUP(N_("Messaging")),
1423 { OPTION_CALLBACK
, 0, "add-header", NULL
, N_("header"),
1424 N_("add email header"), 0, header_callback
},
1425 { OPTION_CALLBACK
, 0, "to", NULL
, N_("email"), N_("add To: header"),
1427 { OPTION_CALLBACK
, 0, "cc", NULL
, N_("email"), N_("add Cc: header"),
1429 { OPTION_CALLBACK
, 0, "from", &from
, N_("ident"),
1430 N_("set From address to <ident> (or committer ident if absent)"),
1431 PARSE_OPT_OPTARG
, from_callback
},
1432 OPT_STRING(0, "in-reply-to", &in_reply_to
, N_("message-id"),
1433 N_("make first mail a reply to <message-id>")),
1434 { OPTION_CALLBACK
, 0, "attach", &rev
, N_("boundary"),
1435 N_("attach the patch"), PARSE_OPT_OPTARG
,
1437 { OPTION_CALLBACK
, 0, "inline", &rev
, N_("boundary"),
1438 N_("inline the patch"),
1439 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
1441 { OPTION_CALLBACK
, 0, "thread", &thread
, N_("style"),
1442 N_("enable message threading, styles: shallow, deep"),
1443 PARSE_OPT_OPTARG
, thread_callback
},
1444 OPT_STRING(0, "signature", &signature
, N_("signature"),
1445 N_("add a signature")),
1446 OPT_STRING(0, "base", &base_commit
, N_("base-commit"),
1447 N_("add prerequisite tree info to the patch series")),
1448 OPT_FILENAME(0, "signature-file", &signature_file
,
1449 N_("add a signature from a file")),
1450 OPT__QUIET(&quiet
, N_("don't print the patch filenames")),
1454 extra_hdr
.strdup_strings
= 1;
1455 extra_to
.strdup_strings
= 1;
1456 extra_cc
.strdup_strings
= 1;
1457 init_log_defaults();
1458 git_config(git_format_config
, NULL
);
1459 init_revisions(&rev
, prefix
);
1460 rev
.commit_format
= CMIT_FMT_EMAIL
;
1461 rev
.expand_tabs_in_log_default
= 0;
1462 rev
.verbose_header
= 1;
1464 rev
.max_parents
= 1;
1465 DIFF_OPT_SET(&rev
.diffopt
, RECURSIVE
);
1466 rev
.subject_prefix
= fmt_patch_subject_prefix
;
1467 memset(&s_r_opt
, 0, sizeof(s_r_opt
));
1468 s_r_opt
.def
= "HEAD";
1469 s_r_opt
.revarg_opt
= REVARG_COMMITTISH
;
1471 if (default_attach
) {
1472 rev
.mime_boundary
= default_attach
;
1477 * Parse the arguments before setup_revisions(), or something
1478 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1479 * possibly a valid SHA1.
1481 argc
= parse_options(argc
, argv
, prefix
, builtin_format_patch_options
,
1482 builtin_format_patch_usage
,
1483 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
1484 PARSE_OPT_KEEP_DASHDASH
);
1486 if (0 < reroll_count
) {
1487 struct strbuf sprefix
= STRBUF_INIT
;
1488 strbuf_addf(&sprefix
, "%s v%d",
1489 rev
.subject_prefix
, reroll_count
);
1490 rev
.reroll_count
= reroll_count
;
1491 rev
.subject_prefix
= strbuf_detach(&sprefix
, NULL
);
1494 for (i
= 0; i
< extra_hdr
.nr
; i
++) {
1495 strbuf_addstr(&buf
, extra_hdr
.items
[i
].string
);
1496 strbuf_addch(&buf
, '\n');
1500 strbuf_addstr(&buf
, "To: ");
1501 for (i
= 0; i
< extra_to
.nr
; i
++) {
1503 strbuf_addstr(&buf
, " ");
1504 strbuf_addstr(&buf
, extra_to
.items
[i
].string
);
1505 if (i
+ 1 < extra_to
.nr
)
1506 strbuf_addch(&buf
, ',');
1507 strbuf_addch(&buf
, '\n');
1511 strbuf_addstr(&buf
, "Cc: ");
1512 for (i
= 0; i
< extra_cc
.nr
; i
++) {
1514 strbuf_addstr(&buf
, " ");
1515 strbuf_addstr(&buf
, extra_cc
.items
[i
].string
);
1516 if (i
+ 1 < extra_cc
.nr
)
1517 strbuf_addch(&buf
, ',');
1518 strbuf_addch(&buf
, '\n');
1521 rev
.extra_headers
= strbuf_detach(&buf
, NULL
);
1524 if (split_ident_line(&rev
.from_ident
, from
, strlen(from
)))
1525 die(_("invalid ident line: %s"), from
);
1528 if (start_number
< 0)
1532 * If numbered is set solely due to format.numbered in config,
1533 * and it would conflict with --keep-subject (-k) from the
1534 * command line, reset "numbered".
1536 if (numbered
&& keep_subject
&& !numbered_cmdline_opt
)
1539 if (numbered
&& keep_subject
)
1540 die (_("-n and -k are mutually exclusive."));
1541 if (keep_subject
&& subject_prefix
)
1542 die (_("--subject-prefix and -k are mutually exclusive."));
1543 rev
.preserve_subject
= keep_subject
;
1545 argc
= setup_revisions(argc
, argv
, &rev
, &s_r_opt
);
1547 die (_("unrecognized argument: %s"), argv
[1]);
1549 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME
)
1550 die(_("--name-only does not make sense"));
1551 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME_STATUS
)
1552 die(_("--name-status does not make sense"));
1553 if (rev
.diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
)
1554 die(_("--check does not make sense"));
1556 if (!use_patch_format
&&
1557 (!rev
.diffopt
.output_format
||
1558 rev
.diffopt
.output_format
== DIFF_FORMAT_PATCH
))
1559 rev
.diffopt
.output_format
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_SUMMARY
;
1561 /* Always generate a patch */
1562 rev
.diffopt
.output_format
|= DIFF_FORMAT_PATCH
;
1564 rev
.zero_commit
= zero_commit
;
1566 if (!DIFF_OPT_TST(&rev
.diffopt
, TEXT
) && !no_binary_diff
)
1567 DIFF_OPT_SET(&rev
.diffopt
, BINARY
);
1570 init_display_notes(&rev
.notes_opt
);
1572 if (!output_directory
&& !use_stdout
)
1573 output_directory
= config_output_directory
;
1576 output_directory
= set_outdir(prefix
, output_directory
);
1580 if (output_directory
) {
1581 if (rev
.diffopt
.use_color
!= GIT_COLOR_ALWAYS
)
1582 rev
.diffopt
.use_color
= GIT_COLOR_NEVER
;
1584 die(_("standard output, or directory, which one?"));
1585 if (mkdir(output_directory
, 0777) < 0 && errno
!= EEXIST
)
1586 die_errno(_("Could not create directory '%s'"),
1590 if (rev
.pending
.nr
== 1) {
1593 if (rev
.max_count
< 0 && !rev
.show_root_diff
) {
1595 * This is traditional behaviour of "git format-patch
1596 * origin" that prepares what the origin side still
1599 rev
.pending
.objects
[0].item
->flags
|= UNINTERESTING
;
1600 add_head_to_pending(&rev
);
1604 * Otherwise, it is "format-patch -22 HEAD", and/or
1605 * "format-patch --root HEAD". The user wants
1606 * get_revision() to do the usual traversal.
1609 if (!strcmp(rev
.pending
.objects
[0].name
, "HEAD"))
1613 unsigned char sha1
[20];
1614 const char *ref
, *v
;
1615 ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
1617 if (ref
&& skip_prefix(ref
, "refs/heads/", &v
))
1618 branch_name
= xstrdup(v
);
1620 branch_name
= xstrdup(""); /* no branch */
1625 * We cannot move this anywhere earlier because we do want to
1626 * know if --root was given explicitly from the command line.
1628 rev
.show_root_diff
= 1;
1630 if (ignore_if_in_upstream
) {
1631 /* Don't say anything if head and upstream are the same. */
1632 if (rev
.pending
.nr
== 2) {
1633 struct object_array_entry
*o
= rev
.pending
.objects
;
1634 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1637 get_patch_ids(&rev
, &ids
);
1641 realstdout
= xfdopen(xdup(1), "w");
1643 if (prepare_revision_walk(&rev
))
1644 die(_("revision walk setup failed"));
1646 while ((commit
= get_revision(&rev
)) != NULL
) {
1647 if (commit
->object
.flags
& BOUNDARY
) {
1649 origin
= (boundary_count
== 1) ? commit
: NULL
;
1653 if (ignore_if_in_upstream
&& has_commit_patch_id(commit
, &ids
))
1657 REALLOC_ARRAY(list
, nr
);
1658 list
[nr
- 1] = commit
;
1664 if (!keep_subject
&& auto_number
&& total
> 1)
1667 rev
.total
= total
+ start_number
- 1;
1668 if (cover_letter
== -1) {
1669 if (config_cover_letter
== COVER_AUTO
)
1670 cover_letter
= (total
> 1);
1672 cover_letter
= (config_cover_letter
== COVER_ON
);
1676 ; /* --no-signature inhibits all signatures */
1677 } else if (signature
&& signature
!= git_version_string
) {
1678 ; /* non-default signature already set */
1679 } else if (signature_file
) {
1680 struct strbuf buf
= STRBUF_INIT
;
1682 if (strbuf_read_file(&buf
, signature_file
, 128) < 0)
1683 die_errno(_("unable to read signature file '%s'"), signature_file
);
1684 signature
= strbuf_detach(&buf
, NULL
);
1687 memset(&bases
, 0, sizeof(bases
));
1688 if (base_commit
|| base_auto
) {
1689 struct commit
*base
= get_base_commit(base_commit
, list
, nr
);
1690 reset_revision_walk();
1691 prepare_bases(&bases
, base
, list
, nr
);
1694 if (in_reply_to
|| thread
|| cover_letter
)
1695 rev
.ref_message_ids
= xcalloc(1, sizeof(struct string_list
));
1697 const char *msgid
= clean_message_id(in_reply_to
);
1698 string_list_append(rev
.ref_message_ids
, msgid
);
1700 rev
.numbered_files
= just_numbers
;
1701 rev
.patch_suffix
= fmt_patch_suffix
;
1704 gen_message_id(&rev
, "cover");
1705 make_cover_letter(&rev
, use_stdout
,
1706 origin
, nr
, list
, branch_name
, quiet
);
1707 print_bases(&bases
);
1711 rev
.add_signoff
= do_signoff
;
1715 rev
.nr
= total
- nr
+ (start_number
- 1);
1716 /* Make the second and subsequent mails replies to the first */
1718 /* Have we already had a message ID? */
1719 if (rev
.message_id
) {
1721 * For deep threading: make every mail
1722 * a reply to the previous one, no
1723 * matter what other options are set.
1725 * For shallow threading:
1727 * Without --cover-letter and
1728 * --in-reply-to, make every mail a
1729 * reply to the one before.
1731 * With --in-reply-to but no
1732 * --cover-letter, make every mail a
1733 * reply to the <reply-to>.
1735 * With --cover-letter, make every
1736 * mail but the cover letter a reply
1737 * to the cover letter. The cover
1738 * letter is a reply to the
1739 * --in-reply-to, if specified.
1741 if (thread
== THREAD_SHALLOW
1742 && rev
.ref_message_ids
->nr
> 0
1743 && (!cover_letter
|| rev
.nr
> 1))
1744 free(rev
.message_id
);
1746 string_list_append(rev
.ref_message_ids
,
1749 gen_message_id(&rev
, oid_to_hex(&commit
->object
.oid
));
1753 reopen_stdout(rev
.numbered_files
? NULL
: commit
, NULL
, &rev
, quiet
))
1754 die(_("Failed to create output files"));
1755 shown
= log_tree_commit(&rev
, commit
);
1756 free_commit_buffer(commit
);
1758 /* We put one extra blank line between formatted
1759 * patches and this flag is used by log-tree code
1760 * to see if it needs to emit a LF before showing
1761 * the log; when using one file per patch, we do
1762 * not want the extra blank line.
1767 if (rev
.mime_boundary
)
1768 printf("\n--%s%s--\n\n\n",
1769 mime_boundary_leader
,
1773 print_bases(&bases
);
1780 string_list_clear(&extra_to
, 0);
1781 string_list_clear(&extra_cc
, 0);
1782 string_list_clear(&extra_hdr
, 0);
1783 if (ignore_if_in_upstream
)
1784 free_patch_ids(&ids
);
1788 static int add_pending_commit(const char *arg
, struct rev_info
*revs
, int flags
)
1790 unsigned char sha1
[20];
1791 if (get_sha1(arg
, sha1
) == 0) {
1792 struct commit
*commit
= lookup_commit_reference(sha1
);
1794 commit
->object
.flags
|= flags
;
1795 add_pending_object(revs
, &commit
->object
, arg
);
1802 static const char * const cherry_usage
[] = {
1803 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1807 static void print_commit(char sign
, struct commit
*commit
, int verbose
,
1811 printf("%c %s\n", sign
,
1812 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
));
1814 struct strbuf buf
= STRBUF_INIT
;
1815 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &buf
);
1816 printf("%c %s %s\n", sign
,
1817 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
),
1819 strbuf_release(&buf
);
1823 int cmd_cherry(int argc
, const char **argv
, const char *prefix
)
1825 struct rev_info revs
;
1826 struct patch_ids ids
;
1827 struct commit
*commit
;
1828 struct commit_list
*list
= NULL
;
1829 struct branch
*current_branch
;
1830 const char *upstream
;
1831 const char *head
= "HEAD";
1832 const char *limit
= NULL
;
1833 int verbose
= 0, abbrev
= 0;
1835 struct option options
[] = {
1836 OPT__ABBREV(&abbrev
),
1837 OPT__VERBOSE(&verbose
, N_("be verbose")),
1841 argc
= parse_options(argc
, argv
, prefix
, options
, cherry_usage
, 0);
1854 current_branch
= branch_get(NULL
);
1855 upstream
= branch_get_upstream(current_branch
, NULL
);
1857 fprintf(stderr
, _("Could not find a tracked"
1858 " remote branch, please"
1859 " specify <upstream> manually.\n"));
1860 usage_with_options(cherry_usage
, options
);
1864 init_revisions(&revs
, prefix
);
1865 revs
.max_parents
= 1;
1867 if (add_pending_commit(head
, &revs
, 0))
1868 die(_("Unknown commit %s"), head
);
1869 if (add_pending_commit(upstream
, &revs
, UNINTERESTING
))
1870 die(_("Unknown commit %s"), upstream
);
1872 /* Don't say anything if head and upstream are the same. */
1873 if (revs
.pending
.nr
== 2) {
1874 struct object_array_entry
*o
= revs
.pending
.objects
;
1875 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1879 get_patch_ids(&revs
, &ids
);
1881 if (limit
&& add_pending_commit(limit
, &revs
, UNINTERESTING
))
1882 die(_("Unknown commit %s"), limit
);
1884 /* reverse the list of commits */
1885 if (prepare_revision_walk(&revs
))
1886 die(_("revision walk setup failed"));
1887 while ((commit
= get_revision(&revs
)) != NULL
) {
1888 commit_list_insert(commit
, &list
);
1894 commit
= list
->item
;
1895 if (has_commit_patch_id(commit
, &ids
))
1897 print_commit(sign
, commit
, verbose
, abbrev
);
1901 free_patch_ids(&ids
);