2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
15 #include "reflog-walk.h"
16 #include "patch-ids.h"
17 #include "run-command.h"
20 #include "string-list.h"
21 #include "parse-options.h"
23 /* Set a default date-time format for git log ("log.date" config variable) */
24 static const char *default_date_mode
= NULL
;
26 static int default_show_root
= 1;
27 static int decoration_style
;
28 static int decoration_given
;
29 static const char *fmt_patch_subject_prefix
= "PATCH";
30 static const char *fmt_pretty
;
32 static const char * const builtin_log_usage
[] = {
33 "git log [<options>] [<since>..<until>] [[--] <path>...]\n"
34 " or: git show [options] <object>...",
38 static int parse_decoration_style(const char *var
, const char *value
)
40 switch (git_config_maybe_bool(var
, value
)) {
42 return DECORATE_SHORT_REFS
;
48 if (!strcmp(value
, "full"))
49 return DECORATE_FULL_REFS
;
50 else if (!strcmp(value
, "short"))
51 return DECORATE_SHORT_REFS
;
55 static int decorate_callback(const struct option
*opt
, const char *arg
, int unset
)
60 decoration_style
= parse_decoration_style("command line", arg
);
62 decoration_style
= DECORATE_SHORT_REFS
;
64 if (decoration_style
< 0)
65 die("invalid --decorate option: %s", arg
);
72 static void cmd_log_init_defaults(struct rev_info
*rev
)
74 rev
->abbrev
= DEFAULT_ABBREV
;
75 rev
->commit_format
= CMIT_FMT_DEFAULT
;
77 get_commit_format(fmt_pretty
, rev
);
78 rev
->verbose_header
= 1;
79 DIFF_OPT_SET(&rev
->diffopt
, RECURSIVE
);
80 rev
->show_root_diff
= default_show_root
;
81 rev
->subject_prefix
= fmt_patch_subject_prefix
;
82 DIFF_OPT_SET(&rev
->diffopt
, ALLOW_TEXTCONV
);
84 if (default_date_mode
)
85 rev
->date_mode
= parse_date_format(default_date_mode
);
88 static void cmd_log_init_finish(int argc
, const char **argv
, const char *prefix
,
89 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
91 struct userformat_want w
;
92 int quiet
= 0, source
= 0;
94 const struct option builtin_log_options
[] = {
95 OPT_BOOLEAN(0, "quiet", &quiet
, "supress diff output"),
96 OPT_BOOLEAN(0, "source", &source
, "show source"),
97 { OPTION_CALLBACK
, 0, "decorate", NULL
, NULL
, "decorate options",
98 PARSE_OPT_OPTARG
, decorate_callback
},
102 argc
= parse_options(argc
, argv
, prefix
,
103 builtin_log_options
, builtin_log_usage
,
104 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
105 PARSE_OPT_KEEP_DASHDASH
);
107 argc
= setup_revisions(argc
, argv
, rev
, opt
);
109 /* Any arguments at this point are not recognized */
111 die("unrecognized argument: %s", argv
[1]);
113 memset(&w
, 0, sizeof(w
));
114 userformat_find_requirements(NULL
, &w
);
116 if (!rev
->show_notes_given
&& (!rev
->pretty_given
|| w
.notes
))
119 init_display_notes(&rev
->notes_opt
);
121 if (rev
->diffopt
.pickaxe
|| rev
->diffopt
.filter
)
122 rev
->always_show_header
= 0;
123 if (DIFF_OPT_TST(&rev
->diffopt
, FOLLOW_RENAMES
)) {
124 rev
->always_show_header
= 0;
125 if (rev
->diffopt
.pathspec
.nr
!= 1)
126 usage("git logs can only follow renames on one pathname at a time");
130 rev
->show_source
= 1;
133 * defeat log.decorate configuration interacting with --pretty=raw
134 * from the command line.
136 if (!decoration_given
&& rev
->pretty_given
137 && rev
->commit_format
== CMIT_FMT_RAW
)
138 decoration_style
= 0;
140 if (decoration_style
) {
141 rev
->show_decorations
= 1;
142 load_ref_decorations(decoration_style
);
147 static void cmd_log_init(int argc
, const char **argv
, const char *prefix
,
148 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
150 cmd_log_init_defaults(rev
);
151 cmd_log_init_finish(argc
, argv
, prefix
, rev
, opt
);
155 * This gives a rough estimate for how many commits we
156 * will print out in the list.
158 static int estimate_commit_count(struct rev_info
*rev
, struct commit_list
*list
)
163 struct commit
*commit
= list
->item
;
164 unsigned int flags
= commit
->object
.flags
;
166 if (!(flags
& (TREESAME
| UNINTERESTING
)))
172 static void show_early_header(struct rev_info
*rev
, const char *stage
, int nr
)
174 if (rev
->shown_one
) {
176 if (rev
->commit_format
!= CMIT_FMT_ONELINE
)
177 putchar(rev
->diffopt
.line_termination
);
179 printf(_("Final output: %d %s\n"), nr
, stage
);
182 static struct itimerval early_output_timer
;
184 static void log_show_early(struct rev_info
*revs
, struct commit_list
*list
)
186 int i
= revs
->early_output
;
189 sort_in_topological_order(&list
, revs
->lifo
);
191 struct commit
*commit
= list
->item
;
192 switch (simplify_commit(revs
, commit
)) {
195 int n
= estimate_commit_count(revs
, list
);
196 show_early_header(revs
, "incomplete", n
);
199 log_tree_commit(revs
, commit
);
210 /* Did we already get enough commits for the early output? */
215 * ..if no, then repeat it twice a second until we
218 * NOTE! We don't use "it_interval", because if the
219 * reader isn't listening, we want our output to be
220 * throttled by the writing, and not have the timer
221 * trigger every second even if we're blocked on a
224 early_output_timer
.it_value
.tv_sec
= 0;
225 early_output_timer
.it_value
.tv_usec
= 500000;
226 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
229 static void early_output(int signal
)
231 show_early_output
= log_show_early
;
234 static void setup_early_output(struct rev_info
*rev
)
239 * Set up the signal handler, minimally intrusively:
240 * we only set a single volatile integer word (not
241 * using sigatomic_t - trying to avoid unnecessary
242 * system dependencies and headers), and using
245 memset(&sa
, 0, sizeof(sa
));
246 sa
.sa_handler
= early_output
;
247 sigemptyset(&sa
.sa_mask
);
248 sa
.sa_flags
= SA_RESTART
;
249 sigaction(SIGALRM
, &sa
, NULL
);
252 * If we can get the whole output in less than a
253 * tenth of a second, don't even bother doing the
254 * early-output thing..
256 * This is a one-time-only trigger.
258 early_output_timer
.it_value
.tv_sec
= 0;
259 early_output_timer
.it_value
.tv_usec
= 100000;
260 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
263 static void finish_early_output(struct rev_info
*rev
)
265 int n
= estimate_commit_count(rev
, rev
->commits
);
266 signal(SIGALRM
, SIG_IGN
);
267 show_early_header(rev
, "done", n
);
270 static int cmd_log_walk(struct rev_info
*rev
)
272 struct commit
*commit
;
276 if (rev
->early_output
)
277 setup_early_output(rev
);
279 if (prepare_revision_walk(rev
))
280 die(_("revision walk setup failed"));
282 if (rev
->early_output
)
283 finish_early_output(rev
);
286 * For --check and --exit-code, the exit code is based on CHECK_FAILED
287 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
288 * retain that state information if replacing rev->diffopt in this loop
290 while ((commit
= get_revision(rev
)) != NULL
) {
291 if (!log_tree_commit(rev
, commit
) &&
294 * We decremented max_count in get_revision,
295 * but we didn't actually show the commit.
298 if (!rev
->reflog_info
) {
299 /* we allow cycles in reflog ancestry */
300 free(commit
->buffer
);
301 commit
->buffer
= NULL
;
303 free_commit_list(commit
->parents
);
304 commit
->parents
= NULL
;
305 if (saved_nrl
< rev
->diffopt
.needed_rename_limit
)
306 saved_nrl
= rev
->diffopt
.needed_rename_limit
;
307 if (rev
->diffopt
.degraded_cc_to_c
)
310 rev
->diffopt
.degraded_cc_to_c
= saved_dcctc
;
311 rev
->diffopt
.needed_rename_limit
= saved_nrl
;
313 if (rev
->diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
&&
314 DIFF_OPT_TST(&rev
->diffopt
, CHECK_FAILED
)) {
317 return diff_result_code(&rev
->diffopt
, 0);
320 static int git_log_config(const char *var
, const char *value
, void *cb
)
322 if (!strcmp(var
, "format.pretty"))
323 return git_config_string(&fmt_pretty
, var
, value
);
324 if (!strcmp(var
, "format.subjectprefix"))
325 return git_config_string(&fmt_patch_subject_prefix
, var
, value
);
326 if (!strcmp(var
, "log.date"))
327 return git_config_string(&default_date_mode
, var
, value
);
328 if (!strcmp(var
, "log.decorate")) {
329 decoration_style
= parse_decoration_style(var
, value
);
330 if (decoration_style
< 0)
331 decoration_style
= 0; /* maybe warn? */
334 if (!strcmp(var
, "log.showroot")) {
335 default_show_root
= git_config_bool(var
, value
);
338 if (!prefixcmp(var
, "color.decorate."))
339 return parse_decorate_color_config(var
, 15, value
);
341 return git_diff_ui_config(var
, value
, cb
);
344 int cmd_whatchanged(int argc
, const char **argv
, const char *prefix
)
347 struct setup_revision_opt opt
;
349 git_config(git_log_config
, NULL
);
351 if (diff_use_color_default
== -1)
352 diff_use_color_default
= git_use_color_default
;
354 init_revisions(&rev
, prefix
);
356 rev
.simplify_history
= 0;
357 memset(&opt
, 0, sizeof(opt
));
359 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
360 if (!rev
.diffopt
.output_format
)
361 rev
.diffopt
.output_format
= DIFF_FORMAT_RAW
;
362 return cmd_log_walk(&rev
);
365 static void show_tagger(char *buf
, int len
, struct rev_info
*rev
)
367 struct strbuf out
= STRBUF_INIT
;
369 pp_user_info("Tagger", rev
->commit_format
, &out
, buf
, rev
->date_mode
,
370 get_log_output_encoding());
371 printf("%s", out
.buf
);
372 strbuf_release(&out
);
375 static int show_object(const unsigned char *sha1
, int show_tag_object
,
376 struct rev_info
*rev
)
379 enum object_type type
;
380 char *buf
= read_sha1_file(sha1
, &type
, &size
);
384 return error(_("Could not read object %s"), sha1_to_hex(sha1
));
387 while (offset
< size
&& buf
[offset
] != '\n') {
388 int new_offset
= offset
+ 1;
389 while (new_offset
< size
&& buf
[new_offset
++] != '\n')
391 if (!prefixcmp(buf
+ offset
, "tagger "))
392 show_tagger(buf
+ offset
+ 7,
393 new_offset
- offset
- 7, rev
);
398 fwrite(buf
+ offset
, size
- offset
, 1, stdout
);
403 static int show_tree_object(const unsigned char *sha1
,
404 const char *base
, int baselen
,
405 const char *pathname
, unsigned mode
, int stage
, void *context
)
407 printf("%s%s\n", pathname
, S_ISDIR(mode
) ? "/" : "");
411 static void show_rev_tweak_rev(struct rev_info
*rev
, struct setup_revision_opt
*opt
)
413 if (rev
->ignore_merges
) {
414 /* There was no "-m" on the command line */
415 rev
->ignore_merges
= 0;
416 if (!rev
->first_parent_only
&& !rev
->combine_merges
) {
417 /* No "--first-parent", "-c", nor "--cc" */
418 rev
->combine_merges
= 1;
419 rev
->dense_combined_merges
= 1;
422 if (!rev
->diffopt
.output_format
)
423 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
426 int cmd_show(int argc
, const char **argv
, const char *prefix
)
429 struct object_array_entry
*objects
;
430 struct setup_revision_opt opt
;
431 struct pathspec match_all
;
432 int i
, count
, ret
= 0;
434 git_config(git_log_config
, NULL
);
436 if (diff_use_color_default
== -1)
437 diff_use_color_default
= git_use_color_default
;
439 init_pathspec(&match_all
, NULL
);
440 init_revisions(&rev
, prefix
);
442 rev
.always_show_header
= 1;
444 memset(&opt
, 0, sizeof(opt
));
446 opt
.tweak
= show_rev_tweak_rev
;
447 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
449 count
= rev
.pending
.nr
;
450 objects
= rev
.pending
.objects
;
451 for (i
= 0; i
< count
&& !ret
; i
++) {
452 struct object
*o
= objects
[i
].item
;
453 const char *name
= objects
[i
].name
;
456 ret
= show_object(o
->sha1
, 0, NULL
);
459 struct tag
*t
= (struct tag
*)o
;
463 printf("%stag %s%s\n",
464 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
466 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
467 ret
= show_object(o
->sha1
, 1, &rev
);
471 o
= parse_object(t
->tagged
->sha1
);
473 ret
= error(_("Could not read object %s"),
474 sha1_to_hex(t
->tagged
->sha1
));
482 printf("%stree %s%s\n\n",
483 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
485 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
486 read_tree_recursive((struct tree
*)o
, "", 0, 0, &match_all
,
487 show_tree_object
, NULL
);
491 rev
.pending
.nr
= rev
.pending
.alloc
= 0;
492 rev
.pending
.objects
= NULL
;
493 add_object_array(o
, name
, &rev
.pending
);
494 ret
= cmd_log_walk(&rev
);
497 ret
= error(_("Unknown type: %d"), o
->type
);
505 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
507 int cmd_log_reflog(int argc
, const char **argv
, const char *prefix
)
510 struct setup_revision_opt opt
;
512 git_config(git_log_config
, NULL
);
514 if (diff_use_color_default
== -1)
515 diff_use_color_default
= git_use_color_default
;
517 init_revisions(&rev
, prefix
);
518 init_reflog_walk(&rev
.reflog_info
);
519 rev
.abbrev_commit
= 1;
520 rev
.verbose_header
= 1;
521 memset(&opt
, 0, sizeof(opt
));
523 cmd_log_init_defaults(&rev
);
524 rev
.commit_format
= CMIT_FMT_ONELINE
;
525 rev
.use_terminator
= 1;
526 rev
.always_show_header
= 1;
527 cmd_log_init_finish(argc
, argv
, prefix
, &rev
, &opt
);
529 return cmd_log_walk(&rev
);
532 int cmd_log(int argc
, const char **argv
, const char *prefix
)
535 struct setup_revision_opt opt
;
537 git_config(git_log_config
, NULL
);
539 if (diff_use_color_default
== -1)
540 diff_use_color_default
= git_use_color_default
;
542 init_revisions(&rev
, prefix
);
543 rev
.always_show_header
= 1;
544 memset(&opt
, 0, sizeof(opt
));
546 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
547 return cmd_log_walk(&rev
);
552 static const char *fmt_patch_suffix
= ".patch";
553 static int numbered
= 0;
554 static int auto_number
= 1;
556 static char *default_attach
= NULL
;
558 static struct string_list extra_hdr
;
559 static struct string_list extra_to
;
560 static struct string_list extra_cc
;
562 static void add_header(const char *value
)
564 struct string_list_item
*item
;
565 int len
= strlen(value
);
566 while (len
&& value
[len
- 1] == '\n')
569 if (!strncasecmp(value
, "to: ", 4)) {
570 item
= string_list_append(&extra_to
, value
+ 4);
572 } else if (!strncasecmp(value
, "cc: ", 4)) {
573 item
= string_list_append(&extra_cc
, value
+ 4);
576 item
= string_list_append(&extra_hdr
, value
);
579 item
->string
[len
] = '\0';
582 #define THREAD_SHALLOW 1
583 #define THREAD_DEEP 2
585 static int do_signoff
;
586 static const char *signature
= git_version_string
;
588 static int git_format_config(const char *var
, const char *value
, void *cb
)
590 if (!strcmp(var
, "format.headers")) {
592 die(_("format.headers without value"));
596 if (!strcmp(var
, "format.suffix"))
597 return git_config_string(&fmt_patch_suffix
, var
, value
);
598 if (!strcmp(var
, "format.to")) {
600 return config_error_nonbool(var
);
601 string_list_append(&extra_to
, value
);
604 if (!strcmp(var
, "format.cc")) {
606 return config_error_nonbool(var
);
607 string_list_append(&extra_cc
, value
);
610 if (!strcmp(var
, "diff.color") || !strcmp(var
, "color.diff")) {
613 if (!strcmp(var
, "format.numbered")) {
614 if (value
&& !strcasecmp(value
, "auto")) {
618 numbered
= git_config_bool(var
, value
);
619 auto_number
= auto_number
&& numbered
;
622 if (!strcmp(var
, "format.attach")) {
624 default_attach
= xstrdup(value
);
626 default_attach
= xstrdup(git_version_string
);
629 if (!strcmp(var
, "format.thread")) {
630 if (value
&& !strcasecmp(value
, "deep")) {
631 thread
= THREAD_DEEP
;
634 if (value
&& !strcasecmp(value
, "shallow")) {
635 thread
= THREAD_SHALLOW
;
638 thread
= git_config_bool(var
, value
) && THREAD_SHALLOW
;
641 if (!strcmp(var
, "format.signoff")) {
642 do_signoff
= git_config_bool(var
, value
);
645 if (!strcmp(var
, "format.signature"))
646 return git_config_string(&signature
, var
, value
);
648 return git_log_config(var
, value
, cb
);
651 static FILE *realstdout
= NULL
;
652 static const char *output_directory
= NULL
;
653 static int outdir_offset
;
655 static int reopen_stdout(struct commit
*commit
, struct rev_info
*rev
, int quiet
)
657 struct strbuf filename
= STRBUF_INIT
;
658 int suffix_len
= strlen(fmt_patch_suffix
) + 1;
660 if (output_directory
) {
661 strbuf_addstr(&filename
, output_directory
);
663 PATH_MAX
- FORMAT_PATCH_NAME_MAX
- suffix_len
)
664 return error(_("name of output directory is too long"));
665 if (filename
.buf
[filename
.len
- 1] != '/')
666 strbuf_addch(&filename
, '/');
669 get_patch_filename(commit
, rev
->nr
, fmt_patch_suffix
, &filename
);
672 fprintf(realstdout
, "%s\n", filename
.buf
+ outdir_offset
);
674 if (freopen(filename
.buf
, "w", stdout
) == NULL
)
675 return error(_("Cannot open patch file %s"), filename
.buf
);
677 strbuf_release(&filename
);
681 static void get_patch_ids(struct rev_info
*rev
, struct patch_ids
*ids
, const char *prefix
)
683 struct rev_info check_rev
;
684 struct commit
*commit
;
685 struct object
*o1
, *o2
;
686 unsigned flags1
, flags2
;
688 if (rev
->pending
.nr
!= 2)
689 die(_("Need exactly one range."));
691 o1
= rev
->pending
.objects
[0].item
;
693 o2
= rev
->pending
.objects
[1].item
;
696 if ((flags1
& UNINTERESTING
) == (flags2
& UNINTERESTING
))
697 die(_("Not a range."));
701 /* given a range a..b get all patch ids for b..a */
702 init_revisions(&check_rev
, prefix
);
703 o1
->flags
^= UNINTERESTING
;
704 o2
->flags
^= UNINTERESTING
;
705 add_pending_object(&check_rev
, o1
, "o1");
706 add_pending_object(&check_rev
, o2
, "o2");
707 if (prepare_revision_walk(&check_rev
))
708 die(_("revision walk setup failed"));
710 while ((commit
= get_revision(&check_rev
)) != NULL
) {
712 if (commit
->parents
&& commit
->parents
->next
)
715 add_commit_patch_id(commit
, ids
);
718 /* reset for next revision walk */
719 clear_commit_marks((struct commit
*)o1
,
720 SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
721 clear_commit_marks((struct commit
*)o2
,
722 SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
727 static void gen_message_id(struct rev_info
*info
, char *base
)
729 const char *committer
= git_committer_info(IDENT_WARN_ON_NO_NAME
);
730 const char *email_start
= strrchr(committer
, '<');
731 const char *email_end
= strrchr(committer
, '>');
732 struct strbuf buf
= STRBUF_INIT
;
733 if (!email_start
|| !email_end
|| email_start
> email_end
- 1)
734 die(_("Could not extract email from committer identity."));
735 strbuf_addf(&buf
, "%s.%lu.git.%.*s", base
,
736 (unsigned long) time(NULL
),
737 (int)(email_end
- email_start
- 1), email_start
+ 1);
738 info
->message_id
= strbuf_detach(&buf
, NULL
);
741 static void print_signature(void)
743 if (signature
&& *signature
)
744 printf("-- \n%s\n\n", signature
);
747 static void make_cover_letter(struct rev_info
*rev
, int use_stdout
,
748 int numbered
, int numbered_files
,
749 struct commit
*origin
,
750 int nr
, struct commit
**list
, struct commit
*head
,
753 const char *committer
;
754 const char *subject_start
= NULL
;
755 const char *body
= "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
757 const char *extra_headers
= rev
->extra_headers
;
759 struct strbuf sb
= STRBUF_INIT
;
761 const char *encoding
= "UTF-8";
762 struct diff_options opts
;
763 int need_8bit_cte
= 0;
764 struct commit
*commit
= NULL
;
766 if (rev
->commit_format
!= CMIT_FMT_EMAIL
)
767 die(_("Cover letter needs email format"));
769 committer
= git_committer_info(0);
771 if (!numbered_files
) {
773 * We fake a commit for the cover letter so we get the filename
776 commit
= xcalloc(1, sizeof(*commit
));
777 commit
->buffer
= xmalloc(400);
778 snprintf(commit
->buffer
, 400,
779 "tree 0000000000000000000000000000000000000000\n"
784 sha1_to_hex(head
->object
.sha1
), committer
, committer
);
787 if (!use_stdout
&& reopen_stdout(commit
, rev
, quiet
))
792 free(commit
->buffer
);
796 log_write_email_headers(rev
, head
, &subject_start
, &extra_headers
,
799 for (i
= 0; !need_8bit_cte
&& i
< nr
; i
++)
800 if (has_non_ascii(list
[i
]->buffer
))
804 pp_user_info(NULL
, CMIT_FMT_EMAIL
, &sb
, committer
, DATE_RFC2822
,
806 pp_title_line(CMIT_FMT_EMAIL
, &msg
, &sb
, subject_start
, extra_headers
,
807 encoding
, need_8bit_cte
);
808 pp_remainder(CMIT_FMT_EMAIL
, &msg
, &sb
, 0);
809 printf("%s\n", sb
.buf
);
818 for (i
= 0; i
< nr
; i
++)
819 shortlog_add_commit(&log
, list
[i
]);
821 shortlog_output(&log
);
824 * We can only do diffstat with a unique reference point
829 memcpy(&opts
, &rev
->diffopt
, sizeof(opts
));
830 opts
.output_format
= DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
832 diff_setup_done(&opts
);
834 diff_tree_sha1(origin
->tree
->object
.sha1
,
835 head
->tree
->object
.sha1
,
844 static const char *clean_message_id(const char *msg_id
)
847 const char *a
, *z
, *m
;
850 while ((ch
= *m
) && (isspace(ch
) || (ch
== '<')))
855 if (!isspace(ch
) && (ch
!= '>'))
860 die(_("insane in-reply-to: %s"), msg_id
);
863 return xmemdupz(a
, z
- a
);
866 static const char *set_outdir(const char *prefix
, const char *output_directory
)
868 if (output_directory
&& is_absolute_path(output_directory
))
869 return output_directory
;
871 if (!prefix
|| !*prefix
) {
872 if (output_directory
)
873 return output_directory
;
874 /* The user did not explicitly ask for "./" */
879 outdir_offset
= strlen(prefix
);
880 if (!output_directory
)
883 return xstrdup(prefix_filename(prefix
, outdir_offset
,
887 static const char * const builtin_format_patch_usage
[] = {
888 "git format-patch [options] [<since> | <revision range>]",
892 static int keep_subject
= 0;
894 static int keep_callback(const struct option
*opt
, const char *arg
, int unset
)
896 ((struct rev_info
*)opt
->value
)->total
= -1;
901 static int subject_prefix
= 0;
903 static int subject_prefix_callback(const struct option
*opt
, const char *arg
,
907 ((struct rev_info
*)opt
->value
)->subject_prefix
= arg
;
911 static int numbered_cmdline_opt
= 0;
913 static int numbered_callback(const struct option
*opt
, const char *arg
,
916 *(int *)opt
->value
= numbered_cmdline_opt
= unset
? 0 : 1;
922 static int no_numbered_callback(const struct option
*opt
, const char *arg
,
925 return numbered_callback(opt
, arg
, 1);
928 static int output_directory_callback(const struct option
*opt
, const char *arg
,
931 const char **dir
= (const char **)opt
->value
;
933 die(_("Two output directories?"));
938 static int thread_callback(const struct option
*opt
, const char *arg
, int unset
)
940 int *thread
= (int *)opt
->value
;
943 else if (!arg
|| !strcmp(arg
, "shallow"))
944 *thread
= THREAD_SHALLOW
;
945 else if (!strcmp(arg
, "deep"))
946 *thread
= THREAD_DEEP
;
952 static int attach_callback(const struct option
*opt
, const char *arg
, int unset
)
954 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
956 rev
->mime_boundary
= NULL
;
958 rev
->mime_boundary
= arg
;
960 rev
->mime_boundary
= git_version_string
;
961 rev
->no_inline
= unset
? 0 : 1;
965 static int inline_callback(const struct option
*opt
, const char *arg
, int unset
)
967 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
969 rev
->mime_boundary
= NULL
;
971 rev
->mime_boundary
= arg
;
973 rev
->mime_boundary
= git_version_string
;
978 static int header_callback(const struct option
*opt
, const char *arg
, int unset
)
981 string_list_clear(&extra_hdr
, 0);
982 string_list_clear(&extra_to
, 0);
983 string_list_clear(&extra_cc
, 0);
990 static int to_callback(const struct option
*opt
, const char *arg
, int unset
)
993 string_list_clear(&extra_to
, 0);
995 string_list_append(&extra_to
, arg
);
999 static int cc_callback(const struct option
*opt
, const char *arg
, int unset
)
1002 string_list_clear(&extra_cc
, 0);
1004 string_list_append(&extra_cc
, arg
);
1008 int cmd_format_patch(int argc
, const char **argv
, const char *prefix
)
1010 struct commit
*commit
;
1011 struct commit
**list
= NULL
;
1012 struct rev_info rev
;
1013 struct setup_revision_opt s_r_opt
;
1014 int nr
= 0, total
, i
;
1016 int start_number
= -1;
1017 int numbered_files
= 0; /* _just_ numbers */
1018 int ignore_if_in_upstream
= 0;
1019 int cover_letter
= 0;
1020 int boundary_count
= 0;
1021 int no_binary_diff
= 0;
1022 struct commit
*origin
= NULL
, *head
= NULL
;
1023 const char *in_reply_to
= NULL
;
1024 struct patch_ids ids
;
1025 char *add_signoff
= NULL
;
1026 struct strbuf buf
= STRBUF_INIT
;
1027 int use_patch_format
= 0;
1029 const struct option builtin_format_patch_options
[] = {
1030 { OPTION_CALLBACK
, 'n', "numbered", &numbered
, NULL
,
1031 "use [PATCH n/m] even with a single patch",
1032 PARSE_OPT_NOARG
, numbered_callback
},
1033 { OPTION_CALLBACK
, 'N', "no-numbered", &numbered
, NULL
,
1034 "use [PATCH] even with multiple patches",
1035 PARSE_OPT_NOARG
, no_numbered_callback
},
1036 OPT_BOOLEAN('s', "signoff", &do_signoff
, "add Signed-off-by:"),
1037 OPT_BOOLEAN(0, "stdout", &use_stdout
,
1038 "print patches to standard out"),
1039 OPT_BOOLEAN(0, "cover-letter", &cover_letter
,
1040 "generate a cover letter"),
1041 OPT_BOOLEAN(0, "numbered-files", &numbered_files
,
1042 "use simple number sequence for output file names"),
1043 OPT_STRING(0, "suffix", &fmt_patch_suffix
, "sfx",
1044 "use <sfx> instead of '.patch'"),
1045 OPT_INTEGER(0, "start-number", &start_number
,
1046 "start numbering patches at <n> instead of 1"),
1047 { OPTION_CALLBACK
, 0, "subject-prefix", &rev
, "prefix",
1048 "Use [<prefix>] instead of [PATCH]",
1049 PARSE_OPT_NONEG
, subject_prefix_callback
},
1050 { OPTION_CALLBACK
, 'o', "output-directory", &output_directory
,
1051 "dir", "store resulting files in <dir>",
1052 PARSE_OPT_NONEG
, output_directory_callback
},
1053 { OPTION_CALLBACK
, 'k', "keep-subject", &rev
, NULL
,
1054 "don't strip/add [PATCH]",
1055 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, keep_callback
},
1056 OPT_BOOLEAN(0, "no-binary", &no_binary_diff
,
1057 "don't output binary diffs"),
1058 OPT_BOOLEAN(0, "ignore-if-in-upstream", &ignore_if_in_upstream
,
1059 "don't include a patch matching a commit upstream"),
1060 { OPTION_BOOLEAN
, 'p', "no-stat", &use_patch_format
, NULL
,
1061 "show patch format instead of default (patch + stat)",
1062 PARSE_OPT_NONEG
| PARSE_OPT_NOARG
},
1063 OPT_GROUP("Messaging"),
1064 { OPTION_CALLBACK
, 0, "add-header", NULL
, "header",
1065 "add email header", 0, header_callback
},
1066 { OPTION_CALLBACK
, 0, "to", NULL
, "email", "add To: header",
1068 { OPTION_CALLBACK
, 0, "cc", NULL
, "email", "add Cc: header",
1070 OPT_STRING(0, "in-reply-to", &in_reply_to
, "message-id",
1071 "make first mail a reply to <message-id>"),
1072 { OPTION_CALLBACK
, 0, "attach", &rev
, "boundary",
1073 "attach the patch", PARSE_OPT_OPTARG
,
1075 { OPTION_CALLBACK
, 0, "inline", &rev
, "boundary",
1077 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
1079 { OPTION_CALLBACK
, 0, "thread", &thread
, "style",
1080 "enable message threading, styles: shallow, deep",
1081 PARSE_OPT_OPTARG
, thread_callback
},
1082 OPT_STRING(0, "signature", &signature
, "signature",
1084 OPT_BOOLEAN(0, "quiet", &quiet
,
1085 "don't print the patch filenames"),
1089 extra_hdr
.strdup_strings
= 1;
1090 extra_to
.strdup_strings
= 1;
1091 extra_cc
.strdup_strings
= 1;
1092 git_config(git_format_config
, NULL
);
1093 init_revisions(&rev
, prefix
);
1094 rev
.commit_format
= CMIT_FMT_EMAIL
;
1095 rev
.verbose_header
= 1;
1097 rev
.max_parents
= 1;
1098 DIFF_OPT_SET(&rev
.diffopt
, RECURSIVE
);
1099 rev
.subject_prefix
= fmt_patch_subject_prefix
;
1100 memset(&s_r_opt
, 0, sizeof(s_r_opt
));
1101 s_r_opt
.def
= "HEAD";
1103 if (default_attach
) {
1104 rev
.mime_boundary
= default_attach
;
1109 * Parse the arguments before setup_revisions(), or something
1110 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1111 * possibly a valid SHA1.
1113 argc
= parse_options(argc
, argv
, prefix
, builtin_format_patch_options
,
1114 builtin_format_patch_usage
,
1115 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
1116 PARSE_OPT_KEEP_DASHDASH
);
1119 const char *committer
;
1121 committer
= git_committer_info(IDENT_ERROR_ON_NO_NAME
);
1122 endpos
= strchr(committer
, '>');
1124 die(_("bogus committer info %s"), committer
);
1125 add_signoff
= xmemdupz(committer
, endpos
- committer
+ 1);
1128 for (i
= 0; i
< extra_hdr
.nr
; i
++) {
1129 strbuf_addstr(&buf
, extra_hdr
.items
[i
].string
);
1130 strbuf_addch(&buf
, '\n');
1134 strbuf_addstr(&buf
, "To: ");
1135 for (i
= 0; i
< extra_to
.nr
; i
++) {
1137 strbuf_addstr(&buf
, " ");
1138 strbuf_addstr(&buf
, extra_to
.items
[i
].string
);
1139 if (i
+ 1 < extra_to
.nr
)
1140 strbuf_addch(&buf
, ',');
1141 strbuf_addch(&buf
, '\n');
1145 strbuf_addstr(&buf
, "Cc: ");
1146 for (i
= 0; i
< extra_cc
.nr
; i
++) {
1148 strbuf_addstr(&buf
, " ");
1149 strbuf_addstr(&buf
, extra_cc
.items
[i
].string
);
1150 if (i
+ 1 < extra_cc
.nr
)
1151 strbuf_addch(&buf
, ',');
1152 strbuf_addch(&buf
, '\n');
1155 rev
.extra_headers
= strbuf_detach(&buf
, NULL
);
1157 if (start_number
< 0)
1161 * If numbered is set solely due to format.numbered in config,
1162 * and it would conflict with --keep-subject (-k) from the
1163 * command line, reset "numbered".
1165 if (numbered
&& keep_subject
&& !numbered_cmdline_opt
)
1168 if (numbered
&& keep_subject
)
1169 die (_("-n and -k are mutually exclusive."));
1170 if (keep_subject
&& subject_prefix
)
1171 die (_("--subject-prefix and -k are mutually exclusive."));
1173 argc
= setup_revisions(argc
, argv
, &rev
, &s_r_opt
);
1175 die (_("unrecognized argument: %s"), argv
[1]);
1177 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME
)
1178 die(_("--name-only does not make sense"));
1179 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME_STATUS
)
1180 die(_("--name-status does not make sense"));
1181 if (rev
.diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
)
1182 die(_("--check does not make sense"));
1184 if (!use_patch_format
&&
1185 (!rev
.diffopt
.output_format
||
1186 rev
.diffopt
.output_format
== DIFF_FORMAT_PATCH
))
1187 rev
.diffopt
.output_format
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_SUMMARY
;
1189 /* Always generate a patch */
1190 rev
.diffopt
.output_format
|= DIFF_FORMAT_PATCH
;
1192 if (!DIFF_OPT_TST(&rev
.diffopt
, TEXT
) && !no_binary_diff
)
1193 DIFF_OPT_SET(&rev
.diffopt
, BINARY
);
1196 init_display_notes(&rev
.notes_opt
);
1199 output_directory
= set_outdir(prefix
, output_directory
);
1203 if (output_directory
) {
1205 die(_("standard output, or directory, which one?"));
1206 if (mkdir(output_directory
, 0777) < 0 && errno
!= EEXIST
)
1207 die_errno(_("Could not create directory '%s'"),
1211 if (rev
.pending
.nr
== 1) {
1212 if (rev
.max_count
< 0 && !rev
.show_root_diff
) {
1214 * This is traditional behaviour of "git format-patch
1215 * origin" that prepares what the origin side still
1218 rev
.pending
.objects
[0].item
->flags
|= UNINTERESTING
;
1219 add_head_to_pending(&rev
);
1222 * Otherwise, it is "format-patch -22 HEAD", and/or
1223 * "format-patch --root HEAD". The user wants
1224 * get_revision() to do the usual traversal.
1229 * We cannot move this anywhere earlier because we do want to
1230 * know if --root was given explicitly from the command line.
1232 rev
.show_root_diff
= 1;
1235 /* remember the range */
1237 for (i
= 0; i
< rev
.pending
.nr
; i
++) {
1238 struct object
*o
= rev
.pending
.objects
[i
].item
;
1239 if (!(o
->flags
& UNINTERESTING
))
1240 head
= (struct commit
*)o
;
1242 /* We can't generate a cover letter without any patches */
1247 if (ignore_if_in_upstream
) {
1248 /* Don't say anything if head and upstream are the same. */
1249 if (rev
.pending
.nr
== 2) {
1250 struct object_array_entry
*o
= rev
.pending
.objects
;
1251 if (hashcmp(o
[0].item
->sha1
, o
[1].item
->sha1
) == 0)
1254 get_patch_ids(&rev
, &ids
, prefix
);
1258 realstdout
= xfdopen(xdup(1), "w");
1260 if (prepare_revision_walk(&rev
))
1261 die(_("revision walk setup failed"));
1263 while ((commit
= get_revision(&rev
)) != NULL
) {
1264 if (commit
->object
.flags
& BOUNDARY
) {
1266 origin
= (boundary_count
== 1) ? commit
: NULL
;
1270 if (ignore_if_in_upstream
&&
1271 has_commit_patch_id(commit
, &ids
))
1275 list
= xrealloc(list
, nr
* sizeof(list
[0]));
1276 list
[nr
- 1] = commit
;
1279 if (!keep_subject
&& auto_number
&& total
> 1)
1282 rev
.total
= total
+ start_number
- 1;
1283 if (in_reply_to
|| thread
|| cover_letter
)
1284 rev
.ref_message_ids
= xcalloc(1, sizeof(struct string_list
));
1286 const char *msgid
= clean_message_id(in_reply_to
);
1287 string_list_append(rev
.ref_message_ids
, msgid
);
1289 rev
.numbered_files
= numbered_files
;
1290 rev
.patch_suffix
= fmt_patch_suffix
;
1293 gen_message_id(&rev
, "cover");
1294 make_cover_letter(&rev
, use_stdout
, numbered
, numbered_files
,
1295 origin
, nr
, list
, head
, quiet
);
1299 rev
.add_signoff
= add_signoff
;
1303 rev
.nr
= total
- nr
+ (start_number
- 1);
1304 /* Make the second and subsequent mails replies to the first */
1306 /* Have we already had a message ID? */
1307 if (rev
.message_id
) {
1309 * For deep threading: make every mail
1310 * a reply to the previous one, no
1311 * matter what other options are set.
1313 * For shallow threading:
1315 * Without --cover-letter and
1316 * --in-reply-to, make every mail a
1317 * reply to the one before.
1319 * With --in-reply-to but no
1320 * --cover-letter, make every mail a
1321 * reply to the <reply-to>.
1323 * With --cover-letter, make every
1324 * mail but the cover letter a reply
1325 * to the cover letter. The cover
1326 * letter is a reply to the
1327 * --in-reply-to, if specified.
1329 if (thread
== THREAD_SHALLOW
1330 && rev
.ref_message_ids
->nr
> 0
1331 && (!cover_letter
|| rev
.nr
> 1))
1332 free(rev
.message_id
);
1334 string_list_append(rev
.ref_message_ids
,
1337 gen_message_id(&rev
, sha1_to_hex(commit
->object
.sha1
));
1340 if (!use_stdout
&& reopen_stdout(numbered_files
? NULL
: commit
,
1342 die(_("Failed to create output files"));
1343 shown
= log_tree_commit(&rev
, commit
);
1344 free(commit
->buffer
);
1345 commit
->buffer
= NULL
;
1347 /* We put one extra blank line between formatted
1348 * patches and this flag is used by log-tree code
1349 * to see if it needs to emit a LF before showing
1350 * the log; when using one file per patch, we do
1351 * not want the extra blank line.
1356 if (rev
.mime_boundary
)
1357 printf("\n--%s%s--\n\n\n",
1358 mime_boundary_leader
,
1367 string_list_clear(&extra_to
, 0);
1368 string_list_clear(&extra_cc
, 0);
1369 string_list_clear(&extra_hdr
, 0);
1370 if (ignore_if_in_upstream
)
1371 free_patch_ids(&ids
);
1375 static int add_pending_commit(const char *arg
, struct rev_info
*revs
, int flags
)
1377 unsigned char sha1
[20];
1378 if (get_sha1(arg
, sha1
) == 0) {
1379 struct commit
*commit
= lookup_commit_reference(sha1
);
1381 commit
->object
.flags
|= flags
;
1382 add_pending_object(revs
, &commit
->object
, arg
);
1389 static const char * const cherry_usage
[] = {
1390 "git cherry [-v] [<upstream> [<head> [<limit>]]]",
1394 static void print_commit(char sign
, struct commit
*commit
, int verbose
,
1398 printf("%c %s\n", sign
,
1399 find_unique_abbrev(commit
->object
.sha1
, abbrev
));
1401 struct strbuf buf
= STRBUF_INIT
;
1402 struct pretty_print_context ctx
= {0};
1403 pretty_print_commit(CMIT_FMT_ONELINE
, commit
, &buf
, &ctx
);
1404 printf("%c %s %s\n", sign
,
1405 find_unique_abbrev(commit
->object
.sha1
, abbrev
),
1407 strbuf_release(&buf
);
1411 int cmd_cherry(int argc
, const char **argv
, const char *prefix
)
1413 struct rev_info revs
;
1414 struct patch_ids ids
;
1415 struct commit
*commit
;
1416 struct commit_list
*list
= NULL
;
1417 struct branch
*current_branch
;
1418 const char *upstream
;
1419 const char *head
= "HEAD";
1420 const char *limit
= NULL
;
1421 int verbose
= 0, abbrev
= 0;
1423 struct option options
[] = {
1424 OPT__ABBREV(&abbrev
),
1425 OPT__VERBOSE(&verbose
, "be verbose"),
1429 argc
= parse_options(argc
, argv
, prefix
, options
, cherry_usage
, 0);
1442 current_branch
= branch_get(NULL
);
1443 if (!current_branch
|| !current_branch
->merge
1444 || !current_branch
->merge
[0]
1445 || !current_branch
->merge
[0]->dst
) {
1446 fprintf(stderr
, _("Could not find a tracked"
1447 " remote branch, please"
1448 " specify <upstream> manually.\n"));
1449 usage_with_options(cherry_usage
, options
);
1452 upstream
= current_branch
->merge
[0]->dst
;
1455 init_revisions(&revs
, prefix
);
1457 revs
.combine_merges
= 0;
1458 revs
.ignore_merges
= 1;
1459 DIFF_OPT_SET(&revs
.diffopt
, RECURSIVE
);
1461 if (add_pending_commit(head
, &revs
, 0))
1462 die(_("Unknown commit %s"), head
);
1463 if (add_pending_commit(upstream
, &revs
, UNINTERESTING
))
1464 die(_("Unknown commit %s"), upstream
);
1466 /* Don't say anything if head and upstream are the same. */
1467 if (revs
.pending
.nr
== 2) {
1468 struct object_array_entry
*o
= revs
.pending
.objects
;
1469 if (hashcmp(o
[0].item
->sha1
, o
[1].item
->sha1
) == 0)
1473 get_patch_ids(&revs
, &ids
, prefix
);
1475 if (limit
&& add_pending_commit(limit
, &revs
, UNINTERESTING
))
1476 die(_("Unknown commit %s"), limit
);
1478 /* reverse the list of commits */
1479 if (prepare_revision_walk(&revs
))
1480 die(_("revision walk setup failed"));
1481 while ((commit
= get_revision(&revs
)) != NULL
) {
1483 if (commit
->parents
&& commit
->parents
->next
)
1486 commit_list_insert(commit
, &list
);
1492 commit
= list
->item
;
1493 if (has_commit_patch_id(commit
, &ids
))
1495 print_commit(sign
, commit
, verbose
, abbrev
);
1499 free_patch_ids(&ids
);