2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
7 #define USE_THE_INDEX_COMPATIBILITY_MACROS
11 #include "object-store.h"
19 #include "reflog-walk.h"
20 #include "patch-ids.h"
21 #include "run-command.h"
24 #include "string-list.h"
25 #include "parse-options.h"
28 #include "streaming.h"
31 #include "gpg-interface.h"
33 #include "commit-slab.h"
34 #include "repository.h"
35 #include "commit-reach.h"
36 #include "interdiff.h"
37 #include "range-diff.h"
39 #define MAIL_DEFAULT_WRAP 72
40 #define COVER_FROM_AUTO_MAX_SUBJECT_LEN 100
42 /* Set a default date-time format for git log ("log.date" config variable) */
43 static const char *default_date_mode
= NULL
;
45 static int default_abbrev_commit
;
46 static int default_show_root
= 1;
47 static int default_follow
;
48 static int default_show_signature
;
49 static int decoration_style
;
50 static int decoration_given
;
51 static int use_mailmap_config
= 1;
52 static const char *fmt_patch_subject_prefix
= "PATCH";
53 static const char *fmt_pretty
;
55 static const char * const builtin_log_usage
[] = {
56 N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
57 N_("git show [<options>] <object>..."),
61 struct line_opt_callback_data
{
64 struct string_list args
;
67 static int session_is_interactive(void)
69 return isatty(1) || pager_in_use();
72 static int auto_decoration_style(void)
74 return session_is_interactive() ? DECORATE_SHORT_REFS
: 0;
77 static int parse_decoration_style(const char *value
)
79 switch (git_parse_maybe_bool(value
)) {
81 return DECORATE_SHORT_REFS
;
87 if (!strcmp(value
, "full"))
88 return DECORATE_FULL_REFS
;
89 else if (!strcmp(value
, "short"))
90 return DECORATE_SHORT_REFS
;
91 else if (!strcmp(value
, "auto"))
92 return auto_decoration_style();
94 * Please update _git_log() in git-completion.bash when you
95 * add new decoration styles.
100 static int decorate_callback(const struct option
*opt
, const char *arg
, int unset
)
103 decoration_style
= 0;
105 decoration_style
= parse_decoration_style(arg
);
107 decoration_style
= DECORATE_SHORT_REFS
;
109 if (decoration_style
< 0)
110 die(_("invalid --decorate option: %s"), arg
);
112 decoration_given
= 1;
117 static int log_line_range_callback(const struct option
*option
, const char *arg
, int unset
)
119 struct line_opt_callback_data
*data
= option
->value
;
121 BUG_ON_OPT_NEG(unset
);
126 data
->rev
->line_level_traverse
= 1;
127 string_list_append(&data
->args
, arg
);
132 static void init_log_defaults(void)
134 init_grep_defaults(the_repository
);
135 init_diff_ui_defaults();
137 decoration_style
= auto_decoration_style();
140 static void cmd_log_init_defaults(struct rev_info
*rev
)
143 get_commit_format(fmt_pretty
, rev
);
145 rev
->diffopt
.flags
.default_follow_renames
= 1;
146 rev
->verbose_header
= 1;
147 rev
->diffopt
.flags
.recursive
= 1;
148 rev
->diffopt
.stat_width
= -1; /* use full terminal width */
149 rev
->diffopt
.stat_graph_width
= -1; /* respect statGraphWidth config */
150 rev
->abbrev_commit
= default_abbrev_commit
;
151 rev
->show_root_diff
= default_show_root
;
152 rev
->subject_prefix
= fmt_patch_subject_prefix
;
153 rev
->show_signature
= default_show_signature
;
154 rev
->diffopt
.flags
.allow_textconv
= 1;
156 if (default_date_mode
)
157 parse_date_format(default_date_mode
, &rev
->date_mode
);
160 static void cmd_log_init_finish(int argc
, const char **argv
, const char *prefix
,
161 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
163 struct userformat_want w
;
164 int quiet
= 0, source
= 0, mailmap
;
165 static struct line_opt_callback_data line_cb
= {NULL
, NULL
, STRING_LIST_INIT_DUP
};
166 static struct string_list decorate_refs_exclude
= STRING_LIST_INIT_NODUP
;
167 static struct string_list decorate_refs_include
= STRING_LIST_INIT_NODUP
;
168 struct decoration_filter decoration_filter
= {&decorate_refs_include
,
169 &decorate_refs_exclude
};
170 static struct revision_sources revision_sources
;
172 const struct option builtin_log_options
[] = {
173 OPT__QUIET(&quiet
, N_("suppress diff output")),
174 OPT_BOOL(0, "source", &source
, N_("show source")),
175 OPT_BOOL(0, "use-mailmap", &mailmap
, N_("Use mail map file")),
176 OPT_STRING_LIST(0, "decorate-refs", &decorate_refs_include
,
177 N_("pattern"), N_("only decorate refs that match <pattern>")),
178 OPT_STRING_LIST(0, "decorate-refs-exclude", &decorate_refs_exclude
,
179 N_("pattern"), N_("do not decorate refs that match <pattern>")),
180 { OPTION_CALLBACK
, 0, "decorate", NULL
, NULL
, N_("decorate options"),
181 PARSE_OPT_OPTARG
, decorate_callback
},
182 OPT_CALLBACK('L', NULL
, &line_cb
, "n,m:file",
183 N_("Process line range n,m in file, counting from 1"),
184 log_line_range_callback
),
189 line_cb
.prefix
= prefix
;
191 mailmap
= use_mailmap_config
;
192 argc
= parse_options(argc
, argv
, prefix
,
193 builtin_log_options
, builtin_log_usage
,
194 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
195 PARSE_OPT_KEEP_DASHDASH
);
198 rev
->diffopt
.output_format
|= DIFF_FORMAT_NO_OUTPUT
;
199 argc
= setup_revisions(argc
, argv
, rev
, opt
);
201 /* Any arguments at this point are not recognized */
203 die(_("unrecognized argument: %s"), argv
[1]);
205 memset(&w
, 0, sizeof(w
));
206 userformat_find_requirements(NULL
, &w
);
208 if (!rev
->show_notes_given
&& (!rev
->pretty_given
|| w
.notes
))
211 init_display_notes(&rev
->notes_opt
);
213 if ((rev
->diffopt
.pickaxe_opts
& DIFF_PICKAXE_KINDS_MASK
) ||
214 rev
->diffopt
.filter
|| rev
->diffopt
.flags
.follow_renames
)
215 rev
->always_show_header
= 0;
217 if (source
|| w
.source
) {
218 init_revision_sources(&revision_sources
);
219 rev
->sources
= &revision_sources
;
223 rev
->mailmap
= xcalloc(1, sizeof(struct string_list
));
224 read_mailmap(rev
->mailmap
, NULL
);
227 if (rev
->pretty_given
&& rev
->commit_format
== CMIT_FMT_RAW
) {
229 * "log --pretty=raw" is special; ignore UI oriented
230 * configuration variables such as decoration.
232 if (!decoration_given
)
233 decoration_style
= 0;
234 if (!rev
->abbrev_commit_given
)
235 rev
->abbrev_commit
= 0;
238 if (decoration_style
) {
239 rev
->show_decorations
= 1;
240 load_ref_decorations(&decoration_filter
, decoration_style
);
243 if (rev
->line_level_traverse
)
244 line_log_init(rev
, line_cb
.prefix
, &line_cb
.args
);
249 static void cmd_log_init(int argc
, const char **argv
, const char *prefix
,
250 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
252 cmd_log_init_defaults(rev
);
253 cmd_log_init_finish(argc
, argv
, prefix
, rev
, opt
);
257 * This gives a rough estimate for how many commits we
258 * will print out in the list.
260 static int estimate_commit_count(struct commit_list
*list
)
265 struct commit
*commit
= list
->item
;
266 unsigned int flags
= commit
->object
.flags
;
268 if (!(flags
& (TREESAME
| UNINTERESTING
)))
274 static void show_early_header(struct rev_info
*rev
, const char *stage
, int nr
)
276 if (rev
->shown_one
) {
278 if (rev
->commit_format
!= CMIT_FMT_ONELINE
)
279 putchar(rev
->diffopt
.line_termination
);
281 fprintf(rev
->diffopt
.file
, _("Final output: %d %s\n"), nr
, stage
);
284 static struct itimerval early_output_timer
;
286 static void log_show_early(struct rev_info
*revs
, struct commit_list
*list
)
288 int i
= revs
->early_output
, close_file
= revs
->diffopt
.close_file
;
291 revs
->diffopt
.close_file
= 0;
292 sort_in_topological_order(&list
, revs
->sort_order
);
294 struct commit
*commit
= list
->item
;
295 switch (simplify_commit(revs
, commit
)) {
298 int n
= estimate_commit_count(list
);
299 show_early_header(revs
, "incomplete", n
);
302 log_tree_commit(revs
, commit
);
309 fclose(revs
->diffopt
.file
);
315 /* Did we already get enough commits for the early output? */
318 fclose(revs
->diffopt
.file
);
323 * ..if no, then repeat it twice a second until we
326 * NOTE! We don't use "it_interval", because if the
327 * reader isn't listening, we want our output to be
328 * throttled by the writing, and not have the timer
329 * trigger every second even if we're blocked on a
332 early_output_timer
.it_value
.tv_sec
= 0;
333 early_output_timer
.it_value
.tv_usec
= 500000;
334 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
337 static void early_output(int signal
)
339 show_early_output
= log_show_early
;
342 static void setup_early_output(void)
347 * Set up the signal handler, minimally intrusively:
348 * we only set a single volatile integer word (not
349 * using sigatomic_t - trying to avoid unnecessary
350 * system dependencies and headers), and using
353 memset(&sa
, 0, sizeof(sa
));
354 sa
.sa_handler
= early_output
;
355 sigemptyset(&sa
.sa_mask
);
356 sa
.sa_flags
= SA_RESTART
;
357 sigaction(SIGALRM
, &sa
, NULL
);
360 * If we can get the whole output in less than a
361 * tenth of a second, don't even bother doing the
362 * early-output thing..
364 * This is a one-time-only trigger.
366 early_output_timer
.it_value
.tv_sec
= 0;
367 early_output_timer
.it_value
.tv_usec
= 100000;
368 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
371 static void finish_early_output(struct rev_info
*rev
)
373 int n
= estimate_commit_count(rev
->commits
);
374 signal(SIGALRM
, SIG_IGN
);
375 show_early_header(rev
, "done", n
);
378 static int cmd_log_walk(struct rev_info
*rev
)
380 struct commit
*commit
;
382 int saved_dcctc
= 0, close_file
= rev
->diffopt
.close_file
;
384 if (rev
->early_output
)
385 setup_early_output();
387 if (prepare_revision_walk(rev
))
388 die(_("revision walk setup failed"));
390 if (rev
->early_output
)
391 finish_early_output(rev
);
394 * For --check and --exit-code, the exit code is based on CHECK_FAILED
395 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
396 * retain that state information if replacing rev->diffopt in this loop
398 rev
->diffopt
.close_file
= 0;
399 while ((commit
= get_revision(rev
)) != NULL
) {
400 if (!log_tree_commit(rev
, commit
) && rev
->max_count
>= 0)
402 * We decremented max_count in get_revision,
403 * but we didn't actually show the commit.
406 if (!rev
->reflog_info
) {
408 * We may show a given commit multiple times when
409 * walking the reflogs.
411 free_commit_buffer(the_repository
->parsed_objects
,
413 free_commit_list(commit
->parents
);
414 commit
->parents
= NULL
;
416 if (saved_nrl
< rev
->diffopt
.needed_rename_limit
)
417 saved_nrl
= rev
->diffopt
.needed_rename_limit
;
418 if (rev
->diffopt
.degraded_cc_to_c
)
421 rev
->diffopt
.degraded_cc_to_c
= saved_dcctc
;
422 rev
->diffopt
.needed_rename_limit
= saved_nrl
;
424 fclose(rev
->diffopt
.file
);
426 if (rev
->diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
&&
427 rev
->diffopt
.flags
.check_failed
) {
430 return diff_result_code(&rev
->diffopt
, 0);
433 static int git_log_config(const char *var
, const char *value
, void *cb
)
435 const char *slot_name
;
437 if (!strcmp(var
, "format.pretty"))
438 return git_config_string(&fmt_pretty
, var
, value
);
439 if (!strcmp(var
, "format.subjectprefix"))
440 return git_config_string(&fmt_patch_subject_prefix
, var
, value
);
441 if (!strcmp(var
, "log.abbrevcommit")) {
442 default_abbrev_commit
= git_config_bool(var
, value
);
445 if (!strcmp(var
, "log.date"))
446 return git_config_string(&default_date_mode
, var
, value
);
447 if (!strcmp(var
, "log.decorate")) {
448 decoration_style
= parse_decoration_style(value
);
449 if (decoration_style
< 0)
450 decoration_style
= 0; /* maybe warn? */
453 if (!strcmp(var
, "log.showroot")) {
454 default_show_root
= git_config_bool(var
, value
);
457 if (!strcmp(var
, "log.follow")) {
458 default_follow
= git_config_bool(var
, value
);
461 if (skip_prefix(var
, "color.decorate.", &slot_name
))
462 return parse_decorate_color_config(var
, slot_name
, value
);
463 if (!strcmp(var
, "log.mailmap")) {
464 use_mailmap_config
= git_config_bool(var
, value
);
467 if (!strcmp(var
, "log.showsignature")) {
468 default_show_signature
= git_config_bool(var
, value
);
472 if (grep_config(var
, value
, cb
) < 0)
474 if (git_gpg_config(var
, value
, cb
) < 0)
476 return git_diff_ui_config(var
, value
, cb
);
479 int cmd_whatchanged(int argc
, const char **argv
, const char *prefix
)
482 struct setup_revision_opt opt
;
485 git_config(git_log_config
, NULL
);
487 repo_init_revisions(the_repository
, &rev
, prefix
);
489 rev
.simplify_history
= 0;
490 memset(&opt
, 0, sizeof(opt
));
492 opt
.revarg_opt
= REVARG_COMMITTISH
;
493 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
494 if (!rev
.diffopt
.output_format
)
495 rev
.diffopt
.output_format
= DIFF_FORMAT_RAW
;
496 return cmd_log_walk(&rev
);
499 static void show_tagger(const char *buf
, struct rev_info
*rev
)
501 struct strbuf out
= STRBUF_INIT
;
502 struct pretty_print_context pp
= {0};
504 pp
.fmt
= rev
->commit_format
;
505 pp
.date_mode
= rev
->date_mode
;
506 pp_user_info(&pp
, "Tagger", &out
, buf
, get_log_output_encoding());
507 fprintf(rev
->diffopt
.file
, "%s", out
.buf
);
508 strbuf_release(&out
);
511 static int show_blob_object(const struct object_id
*oid
, struct rev_info
*rev
, const char *obj_name
)
513 struct object_id oidc
;
514 struct object_context obj_context
;
518 fflush(rev
->diffopt
.file
);
519 if (!rev
->diffopt
.flags
.textconv_set_via_cmdline
||
520 !rev
->diffopt
.flags
.allow_textconv
)
521 return stream_blob_to_fd(1, oid
, NULL
, 0);
523 if (get_oid_with_context(the_repository
, obj_name
,
525 &oidc
, &obj_context
))
526 die(_("not a valid object name %s"), obj_name
);
527 if (!obj_context
.path
||
528 !textconv_object(the_repository
, obj_context
.path
,
529 obj_context
.mode
, &oidc
, 1, &buf
, &size
)) {
530 free(obj_context
.path
);
531 return stream_blob_to_fd(1, oid
, NULL
, 0);
535 die(_("git show %s: bad file"), obj_name
);
537 write_or_die(1, buf
, size
);
538 free(obj_context
.path
);
542 static int show_tag_object(const struct object_id
*oid
, struct rev_info
*rev
)
545 enum object_type type
;
546 char *buf
= read_object_file(oid
, &type
, &size
);
550 return error(_("could not read object %s"), oid_to_hex(oid
));
552 assert(type
== OBJ_TAG
);
553 while (offset
< size
&& buf
[offset
] != '\n') {
554 int new_offset
= offset
+ 1;
556 while (new_offset
< size
&& buf
[new_offset
++] != '\n')
558 if (skip_prefix(buf
+ offset
, "tagger ", &ident
))
559 show_tagger(ident
, rev
);
564 fwrite(buf
+ offset
, size
- offset
, 1, rev
->diffopt
.file
);
569 static int show_tree_object(const struct object_id
*oid
,
571 const char *pathname
, unsigned mode
, int stage
, void *context
)
573 FILE *file
= context
;
574 fprintf(file
, "%s%s\n", pathname
, S_ISDIR(mode
) ? "/" : "");
578 static void show_setup_revisions_tweak(struct rev_info
*rev
,
579 struct setup_revision_opt
*opt
)
581 if (rev
->ignore_merges
) {
582 /* There was no "-m" on the command line */
583 rev
->ignore_merges
= 0;
584 if (!rev
->first_parent_only
&& !rev
->combine_merges
) {
585 /* No "--first-parent", "-c", or "--cc" */
586 rev
->combine_merges
= 1;
587 rev
->dense_combined_merges
= 1;
590 if (!rev
->diffopt
.output_format
)
591 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
594 int cmd_show(int argc
, const char **argv
, const char *prefix
)
597 struct object_array_entry
*objects
;
598 struct setup_revision_opt opt
;
599 struct pathspec match_all
;
600 int i
, count
, ret
= 0;
603 git_config(git_log_config
, NULL
);
605 memset(&match_all
, 0, sizeof(match_all
));
606 repo_init_revisions(the_repository
, &rev
, prefix
);
608 rev
.always_show_header
= 1;
609 rev
.no_walk
= REVISION_WALK_NO_WALK_SORTED
;
610 rev
.diffopt
.stat_width
= -1; /* Scale to real terminal size */
612 memset(&opt
, 0, sizeof(opt
));
614 opt
.tweak
= show_setup_revisions_tweak
;
615 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
618 return cmd_log_walk(&rev
);
620 count
= rev
.pending
.nr
;
621 objects
= rev
.pending
.objects
;
622 for (i
= 0; i
< count
&& !ret
; i
++) {
623 struct object
*o
= objects
[i
].item
;
624 const char *name
= objects
[i
].name
;
627 ret
= show_blob_object(&o
->oid
, &rev
, name
);
630 struct tag
*t
= (struct tag
*)o
;
634 fprintf(rev
.diffopt
.file
, "%stag %s%s\n",
635 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
637 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
638 ret
= show_tag_object(&o
->oid
, &rev
);
642 o
= parse_object(the_repository
, &t
->tagged
->oid
);
644 ret
= error(_("could not read object %s"),
645 oid_to_hex(&t
->tagged
->oid
));
653 fprintf(rev
.diffopt
.file
, "%stree %s%s\n\n",
654 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
656 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
657 read_tree_recursive(the_repository
, (struct tree
*)o
, "",
658 0, 0, &match_all
, show_tree_object
,
663 rev
.pending
.nr
= rev
.pending
.alloc
= 0;
664 rev
.pending
.objects
= NULL
;
665 add_object_array(o
, name
, &rev
.pending
);
666 ret
= cmd_log_walk(&rev
);
669 ret
= error(_("unknown type: %d"), o
->type
);
677 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
679 int cmd_log_reflog(int argc
, const char **argv
, const char *prefix
)
682 struct setup_revision_opt opt
;
685 git_config(git_log_config
, NULL
);
687 repo_init_revisions(the_repository
, &rev
, prefix
);
688 init_reflog_walk(&rev
.reflog_info
);
689 rev
.verbose_header
= 1;
690 memset(&opt
, 0, sizeof(opt
));
692 cmd_log_init_defaults(&rev
);
693 rev
.abbrev_commit
= 1;
694 rev
.commit_format
= CMIT_FMT_ONELINE
;
695 rev
.use_terminator
= 1;
696 rev
.always_show_header
= 1;
697 cmd_log_init_finish(argc
, argv
, prefix
, &rev
, &opt
);
699 return cmd_log_walk(&rev
);
702 static void log_setup_revisions_tweak(struct rev_info
*rev
,
703 struct setup_revision_opt
*opt
)
705 if (rev
->diffopt
.flags
.default_follow_renames
&&
706 rev
->prune_data
.nr
== 1)
707 rev
->diffopt
.flags
.follow_renames
= 1;
709 /* Turn --cc/-c into -p --cc/-c when -p was not given */
710 if (!rev
->diffopt
.output_format
&& rev
->combine_merges
)
711 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
713 /* Turn -m on when --cc/-c was given */
714 if (rev
->combine_merges
)
715 rev
->ignore_merges
= 0;
718 int cmd_log(int argc
, const char **argv
, const char *prefix
)
721 struct setup_revision_opt opt
;
724 git_config(git_log_config
, NULL
);
726 repo_init_revisions(the_repository
, &rev
, prefix
);
727 rev
.always_show_header
= 1;
728 memset(&opt
, 0, sizeof(opt
));
730 opt
.revarg_opt
= REVARG_COMMITTISH
;
731 opt
.tweak
= log_setup_revisions_tweak
;
732 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
733 return cmd_log_walk(&rev
);
738 static const char *fmt_patch_suffix
= ".patch";
739 static int numbered
= 0;
740 static int auto_number
= 1;
742 static char *default_attach
= NULL
;
744 static struct string_list extra_hdr
= STRING_LIST_INIT_NODUP
;
745 static struct string_list extra_to
= STRING_LIST_INIT_NODUP
;
746 static struct string_list extra_cc
= STRING_LIST_INIT_NODUP
;
748 static void add_header(const char *value
)
750 struct string_list_item
*item
;
751 int len
= strlen(value
);
752 while (len
&& value
[len
- 1] == '\n')
755 if (!strncasecmp(value
, "to: ", 4)) {
756 item
= string_list_append(&extra_to
, value
+ 4);
758 } else if (!strncasecmp(value
, "cc: ", 4)) {
759 item
= string_list_append(&extra_cc
, value
+ 4);
762 item
= string_list_append(&extra_hdr
, value
);
765 item
->string
[len
] = '\0';
781 enum cover_from_description
{
788 static enum thread_level thread
;
789 static int do_signoff
;
790 static int base_auto
;
792 static const char *signature
= git_version_string
;
793 static const char *signature_file
;
794 static enum cover_setting config_cover_letter
;
795 static const char *config_output_directory
;
796 static enum cover_from_description cover_from_description_mode
= COVER_FROM_MESSAGE
;
798 static enum cover_from_description
parse_cover_from_description(const char *arg
)
800 if (!arg
|| !strcmp(arg
, "default"))
801 return COVER_FROM_MESSAGE
;
802 else if (!strcmp(arg
, "none"))
803 return COVER_FROM_NONE
;
804 else if (!strcmp(arg
, "message"))
805 return COVER_FROM_MESSAGE
;
806 else if (!strcmp(arg
, "subject"))
807 return COVER_FROM_SUBJECT
;
808 else if (!strcmp(arg
, "auto"))
809 return COVER_FROM_AUTO
;
811 die(_("%s: invalid cover from description mode"), arg
);
814 static int git_format_config(const char *var
, const char *value
, void *cb
)
816 struct rev_info
*rev
= cb
;
818 if (!strcmp(var
, "format.headers")) {
820 die(_("format.headers without value"));
824 if (!strcmp(var
, "format.suffix"))
825 return git_config_string(&fmt_patch_suffix
, var
, value
);
826 if (!strcmp(var
, "format.to")) {
828 return config_error_nonbool(var
);
829 string_list_append(&extra_to
, value
);
832 if (!strcmp(var
, "format.cc")) {
834 return config_error_nonbool(var
);
835 string_list_append(&extra_cc
, value
);
838 if (!strcmp(var
, "diff.color") || !strcmp(var
, "color.diff") ||
839 !strcmp(var
, "color.ui") || !strcmp(var
, "diff.submodule")) {
842 if (!strcmp(var
, "format.numbered")) {
843 if (value
&& !strcasecmp(value
, "auto")) {
847 numbered
= git_config_bool(var
, value
);
848 auto_number
= auto_number
&& numbered
;
851 if (!strcmp(var
, "format.attach")) {
853 default_attach
= xstrdup(value
);
855 default_attach
= xstrdup(git_version_string
);
858 if (!strcmp(var
, "format.thread")) {
859 if (value
&& !strcasecmp(value
, "deep")) {
860 thread
= THREAD_DEEP
;
863 if (value
&& !strcasecmp(value
, "shallow")) {
864 thread
= THREAD_SHALLOW
;
867 thread
= git_config_bool(var
, value
) ? THREAD_SHALLOW
: THREAD_UNSET
;
870 if (!strcmp(var
, "format.signoff")) {
871 do_signoff
= git_config_bool(var
, value
);
874 if (!strcmp(var
, "format.signature"))
875 return git_config_string(&signature
, var
, value
);
876 if (!strcmp(var
, "format.signaturefile"))
877 return git_config_pathname(&signature_file
, var
, value
);
878 if (!strcmp(var
, "format.coverletter")) {
879 if (value
&& !strcasecmp(value
, "auto")) {
880 config_cover_letter
= COVER_AUTO
;
883 config_cover_letter
= git_config_bool(var
, value
) ? COVER_ON
: COVER_OFF
;
886 if (!strcmp(var
, "format.outputdirectory"))
887 return git_config_string(&config_output_directory
, var
, value
);
888 if (!strcmp(var
, "format.useautobase")) {
889 base_auto
= git_config_bool(var
, value
);
892 if (!strcmp(var
, "format.from")) {
893 int b
= git_parse_maybe_bool(value
);
896 from
= xstrdup(value
);
898 from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
903 if (!strcmp(var
, "format.notes")) {
904 struct strbuf buf
= STRBUF_INIT
;
905 int b
= git_parse_maybe_bool(value
);
910 strbuf_addstr(&buf
, value
);
911 expand_notes_ref(&buf
);
912 string_list_append(&rev
->notes_opt
.extra_notes_refs
,
913 strbuf_detach(&buf
, NULL
));
915 rev
->notes_opt
.use_default_notes
= 1;
919 if (!strcmp(var
, "format.coverfromdescription")) {
920 cover_from_description_mode
= parse_cover_from_description(value
);
924 return git_log_config(var
, value
, cb
);
927 static const char *output_directory
= NULL
;
928 static int outdir_offset
;
930 static int open_next_file(struct commit
*commit
, const char *subject
,
931 struct rev_info
*rev
, int quiet
)
933 struct strbuf filename
= STRBUF_INIT
;
934 int suffix_len
= strlen(rev
->patch_suffix
) + 1;
936 if (output_directory
) {
937 strbuf_addstr(&filename
, output_directory
);
939 PATH_MAX
- FORMAT_PATCH_NAME_MAX
- suffix_len
) {
940 strbuf_release(&filename
);
941 return error(_("name of output directory is too long"));
943 strbuf_complete(&filename
, '/');
946 if (rev
->numbered_files
)
947 strbuf_addf(&filename
, "%d", rev
->nr
);
949 fmt_output_commit(&filename
, commit
, rev
);
951 fmt_output_subject(&filename
, subject
, rev
);
954 printf("%s\n", filename
.buf
+ outdir_offset
);
956 if ((rev
->diffopt
.file
= fopen(filename
.buf
, "w")) == NULL
) {
957 error_errno(_("cannot open patch file %s"), filename
.buf
);
958 strbuf_release(&filename
);
962 strbuf_release(&filename
);
966 static void get_patch_ids(struct rev_info
*rev
, struct patch_ids
*ids
)
968 struct rev_info check_rev
;
969 struct commit
*commit
, *c1
, *c2
;
970 struct object
*o1
, *o2
;
971 unsigned flags1
, flags2
;
973 if (rev
->pending
.nr
!= 2)
974 die(_("need exactly one range"));
976 o1
= rev
->pending
.objects
[0].item
;
977 o2
= rev
->pending
.objects
[1].item
;
980 c1
= lookup_commit_reference(the_repository
, &o1
->oid
);
981 c2
= lookup_commit_reference(the_repository
, &o2
->oid
);
983 if ((flags1
& UNINTERESTING
) == (flags2
& UNINTERESTING
))
984 die(_("not a range"));
986 init_patch_ids(the_repository
, ids
);
988 /* given a range a..b get all patch ids for b..a */
989 repo_init_revisions(the_repository
, &check_rev
, rev
->prefix
);
990 check_rev
.max_parents
= 1;
991 o1
->flags
^= UNINTERESTING
;
992 o2
->flags
^= UNINTERESTING
;
993 add_pending_object(&check_rev
, o1
, "o1");
994 add_pending_object(&check_rev
, o2
, "o2");
995 if (prepare_revision_walk(&check_rev
))
996 die(_("revision walk setup failed"));
998 while ((commit
= get_revision(&check_rev
)) != NULL
) {
999 add_commit_patch_id(commit
, ids
);
1002 /* reset for next revision walk */
1003 clear_commit_marks(c1
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
1004 clear_commit_marks(c2
, SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
1009 static void gen_message_id(struct rev_info
*info
, char *base
)
1011 struct strbuf buf
= STRBUF_INIT
;
1012 strbuf_addf(&buf
, "%s.%"PRItime
".git.%s", base
,
1013 (timestamp_t
) time(NULL
),
1014 git_committer_info(IDENT_NO_NAME
|IDENT_NO_DATE
|IDENT_STRICT
));
1015 info
->message_id
= strbuf_detach(&buf
, NULL
);
1018 static void print_signature(FILE *file
)
1020 if (!signature
|| !*signature
)
1023 fprintf(file
, "-- \n%s", signature
);
1024 if (signature
[strlen(signature
)-1] != '\n')
1029 static char *find_branch_name(struct rev_info
*rev
)
1031 int i
, positive
= -1;
1032 struct object_id branch_oid
;
1033 const struct object_id
*tip_oid
;
1034 const char *ref
, *v
;
1035 char *full_ref
, *branch
= NULL
;
1037 for (i
= 0; i
< rev
->cmdline
.nr
; i
++) {
1038 if (rev
->cmdline
.rev
[i
].flags
& UNINTERESTING
)
1047 ref
= rev
->cmdline
.rev
[positive
].name
;
1048 tip_oid
= &rev
->cmdline
.rev
[positive
].item
->oid
;
1049 if (dwim_ref(ref
, strlen(ref
), &branch_oid
, &full_ref
) &&
1050 skip_prefix(full_ref
, "refs/heads/", &v
) &&
1051 oideq(tip_oid
, &branch_oid
))
1052 branch
= xstrdup(v
);
1057 static void show_diffstat(struct rev_info
*rev
,
1058 struct commit
*origin
, struct commit
*head
)
1060 struct diff_options opts
;
1062 memcpy(&opts
, &rev
->diffopt
, sizeof(opts
));
1063 opts
.output_format
= DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
1064 diff_setup_done(&opts
);
1066 diff_tree_oid(get_commit_tree_oid(origin
),
1067 get_commit_tree_oid(head
),
1069 diffcore_std(&opts
);
1072 fprintf(rev
->diffopt
.file
, "\n");
1075 static void prepare_cover_text(struct pretty_print_context
*pp
,
1076 const char *branch_name
,
1078 const char *encoding
,
1081 const char *subject
= "*** SUBJECT HERE ***";
1082 const char *body
= "*** BLURB HERE ***";
1083 struct strbuf description_sb
= STRBUF_INIT
;
1084 struct strbuf subject_sb
= STRBUF_INIT
;
1086 if (cover_from_description_mode
== COVER_FROM_NONE
)
1089 if (branch_name
&& *branch_name
)
1090 read_branch_desc(&description_sb
, branch_name
);
1091 if (!description_sb
.len
)
1094 if (cover_from_description_mode
== COVER_FROM_SUBJECT
||
1095 cover_from_description_mode
== COVER_FROM_AUTO
)
1096 body
= format_subject(&subject_sb
, description_sb
.buf
, " ");
1098 if (cover_from_description_mode
== COVER_FROM_MESSAGE
||
1099 (cover_from_description_mode
== COVER_FROM_AUTO
&&
1100 subject_sb
.len
> COVER_FROM_AUTO_MAX_SUBJECT_LEN
))
1101 body
= description_sb
.buf
;
1103 subject
= subject_sb
.buf
;
1106 pp_title_line(pp
, &subject
, sb
, encoding
, need_8bit_cte
);
1107 pp_remainder(pp
, &body
, sb
, 0);
1109 strbuf_release(&description_sb
);
1110 strbuf_release(&subject_sb
);
1113 static void make_cover_letter(struct rev_info
*rev
, int use_stdout
,
1114 struct commit
*origin
,
1115 int nr
, struct commit
**list
,
1116 const char *branch_name
,
1119 const char *committer
;
1120 struct shortlog log
;
1121 struct strbuf sb
= STRBUF_INIT
;
1123 const char *encoding
= "UTF-8";
1124 int need_8bit_cte
= 0;
1125 struct pretty_print_context pp
= {0};
1126 struct commit
*head
= list
[0];
1128 if (!cmit_fmt_is_mail(rev
->commit_format
))
1129 die(_("cover letter needs email format"));
1131 committer
= git_committer_info(0);
1134 open_next_file(NULL
, rev
->numbered_files
? NULL
: "cover-letter", rev
, quiet
))
1135 die(_("failed to create cover-letter file"));
1137 log_write_email_headers(rev
, head
, &pp
.after_subject
, &need_8bit_cte
, 0);
1139 for (i
= 0; !need_8bit_cte
&& i
< nr
; i
++) {
1140 const char *buf
= get_commit_buffer(list
[i
], NULL
);
1141 if (has_non_ascii(buf
))
1143 unuse_commit_buffer(list
[i
], buf
);
1147 branch_name
= find_branch_name(rev
);
1149 pp
.fmt
= CMIT_FMT_EMAIL
;
1150 pp
.date_mode
.type
= DATE_RFC2822
;
1152 pp
.print_email_subject
= 1;
1153 pp_user_info(&pp
, NULL
, &sb
, committer
, encoding
);
1154 prepare_cover_text(&pp
, branch_name
, &sb
, encoding
, need_8bit_cte
);
1155 fprintf(rev
->diffopt
.file
, "%s\n", sb
.buf
);
1157 strbuf_release(&sb
);
1159 shortlog_init(&log
);
1161 log
.wrap
= MAIL_DEFAULT_WRAP
;
1164 log
.file
= rev
->diffopt
.file
;
1165 for (i
= 0; i
< nr
; i
++)
1166 shortlog_add_commit(&log
, list
[i
]);
1168 shortlog_output(&log
);
1170 /* We can only do diffstat with a unique reference point */
1172 show_diffstat(rev
, origin
, head
);
1174 if (rev
->idiff_oid1
) {
1175 fprintf_ln(rev
->diffopt
.file
, "%s", rev
->idiff_title
);
1176 show_interdiff(rev
, 0);
1181 * Pass minimum required diff-options to range-diff; others
1182 * can be added later if deemed desirable.
1184 struct diff_options opts
;
1186 opts
.file
= rev
->diffopt
.file
;
1187 opts
.use_color
= rev
->diffopt
.use_color
;
1188 diff_setup_done(&opts
);
1189 fprintf_ln(rev
->diffopt
.file
, "%s", rev
->rdiff_title
);
1190 show_range_diff(rev
->rdiff1
, rev
->rdiff2
,
1191 rev
->creation_factor
, 1, &opts
);
1195 static const char *clean_message_id(const char *msg_id
)
1198 const char *a
, *z
, *m
;
1201 while ((ch
= *m
) && (isspace(ch
) || (ch
== '<')))
1206 if (!isspace(ch
) && (ch
!= '>'))
1211 die(_("insane in-reply-to: %s"), msg_id
);
1214 return xmemdupz(a
, z
- a
);
1217 static const char *set_outdir(const char *prefix
, const char *output_directory
)
1219 if (output_directory
&& is_absolute_path(output_directory
))
1220 return output_directory
;
1222 if (!prefix
|| !*prefix
) {
1223 if (output_directory
)
1224 return output_directory
;
1225 /* The user did not explicitly ask for "./" */
1230 outdir_offset
= strlen(prefix
);
1231 if (!output_directory
)
1234 return prefix_filename(prefix
, output_directory
);
1237 static const char * const builtin_format_patch_usage
[] = {
1238 N_("git format-patch [<options>] [<since> | <revision-range>]"),
1242 static int keep_subject
= 0;
1244 static int keep_callback(const struct option
*opt
, const char *arg
, int unset
)
1246 BUG_ON_OPT_NEG(unset
);
1247 BUG_ON_OPT_ARG(arg
);
1248 ((struct rev_info
*)opt
->value
)->total
= -1;
1253 static int subject_prefix
= 0;
1255 static int subject_prefix_callback(const struct option
*opt
, const char *arg
,
1258 BUG_ON_OPT_NEG(unset
);
1260 ((struct rev_info
*)opt
->value
)->subject_prefix
= arg
;
1264 static int rfc_callback(const struct option
*opt
, const char *arg
, int unset
)
1266 BUG_ON_OPT_NEG(unset
);
1267 BUG_ON_OPT_ARG(arg
);
1268 return subject_prefix_callback(opt
, "RFC PATCH", unset
);
1271 static int numbered_cmdline_opt
= 0;
1273 static int numbered_callback(const struct option
*opt
, const char *arg
,
1276 BUG_ON_OPT_ARG(arg
);
1277 *(int *)opt
->value
= numbered_cmdline_opt
= unset
? 0 : 1;
1283 static int no_numbered_callback(const struct option
*opt
, const char *arg
,
1286 BUG_ON_OPT_NEG(unset
);
1287 return numbered_callback(opt
, arg
, 1);
1290 static int output_directory_callback(const struct option
*opt
, const char *arg
,
1293 const char **dir
= (const char **)opt
->value
;
1294 BUG_ON_OPT_NEG(unset
);
1296 die(_("two output directories?"));
1301 static int thread_callback(const struct option
*opt
, const char *arg
, int unset
)
1303 enum thread_level
*thread
= (enum thread_level
*)opt
->value
;
1305 *thread
= THREAD_UNSET
;
1306 else if (!arg
|| !strcmp(arg
, "shallow"))
1307 *thread
= THREAD_SHALLOW
;
1308 else if (!strcmp(arg
, "deep"))
1309 *thread
= THREAD_DEEP
;
1311 * Please update _git_formatpatch() in git-completion.bash
1312 * when you add new options.
1319 static int attach_callback(const struct option
*opt
, const char *arg
, int unset
)
1321 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1323 rev
->mime_boundary
= NULL
;
1325 rev
->mime_boundary
= arg
;
1327 rev
->mime_boundary
= git_version_string
;
1328 rev
->no_inline
= unset
? 0 : 1;
1332 static int inline_callback(const struct option
*opt
, const char *arg
, int unset
)
1334 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
1336 rev
->mime_boundary
= NULL
;
1338 rev
->mime_boundary
= arg
;
1340 rev
->mime_boundary
= git_version_string
;
1345 static int header_callback(const struct option
*opt
, const char *arg
, int unset
)
1348 string_list_clear(&extra_hdr
, 0);
1349 string_list_clear(&extra_to
, 0);
1350 string_list_clear(&extra_cc
, 0);
1357 static int to_callback(const struct option
*opt
, const char *arg
, int unset
)
1360 string_list_clear(&extra_to
, 0);
1362 string_list_append(&extra_to
, arg
);
1366 static int cc_callback(const struct option
*opt
, const char *arg
, int unset
)
1369 string_list_clear(&extra_cc
, 0);
1371 string_list_append(&extra_cc
, arg
);
1375 static int from_callback(const struct option
*opt
, const char *arg
, int unset
)
1377 char **from
= opt
->value
;
1384 *from
= xstrdup(arg
);
1386 *from
= xstrdup(git_committer_info(IDENT_NO_DATE
));
1390 struct base_tree_info
{
1391 struct object_id base_commit
;
1392 int nr_patch_id
, alloc_patch_id
;
1393 struct object_id
*patch_id
;
1396 static struct commit
*get_base_commit(const char *base_commit
,
1397 struct commit
**list
,
1400 struct commit
*base
= NULL
;
1401 struct commit
**rev
;
1402 int i
= 0, rev_nr
= 0;
1404 if (base_commit
&& strcmp(base_commit
, "auto")) {
1405 base
= lookup_commit_reference_by_name(base_commit
);
1407 die(_("unknown commit %s"), base_commit
);
1408 } else if ((base_commit
&& !strcmp(base_commit
, "auto")) || base_auto
) {
1409 struct branch
*curr_branch
= branch_get(NULL
);
1410 const char *upstream
= branch_get_upstream(curr_branch
, NULL
);
1412 struct commit_list
*base_list
;
1413 struct commit
*commit
;
1414 struct object_id oid
;
1416 if (get_oid(upstream
, &oid
))
1417 die(_("failed to resolve '%s' as a valid ref"), upstream
);
1418 commit
= lookup_commit_or_die(&oid
, "upstream base");
1419 base_list
= get_merge_bases_many(commit
, total
, list
);
1420 /* There should be one and only one merge base. */
1421 if (!base_list
|| base_list
->next
)
1422 die(_("could not find exact merge base"));
1423 base
= base_list
->item
;
1424 free_commit_list(base_list
);
1426 die(_("failed to get upstream, if you want to record base commit automatically,\n"
1427 "please use git branch --set-upstream-to to track a remote branch.\n"
1428 "Or you could specify base commit by --base=<base-commit-id> manually"));
1432 ALLOC_ARRAY(rev
, total
);
1433 for (i
= 0; i
< total
; i
++)
1438 * Get merge base through pair-wise computations
1439 * and store it in rev[0].
1441 while (rev_nr
> 1) {
1442 for (i
= 0; i
< rev_nr
/ 2; i
++) {
1443 struct commit_list
*merge_base
;
1444 merge_base
= get_merge_bases(rev
[2 * i
], rev
[2 * i
+ 1]);
1445 if (!merge_base
|| merge_base
->next
)
1446 die(_("failed to find exact merge base"));
1448 rev
[i
] = merge_base
->item
;
1452 rev
[i
] = rev
[2 * i
];
1453 rev_nr
= DIV_ROUND_UP(rev_nr
, 2);
1456 if (!in_merge_bases(base
, rev
[0]))
1457 die(_("base commit should be the ancestor of revision list"));
1459 for (i
= 0; i
< total
; i
++) {
1460 if (base
== list
[i
])
1461 die(_("base commit shouldn't be in revision list"));
1468 define_commit_slab(commit_base
, int);
1470 static void prepare_bases(struct base_tree_info
*bases
,
1471 struct commit
*base
,
1472 struct commit
**list
,
1475 struct commit
*commit
;
1476 struct rev_info revs
;
1477 struct diff_options diffopt
;
1478 struct commit_base commit_base
;
1484 init_commit_base(&commit_base
);
1485 repo_diff_setup(the_repository
, &diffopt
);
1486 diffopt
.flags
.recursive
= 1;
1487 diff_setup_done(&diffopt
);
1489 oidcpy(&bases
->base_commit
, &base
->object
.oid
);
1491 repo_init_revisions(the_repository
, &revs
, NULL
);
1492 revs
.max_parents
= 1;
1493 revs
.topo_order
= 1;
1494 for (i
= 0; i
< total
; i
++) {
1495 list
[i
]->object
.flags
&= ~UNINTERESTING
;
1496 add_pending_object(&revs
, &list
[i
]->object
, "rev_list");
1497 *commit_base_at(&commit_base
, list
[i
]) = 1;
1499 base
->object
.flags
|= UNINTERESTING
;
1500 add_pending_object(&revs
, &base
->object
, "base");
1502 if (prepare_revision_walk(&revs
))
1503 die(_("revision walk setup failed"));
1505 * Traverse the commits list, get prerequisite patch ids
1506 * and stuff them in bases structure.
1508 while ((commit
= get_revision(&revs
)) != NULL
) {
1509 struct object_id oid
;
1510 struct object_id
*patch_id
;
1511 if (*commit_base_at(&commit_base
, commit
))
1513 if (commit_patch_id(commit
, &diffopt
, &oid
, 0, 1))
1514 die(_("cannot get patch id"));
1515 ALLOC_GROW(bases
->patch_id
, bases
->nr_patch_id
+ 1, bases
->alloc_patch_id
);
1516 patch_id
= bases
->patch_id
+ bases
->nr_patch_id
;
1517 oidcpy(patch_id
, &oid
);
1518 bases
->nr_patch_id
++;
1520 clear_commit_base(&commit_base
);
1523 static void print_bases(struct base_tree_info
*bases
, FILE *file
)
1527 /* Only do this once, either for the cover or for the first one */
1528 if (is_null_oid(&bases
->base_commit
))
1531 /* Show the base commit */
1532 fprintf(file
, "\nbase-commit: %s\n", oid_to_hex(&bases
->base_commit
));
1534 /* Show the prerequisite patches */
1535 for (i
= bases
->nr_patch_id
- 1; i
>= 0; i
--)
1536 fprintf(file
, "prerequisite-patch-id: %s\n", oid_to_hex(&bases
->patch_id
[i
]));
1538 free(bases
->patch_id
);
1539 bases
->nr_patch_id
= 0;
1540 bases
->alloc_patch_id
= 0;
1541 oidclr(&bases
->base_commit
);
1544 static const char *diff_title(struct strbuf
*sb
, int reroll_count
,
1545 const char *generic
, const char *rerolled
)
1547 if (reroll_count
<= 0)
1548 strbuf_addstr(sb
, generic
);
1549 else /* RFC may be v0, so allow -v1 to diff against v0 */
1550 strbuf_addf(sb
, rerolled
, reroll_count
- 1);
1554 static void infer_range_diff_ranges(struct strbuf
*r1
,
1557 struct commit
*origin
,
1558 struct commit
*head
)
1560 const char *head_oid
= oid_to_hex(&head
->object
.oid
);
1562 if (!strstr(prev
, "..")) {
1563 strbuf_addf(r1
, "%s..%s", head_oid
, prev
);
1564 strbuf_addf(r2
, "%s..%s", prev
, head_oid
);
1565 } else if (!origin
) {
1566 die(_("failed to infer range-diff ranges"));
1568 strbuf_addstr(r1
, prev
);
1569 strbuf_addf(r2
, "%s..%s",
1570 oid_to_hex(&origin
->object
.oid
), head_oid
);
1574 int cmd_format_patch(int argc
, const char **argv
, const char *prefix
)
1576 struct commit
*commit
;
1577 struct commit
**list
= NULL
;
1578 struct rev_info rev
;
1579 struct setup_revision_opt s_r_opt
;
1580 int nr
= 0, total
, i
;
1582 int start_number
= -1;
1583 int just_numbers
= 0;
1584 int ignore_if_in_upstream
= 0;
1585 int cover_letter
= -1;
1586 int boundary_count
= 0;
1587 int no_binary_diff
= 0;
1588 int zero_commit
= 0;
1589 struct commit
*origin
= NULL
;
1590 const char *in_reply_to
= NULL
;
1591 struct patch_ids ids
;
1592 struct strbuf buf
= STRBUF_INIT
;
1593 int use_patch_format
= 0;
1595 int reroll_count
= -1;
1596 char *cover_from_description_arg
= NULL
;
1597 char *branch_name
= NULL
;
1598 char *base_commit
= NULL
;
1599 struct base_tree_info bases
;
1600 int show_progress
= 0;
1601 struct progress
*progress
= NULL
;
1602 struct oid_array idiff_prev
= OID_ARRAY_INIT
;
1603 struct strbuf idiff_title
= STRBUF_INIT
;
1604 const char *rdiff_prev
= NULL
;
1605 struct strbuf rdiff1
= STRBUF_INIT
;
1606 struct strbuf rdiff2
= STRBUF_INIT
;
1607 struct strbuf rdiff_title
= STRBUF_INIT
;
1608 int creation_factor
= -1;
1610 const struct option builtin_format_patch_options
[] = {
1611 { OPTION_CALLBACK
, 'n', "numbered", &numbered
, NULL
,
1612 N_("use [PATCH n/m] even with a single patch"),
1613 PARSE_OPT_NOARG
, numbered_callback
},
1614 { OPTION_CALLBACK
, 'N', "no-numbered", &numbered
, NULL
,
1615 N_("use [PATCH] even with multiple patches"),
1616 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, no_numbered_callback
},
1617 OPT_BOOL('s', "signoff", &do_signoff
, N_("add Signed-off-by:")),
1618 OPT_BOOL(0, "stdout", &use_stdout
,
1619 N_("print patches to standard out")),
1620 OPT_BOOL(0, "cover-letter", &cover_letter
,
1621 N_("generate a cover letter")),
1622 OPT_BOOL(0, "numbered-files", &just_numbers
,
1623 N_("use simple number sequence for output file names")),
1624 OPT_STRING(0, "suffix", &fmt_patch_suffix
, N_("sfx"),
1625 N_("use <sfx> instead of '.patch'")),
1626 OPT_INTEGER(0, "start-number", &start_number
,
1627 N_("start numbering patches at <n> instead of 1")),
1628 OPT_INTEGER('v', "reroll-count", &reroll_count
,
1629 N_("mark the series as Nth re-roll")),
1630 { OPTION_CALLBACK
, 0, "rfc", &rev
, NULL
,
1631 N_("Use [RFC PATCH] instead of [PATCH]"),
1632 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, rfc_callback
},
1633 OPT_STRING(0, "cover-from-description", &cover_from_description_arg
,
1634 N_("cover-from-description-mode"),
1635 N_("generate parts of a cover letter based on a branch's description")),
1636 { OPTION_CALLBACK
, 0, "subject-prefix", &rev
, N_("prefix"),
1637 N_("Use [<prefix>] instead of [PATCH]"),
1638 PARSE_OPT_NONEG
, subject_prefix_callback
},
1639 { OPTION_CALLBACK
, 'o', "output-directory", &output_directory
,
1640 N_("dir"), N_("store resulting files in <dir>"),
1641 PARSE_OPT_NONEG
, output_directory_callback
},
1642 { OPTION_CALLBACK
, 'k', "keep-subject", &rev
, NULL
,
1643 N_("don't strip/add [PATCH]"),
1644 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, keep_callback
},
1645 OPT_BOOL(0, "no-binary", &no_binary_diff
,
1646 N_("don't output binary diffs")),
1647 OPT_BOOL(0, "zero-commit", &zero_commit
,
1648 N_("output all-zero hash in From header")),
1649 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream
,
1650 N_("don't include a patch matching a commit upstream")),
1651 OPT_SET_INT_F('p', "no-stat", &use_patch_format
,
1652 N_("show patch format instead of default (patch + stat)"),
1653 1, PARSE_OPT_NONEG
),
1654 OPT_GROUP(N_("Messaging")),
1655 { OPTION_CALLBACK
, 0, "add-header", NULL
, N_("header"),
1656 N_("add email header"), 0, header_callback
},
1657 { OPTION_CALLBACK
, 0, "to", NULL
, N_("email"), N_("add To: header"),
1659 { OPTION_CALLBACK
, 0, "cc", NULL
, N_("email"), N_("add Cc: header"),
1661 { OPTION_CALLBACK
, 0, "from", &from
, N_("ident"),
1662 N_("set From address to <ident> (or committer ident if absent)"),
1663 PARSE_OPT_OPTARG
, from_callback
},
1664 OPT_STRING(0, "in-reply-to", &in_reply_to
, N_("message-id"),
1665 N_("make first mail a reply to <message-id>")),
1666 { OPTION_CALLBACK
, 0, "attach", &rev
, N_("boundary"),
1667 N_("attach the patch"), PARSE_OPT_OPTARG
,
1669 { OPTION_CALLBACK
, 0, "inline", &rev
, N_("boundary"),
1670 N_("inline the patch"),
1671 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
1673 { OPTION_CALLBACK
, 0, "thread", &thread
, N_("style"),
1674 N_("enable message threading, styles: shallow, deep"),
1675 PARSE_OPT_OPTARG
, thread_callback
},
1676 OPT_STRING(0, "signature", &signature
, N_("signature"),
1677 N_("add a signature")),
1678 OPT_STRING(0, "base", &base_commit
, N_("base-commit"),
1679 N_("add prerequisite tree info to the patch series")),
1680 OPT_FILENAME(0, "signature-file", &signature_file
,
1681 N_("add a signature from a file")),
1682 OPT__QUIET(&quiet
, N_("don't print the patch filenames")),
1683 OPT_BOOL(0, "progress", &show_progress
,
1684 N_("show progress while generating patches")),
1685 OPT_CALLBACK(0, "interdiff", &idiff_prev
, N_("rev"),
1686 N_("show changes against <rev> in cover letter or single patch"),
1687 parse_opt_object_name
),
1688 OPT_STRING(0, "range-diff", &rdiff_prev
, N_("refspec"),
1689 N_("show changes against <refspec> in cover letter or single patch")),
1690 OPT_INTEGER(0, "creation-factor", &creation_factor
,
1691 N_("percentage by which creation is weighted")),
1695 extra_hdr
.strdup_strings
= 1;
1696 extra_to
.strdup_strings
= 1;
1697 extra_cc
.strdup_strings
= 1;
1698 init_log_defaults();
1699 repo_init_revisions(the_repository
, &rev
, prefix
);
1700 git_config(git_format_config
, &rev
);
1701 rev
.commit_format
= CMIT_FMT_EMAIL
;
1702 rev
.expand_tabs_in_log_default
= 0;
1703 rev
.verbose_header
= 1;
1705 rev
.max_parents
= 1;
1706 rev
.diffopt
.flags
.recursive
= 1;
1707 rev
.subject_prefix
= fmt_patch_subject_prefix
;
1708 memset(&s_r_opt
, 0, sizeof(s_r_opt
));
1709 s_r_opt
.def
= "HEAD";
1710 s_r_opt
.revarg_opt
= REVARG_COMMITTISH
;
1712 if (default_attach
) {
1713 rev
.mime_boundary
= default_attach
;
1718 * Parse the arguments before setup_revisions(), or something
1719 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1720 * possibly a valid SHA1.
1722 argc
= parse_options(argc
, argv
, prefix
, builtin_format_patch_options
,
1723 builtin_format_patch_usage
,
1724 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
1725 PARSE_OPT_KEEP_DASHDASH
);
1727 if (cover_from_description_arg
)
1728 cover_from_description_mode
= parse_cover_from_description(cover_from_description_arg
);
1730 if (0 < reroll_count
) {
1731 struct strbuf sprefix
= STRBUF_INIT
;
1732 strbuf_addf(&sprefix
, "%s v%d",
1733 rev
.subject_prefix
, reroll_count
);
1734 rev
.reroll_count
= reroll_count
;
1735 rev
.subject_prefix
= strbuf_detach(&sprefix
, NULL
);
1738 for (i
= 0; i
< extra_hdr
.nr
; i
++) {
1739 strbuf_addstr(&buf
, extra_hdr
.items
[i
].string
);
1740 strbuf_addch(&buf
, '\n');
1744 strbuf_addstr(&buf
, "To: ");
1745 for (i
= 0; i
< extra_to
.nr
; i
++) {
1747 strbuf_addstr(&buf
, " ");
1748 strbuf_addstr(&buf
, extra_to
.items
[i
].string
);
1749 if (i
+ 1 < extra_to
.nr
)
1750 strbuf_addch(&buf
, ',');
1751 strbuf_addch(&buf
, '\n');
1755 strbuf_addstr(&buf
, "Cc: ");
1756 for (i
= 0; i
< extra_cc
.nr
; i
++) {
1758 strbuf_addstr(&buf
, " ");
1759 strbuf_addstr(&buf
, extra_cc
.items
[i
].string
);
1760 if (i
+ 1 < extra_cc
.nr
)
1761 strbuf_addch(&buf
, ',');
1762 strbuf_addch(&buf
, '\n');
1765 rev
.extra_headers
= strbuf_detach(&buf
, NULL
);
1768 if (split_ident_line(&rev
.from_ident
, from
, strlen(from
)))
1769 die(_("invalid ident line: %s"), from
);
1772 if (start_number
< 0)
1776 * If numbered is set solely due to format.numbered in config,
1777 * and it would conflict with --keep-subject (-k) from the
1778 * command line, reset "numbered".
1780 if (numbered
&& keep_subject
&& !numbered_cmdline_opt
)
1783 if (numbered
&& keep_subject
)
1784 die(_("-n and -k are mutually exclusive"));
1785 if (keep_subject
&& subject_prefix
)
1786 die(_("--subject-prefix/--rfc and -k are mutually exclusive"));
1787 rev
.preserve_subject
= keep_subject
;
1789 argc
= setup_revisions(argc
, argv
, &rev
, &s_r_opt
);
1791 die(_("unrecognized argument: %s"), argv
[1]);
1793 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME
)
1794 die(_("--name-only does not make sense"));
1795 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME_STATUS
)
1796 die(_("--name-status does not make sense"));
1797 if (rev
.diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
)
1798 die(_("--check does not make sense"));
1800 if (!use_patch_format
&&
1801 (!rev
.diffopt
.output_format
||
1802 rev
.diffopt
.output_format
== DIFF_FORMAT_PATCH
))
1803 rev
.diffopt
.output_format
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_SUMMARY
;
1804 if (!rev
.diffopt
.stat_width
)
1805 rev
.diffopt
.stat_width
= MAIL_DEFAULT_WRAP
;
1807 /* Always generate a patch */
1808 rev
.diffopt
.output_format
|= DIFF_FORMAT_PATCH
;
1810 rev
.zero_commit
= zero_commit
;
1812 if (!rev
.diffopt
.flags
.text
&& !no_binary_diff
)
1813 rev
.diffopt
.flags
.binary
= 1;
1816 init_display_notes(&rev
.notes_opt
);
1818 if (!output_directory
&& !use_stdout
)
1819 output_directory
= config_output_directory
;
1822 output_directory
= set_outdir(prefix
, output_directory
);
1826 if (output_directory
) {
1827 if (rev
.diffopt
.use_color
!= GIT_COLOR_ALWAYS
)
1828 rev
.diffopt
.use_color
= GIT_COLOR_NEVER
;
1830 die(_("standard output, or directory, which one?"));
1831 if (mkdir(output_directory
, 0777) < 0 && errno
!= EEXIST
)
1832 die_errno(_("could not create directory '%s'"),
1836 if (rev
.pending
.nr
== 1) {
1839 if (rev
.max_count
< 0 && !rev
.show_root_diff
) {
1841 * This is traditional behaviour of "git format-patch
1842 * origin" that prepares what the origin side still
1845 rev
.pending
.objects
[0].item
->flags
|= UNINTERESTING
;
1846 add_head_to_pending(&rev
);
1850 * Otherwise, it is "format-patch -22 HEAD", and/or
1851 * "format-patch --root HEAD". The user wants
1852 * get_revision() to do the usual traversal.
1855 if (!strcmp(rev
.pending
.objects
[0].name
, "HEAD"))
1859 const char *ref
, *v
;
1860 ref
= resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
,
1862 if (ref
&& skip_prefix(ref
, "refs/heads/", &v
))
1863 branch_name
= xstrdup(v
);
1865 branch_name
= xstrdup(""); /* no branch */
1870 * We cannot move this anywhere earlier because we do want to
1871 * know if --root was given explicitly from the command line.
1873 rev
.show_root_diff
= 1;
1875 if (ignore_if_in_upstream
) {
1876 /* Don't say anything if head and upstream are the same. */
1877 if (rev
.pending
.nr
== 2) {
1878 struct object_array_entry
*o
= rev
.pending
.objects
;
1879 if (oideq(&o
[0].item
->oid
, &o
[1].item
->oid
))
1882 get_patch_ids(&rev
, &ids
);
1885 if (prepare_revision_walk(&rev
))
1886 die(_("revision walk setup failed"));
1888 while ((commit
= get_revision(&rev
)) != NULL
) {
1889 if (commit
->object
.flags
& BOUNDARY
) {
1891 origin
= (boundary_count
== 1) ? commit
: NULL
;
1895 if (ignore_if_in_upstream
&& has_commit_patch_id(commit
, &ids
))
1899 REALLOC_ARRAY(list
, nr
);
1900 list
[nr
- 1] = commit
;
1906 if (cover_letter
== -1) {
1907 if (config_cover_letter
== COVER_AUTO
)
1908 cover_letter
= (total
> 1);
1910 cover_letter
= (config_cover_letter
== COVER_ON
);
1912 if (!keep_subject
&& auto_number
&& (total
> 1 || cover_letter
))
1915 rev
.total
= total
+ start_number
- 1;
1917 if (idiff_prev
.nr
) {
1918 if (!cover_letter
&& total
!= 1)
1919 die(_("--interdiff requires --cover-letter or single patch"));
1920 rev
.idiff_oid1
= &idiff_prev
.oid
[idiff_prev
.nr
- 1];
1921 rev
.idiff_oid2
= get_commit_tree_oid(list
[0]);
1922 rev
.idiff_title
= diff_title(&idiff_title
, reroll_count
,
1924 _("Interdiff against v%d:"));
1927 if (creation_factor
< 0)
1928 creation_factor
= RANGE_DIFF_CREATION_FACTOR_DEFAULT
;
1929 else if (!rdiff_prev
)
1930 die(_("--creation-factor requires --range-diff"));
1933 if (!cover_letter
&& total
!= 1)
1934 die(_("--range-diff requires --cover-letter or single patch"));
1936 infer_range_diff_ranges(&rdiff1
, &rdiff2
, rdiff_prev
,
1938 rev
.rdiff1
= rdiff1
.buf
;
1939 rev
.rdiff2
= rdiff2
.buf
;
1940 rev
.creation_factor
= creation_factor
;
1941 rev
.rdiff_title
= diff_title(&rdiff_title
, reroll_count
,
1943 _("Range-diff against v%d:"));
1947 ; /* --no-signature inhibits all signatures */
1948 } else if (signature
&& signature
!= git_version_string
) {
1949 ; /* non-default signature already set */
1950 } else if (signature_file
) {
1951 struct strbuf buf
= STRBUF_INIT
;
1953 if (strbuf_read_file(&buf
, signature_file
, 128) < 0)
1954 die_errno(_("unable to read signature file '%s'"), signature_file
);
1955 signature
= strbuf_detach(&buf
, NULL
);
1958 memset(&bases
, 0, sizeof(bases
));
1959 if (base_commit
|| base_auto
) {
1960 struct commit
*base
= get_base_commit(base_commit
, list
, nr
);
1961 reset_revision_walk();
1962 clear_object_flags(UNINTERESTING
);
1963 prepare_bases(&bases
, base
, list
, nr
);
1966 if (in_reply_to
|| thread
|| cover_letter
)
1967 rev
.ref_message_ids
= xcalloc(1, sizeof(struct string_list
));
1969 const char *msgid
= clean_message_id(in_reply_to
);
1970 string_list_append(rev
.ref_message_ids
, msgid
);
1972 rev
.numbered_files
= just_numbers
;
1973 rev
.patch_suffix
= fmt_patch_suffix
;
1976 gen_message_id(&rev
, "cover");
1977 make_cover_letter(&rev
, use_stdout
,
1978 origin
, nr
, list
, branch_name
, quiet
);
1979 print_bases(&bases
, rev
.diffopt
.file
);
1980 print_signature(rev
.diffopt
.file
);
1983 /* interdiff/range-diff in cover-letter; omit from patches */
1984 rev
.idiff_oid1
= NULL
;
1987 rev
.add_signoff
= do_signoff
;
1990 progress
= start_delayed_progress(_("Generating patches"), total
);
1993 display_progress(progress
, total
- nr
);
1995 rev
.nr
= total
- nr
+ (start_number
- 1);
1996 /* Make the second and subsequent mails replies to the first */
1998 /* Have we already had a message ID? */
1999 if (rev
.message_id
) {
2001 * For deep threading: make every mail
2002 * a reply to the previous one, no
2003 * matter what other options are set.
2005 * For shallow threading:
2007 * Without --cover-letter and
2008 * --in-reply-to, make every mail a
2009 * reply to the one before.
2011 * With --in-reply-to but no
2012 * --cover-letter, make every mail a
2013 * reply to the <reply-to>.
2015 * With --cover-letter, make every
2016 * mail but the cover letter a reply
2017 * to the cover letter. The cover
2018 * letter is a reply to the
2019 * --in-reply-to, if specified.
2021 if (thread
== THREAD_SHALLOW
2022 && rev
.ref_message_ids
->nr
> 0
2023 && (!cover_letter
|| rev
.nr
> 1))
2024 free(rev
.message_id
);
2026 string_list_append(rev
.ref_message_ids
,
2029 gen_message_id(&rev
, oid_to_hex(&commit
->object
.oid
));
2033 open_next_file(rev
.numbered_files
? NULL
: commit
, NULL
, &rev
, quiet
))
2034 die(_("failed to create output files"));
2035 shown
= log_tree_commit(&rev
, commit
);
2036 free_commit_buffer(the_repository
->parsed_objects
,
2039 /* We put one extra blank line between formatted
2040 * patches and this flag is used by log-tree code
2041 * to see if it needs to emit a LF before showing
2042 * the log; when using one file per patch, we do
2043 * not want the extra blank line.
2048 print_bases(&bases
, rev
.diffopt
.file
);
2049 if (rev
.mime_boundary
)
2050 fprintf(rev
.diffopt
.file
, "\n--%s%s--\n\n\n",
2051 mime_boundary_leader
,
2054 print_signature(rev
.diffopt
.file
);
2057 fclose(rev
.diffopt
.file
);
2059 stop_progress(&progress
);
2062 string_list_clear(&extra_to
, 0);
2063 string_list_clear(&extra_cc
, 0);
2064 string_list_clear(&extra_hdr
, 0);
2065 if (ignore_if_in_upstream
)
2066 free_patch_ids(&ids
);
2069 oid_array_clear(&idiff_prev
);
2070 strbuf_release(&idiff_title
);
2071 strbuf_release(&rdiff1
);
2072 strbuf_release(&rdiff2
);
2073 strbuf_release(&rdiff_title
);
2077 static int add_pending_commit(const char *arg
, struct rev_info
*revs
, int flags
)
2079 struct object_id oid
;
2080 if (get_oid(arg
, &oid
) == 0) {
2081 struct commit
*commit
= lookup_commit_reference(the_repository
,
2084 commit
->object
.flags
|= flags
;
2085 add_pending_object(revs
, &commit
->object
, arg
);
2092 static const char * const cherry_usage
[] = {
2093 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
2097 static void print_commit(char sign
, struct commit
*commit
, int verbose
,
2098 int abbrev
, FILE *file
)
2101 fprintf(file
, "%c %s\n", sign
,
2102 find_unique_abbrev(&commit
->object
.oid
, abbrev
));
2104 struct strbuf buf
= STRBUF_INIT
;
2105 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &buf
);
2106 fprintf(file
, "%c %s %s\n", sign
,
2107 find_unique_abbrev(&commit
->object
.oid
, abbrev
),
2109 strbuf_release(&buf
);
2113 int cmd_cherry(int argc
, const char **argv
, const char *prefix
)
2115 struct rev_info revs
;
2116 struct patch_ids ids
;
2117 struct commit
*commit
;
2118 struct commit_list
*list
= NULL
;
2119 struct branch
*current_branch
;
2120 const char *upstream
;
2121 const char *head
= "HEAD";
2122 const char *limit
= NULL
;
2123 int verbose
= 0, abbrev
= 0;
2125 struct option options
[] = {
2126 OPT__ABBREV(&abbrev
),
2127 OPT__VERBOSE(&verbose
, N_("be verbose")),
2131 argc
= parse_options(argc
, argv
, prefix
, options
, cherry_usage
, 0);
2144 current_branch
= branch_get(NULL
);
2145 upstream
= branch_get_upstream(current_branch
, NULL
);
2147 fprintf(stderr
, _("Could not find a tracked"
2148 " remote branch, please"
2149 " specify <upstream> manually.\n"));
2150 usage_with_options(cherry_usage
, options
);
2154 repo_init_revisions(the_repository
, &revs
, prefix
);
2155 revs
.max_parents
= 1;
2157 if (add_pending_commit(head
, &revs
, 0))
2158 die(_("unknown commit %s"), head
);
2159 if (add_pending_commit(upstream
, &revs
, UNINTERESTING
))
2160 die(_("unknown commit %s"), upstream
);
2162 /* Don't say anything if head and upstream are the same. */
2163 if (revs
.pending
.nr
== 2) {
2164 struct object_array_entry
*o
= revs
.pending
.objects
;
2165 if (oideq(&o
[0].item
->oid
, &o
[1].item
->oid
))
2169 get_patch_ids(&revs
, &ids
);
2171 if (limit
&& add_pending_commit(limit
, &revs
, UNINTERESTING
))
2172 die(_("unknown commit %s"), limit
);
2174 /* reverse the list of commits */
2175 if (prepare_revision_walk(&revs
))
2176 die(_("revision walk setup failed"));
2177 while ((commit
= get_revision(&revs
)) != NULL
) {
2178 commit_list_insert(commit
, &list
);
2184 commit
= list
->item
;
2185 if (has_commit_patch_id(commit
, &ids
))
2187 print_commit(sign
, commit
, verbose
, abbrev
, revs
.diffopt
.file
);
2191 free_patch_ids(&ids
);