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"
31 /* Set a default date-time format for git log ("log.date" config variable) */
32 static const char *default_date_mode
= NULL
;
34 static int default_abbrev_commit
;
35 static int default_show_root
= 1;
36 static int default_follow
;
37 static int default_show_signature
;
38 static int decoration_style
;
39 static int decoration_given
;
40 static int use_mailmap_config
;
41 static const char *fmt_patch_subject_prefix
= "PATCH";
42 static const char *fmt_pretty
;
44 static const char * const builtin_log_usage
[] = {
45 N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
46 N_("git show [<options>] <object>..."),
50 struct line_opt_callback_data
{
53 struct string_list args
;
56 static int auto_decoration_style(void)
58 return (isatty(1) || pager_in_use()) ? DECORATE_SHORT_REFS
: 0;
61 static int parse_decoration_style(const char *var
, const char *value
)
63 switch (git_config_maybe_bool(var
, value
)) {
65 return DECORATE_SHORT_REFS
;
71 if (!strcmp(value
, "full"))
72 return DECORATE_FULL_REFS
;
73 else if (!strcmp(value
, "short"))
74 return DECORATE_SHORT_REFS
;
75 else if (!strcmp(value
, "auto"))
76 return auto_decoration_style();
80 static int decorate_callback(const struct option
*opt
, const char *arg
, int unset
)
85 decoration_style
= parse_decoration_style("command line", arg
);
87 decoration_style
= DECORATE_SHORT_REFS
;
89 if (decoration_style
< 0)
90 die(_("invalid --decorate option: %s"), arg
);
97 static int log_line_range_callback(const struct option
*option
, const char *arg
, int unset
)
99 struct line_opt_callback_data
*data
= option
->value
;
104 data
->rev
->line_level_traverse
= 1;
105 string_list_append(&data
->args
, arg
);
110 static void init_log_defaults(void)
112 init_grep_defaults();
113 init_diff_ui_defaults();
115 decoration_style
= auto_decoration_style();
118 static void cmd_log_init_defaults(struct rev_info
*rev
)
121 get_commit_format(fmt_pretty
, rev
);
123 DIFF_OPT_SET(&rev
->diffopt
, DEFAULT_FOLLOW_RENAMES
);
124 rev
->verbose_header
= 1;
125 DIFF_OPT_SET(&rev
->diffopt
, RECURSIVE
);
126 rev
->diffopt
.stat_width
= -1; /* use full terminal width */
127 rev
->diffopt
.stat_graph_width
= -1; /* respect statGraphWidth config */
128 rev
->abbrev_commit
= default_abbrev_commit
;
129 rev
->show_root_diff
= default_show_root
;
130 rev
->subject_prefix
= fmt_patch_subject_prefix
;
131 rev
->show_signature
= default_show_signature
;
132 DIFF_OPT_SET(&rev
->diffopt
, ALLOW_TEXTCONV
);
134 if (default_date_mode
)
135 parse_date_format(default_date_mode
, &rev
->date_mode
);
136 rev
->diffopt
.touched_flags
= 0;
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
};
146 const struct option builtin_log_options
[] = {
147 OPT__QUIET(&quiet
, N_("suppress diff output")),
148 OPT_BOOL(0, "source", &source
, N_("show source")),
149 OPT_BOOL(0, "use-mailmap", &mailmap
, N_("Use mail map file")),
150 { OPTION_CALLBACK
, 0, "decorate", NULL
, NULL
, N_("decorate options"),
151 PARSE_OPT_OPTARG
, decorate_callback
},
152 OPT_CALLBACK('L', NULL
, &line_cb
, "n,m:file",
153 N_("Process line range n,m in file, counting from 1"),
154 log_line_range_callback
),
159 line_cb
.prefix
= prefix
;
161 mailmap
= use_mailmap_config
;
162 argc
= parse_options(argc
, argv
, prefix
,
163 builtin_log_options
, builtin_log_usage
,
164 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
165 PARSE_OPT_KEEP_DASHDASH
);
168 rev
->diffopt
.output_format
|= DIFF_FORMAT_NO_OUTPUT
;
169 argc
= setup_revisions(argc
, argv
, rev
, opt
);
171 /* Any arguments at this point are not recognized */
173 die(_("unrecognized argument: %s"), argv
[1]);
175 memset(&w
, 0, sizeof(w
));
176 userformat_find_requirements(NULL
, &w
);
178 if (!rev
->show_notes_given
&& (!rev
->pretty_given
|| w
.notes
))
181 init_display_notes(&rev
->notes_opt
);
183 if (rev
->diffopt
.pickaxe
|| rev
->diffopt
.filter
||
184 DIFF_OPT_TST(&rev
->diffopt
, FOLLOW_RENAMES
))
185 rev
->always_show_header
= 0;
188 rev
->show_source
= 1;
191 rev
->mailmap
= xcalloc(1, sizeof(struct string_list
));
192 read_mailmap(rev
->mailmap
, NULL
);
195 if (rev
->pretty_given
&& rev
->commit_format
== CMIT_FMT_RAW
) {
197 * "log --pretty=raw" is special; ignore UI oriented
198 * configuration variables such as decoration.
200 if (!decoration_given
)
201 decoration_style
= 0;
202 if (!rev
->abbrev_commit_given
)
203 rev
->abbrev_commit
= 0;
206 if (decoration_style
) {
207 rev
->show_decorations
= 1;
208 load_ref_decorations(decoration_style
);
211 if (rev
->line_level_traverse
)
212 line_log_init(rev
, line_cb
.prefix
, &line_cb
.args
);
217 static void cmd_log_init(int argc
, const char **argv
, const char *prefix
,
218 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
220 cmd_log_init_defaults(rev
);
221 cmd_log_init_finish(argc
, argv
, prefix
, rev
, opt
);
225 * This gives a rough estimate for how many commits we
226 * will print out in the list.
228 static int estimate_commit_count(struct rev_info
*rev
, struct commit_list
*list
)
233 struct commit
*commit
= list
->item
;
234 unsigned int flags
= commit
->object
.flags
;
236 if (!(flags
& (TREESAME
| UNINTERESTING
)))
242 static void show_early_header(struct rev_info
*rev
, const char *stage
, int nr
)
244 if (rev
->shown_one
) {
246 if (rev
->commit_format
!= CMIT_FMT_ONELINE
)
247 putchar(rev
->diffopt
.line_termination
);
249 fprintf(rev
->diffopt
.file
, _("Final output: %d %s\n"), nr
, stage
);
252 static struct itimerval early_output_timer
;
254 static void log_show_early(struct rev_info
*revs
, struct commit_list
*list
)
256 int i
= revs
->early_output
, close_file
= revs
->diffopt
.close_file
;
259 revs
->diffopt
.close_file
= 0;
260 sort_in_topological_order(&list
, revs
->sort_order
);
262 struct commit
*commit
= list
->item
;
263 switch (simplify_commit(revs
, commit
)) {
266 int n
= estimate_commit_count(revs
, list
);
267 show_early_header(revs
, "incomplete", n
);
270 log_tree_commit(revs
, commit
);
277 fclose(revs
->diffopt
.file
);
283 /* Did we already get enough commits for the early output? */
286 fclose(revs
->diffopt
.file
);
291 * ..if no, then repeat it twice a second until we
294 * NOTE! We don't use "it_interval", because if the
295 * reader isn't listening, we want our output to be
296 * throttled by the writing, and not have the timer
297 * trigger every second even if we're blocked on a
300 early_output_timer
.it_value
.tv_sec
= 0;
301 early_output_timer
.it_value
.tv_usec
= 500000;
302 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
305 static void early_output(int signal
)
307 show_early_output
= log_show_early
;
310 static void setup_early_output(struct rev_info
*rev
)
315 * Set up the signal handler, minimally intrusively:
316 * we only set a single volatile integer word (not
317 * using sigatomic_t - trying to avoid unnecessary
318 * system dependencies and headers), and using
321 memset(&sa
, 0, sizeof(sa
));
322 sa
.sa_handler
= early_output
;
323 sigemptyset(&sa
.sa_mask
);
324 sa
.sa_flags
= SA_RESTART
;
325 sigaction(SIGALRM
, &sa
, NULL
);
328 * If we can get the whole output in less than a
329 * tenth of a second, don't even bother doing the
330 * early-output thing..
332 * This is a one-time-only trigger.
334 early_output_timer
.it_value
.tv_sec
= 0;
335 early_output_timer
.it_value
.tv_usec
= 100000;
336 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
339 static void finish_early_output(struct rev_info
*rev
)
341 int n
= estimate_commit_count(rev
, rev
->commits
);
342 signal(SIGALRM
, SIG_IGN
);
343 show_early_header(rev
, "done", n
);
346 static int cmd_log_walk(struct rev_info
*rev
)
348 struct commit
*commit
;
350 int saved_dcctc
= 0, close_file
= rev
->diffopt
.close_file
;
352 if (rev
->early_output
)
353 setup_early_output(rev
);
355 if (prepare_revision_walk(rev
))
356 die(_("revision walk setup failed"));
358 if (rev
->early_output
)
359 finish_early_output(rev
);
362 * For --check and --exit-code, the exit code is based on CHECK_FAILED
363 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
364 * retain that state information if replacing rev->diffopt in this loop
366 rev
->diffopt
.close_file
= 0;
367 while ((commit
= get_revision(rev
)) != NULL
) {
368 if (!log_tree_commit(rev
, commit
) && rev
->max_count
>= 0)
370 * We decremented max_count in get_revision,
371 * but we didn't actually show the commit.
374 if (!rev
->reflog_info
) {
375 /* we allow cycles in reflog ancestry */
376 free_commit_buffer(commit
);
378 free_commit_list(commit
->parents
);
379 commit
->parents
= NULL
;
380 if (saved_nrl
< rev
->diffopt
.needed_rename_limit
)
381 saved_nrl
= rev
->diffopt
.needed_rename_limit
;
382 if (rev
->diffopt
.degraded_cc_to_c
)
385 rev
->diffopt
.degraded_cc_to_c
= saved_dcctc
;
386 rev
->diffopt
.needed_rename_limit
= saved_nrl
;
388 fclose(rev
->diffopt
.file
);
390 if (rev
->diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
&&
391 DIFF_OPT_TST(&rev
->diffopt
, CHECK_FAILED
)) {
394 return diff_result_code(&rev
->diffopt
, 0);
397 static int git_log_config(const char *var
, const char *value
, void *cb
)
399 const char *slot_name
;
401 if (!strcmp(var
, "format.pretty"))
402 return git_config_string(&fmt_pretty
, var
, value
);
403 if (!strcmp(var
, "format.subjectprefix"))
404 return git_config_string(&fmt_patch_subject_prefix
, var
, value
);
405 if (!strcmp(var
, "log.abbrevcommit")) {
406 default_abbrev_commit
= git_config_bool(var
, value
);
409 if (!strcmp(var
, "log.date"))
410 return git_config_string(&default_date_mode
, var
, value
);
411 if (!strcmp(var
, "log.decorate")) {
412 decoration_style
= parse_decoration_style(var
, value
);
413 if (decoration_style
< 0)
414 decoration_style
= 0; /* maybe warn? */
417 if (!strcmp(var
, "log.showroot")) {
418 default_show_root
= git_config_bool(var
, value
);
421 if (!strcmp(var
, "log.follow")) {
422 default_follow
= git_config_bool(var
, value
);
425 if (skip_prefix(var
, "color.decorate.", &slot_name
))
426 return parse_decorate_color_config(var
, slot_name
, value
);
427 if (!strcmp(var
, "log.mailmap")) {
428 use_mailmap_config
= git_config_bool(var
, value
);
431 if (!strcmp(var
, "log.showsignature")) {
432 default_show_signature
= git_config_bool(var
, value
);
436 if (grep_config(var
, value
, cb
) < 0)
438 if (git_gpg_config(var
, value
, cb
) < 0)
440 return git_diff_ui_config(var
, value
, cb
);
443 int cmd_whatchanged(int argc
, const char **argv
, const char *prefix
)
446 struct setup_revision_opt opt
;
449 git_config(git_log_config
, NULL
);
451 init_revisions(&rev
, prefix
);
453 rev
.simplify_history
= 0;
454 memset(&opt
, 0, sizeof(opt
));
456 opt
.revarg_opt
= REVARG_COMMITTISH
;
457 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
458 if (!rev
.diffopt
.output_format
)
459 rev
.diffopt
.output_format
= DIFF_FORMAT_RAW
;
460 return cmd_log_walk(&rev
);
463 static void show_tagger(char *buf
, int len
, struct rev_info
*rev
)
465 struct strbuf out
= STRBUF_INIT
;
466 struct pretty_print_context pp
= {0};
468 pp
.fmt
= rev
->commit_format
;
469 pp
.date_mode
= rev
->date_mode
;
470 pp_user_info(&pp
, "Tagger", &out
, buf
, get_log_output_encoding());
471 fprintf(rev
->diffopt
.file
, "%s", out
.buf
);
472 strbuf_release(&out
);
475 static int show_blob_object(const struct object_id
*oid
, struct rev_info
*rev
, const char *obj_name
)
477 struct object_id oidc
;
478 struct object_context obj_context
;
482 fflush(rev
->diffopt
.file
);
483 if (!DIFF_OPT_TOUCHED(&rev
->diffopt
, ALLOW_TEXTCONV
) ||
484 !DIFF_OPT_TST(&rev
->diffopt
, ALLOW_TEXTCONV
))
485 return stream_blob_to_fd(1, oid
, NULL
, 0);
487 if (get_oid_with_context(obj_name
, GET_SHA1_RECORD_PATH
,
488 &oidc
, &obj_context
))
489 die(_("Not a valid object name %s"), obj_name
);
490 if (!obj_context
.path
||
491 !textconv_object(obj_context
.path
, obj_context
.mode
, &oidc
, 1, &buf
, &size
)) {
492 free(obj_context
.path
);
493 return stream_blob_to_fd(1, oid
, NULL
, 0);
497 die(_("git show %s: bad file"), obj_name
);
499 write_or_die(1, buf
, size
);
500 free(obj_context
.path
);
504 static int show_tag_object(const struct object_id
*oid
, struct rev_info
*rev
)
507 enum object_type type
;
508 char *buf
= read_sha1_file(oid
->hash
, &type
, &size
);
512 return error(_("Could not read object %s"), oid_to_hex(oid
));
514 assert(type
== OBJ_TAG
);
515 while (offset
< size
&& buf
[offset
] != '\n') {
516 int new_offset
= offset
+ 1;
517 while (new_offset
< size
&& buf
[new_offset
++] != '\n')
519 if (starts_with(buf
+ offset
, "tagger "))
520 show_tagger(buf
+ offset
+ 7,
521 new_offset
- offset
- 7, rev
);
526 fwrite(buf
+ offset
, size
- offset
, 1, rev
->diffopt
.file
);
531 static int show_tree_object(const unsigned char *sha1
,
533 const char *pathname
, unsigned mode
, int stage
, void *context
)
535 FILE *file
= context
;
536 fprintf(file
, "%s%s\n", pathname
, S_ISDIR(mode
) ? "/" : "");
540 static void show_setup_revisions_tweak(struct rev_info
*rev
,
541 struct setup_revision_opt
*opt
)
543 if (rev
->ignore_merges
) {
544 /* There was no "-m" on the command line */
545 rev
->ignore_merges
= 0;
546 if (!rev
->first_parent_only
&& !rev
->combine_merges
) {
547 /* No "--first-parent", "-c", or "--cc" */
548 rev
->combine_merges
= 1;
549 rev
->dense_combined_merges
= 1;
552 if (!rev
->diffopt
.output_format
)
553 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
556 int cmd_show(int argc
, const char **argv
, const char *prefix
)
559 struct object_array_entry
*objects
;
560 struct setup_revision_opt opt
;
561 struct pathspec match_all
;
562 int i
, count
, ret
= 0;
565 git_config(git_log_config
, NULL
);
567 memset(&match_all
, 0, sizeof(match_all
));
568 init_revisions(&rev
, prefix
);
570 rev
.always_show_header
= 1;
571 rev
.no_walk
= REVISION_WALK_NO_WALK_SORTED
;
572 rev
.diffopt
.stat_width
= -1; /* Scale to real terminal size */
574 memset(&opt
, 0, sizeof(opt
));
576 opt
.tweak
= show_setup_revisions_tweak
;
577 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
580 return cmd_log_walk(&rev
);
582 count
= rev
.pending
.nr
;
583 objects
= rev
.pending
.objects
;
584 for (i
= 0; i
< count
&& !ret
; i
++) {
585 struct object
*o
= objects
[i
].item
;
586 const char *name
= objects
[i
].name
;
589 ret
= show_blob_object(&o
->oid
, &rev
, name
);
592 struct tag
*t
= (struct tag
*)o
;
596 fprintf(rev
.diffopt
.file
, "%stag %s%s\n",
597 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
599 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
600 ret
= show_tag_object(&o
->oid
, &rev
);
604 o
= parse_object(&t
->tagged
->oid
);
606 ret
= error(_("Could not read object %s"),
607 oid_to_hex(&t
->tagged
->oid
));
615 fprintf(rev
.diffopt
.file
, "%stree %s%s\n\n",
616 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
618 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
619 read_tree_recursive((struct tree
*)o
, "", 0, 0, &match_all
,
620 show_tree_object
, rev
.diffopt
.file
);
624 rev
.pending
.nr
= rev
.pending
.alloc
= 0;
625 rev
.pending
.objects
= NULL
;
626 add_object_array(o
, name
, &rev
.pending
);
627 ret
= cmd_log_walk(&rev
);
630 ret
= error(_("Unknown type: %d"), o
->type
);
638 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
640 int cmd_log_reflog(int argc
, const char **argv
, const char *prefix
)
643 struct setup_revision_opt opt
;
646 git_config(git_log_config
, NULL
);
648 init_revisions(&rev
, prefix
);
649 init_reflog_walk(&rev
.reflog_info
);
650 rev
.verbose_header
= 1;
651 memset(&opt
, 0, sizeof(opt
));
653 cmd_log_init_defaults(&rev
);
654 rev
.abbrev_commit
= 1;
655 rev
.commit_format
= CMIT_FMT_ONELINE
;
656 rev
.use_terminator
= 1;
657 rev
.always_show_header
= 1;
658 cmd_log_init_finish(argc
, argv
, prefix
, &rev
, &opt
);
660 return cmd_log_walk(&rev
);
663 static void log_setup_revisions_tweak(struct rev_info
*rev
,
664 struct setup_revision_opt
*opt
)
666 if (DIFF_OPT_TST(&rev
->diffopt
, DEFAULT_FOLLOW_RENAMES
) &&
667 rev
->prune_data
.nr
== 1)
668 DIFF_OPT_SET(&rev
->diffopt
, FOLLOW_RENAMES
);
670 /* Turn --cc/-c into -p --cc/-c when -p was not given */
671 if (!rev
->diffopt
.output_format
&& rev
->combine_merges
)
672 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
674 /* Turn -m on when --cc/-c was given */
675 if (rev
->combine_merges
)
676 rev
->ignore_merges
= 0;
679 int cmd_log(int argc
, const char **argv
, const char *prefix
)
682 struct setup_revision_opt opt
;
685 git_config(git_log_config
, NULL
);
687 init_revisions(&rev
, prefix
);
688 rev
.always_show_header
= 1;
689 memset(&opt
, 0, sizeof(opt
));
691 opt
.revarg_opt
= REVARG_COMMITTISH
;
692 opt
.tweak
= log_setup_revisions_tweak
;
693 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
694 return cmd_log_walk(&rev
);
699 static const char *fmt_patch_suffix
= ".patch";
700 static int numbered
= 0;
701 static int auto_number
= 1;
703 static char *default_attach
= NULL
;
705 static struct string_list extra_hdr
= STRING_LIST_INIT_NODUP
;
706 static struct string_list extra_to
= STRING_LIST_INIT_NODUP
;
707 static struct string_list extra_cc
= STRING_LIST_INIT_NODUP
;
709 static void add_header(const char *value
)
711 struct string_list_item
*item
;
712 int len
= strlen(value
);
713 while (len
&& value
[len
- 1] == '\n')
716 if (!strncasecmp(value
, "to: ", 4)) {
717 item
= string_list_append(&extra_to
, value
+ 4);
719 } else if (!strncasecmp(value
, "cc: ", 4)) {
720 item
= string_list_append(&extra_cc
, value
+ 4);
723 item
= string_list_append(&extra_hdr
, value
);
726 item
->string
[len
] = '\0';
729 #define THREAD_SHALLOW 1
730 #define THREAD_DEEP 2
732 static int do_signoff
;
733 static int base_auto
;
735 static const char *signature
= git_version_string
;
736 static const char *signature_file
;
737 static int config_cover_letter
;
738 static const char *config_output_directory
;
747 static int git_format_config(const char *var
, const char *value
, void *cb
)
749 if (!strcmp(var
, "format.headers")) {
751 die(_("format.headers without value"));
755 if (!strcmp(var
, "format.suffix"))
756 return git_config_string(&fmt_patch_suffix
, var
, value
);
757 if (!strcmp(var
, "format.to")) {
759 return config_error_nonbool(var
);
760 string_list_append(&extra_to
, value
);
763 if (!strcmp(var
, "format.cc")) {
765 return config_error_nonbool(var
);
766 string_list_append(&extra_cc
, value
);
769 if (!strcmp(var
, "diff.color") || !strcmp(var
, "color.diff") ||
770 !strcmp(var
, "color.ui") || !strcmp(var
, "diff.submodule")) {
773 if (!strcmp(var
, "format.numbered")) {
774 if (value
&& !strcasecmp(value
, "auto")) {
778 numbered
= git_config_bool(var
, value
);
779 auto_number
= auto_number
&& numbered
;
782 if (!strcmp(var
, "format.attach")) {
784 default_attach
= xstrdup(value
);
786 default_attach
= xstrdup(git_version_string
);
789 if (!strcmp(var
, "format.thread")) {
790 if (value
&& !strcasecmp(value
, "deep")) {
791 thread
= THREAD_DEEP
;
794 if (value
&& !strcasecmp(value
, "shallow")) {
795 thread
= THREAD_SHALLOW
;
798 thread
= git_config_bool(var
, value
) && THREAD_SHALLOW
;
801 if (!strcmp(var
, "format.signoff")) {
802 do_signoff
= git_config_bool(var
, value
);
805 if (!strcmp(var
, "format.signature"))
806 return git_config_string(&signature
, var
, value
);
807 if (!strcmp(var
, "format.signaturefile"))
808 return git_config_pathname(&signature_file
, var
, value
);
809 if (!strcmp(var
, "format.coverletter")) {
810 if (value
&& !strcasecmp(value
, "auto")) {
811 config_cover_letter
= COVER_AUTO
;
814 config_cover_letter
= git_config_bool(var
, value
) ? COVER_ON
: COVER_OFF
;
817 if (!strcmp(var
, "format.outputdirectory"))
818 return git_config_string(&config_output_directory
, var
, value
);
819 if (!strcmp(var
, "format.useautobase")) {
820 base_auto
= git_config_bool(var
, value
);
823 if (!strcmp(var
, "format.from")) {
824 int b
= git_config_maybe_bool(var
, value
);
827 from
= xstrdup(value
);
829 from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
835 return git_log_config(var
, value
, cb
);
838 static const char *output_directory
= NULL
;
839 static int outdir_offset
;
841 static int open_next_file(struct commit
*commit
, const char *subject
,
842 struct rev_info
*rev
, int quiet
)
844 struct strbuf filename
= STRBUF_INIT
;
845 int suffix_len
= strlen(rev
->patch_suffix
) + 1;
847 if (output_directory
) {
848 strbuf_addstr(&filename
, output_directory
);
850 PATH_MAX
- FORMAT_PATCH_NAME_MAX
- suffix_len
) {
851 strbuf_release(&filename
);
852 return error(_("name of output directory is too long"));
854 strbuf_complete(&filename
, '/');
857 if (rev
->numbered_files
)
858 strbuf_addf(&filename
, "%d", rev
->nr
);
860 fmt_output_commit(&filename
, commit
, rev
);
862 fmt_output_subject(&filename
, subject
, rev
);
865 printf("%s\n", filename
.buf
+ outdir_offset
);
867 if ((rev
->diffopt
.file
= fopen(filename
.buf
, "w")) == NULL
) {
868 error_errno(_("Cannot open patch file %s"), filename
.buf
);
869 strbuf_release(&filename
);
873 strbuf_release(&filename
);
877 static void get_patch_ids(struct rev_info
*rev
, struct patch_ids
*ids
)
879 struct rev_info check_rev
;
880 struct commit
*commit
, *c1
, *c2
;
881 struct object
*o1
, *o2
;
882 unsigned flags1
, flags2
;
884 if (rev
->pending
.nr
!= 2)
885 die(_("Need exactly one range."));
887 o1
= rev
->pending
.objects
[0].item
;
888 o2
= rev
->pending
.objects
[1].item
;
891 c1
= lookup_commit_reference(&o1
->oid
);
892 c2
= lookup_commit_reference(&o2
->oid
);
894 if ((flags1
& UNINTERESTING
) == (flags2
& UNINTERESTING
))
895 die(_("Not a range."));
899 /* given a range a..b get all patch ids for b..a */
900 init_revisions(&check_rev
, rev
->prefix
);
901 check_rev
.max_parents
= 1;
902 o1
->flags
^= UNINTERESTING
;
903 o2
->flags
^= UNINTERESTING
;
904 add_pending_object(&check_rev
, o1
, "o1");
905 add_pending_object(&check_rev
, o2
, "o2");
906 if (prepare_revision_walk(&check_rev
))
907 die(_("revision walk setup failed"));
909 while ((commit
= get_revision(&check_rev
)) != NULL
) {
910 add_commit_patch_id(commit
, ids
);
913 /* reset for next revision walk */
914 clear_commit_marks(c1
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
915 clear_commit_marks(c2
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
920 static void gen_message_id(struct rev_info
*info
, char *base
)
922 struct strbuf buf
= STRBUF_INIT
;
923 strbuf_addf(&buf
, "%s.%"PRItime
".git.%s", base
,
924 (timestamp_t
) time(NULL
),
925 git_committer_info(IDENT_NO_NAME
|IDENT_NO_DATE
|IDENT_STRICT
));
926 info
->message_id
= strbuf_detach(&buf
, NULL
);
929 static void print_signature(FILE *file
)
931 if (!signature
|| !*signature
)
934 fprintf(file
, "-- \n%s", signature
);
935 if (signature
[strlen(signature
)-1] != '\n')
940 static void add_branch_description(struct strbuf
*buf
, const char *branch_name
)
942 struct strbuf desc
= STRBUF_INIT
;
943 if (!branch_name
|| !*branch_name
)
945 read_branch_desc(&desc
, branch_name
);
947 strbuf_addch(buf
, '\n');
948 strbuf_addbuf(buf
, &desc
);
949 strbuf_addch(buf
, '\n');
951 strbuf_release(&desc
);
954 static char *find_branch_name(struct rev_info
*rev
)
956 int i
, positive
= -1;
957 struct object_id branch_oid
;
958 const struct object_id
*tip_oid
;
960 char *full_ref
, *branch
= NULL
;
962 for (i
= 0; i
< rev
->cmdline
.nr
; i
++) {
963 if (rev
->cmdline
.rev
[i
].flags
& UNINTERESTING
)
972 ref
= rev
->cmdline
.rev
[positive
].name
;
973 tip_oid
= &rev
->cmdline
.rev
[positive
].item
->oid
;
974 if (dwim_ref(ref
, strlen(ref
), branch_oid
.hash
, &full_ref
) &&
975 skip_prefix(full_ref
, "refs/heads/", &v
) &&
976 !oidcmp(tip_oid
, &branch_oid
))
982 static void make_cover_letter(struct rev_info
*rev
, int use_stdout
,
983 struct commit
*origin
,
984 int nr
, struct commit
**list
,
985 const char *branch_name
,
988 const char *committer
;
989 const char *body
= "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
992 struct strbuf sb
= STRBUF_INIT
;
994 const char *encoding
= "UTF-8";
995 struct diff_options opts
;
996 int need_8bit_cte
= 0;
997 struct pretty_print_context pp
= {0};
998 struct commit
*head
= list
[0];
1000 if (!cmit_fmt_is_mail(rev
->commit_format
))
1001 die(_("Cover letter needs email format"));
1003 committer
= git_committer_info(0);
1006 open_next_file(NULL
, rev
->numbered_files
? NULL
: "cover-letter", rev
, quiet
))
1009 log_write_email_headers(rev
, head
, &pp
.after_subject
, &need_8bit_cte
);
1011 for (i
= 0; !need_8bit_cte
&& i
< nr
; i
++) {
1012 const char *buf
= get_commit_buffer(list
[i
], NULL
);
1013 if (has_non_ascii(buf
))
1015 unuse_commit_buffer(list
[i
], buf
);
1019 branch_name
= find_branch_name(rev
);
1022 pp
.fmt
= CMIT_FMT_EMAIL
;
1023 pp
.date_mode
.type
= DATE_RFC2822
;
1025 pp
.print_email_subject
= 1;
1026 pp_user_info(&pp
, NULL
, &sb
, committer
, encoding
);
1027 pp_title_line(&pp
, &msg
, &sb
, encoding
, need_8bit_cte
);
1028 pp_remainder(&pp
, &msg
, &sb
, 0);
1029 add_branch_description(&sb
, branch_name
);
1030 fprintf(rev
->diffopt
.file
, "%s\n", sb
.buf
);
1032 strbuf_release(&sb
);
1034 shortlog_init(&log
);
1039 log
.file
= rev
->diffopt
.file
;
1040 for (i
= 0; i
< nr
; i
++)
1041 shortlog_add_commit(&log
, list
[i
]);
1043 shortlog_output(&log
);
1046 * We can only do diffstat with a unique reference point
1051 memcpy(&opts
, &rev
->diffopt
, sizeof(opts
));
1052 opts
.output_format
= DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
1054 diff_setup_done(&opts
);
1056 diff_tree_oid(&origin
->tree
->object
.oid
,
1057 &head
->tree
->object
.oid
,
1059 diffcore_std(&opts
);
1062 fprintf(rev
->diffopt
.file
, "\n");
1065 static const char *clean_message_id(const char *msg_id
)
1068 const char *a
, *z
, *m
;
1071 while ((ch
= *m
) && (isspace(ch
) || (ch
== '<')))
1076 if (!isspace(ch
) && (ch
!= '>'))
1081 die(_("insane in-reply-to: %s"), msg_id
);
1084 return xmemdupz(a
, z
- a
);
1087 static const char *set_outdir(const char *prefix
, const char *output_directory
)
1089 if (output_directory
&& is_absolute_path(output_directory
))
1090 return output_directory
;
1092 if (!prefix
|| !*prefix
) {
1093 if (output_directory
)
1094 return output_directory
;
1095 /* The user did not explicitly ask for "./" */
1100 outdir_offset
= strlen(prefix
);
1101 if (!output_directory
)
1104 return prefix_filename(prefix
, output_directory
);
1107 static const char * const builtin_format_patch_usage
[] = {
1108 N_("git format-patch [<options>] [<since> | <revision-range>]"),
1112 static int keep_subject
= 0;
1114 static int keep_callback(const struct option
*opt
, const char *arg
, int unset
)
1116 ((struct rev_info
*)opt
->value
)->total
= -1;
1121 static int subject_prefix
= 0;
1123 static int subject_prefix_callback(const struct option
*opt
, const char *arg
,
1127 ((struct rev_info
*)opt
->value
)->subject_prefix
= arg
;
1131 static int rfc_callback(const struct option
*opt
, const char *arg
, int unset
)
1133 return subject_prefix_callback(opt
, "RFC PATCH", unset
);
1136 static int numbered_cmdline_opt
= 0;
1138 static int numbered_callback(const struct option
*opt
, const char *arg
,
1141 *(int *)opt
->value
= numbered_cmdline_opt
= unset
? 0 : 1;
1147 static int no_numbered_callback(const struct option
*opt
, const char *arg
,
1150 return numbered_callback(opt
, arg
, 1);
1153 static int output_directory_callback(const struct option
*opt
, const char *arg
,
1156 const char **dir
= (const char **)opt
->value
;
1158 die(_("Two output directories?"));
1163 static int thread_callback(const struct option
*opt
, const char *arg
, int unset
)
1165 int *thread
= (int *)opt
->value
;
1168 else if (!arg
|| !strcmp(arg
, "shallow"))
1169 *thread
= THREAD_SHALLOW
;
1170 else if (!strcmp(arg
, "deep"))
1171 *thread
= THREAD_DEEP
;
1177 static int attach_callback(const struct option
*opt
, const char *arg
, int unset
)
1179 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1181 rev
->mime_boundary
= NULL
;
1183 rev
->mime_boundary
= arg
;
1185 rev
->mime_boundary
= git_version_string
;
1186 rev
->no_inline
= unset
? 0 : 1;
1190 static int inline_callback(const struct option
*opt
, const char *arg
, int unset
)
1192 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1194 rev
->mime_boundary
= NULL
;
1196 rev
->mime_boundary
= arg
;
1198 rev
->mime_boundary
= git_version_string
;
1203 static int header_callback(const struct option
*opt
, const char *arg
, int unset
)
1206 string_list_clear(&extra_hdr
, 0);
1207 string_list_clear(&extra_to
, 0);
1208 string_list_clear(&extra_cc
, 0);
1215 static int to_callback(const struct option
*opt
, const char *arg
, int unset
)
1218 string_list_clear(&extra_to
, 0);
1220 string_list_append(&extra_to
, arg
);
1224 static int cc_callback(const struct option
*opt
, const char *arg
, int unset
)
1227 string_list_clear(&extra_cc
, 0);
1229 string_list_append(&extra_cc
, arg
);
1233 static int from_callback(const struct option
*opt
, const char *arg
, int unset
)
1235 char **from
= opt
->value
;
1242 *from
= xstrdup(arg
);
1244 *from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
1248 struct base_tree_info
{
1249 struct object_id base_commit
;
1250 int nr_patch_id
, alloc_patch_id
;
1251 struct object_id
*patch_id
;
1254 static struct commit
*get_base_commit(const char *base_commit
,
1255 struct commit
**list
,
1258 struct commit
*base
= NULL
;
1259 struct commit
**rev
;
1260 int i
= 0, rev_nr
= 0;
1262 if (base_commit
&& strcmp(base_commit
, "auto")) {
1263 base
= lookup_commit_reference_by_name(base_commit
);
1265 die(_("Unknown commit %s"), base_commit
);
1266 } else if ((base_commit
&& !strcmp(base_commit
, "auto")) || base_auto
) {
1267 struct branch
*curr_branch
= branch_get(NULL
);
1268 const char *upstream
= branch_get_upstream(curr_branch
, NULL
);
1270 struct commit_list
*base_list
;
1271 struct commit
*commit
;
1272 struct object_id oid
;
1274 if (get_oid(upstream
, &oid
))
1275 die(_("Failed to resolve '%s' as a valid ref."), upstream
);
1276 commit
= lookup_commit_or_die(&oid
, "upstream base");
1277 base_list
= get_merge_bases_many(commit
, total
, list
);
1278 /* There should be one and only one merge base. */
1279 if (!base_list
|| base_list
->next
)
1280 die(_("Could not find exact merge base."));
1281 base
= base_list
->item
;
1282 free_commit_list(base_list
);
1284 die(_("Failed to get upstream, if you want to record base commit automatically,\n"
1285 "please use git branch --set-upstream-to to track a remote branch.\n"
1286 "Or you could specify base commit by --base=<base-commit-id> manually."));
1290 ALLOC_ARRAY(rev
, total
);
1291 for (i
= 0; i
< total
; i
++)
1296 * Get merge base through pair-wise computations
1297 * and store it in rev[0].
1299 while (rev_nr
> 1) {
1300 for (i
= 0; i
< rev_nr
/ 2; i
++) {
1301 struct commit_list
*merge_base
;
1302 merge_base
= get_merge_bases(rev
[2 * i
], rev
[2 * i
+ 1]);
1303 if (!merge_base
|| merge_base
->next
)
1304 die(_("Failed to find exact merge base"));
1306 rev
[i
] = merge_base
->item
;
1310 rev
[i
] = rev
[2 * i
];
1311 rev_nr
= DIV_ROUND_UP(rev_nr
, 2);
1314 if (!in_merge_bases(base
, rev
[0]))
1315 die(_("base commit should be the ancestor of revision list"));
1317 for (i
= 0; i
< total
; i
++) {
1318 if (base
== list
[i
])
1319 die(_("base commit shouldn't be in revision list"));
1326 static void prepare_bases(struct base_tree_info
*bases
,
1327 struct commit
*base
,
1328 struct commit
**list
,
1331 struct commit
*commit
;
1332 struct rev_info revs
;
1333 struct diff_options diffopt
;
1339 diff_setup(&diffopt
);
1340 DIFF_OPT_SET(&diffopt
, RECURSIVE
);
1341 diff_setup_done(&diffopt
);
1343 oidcpy(&bases
->base_commit
, &base
->object
.oid
);
1345 init_revisions(&revs
, NULL
);
1346 revs
.max_parents
= 1;
1347 revs
.topo_order
= 1;
1348 for (i
= 0; i
< total
; i
++) {
1349 list
[i
]->object
.flags
&= ~UNINTERESTING
;
1350 add_pending_object(&revs
, &list
[i
]->object
, "rev_list");
1351 list
[i
]->util
= (void *)1;
1353 base
->object
.flags
|= UNINTERESTING
;
1354 add_pending_object(&revs
, &base
->object
, "base");
1356 if (prepare_revision_walk(&revs
))
1357 die(_("revision walk setup failed"));
1359 * Traverse the commits list, get prerequisite patch ids
1360 * and stuff them in bases structure.
1362 while ((commit
= get_revision(&revs
)) != NULL
) {
1363 struct object_id oid
;
1364 struct object_id
*patch_id
;
1367 if (commit_patch_id(commit
, &diffopt
, &oid
, 0))
1368 die(_("cannot get patch id"));
1369 ALLOC_GROW(bases
->patch_id
, bases
->nr_patch_id
+ 1, bases
->alloc_patch_id
);
1370 patch_id
= bases
->patch_id
+ bases
->nr_patch_id
;
1371 oidcpy(patch_id
, &oid
);
1372 bases
->nr_patch_id
++;
1376 static void print_bases(struct base_tree_info
*bases
, FILE *file
)
1380 /* Only do this once, either for the cover or for the first one */
1381 if (is_null_oid(&bases
->base_commit
))
1384 /* Show the base commit */
1385 fprintf(file
, "\nbase-commit: %s\n", oid_to_hex(&bases
->base_commit
));
1387 /* Show the prerequisite patches */
1388 for (i
= bases
->nr_patch_id
- 1; i
>= 0; i
--)
1389 fprintf(file
, "prerequisite-patch-id: %s\n", oid_to_hex(&bases
->patch_id
[i
]));
1391 free(bases
->patch_id
);
1392 bases
->nr_patch_id
= 0;
1393 bases
->alloc_patch_id
= 0;
1394 oidclr(&bases
->base_commit
);
1397 int cmd_format_patch(int argc
, const char **argv
, const char *prefix
)
1399 struct commit
*commit
;
1400 struct commit
**list
= NULL
;
1401 struct rev_info rev
;
1402 struct setup_revision_opt s_r_opt
;
1403 int nr
= 0, total
, i
;
1405 int start_number
= -1;
1406 int just_numbers
= 0;
1407 int ignore_if_in_upstream
= 0;
1408 int cover_letter
= -1;
1409 int boundary_count
= 0;
1410 int no_binary_diff
= 0;
1411 int zero_commit
= 0;
1412 struct commit
*origin
= NULL
;
1413 const char *in_reply_to
= NULL
;
1414 struct patch_ids ids
;
1415 struct strbuf buf
= STRBUF_INIT
;
1416 int use_patch_format
= 0;
1418 int reroll_count
= -1;
1419 char *branch_name
= NULL
;
1420 char *base_commit
= NULL
;
1421 struct base_tree_info bases
;
1423 const struct option builtin_format_patch_options
[] = {
1424 { OPTION_CALLBACK
, 'n', "numbered", &numbered
, NULL
,
1425 N_("use [PATCH n/m] even with a single patch"),
1426 PARSE_OPT_NOARG
, numbered_callback
},
1427 { OPTION_CALLBACK
, 'N', "no-numbered", &numbered
, NULL
,
1428 N_("use [PATCH] even with multiple patches"),
1429 PARSE_OPT_NOARG
, no_numbered_callback
},
1430 OPT_BOOL('s', "signoff", &do_signoff
, N_("add Signed-off-by:")),
1431 OPT_BOOL(0, "stdout", &use_stdout
,
1432 N_("print patches to standard out")),
1433 OPT_BOOL(0, "cover-letter", &cover_letter
,
1434 N_("generate a cover letter")),
1435 OPT_BOOL(0, "numbered-files", &just_numbers
,
1436 N_("use simple number sequence for output file names")),
1437 OPT_STRING(0, "suffix", &fmt_patch_suffix
, N_("sfx"),
1438 N_("use <sfx> instead of '.patch'")),
1439 OPT_INTEGER(0, "start-number", &start_number
,
1440 N_("start numbering patches at <n> instead of 1")),
1441 OPT_INTEGER('v', "reroll-count", &reroll_count
,
1442 N_("mark the series as Nth re-roll")),
1443 { OPTION_CALLBACK
, 0, "rfc", &rev
, NULL
,
1444 N_("Use [RFC PATCH] instead of [PATCH]"),
1445 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, rfc_callback
},
1446 { OPTION_CALLBACK
, 0, "subject-prefix", &rev
, N_("prefix"),
1447 N_("Use [<prefix>] instead of [PATCH]"),
1448 PARSE_OPT_NONEG
, subject_prefix_callback
},
1449 { OPTION_CALLBACK
, 'o', "output-directory", &output_directory
,
1450 N_("dir"), N_("store resulting files in <dir>"),
1451 PARSE_OPT_NONEG
, output_directory_callback
},
1452 { OPTION_CALLBACK
, 'k', "keep-subject", &rev
, NULL
,
1453 N_("don't strip/add [PATCH]"),
1454 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, keep_callback
},
1455 OPT_BOOL(0, "no-binary", &no_binary_diff
,
1456 N_("don't output binary diffs")),
1457 OPT_BOOL(0, "zero-commit", &zero_commit
,
1458 N_("output all-zero hash in From header")),
1459 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream
,
1460 N_("don't include a patch matching a commit upstream")),
1461 { OPTION_SET_INT
, 'p', "no-stat", &use_patch_format
, NULL
,
1462 N_("show patch format instead of default (patch + stat)"),
1463 PARSE_OPT_NONEG
| PARSE_OPT_NOARG
, NULL
, 1},
1464 OPT_GROUP(N_("Messaging")),
1465 { OPTION_CALLBACK
, 0, "add-header", NULL
, N_("header"),
1466 N_("add email header"), 0, header_callback
},
1467 { OPTION_CALLBACK
, 0, "to", NULL
, N_("email"), N_("add To: header"),
1469 { OPTION_CALLBACK
, 0, "cc", NULL
, N_("email"), N_("add Cc: header"),
1471 { OPTION_CALLBACK
, 0, "from", &from
, N_("ident"),
1472 N_("set From address to <ident> (or committer ident if absent)"),
1473 PARSE_OPT_OPTARG
, from_callback
},
1474 OPT_STRING(0, "in-reply-to", &in_reply_to
, N_("message-id"),
1475 N_("make first mail a reply to <message-id>")),
1476 { OPTION_CALLBACK
, 0, "attach", &rev
, N_("boundary"),
1477 N_("attach the patch"), PARSE_OPT_OPTARG
,
1479 { OPTION_CALLBACK
, 0, "inline", &rev
, N_("boundary"),
1480 N_("inline the patch"),
1481 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
1483 { OPTION_CALLBACK
, 0, "thread", &thread
, N_("style"),
1484 N_("enable message threading, styles: shallow, deep"),
1485 PARSE_OPT_OPTARG
, thread_callback
},
1486 OPT_STRING(0, "signature", &signature
, N_("signature"),
1487 N_("add a signature")),
1488 OPT_STRING(0, "base", &base_commit
, N_("base-commit"),
1489 N_("add prerequisite tree info to the patch series")),
1490 OPT_FILENAME(0, "signature-file", &signature_file
,
1491 N_("add a signature from a file")),
1492 OPT__QUIET(&quiet
, N_("don't print the patch filenames")),
1496 extra_hdr
.strdup_strings
= 1;
1497 extra_to
.strdup_strings
= 1;
1498 extra_cc
.strdup_strings
= 1;
1499 init_log_defaults();
1500 git_config(git_format_config
, NULL
);
1501 init_revisions(&rev
, prefix
);
1502 rev
.commit_format
= CMIT_FMT_EMAIL
;
1503 rev
.expand_tabs_in_log_default
= 0;
1504 rev
.verbose_header
= 1;
1506 rev
.max_parents
= 1;
1507 DIFF_OPT_SET(&rev
.diffopt
, RECURSIVE
);
1508 rev
.subject_prefix
= fmt_patch_subject_prefix
;
1509 memset(&s_r_opt
, 0, sizeof(s_r_opt
));
1510 s_r_opt
.def
= "HEAD";
1511 s_r_opt
.revarg_opt
= REVARG_COMMITTISH
;
1513 if (default_attach
) {
1514 rev
.mime_boundary
= default_attach
;
1519 * Parse the arguments before setup_revisions(), or something
1520 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1521 * possibly a valid SHA1.
1523 argc
= parse_options(argc
, argv
, prefix
, builtin_format_patch_options
,
1524 builtin_format_patch_usage
,
1525 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
1526 PARSE_OPT_KEEP_DASHDASH
);
1528 if (0 < reroll_count
) {
1529 struct strbuf sprefix
= STRBUF_INIT
;
1530 strbuf_addf(&sprefix
, "%s v%d",
1531 rev
.subject_prefix
, reroll_count
);
1532 rev
.reroll_count
= reroll_count
;
1533 rev
.subject_prefix
= strbuf_detach(&sprefix
, NULL
);
1536 for (i
= 0; i
< extra_hdr
.nr
; i
++) {
1537 strbuf_addstr(&buf
, extra_hdr
.items
[i
].string
);
1538 strbuf_addch(&buf
, '\n');
1542 strbuf_addstr(&buf
, "To: ");
1543 for (i
= 0; i
< extra_to
.nr
; i
++) {
1545 strbuf_addstr(&buf
, " ");
1546 strbuf_addstr(&buf
, extra_to
.items
[i
].string
);
1547 if (i
+ 1 < extra_to
.nr
)
1548 strbuf_addch(&buf
, ',');
1549 strbuf_addch(&buf
, '\n');
1553 strbuf_addstr(&buf
, "Cc: ");
1554 for (i
= 0; i
< extra_cc
.nr
; i
++) {
1556 strbuf_addstr(&buf
, " ");
1557 strbuf_addstr(&buf
, extra_cc
.items
[i
].string
);
1558 if (i
+ 1 < extra_cc
.nr
)
1559 strbuf_addch(&buf
, ',');
1560 strbuf_addch(&buf
, '\n');
1563 rev
.extra_headers
= strbuf_detach(&buf
, NULL
);
1566 if (split_ident_line(&rev
.from_ident
, from
, strlen(from
)))
1567 die(_("invalid ident line: %s"), from
);
1570 if (start_number
< 0)
1574 * If numbered is set solely due to format.numbered in config,
1575 * and it would conflict with --keep-subject (-k) from the
1576 * command line, reset "numbered".
1578 if (numbered
&& keep_subject
&& !numbered_cmdline_opt
)
1581 if (numbered
&& keep_subject
)
1582 die (_("-n and -k are mutually exclusive."));
1583 if (keep_subject
&& subject_prefix
)
1584 die (_("--subject-prefix/--rfc and -k are mutually exclusive."));
1585 rev
.preserve_subject
= keep_subject
;
1587 argc
= setup_revisions(argc
, argv
, &rev
, &s_r_opt
);
1589 die (_("unrecognized argument: %s"), argv
[1]);
1591 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME
)
1592 die(_("--name-only does not make sense"));
1593 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME_STATUS
)
1594 die(_("--name-status does not make sense"));
1595 if (rev
.diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
)
1596 die(_("--check does not make sense"));
1598 if (!use_patch_format
&&
1599 (!rev
.diffopt
.output_format
||
1600 rev
.diffopt
.output_format
== DIFF_FORMAT_PATCH
))
1601 rev
.diffopt
.output_format
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_SUMMARY
;
1603 /* Always generate a patch */
1604 rev
.diffopt
.output_format
|= DIFF_FORMAT_PATCH
;
1606 rev
.zero_commit
= zero_commit
;
1608 if (!DIFF_OPT_TST(&rev
.diffopt
, TEXT
) && !no_binary_diff
)
1609 DIFF_OPT_SET(&rev
.diffopt
, BINARY
);
1612 init_display_notes(&rev
.notes_opt
);
1614 if (!output_directory
&& !use_stdout
)
1615 output_directory
= config_output_directory
;
1618 output_directory
= set_outdir(prefix
, output_directory
);
1622 if (output_directory
) {
1623 if (rev
.diffopt
.use_color
!= GIT_COLOR_ALWAYS
)
1624 rev
.diffopt
.use_color
= GIT_COLOR_NEVER
;
1626 die(_("standard output, or directory, which one?"));
1627 if (mkdir(output_directory
, 0777) < 0 && errno
!= EEXIST
)
1628 die_errno(_("Could not create directory '%s'"),
1632 if (rev
.pending
.nr
== 1) {
1635 if (rev
.max_count
< 0 && !rev
.show_root_diff
) {
1637 * This is traditional behaviour of "git format-patch
1638 * origin" that prepares what the origin side still
1641 rev
.pending
.objects
[0].item
->flags
|= UNINTERESTING
;
1642 add_head_to_pending(&rev
);
1646 * Otherwise, it is "format-patch -22 HEAD", and/or
1647 * "format-patch --root HEAD". The user wants
1648 * get_revision() to do the usual traversal.
1651 if (!strcmp(rev
.pending
.objects
[0].name
, "HEAD"))
1655 struct object_id oid
;
1656 const char *ref
, *v
;
1657 ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
1659 if (ref
&& skip_prefix(ref
, "refs/heads/", &v
))
1660 branch_name
= xstrdup(v
);
1662 branch_name
= xstrdup(""); /* no branch */
1667 * We cannot move this anywhere earlier because we do want to
1668 * know if --root was given explicitly from the command line.
1670 rev
.show_root_diff
= 1;
1672 if (ignore_if_in_upstream
) {
1673 /* Don't say anything if head and upstream are the same. */
1674 if (rev
.pending
.nr
== 2) {
1675 struct object_array_entry
*o
= rev
.pending
.objects
;
1676 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1679 get_patch_ids(&rev
, &ids
);
1682 if (prepare_revision_walk(&rev
))
1683 die(_("revision walk setup failed"));
1685 while ((commit
= get_revision(&rev
)) != NULL
) {
1686 if (commit
->object
.flags
& BOUNDARY
) {
1688 origin
= (boundary_count
== 1) ? commit
: NULL
;
1692 if (ignore_if_in_upstream
&& has_commit_patch_id(commit
, &ids
))
1696 REALLOC_ARRAY(list
, nr
);
1697 list
[nr
- 1] = commit
;
1703 if (cover_letter
== -1) {
1704 if (config_cover_letter
== COVER_AUTO
)
1705 cover_letter
= (total
> 1);
1707 cover_letter
= (config_cover_letter
== COVER_ON
);
1709 if (!keep_subject
&& auto_number
&& (total
> 1 || cover_letter
))
1712 rev
.total
= total
+ start_number
- 1;
1715 ; /* --no-signature inhibits all signatures */
1716 } else if (signature
&& signature
!= git_version_string
) {
1717 ; /* non-default signature already set */
1718 } else if (signature_file
) {
1719 struct strbuf buf
= STRBUF_INIT
;
1721 if (strbuf_read_file(&buf
, signature_file
, 128) < 0)
1722 die_errno(_("unable to read signature file '%s'"), signature_file
);
1723 signature
= strbuf_detach(&buf
, NULL
);
1726 memset(&bases
, 0, sizeof(bases
));
1727 if (base_commit
|| base_auto
) {
1728 struct commit
*base
= get_base_commit(base_commit
, list
, nr
);
1729 reset_revision_walk();
1730 prepare_bases(&bases
, base
, list
, nr
);
1733 if (in_reply_to
|| thread
|| cover_letter
)
1734 rev
.ref_message_ids
= xcalloc(1, sizeof(struct string_list
));
1736 const char *msgid
= clean_message_id(in_reply_to
);
1737 string_list_append(rev
.ref_message_ids
, msgid
);
1739 rev
.numbered_files
= just_numbers
;
1740 rev
.patch_suffix
= fmt_patch_suffix
;
1743 gen_message_id(&rev
, "cover");
1744 make_cover_letter(&rev
, use_stdout
,
1745 origin
, nr
, list
, branch_name
, quiet
);
1746 print_bases(&bases
, rev
.diffopt
.file
);
1747 print_signature(rev
.diffopt
.file
);
1751 rev
.add_signoff
= do_signoff
;
1755 rev
.nr
= total
- nr
+ (start_number
- 1);
1756 /* Make the second and subsequent mails replies to the first */
1758 /* Have we already had a message ID? */
1759 if (rev
.message_id
) {
1761 * For deep threading: make every mail
1762 * a reply to the previous one, no
1763 * matter what other options are set.
1765 * For shallow threading:
1767 * Without --cover-letter and
1768 * --in-reply-to, make every mail a
1769 * reply to the one before.
1771 * With --in-reply-to but no
1772 * --cover-letter, make every mail a
1773 * reply to the <reply-to>.
1775 * With --cover-letter, make every
1776 * mail but the cover letter a reply
1777 * to the cover letter. The cover
1778 * letter is a reply to the
1779 * --in-reply-to, if specified.
1781 if (thread
== THREAD_SHALLOW
1782 && rev
.ref_message_ids
->nr
> 0
1783 && (!cover_letter
|| rev
.nr
> 1))
1784 free(rev
.message_id
);
1786 string_list_append(rev
.ref_message_ids
,
1789 gen_message_id(&rev
, oid_to_hex(&commit
->object
.oid
));
1793 open_next_file(rev
.numbered_files
? NULL
: commit
, NULL
, &rev
, quiet
))
1794 die(_("Failed to create output files"));
1795 shown
= log_tree_commit(&rev
, commit
);
1796 free_commit_buffer(commit
);
1798 /* We put one extra blank line between formatted
1799 * patches and this flag is used by log-tree code
1800 * to see if it needs to emit a LF before showing
1801 * the log; when using one file per patch, we do
1802 * not want the extra blank line.
1807 print_bases(&bases
, rev
.diffopt
.file
);
1808 if (rev
.mime_boundary
)
1809 fprintf(rev
.diffopt
.file
, "\n--%s%s--\n\n\n",
1810 mime_boundary_leader
,
1813 print_signature(rev
.diffopt
.file
);
1816 fclose(rev
.diffopt
.file
);
1820 string_list_clear(&extra_to
, 0);
1821 string_list_clear(&extra_cc
, 0);
1822 string_list_clear(&extra_hdr
, 0);
1823 if (ignore_if_in_upstream
)
1824 free_patch_ids(&ids
);
1828 static int add_pending_commit(const char *arg
, struct rev_info
*revs
, int flags
)
1830 struct object_id oid
;
1831 if (get_oid(arg
, &oid
) == 0) {
1832 struct commit
*commit
= lookup_commit_reference(&oid
);
1834 commit
->object
.flags
|= flags
;
1835 add_pending_object(revs
, &commit
->object
, arg
);
1842 static const char * const cherry_usage
[] = {
1843 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1847 static void print_commit(char sign
, struct commit
*commit
, int verbose
,
1848 int abbrev
, FILE *file
)
1851 fprintf(file
, "%c %s\n", sign
,
1852 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
));
1854 struct strbuf buf
= STRBUF_INIT
;
1855 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &buf
);
1856 fprintf(file
, "%c %s %s\n", sign
,
1857 find_unique_abbrev(commit
->object
.oid
.hash
, abbrev
),
1859 strbuf_release(&buf
);
1863 int cmd_cherry(int argc
, const char **argv
, const char *prefix
)
1865 struct rev_info revs
;
1866 struct patch_ids ids
;
1867 struct commit
*commit
;
1868 struct commit_list
*list
= NULL
;
1869 struct branch
*current_branch
;
1870 const char *upstream
;
1871 const char *head
= "HEAD";
1872 const char *limit
= NULL
;
1873 int verbose
= 0, abbrev
= 0;
1875 struct option options
[] = {
1876 OPT__ABBREV(&abbrev
),
1877 OPT__VERBOSE(&verbose
, N_("be verbose")),
1881 argc
= parse_options(argc
, argv
, prefix
, options
, cherry_usage
, 0);
1894 current_branch
= branch_get(NULL
);
1895 upstream
= branch_get_upstream(current_branch
, NULL
);
1897 fprintf(stderr
, _("Could not find a tracked"
1898 " remote branch, please"
1899 " specify <upstream> manually.\n"));
1900 usage_with_options(cherry_usage
, options
);
1904 init_revisions(&revs
, prefix
);
1905 revs
.max_parents
= 1;
1907 if (add_pending_commit(head
, &revs
, 0))
1908 die(_("Unknown commit %s"), head
);
1909 if (add_pending_commit(upstream
, &revs
, UNINTERESTING
))
1910 die(_("Unknown commit %s"), upstream
);
1912 /* Don't say anything if head and upstream are the same. */
1913 if (revs
.pending
.nr
== 2) {
1914 struct object_array_entry
*o
= revs
.pending
.objects
;
1915 if (oidcmp(&o
[0].item
->oid
, &o
[1].item
->oid
) == 0)
1919 get_patch_ids(&revs
, &ids
);
1921 if (limit
&& add_pending_commit(limit
, &revs
, UNINTERESTING
))
1922 die(_("Unknown commit %s"), limit
);
1924 /* reverse the list of commits */
1925 if (prepare_revision_walk(&revs
))
1926 die(_("revision walk setup failed"));
1927 while ((commit
= get_revision(&revs
)) != NULL
) {
1928 commit_list_insert(commit
, &list
);
1934 commit
= list
->item
;
1935 if (has_commit_patch_id(commit
, &ids
))
1937 print_commit(sign
, commit
, verbose
, abbrev
, revs
.diffopt
.file
);
1941 free_patch_ids(&ids
);