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 #include "streaming.h"
26 /* Set a default date-time format for git log ("log.date" config variable) */
27 static const char *default_date_mode
= NULL
;
29 static int default_abbrev_commit
;
30 static int default_show_root
= 1;
31 static int decoration_style
;
32 static int decoration_given
;
33 static const char *fmt_patch_subject_prefix
= "PATCH";
34 static const char *fmt_pretty
;
36 static const char * const builtin_log_usage
[] = {
37 N_("git log [<options>] [<since>..<until>] [[--] <path>...]\n")
38 N_(" or: git show [options] <object>..."),
42 static int parse_decoration_style(const char *var
, const char *value
)
44 switch (git_config_maybe_bool(var
, value
)) {
46 return DECORATE_SHORT_REFS
;
52 if (!strcmp(value
, "full"))
53 return DECORATE_FULL_REFS
;
54 else if (!strcmp(value
, "short"))
55 return DECORATE_SHORT_REFS
;
59 static int decorate_callback(const struct option
*opt
, const char *arg
, int unset
)
64 decoration_style
= parse_decoration_style("command line", arg
);
66 decoration_style
= DECORATE_SHORT_REFS
;
68 if (decoration_style
< 0)
69 die("invalid --decorate option: %s", arg
);
76 static void cmd_log_init_defaults(struct rev_info
*rev
)
79 get_commit_format(fmt_pretty
, rev
);
80 rev
->verbose_header
= 1;
81 DIFF_OPT_SET(&rev
->diffopt
, RECURSIVE
);
82 rev
->diffopt
.stat_width
= -1; /* use full terminal width */
83 rev
->diffopt
.stat_graph_width
= -1; /* respect statGraphWidth config */
84 rev
->abbrev_commit
= default_abbrev_commit
;
85 rev
->show_root_diff
= default_show_root
;
86 rev
->subject_prefix
= fmt_patch_subject_prefix
;
87 DIFF_OPT_SET(&rev
->diffopt
, ALLOW_TEXTCONV
);
89 if (default_date_mode
)
90 rev
->date_mode
= parse_date_format(default_date_mode
);
93 static void cmd_log_init_finish(int argc
, const char **argv
, const char *prefix
,
94 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
96 struct userformat_want w
;
97 int quiet
= 0, source
= 0;
99 const struct option builtin_log_options
[] = {
100 OPT_BOOLEAN(0, "quiet", &quiet
, N_("suppress diff output")),
101 OPT_BOOLEAN(0, "source", &source
, N_("show source")),
102 { OPTION_CALLBACK
, 0, "decorate", NULL
, NULL
, N_("decorate options"),
103 PARSE_OPT_OPTARG
, decorate_callback
},
107 argc
= parse_options(argc
, argv
, prefix
,
108 builtin_log_options
, builtin_log_usage
,
109 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
110 PARSE_OPT_KEEP_DASHDASH
);
113 rev
->diffopt
.output_format
|= DIFF_FORMAT_NO_OUTPUT
;
114 argc
= setup_revisions(argc
, argv
, rev
, opt
);
116 /* Any arguments at this point are not recognized */
118 die("unrecognized argument: %s", argv
[1]);
120 memset(&w
, 0, sizeof(w
));
121 userformat_find_requirements(NULL
, &w
);
123 if (!rev
->show_notes_given
&& (!rev
->pretty_given
|| w
.notes
))
126 init_display_notes(&rev
->notes_opt
);
128 if (rev
->diffopt
.pickaxe
|| rev
->diffopt
.filter
)
129 rev
->always_show_header
= 0;
130 if (DIFF_OPT_TST(&rev
->diffopt
, FOLLOW_RENAMES
)) {
131 rev
->always_show_header
= 0;
132 if (rev
->diffopt
.pathspec
.nr
!= 1)
133 usage("git logs can only follow renames on one pathname at a time");
137 rev
->show_source
= 1;
139 if (rev
->pretty_given
&& rev
->commit_format
== CMIT_FMT_RAW
) {
141 * "log --pretty=raw" is special; ignore UI oriented
142 * configuration variables such as decoration.
144 if (!decoration_given
)
145 decoration_style
= 0;
146 if (!rev
->abbrev_commit_given
)
147 rev
->abbrev_commit
= 0;
150 if (decoration_style
) {
151 rev
->show_decorations
= 1;
152 load_ref_decorations(decoration_style
);
157 static void cmd_log_init(int argc
, const char **argv
, const char *prefix
,
158 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
160 cmd_log_init_defaults(rev
);
161 cmd_log_init_finish(argc
, argv
, prefix
, rev
, opt
);
165 * This gives a rough estimate for how many commits we
166 * will print out in the list.
168 static int estimate_commit_count(struct rev_info
*rev
, struct commit_list
*list
)
173 struct commit
*commit
= list
->item
;
174 unsigned int flags
= commit
->object
.flags
;
176 if (!(flags
& (TREESAME
| UNINTERESTING
)))
182 static void show_early_header(struct rev_info
*rev
, const char *stage
, int nr
)
184 if (rev
->shown_one
) {
186 if (rev
->commit_format
!= CMIT_FMT_ONELINE
)
187 putchar(rev
->diffopt
.line_termination
);
189 printf(_("Final output: %d %s\n"), nr
, stage
);
192 static struct itimerval early_output_timer
;
194 static void log_show_early(struct rev_info
*revs
, struct commit_list
*list
)
196 int i
= revs
->early_output
;
199 sort_in_topological_order(&list
, revs
->lifo
);
201 struct commit
*commit
= list
->item
;
202 switch (simplify_commit(revs
, commit
)) {
205 int n
= estimate_commit_count(revs
, list
);
206 show_early_header(revs
, "incomplete", n
);
209 log_tree_commit(revs
, commit
);
220 /* Did we already get enough commits for the early output? */
225 * ..if no, then repeat it twice a second until we
228 * NOTE! We don't use "it_interval", because if the
229 * reader isn't listening, we want our output to be
230 * throttled by the writing, and not have the timer
231 * trigger every second even if we're blocked on a
234 early_output_timer
.it_value
.tv_sec
= 0;
235 early_output_timer
.it_value
.tv_usec
= 500000;
236 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
239 static void early_output(int signal
)
241 show_early_output
= log_show_early
;
244 static void setup_early_output(struct rev_info
*rev
)
249 * Set up the signal handler, minimally intrusively:
250 * we only set a single volatile integer word (not
251 * using sigatomic_t - trying to avoid unnecessary
252 * system dependencies and headers), and using
255 memset(&sa
, 0, sizeof(sa
));
256 sa
.sa_handler
= early_output
;
257 sigemptyset(&sa
.sa_mask
);
258 sa
.sa_flags
= SA_RESTART
;
259 sigaction(SIGALRM
, &sa
, NULL
);
262 * If we can get the whole output in less than a
263 * tenth of a second, don't even bother doing the
264 * early-output thing..
266 * This is a one-time-only trigger.
268 early_output_timer
.it_value
.tv_sec
= 0;
269 early_output_timer
.it_value
.tv_usec
= 100000;
270 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
273 static void finish_early_output(struct rev_info
*rev
)
275 int n
= estimate_commit_count(rev
, rev
->commits
);
276 signal(SIGALRM
, SIG_IGN
);
277 show_early_header(rev
, "done", n
);
280 static int cmd_log_walk(struct rev_info
*rev
)
282 struct commit
*commit
;
286 if (rev
->early_output
)
287 setup_early_output(rev
);
289 if (prepare_revision_walk(rev
))
290 die(_("revision walk setup failed"));
292 if (rev
->early_output
)
293 finish_early_output(rev
);
296 * For --check and --exit-code, the exit code is based on CHECK_FAILED
297 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
298 * retain that state information if replacing rev->diffopt in this loop
300 while ((commit
= get_revision(rev
)) != NULL
) {
301 if (!log_tree_commit(rev
, commit
) &&
304 * We decremented max_count in get_revision,
305 * but we didn't actually show the commit.
308 if (!rev
->reflog_info
) {
309 /* we allow cycles in reflog ancestry */
310 free(commit
->buffer
);
311 commit
->buffer
= NULL
;
313 free_commit_list(commit
->parents
);
314 commit
->parents
= NULL
;
315 if (saved_nrl
< rev
->diffopt
.needed_rename_limit
)
316 saved_nrl
= rev
->diffopt
.needed_rename_limit
;
317 if (rev
->diffopt
.degraded_cc_to_c
)
320 rev
->diffopt
.degraded_cc_to_c
= saved_dcctc
;
321 rev
->diffopt
.needed_rename_limit
= saved_nrl
;
323 if (rev
->diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
&&
324 DIFF_OPT_TST(&rev
->diffopt
, CHECK_FAILED
)) {
327 return diff_result_code(&rev
->diffopt
, 0);
330 static int git_log_config(const char *var
, const char *value
, void *cb
)
332 if (!strcmp(var
, "format.pretty"))
333 return git_config_string(&fmt_pretty
, var
, value
);
334 if (!strcmp(var
, "format.subjectprefix"))
335 return git_config_string(&fmt_patch_subject_prefix
, var
, value
);
336 if (!strcmp(var
, "log.abbrevcommit")) {
337 default_abbrev_commit
= git_config_bool(var
, value
);
340 if (!strcmp(var
, "log.date"))
341 return git_config_string(&default_date_mode
, var
, value
);
342 if (!strcmp(var
, "log.decorate")) {
343 decoration_style
= parse_decoration_style(var
, value
);
344 if (decoration_style
< 0)
345 decoration_style
= 0; /* maybe warn? */
348 if (!strcmp(var
, "log.showroot")) {
349 default_show_root
= git_config_bool(var
, value
);
352 if (!prefixcmp(var
, "color.decorate."))
353 return parse_decorate_color_config(var
, 15, value
);
354 if (grep_config(var
, value
, cb
) < 0)
356 return git_diff_ui_config(var
, value
, cb
);
359 int cmd_whatchanged(int argc
, const char **argv
, const char *prefix
)
362 struct setup_revision_opt opt
;
364 init_grep_defaults();
365 git_config(git_log_config
, NULL
);
367 init_revisions(&rev
, prefix
);
369 rev
.simplify_history
= 0;
370 memset(&opt
, 0, sizeof(opt
));
372 opt
.revarg_opt
= REVARG_COMMITTISH
;
373 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
374 if (!rev
.diffopt
.output_format
)
375 rev
.diffopt
.output_format
= DIFF_FORMAT_RAW
;
376 return cmd_log_walk(&rev
);
379 static void show_tagger(char *buf
, int len
, struct rev_info
*rev
)
381 struct strbuf out
= STRBUF_INIT
;
382 struct pretty_print_context pp
= {0};
384 pp
.fmt
= rev
->commit_format
;
385 pp
.date_mode
= rev
->date_mode
;
386 pp_user_info(&pp
, "Tagger", &out
, buf
, get_log_output_encoding());
387 printf("%s", out
.buf
);
388 strbuf_release(&out
);
391 static int show_blob_object(const unsigned char *sha1
, struct rev_info
*rev
)
394 return stream_blob_to_fd(1, sha1
, NULL
, 0);
397 static int show_tag_object(const unsigned char *sha1
, struct rev_info
*rev
)
400 enum object_type type
;
401 char *buf
= read_sha1_file(sha1
, &type
, &size
);
405 return error(_("Could not read object %s"), sha1_to_hex(sha1
));
407 assert(type
== OBJ_TAG
);
408 while (offset
< size
&& buf
[offset
] != '\n') {
409 int new_offset
= offset
+ 1;
410 while (new_offset
< size
&& buf
[new_offset
++] != '\n')
412 if (!prefixcmp(buf
+ offset
, "tagger "))
413 show_tagger(buf
+ offset
+ 7,
414 new_offset
- offset
- 7, rev
);
419 fwrite(buf
+ offset
, size
- offset
, 1, stdout
);
424 static int show_tree_object(const unsigned char *sha1
,
425 const char *base
, int baselen
,
426 const char *pathname
, unsigned mode
, int stage
, void *context
)
428 printf("%s%s\n", pathname
, S_ISDIR(mode
) ? "/" : "");
432 static void show_rev_tweak_rev(struct rev_info
*rev
, struct setup_revision_opt
*opt
)
434 if (rev
->ignore_merges
) {
435 /* There was no "-m" on the command line */
436 rev
->ignore_merges
= 0;
437 if (!rev
->first_parent_only
&& !rev
->combine_merges
) {
438 /* No "--first-parent", "-c", nor "--cc" */
439 rev
->combine_merges
= 1;
440 rev
->dense_combined_merges
= 1;
443 if (!rev
->diffopt
.output_format
)
444 rev
->diffopt
.output_format
= DIFF_FORMAT_PATCH
;
447 int cmd_show(int argc
, const char **argv
, const char *prefix
)
450 struct object_array_entry
*objects
;
451 struct setup_revision_opt opt
;
452 struct pathspec match_all
;
453 int i
, count
, ret
= 0;
455 init_grep_defaults();
456 git_config(git_log_config
, NULL
);
458 init_pathspec(&match_all
, NULL
);
459 init_revisions(&rev
, prefix
);
461 rev
.always_show_header
= 1;
462 rev
.no_walk
= REVISION_WALK_NO_WALK_SORTED
;
463 rev
.diffopt
.stat_width
= -1; /* Scale to real terminal size */
465 memset(&opt
, 0, sizeof(opt
));
467 opt
.tweak
= show_rev_tweak_rev
;
468 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
471 return cmd_log_walk(&rev
);
473 count
= rev
.pending
.nr
;
474 objects
= rev
.pending
.objects
;
475 for (i
= 0; i
< count
&& !ret
; i
++) {
476 struct object
*o
= objects
[i
].item
;
477 const char *name
= objects
[i
].name
;
480 ret
= show_blob_object(o
->sha1
, NULL
);
483 struct tag
*t
= (struct tag
*)o
;
487 printf("%stag %s%s\n",
488 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
490 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
491 ret
= show_tag_object(o
->sha1
, &rev
);
495 o
= parse_object(t
->tagged
->sha1
);
497 ret
= error(_("Could not read object %s"),
498 sha1_to_hex(t
->tagged
->sha1
));
506 printf("%stree %s%s\n\n",
507 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
509 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
510 read_tree_recursive((struct tree
*)o
, "", 0, 0, &match_all
,
511 show_tree_object
, NULL
);
515 rev
.pending
.nr
= rev
.pending
.alloc
= 0;
516 rev
.pending
.objects
= NULL
;
517 add_object_array(o
, name
, &rev
.pending
);
518 ret
= cmd_log_walk(&rev
);
521 ret
= error(_("Unknown type: %d"), o
->type
);
529 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
531 int cmd_log_reflog(int argc
, const char **argv
, const char *prefix
)
534 struct setup_revision_opt opt
;
536 init_grep_defaults();
537 git_config(git_log_config
, NULL
);
539 init_revisions(&rev
, prefix
);
540 init_reflog_walk(&rev
.reflog_info
);
541 rev
.verbose_header
= 1;
542 memset(&opt
, 0, sizeof(opt
));
544 cmd_log_init_defaults(&rev
);
545 rev
.abbrev_commit
= 1;
546 rev
.commit_format
= CMIT_FMT_ONELINE
;
547 rev
.use_terminator
= 1;
548 rev
.always_show_header
= 1;
549 cmd_log_init_finish(argc
, argv
, prefix
, &rev
, &opt
);
551 return cmd_log_walk(&rev
);
554 int cmd_log(int argc
, const char **argv
, const char *prefix
)
557 struct setup_revision_opt opt
;
559 init_grep_defaults();
560 git_config(git_log_config
, NULL
);
562 init_revisions(&rev
, prefix
);
563 rev
.always_show_header
= 1;
564 memset(&opt
, 0, sizeof(opt
));
566 opt
.revarg_opt
= REVARG_COMMITTISH
;
567 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
568 return cmd_log_walk(&rev
);
573 static const char *fmt_patch_suffix
= ".patch";
574 static int numbered
= 0;
575 static int auto_number
= 1;
577 static char *default_attach
= NULL
;
579 static struct string_list extra_hdr
;
580 static struct string_list extra_to
;
581 static struct string_list extra_cc
;
583 static void add_header(const char *value
)
585 struct string_list_item
*item
;
586 int len
= strlen(value
);
587 while (len
&& value
[len
- 1] == '\n')
590 if (!strncasecmp(value
, "to: ", 4)) {
591 item
= string_list_append(&extra_to
, value
+ 4);
593 } else if (!strncasecmp(value
, "cc: ", 4)) {
594 item
= string_list_append(&extra_cc
, value
+ 4);
597 item
= string_list_append(&extra_hdr
, value
);
600 item
->string
[len
] = '\0';
603 #define THREAD_SHALLOW 1
604 #define THREAD_DEEP 2
606 static int do_signoff
;
607 static const char *signature
= git_version_string
;
609 static int git_format_config(const char *var
, const char *value
, void *cb
)
611 if (!strcmp(var
, "format.headers")) {
613 die(_("format.headers without value"));
617 if (!strcmp(var
, "format.suffix"))
618 return git_config_string(&fmt_patch_suffix
, var
, value
);
619 if (!strcmp(var
, "format.to")) {
621 return config_error_nonbool(var
);
622 string_list_append(&extra_to
, value
);
625 if (!strcmp(var
, "format.cc")) {
627 return config_error_nonbool(var
);
628 string_list_append(&extra_cc
, value
);
631 if (!strcmp(var
, "diff.color") || !strcmp(var
, "color.diff") ||
632 !strcmp(var
, "color.ui")) {
635 if (!strcmp(var
, "format.numbered")) {
636 if (value
&& !strcasecmp(value
, "auto")) {
640 numbered
= git_config_bool(var
, value
);
641 auto_number
= auto_number
&& numbered
;
644 if (!strcmp(var
, "format.attach")) {
646 default_attach
= xstrdup(value
);
648 default_attach
= xstrdup(git_version_string
);
651 if (!strcmp(var
, "format.thread")) {
652 if (value
&& !strcasecmp(value
, "deep")) {
653 thread
= THREAD_DEEP
;
656 if (value
&& !strcasecmp(value
, "shallow")) {
657 thread
= THREAD_SHALLOW
;
660 thread
= git_config_bool(var
, value
) && THREAD_SHALLOW
;
663 if (!strcmp(var
, "format.signoff")) {
664 do_signoff
= git_config_bool(var
, value
);
667 if (!strcmp(var
, "format.signature"))
668 return git_config_string(&signature
, var
, value
);
670 return git_log_config(var
, value
, cb
);
673 static FILE *realstdout
= NULL
;
674 static const char *output_directory
= NULL
;
675 static int outdir_offset
;
677 static int reopen_stdout(struct commit
*commit
, const char *subject
,
678 struct rev_info
*rev
, int quiet
)
680 struct strbuf filename
= STRBUF_INIT
;
681 int suffix_len
= strlen(fmt_patch_suffix
) + 1;
683 if (output_directory
) {
684 strbuf_addstr(&filename
, output_directory
);
686 PATH_MAX
- FORMAT_PATCH_NAME_MAX
- suffix_len
)
687 return error(_("name of output directory is too long"));
688 if (filename
.buf
[filename
.len
- 1] != '/')
689 strbuf_addch(&filename
, '/');
692 get_patch_filename(commit
, subject
, rev
->nr
, fmt_patch_suffix
, &filename
);
695 fprintf(realstdout
, "%s\n", filename
.buf
+ outdir_offset
);
697 if (freopen(filename
.buf
, "w", stdout
) == NULL
)
698 return error(_("Cannot open patch file %s"), filename
.buf
);
700 strbuf_release(&filename
);
704 static void get_patch_ids(struct rev_info
*rev
, struct patch_ids
*ids
)
706 struct rev_info check_rev
;
707 struct commit
*commit
;
708 struct object
*o1
, *o2
;
709 unsigned flags1
, flags2
;
711 if (rev
->pending
.nr
!= 2)
712 die(_("Need exactly one range."));
714 o1
= rev
->pending
.objects
[0].item
;
716 o2
= rev
->pending
.objects
[1].item
;
719 if ((flags1
& UNINTERESTING
) == (flags2
& UNINTERESTING
))
720 die(_("Not a range."));
724 /* given a range a..b get all patch ids for b..a */
725 init_revisions(&check_rev
, rev
->prefix
);
726 check_rev
.max_parents
= 1;
727 o1
->flags
^= UNINTERESTING
;
728 o2
->flags
^= UNINTERESTING
;
729 add_pending_object(&check_rev
, o1
, "o1");
730 add_pending_object(&check_rev
, o2
, "o2");
731 if (prepare_revision_walk(&check_rev
))
732 die(_("revision walk setup failed"));
734 while ((commit
= get_revision(&check_rev
)) != NULL
) {
735 add_commit_patch_id(commit
, ids
);
738 /* reset for next revision walk */
739 clear_commit_marks((struct commit
*)o1
,
740 SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
741 clear_commit_marks((struct commit
*)o2
,
742 SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
747 static void gen_message_id(struct rev_info
*info
, char *base
)
749 struct strbuf buf
= STRBUF_INIT
;
750 strbuf_addf(&buf
, "%s.%lu.git.%s", base
,
751 (unsigned long) time(NULL
),
752 git_committer_info(IDENT_NO_NAME
|IDENT_NO_DATE
|IDENT_STRICT
));
753 info
->message_id
= strbuf_detach(&buf
, NULL
);
756 static void print_signature(void)
758 if (signature
&& *signature
)
759 printf("-- \n%s\n\n", signature
);
762 static void add_branch_description(struct strbuf
*buf
, const char *branch_name
)
764 struct strbuf desc
= STRBUF_INIT
;
765 if (!branch_name
|| !*branch_name
)
767 read_branch_desc(&desc
, branch_name
);
769 strbuf_addch(buf
, '\n');
770 strbuf_add(buf
, desc
.buf
, desc
.len
);
771 strbuf_addch(buf
, '\n');
775 static void make_cover_letter(struct rev_info
*rev
, int use_stdout
,
776 int numbered
, int numbered_files
,
777 struct commit
*origin
,
778 int nr
, struct commit
**list
, struct commit
*head
,
779 const char *branch_name
,
782 const char *committer
;
783 const char *body
= "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
786 struct strbuf sb
= STRBUF_INIT
;
788 const char *encoding
= "UTF-8";
789 struct diff_options opts
;
790 int need_8bit_cte
= 0;
791 struct pretty_print_context pp
= {0};
793 if (rev
->commit_format
!= CMIT_FMT_EMAIL
)
794 die(_("Cover letter needs email format"));
796 committer
= git_committer_info(0);
799 reopen_stdout(NULL
, numbered_files
? NULL
: "cover-letter", rev
, quiet
))
802 log_write_email_headers(rev
, head
, &pp
.subject
, &pp
.after_subject
,
805 for (i
= 0; !need_8bit_cte
&& i
< nr
; i
++)
806 if (has_non_ascii(list
[i
]->buffer
))
810 pp
.fmt
= CMIT_FMT_EMAIL
;
811 pp
.date_mode
= DATE_RFC2822
;
812 pp_user_info(&pp
, NULL
, &sb
, committer
, encoding
);
813 pp_title_line(&pp
, &msg
, &sb
, encoding
, need_8bit_cte
);
814 pp_remainder(&pp
, &msg
, &sb
, 0);
815 add_branch_description(&sb
, branch_name
);
816 printf("%s\n", sb
.buf
);
825 for (i
= 0; i
< nr
; i
++)
826 shortlog_add_commit(&log
, list
[i
]);
828 shortlog_output(&log
);
831 * We can only do diffstat with a unique reference point
836 memcpy(&opts
, &rev
->diffopt
, sizeof(opts
));
837 opts
.output_format
= DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
839 diff_setup_done(&opts
);
841 diff_tree_sha1(origin
->tree
->object
.sha1
,
842 head
->tree
->object
.sha1
,
851 static const char *clean_message_id(const char *msg_id
)
854 const char *a
, *z
, *m
;
857 while ((ch
= *m
) && (isspace(ch
) || (ch
== '<')))
862 if (!isspace(ch
) && (ch
!= '>'))
867 die(_("insane in-reply-to: %s"), msg_id
);
870 return xmemdupz(a
, z
- a
);
873 static const char *set_outdir(const char *prefix
, const char *output_directory
)
875 if (output_directory
&& is_absolute_path(output_directory
))
876 return output_directory
;
878 if (!prefix
|| !*prefix
) {
879 if (output_directory
)
880 return output_directory
;
881 /* The user did not explicitly ask for "./" */
886 outdir_offset
= strlen(prefix
);
887 if (!output_directory
)
890 return xstrdup(prefix_filename(prefix
, outdir_offset
,
894 static const char * const builtin_format_patch_usage
[] = {
895 N_("git format-patch [options] [<since> | <revision range>]"),
899 static int keep_subject
= 0;
901 static int keep_callback(const struct option
*opt
, const char *arg
, int unset
)
903 ((struct rev_info
*)opt
->value
)->total
= -1;
908 static int subject_prefix
= 0;
910 static int subject_prefix_callback(const struct option
*opt
, const char *arg
,
914 ((struct rev_info
*)opt
->value
)->subject_prefix
= arg
;
918 static int numbered_cmdline_opt
= 0;
920 static int numbered_callback(const struct option
*opt
, const char *arg
,
923 *(int *)opt
->value
= numbered_cmdline_opt
= unset
? 0 : 1;
929 static int no_numbered_callback(const struct option
*opt
, const char *arg
,
932 return numbered_callback(opt
, arg
, 1);
935 static int output_directory_callback(const struct option
*opt
, const char *arg
,
938 const char **dir
= (const char **)opt
->value
;
940 die(_("Two output directories?"));
945 static int thread_callback(const struct option
*opt
, const char *arg
, int unset
)
947 int *thread
= (int *)opt
->value
;
950 else if (!arg
|| !strcmp(arg
, "shallow"))
951 *thread
= THREAD_SHALLOW
;
952 else if (!strcmp(arg
, "deep"))
953 *thread
= THREAD_DEEP
;
959 static int attach_callback(const struct option
*opt
, const char *arg
, int unset
)
961 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
963 rev
->mime_boundary
= NULL
;
965 rev
->mime_boundary
= arg
;
967 rev
->mime_boundary
= git_version_string
;
968 rev
->no_inline
= unset
? 0 : 1;
972 static int inline_callback(const struct option
*opt
, const char *arg
, int unset
)
974 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
976 rev
->mime_boundary
= NULL
;
978 rev
->mime_boundary
= arg
;
980 rev
->mime_boundary
= git_version_string
;
985 static int header_callback(const struct option
*opt
, const char *arg
, int unset
)
988 string_list_clear(&extra_hdr
, 0);
989 string_list_clear(&extra_to
, 0);
990 string_list_clear(&extra_cc
, 0);
997 static int to_callback(const struct option
*opt
, const char *arg
, int unset
)
1000 string_list_clear(&extra_to
, 0);
1002 string_list_append(&extra_to
, arg
);
1006 static int cc_callback(const struct option
*opt
, const char *arg
, int unset
)
1009 string_list_clear(&extra_cc
, 0);
1011 string_list_append(&extra_cc
, arg
);
1015 static char *find_branch_name(struct rev_info
*rev
)
1017 int i
, positive
= -1;
1018 unsigned char branch_sha1
[20];
1019 const unsigned char *tip_sha1
;
1021 char *full_ref
, *branch
= NULL
;
1023 for (i
= 0; i
< rev
->cmdline
.nr
; i
++) {
1024 if (rev
->cmdline
.rev
[i
].flags
& UNINTERESTING
)
1031 if (0 <= positive
) {
1032 ref
= rev
->cmdline
.rev
[positive
].name
;
1033 tip_sha1
= rev
->cmdline
.rev
[positive
].item
->sha1
;
1034 } else if (!rev
->cmdline
.nr
&& rev
->pending
.nr
== 1 &&
1035 !strcmp(rev
->pending
.objects
[0].name
, "HEAD")) {
1037 * No actual ref from command line, but "HEAD" from
1038 * rev->def was added in setup_revisions()
1039 * e.g. format-patch --cover-letter -12
1042 tip_sha1
= rev
->pending
.objects
[0].item
->sha1
;
1046 if (dwim_ref(ref
, strlen(ref
), branch_sha1
, &full_ref
) &&
1047 !prefixcmp(full_ref
, "refs/heads/") &&
1048 !hashcmp(tip_sha1
, branch_sha1
))
1049 branch
= xstrdup(full_ref
+ strlen("refs/heads/"));
1054 int cmd_format_patch(int argc
, const char **argv
, const char *prefix
)
1056 struct commit
*commit
;
1057 struct commit
**list
= NULL
;
1058 struct rev_info rev
;
1059 struct setup_revision_opt s_r_opt
;
1060 int nr
= 0, total
, i
;
1062 int start_number
= -1;
1063 int numbered_files
= 0; /* _just_ numbers */
1064 int ignore_if_in_upstream
= 0;
1065 int cover_letter
= 0;
1066 int boundary_count
= 0;
1067 int no_binary_diff
= 0;
1068 struct commit
*origin
= NULL
, *head
= NULL
;
1069 const char *in_reply_to
= NULL
;
1070 struct patch_ids ids
;
1071 char *add_signoff
= NULL
;
1072 struct strbuf buf
= STRBUF_INIT
;
1073 int use_patch_format
= 0;
1075 char *branch_name
= NULL
;
1076 const struct option builtin_format_patch_options
[] = {
1077 { OPTION_CALLBACK
, 'n', "numbered", &numbered
, NULL
,
1078 N_("use [PATCH n/m] even with a single patch"),
1079 PARSE_OPT_NOARG
, numbered_callback
},
1080 { OPTION_CALLBACK
, 'N', "no-numbered", &numbered
, NULL
,
1081 N_("use [PATCH] even with multiple patches"),
1082 PARSE_OPT_NOARG
, no_numbered_callback
},
1083 OPT_BOOLEAN('s', "signoff", &do_signoff
, N_("add Signed-off-by:")),
1084 OPT_BOOLEAN(0, "stdout", &use_stdout
,
1085 N_("print patches to standard out")),
1086 OPT_BOOLEAN(0, "cover-letter", &cover_letter
,
1087 N_("generate a cover letter")),
1088 OPT_BOOLEAN(0, "numbered-files", &numbered_files
,
1089 N_("use simple number sequence for output file names")),
1090 OPT_STRING(0, "suffix", &fmt_patch_suffix
, N_("sfx"),
1091 N_("use <sfx> instead of '.patch'")),
1092 OPT_INTEGER(0, "start-number", &start_number
,
1093 N_("start numbering patches at <n> instead of 1")),
1094 { OPTION_CALLBACK
, 0, "subject-prefix", &rev
, N_("prefix"),
1095 N_("Use [<prefix>] instead of [PATCH]"),
1096 PARSE_OPT_NONEG
, subject_prefix_callback
},
1097 { OPTION_CALLBACK
, 'o', "output-directory", &output_directory
,
1098 N_("dir"), N_("store resulting files in <dir>"),
1099 PARSE_OPT_NONEG
, output_directory_callback
},
1100 { OPTION_CALLBACK
, 'k', "keep-subject", &rev
, NULL
,
1101 N_("don't strip/add [PATCH]"),
1102 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, keep_callback
},
1103 OPT_BOOLEAN(0, "no-binary", &no_binary_diff
,
1104 N_("don't output binary diffs")),
1105 OPT_BOOLEAN(0, "ignore-if-in-upstream", &ignore_if_in_upstream
,
1106 N_("don't include a patch matching a commit upstream")),
1107 { OPTION_BOOLEAN
, 'p', "no-stat", &use_patch_format
, NULL
,
1108 N_("show patch format instead of default (patch + stat)"),
1109 PARSE_OPT_NONEG
| PARSE_OPT_NOARG
},
1110 OPT_GROUP(N_("Messaging")),
1111 { OPTION_CALLBACK
, 0, "add-header", NULL
, N_("header"),
1112 N_("add email header"), 0, header_callback
},
1113 { OPTION_CALLBACK
, 0, "to", NULL
, N_("email"), N_("add To: header"),
1115 { OPTION_CALLBACK
, 0, "cc", NULL
, N_("email"), N_("add Cc: header"),
1117 OPT_STRING(0, "in-reply-to", &in_reply_to
, N_("message-id"),
1118 N_("make first mail a reply to <message-id>")),
1119 { OPTION_CALLBACK
, 0, "attach", &rev
, N_("boundary"),
1120 N_("attach the patch"), PARSE_OPT_OPTARG
,
1122 { OPTION_CALLBACK
, 0, "inline", &rev
, N_("boundary"),
1123 N_("inline the patch"),
1124 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
1126 { OPTION_CALLBACK
, 0, "thread", &thread
, N_("style"),
1127 N_("enable message threading, styles: shallow, deep"),
1128 PARSE_OPT_OPTARG
, thread_callback
},
1129 OPT_STRING(0, "signature", &signature
, N_("signature"),
1130 N_("add a signature")),
1131 OPT_BOOLEAN(0, "quiet", &quiet
,
1132 N_("don't print the patch filenames")),
1136 extra_hdr
.strdup_strings
= 1;
1137 extra_to
.strdup_strings
= 1;
1138 extra_cc
.strdup_strings
= 1;
1139 init_grep_defaults();
1140 git_config(git_format_config
, NULL
);
1141 init_revisions(&rev
, prefix
);
1142 rev
.commit_format
= CMIT_FMT_EMAIL
;
1143 rev
.verbose_header
= 1;
1145 rev
.max_parents
= 1;
1146 DIFF_OPT_SET(&rev
.diffopt
, RECURSIVE
);
1147 rev
.subject_prefix
= fmt_patch_subject_prefix
;
1148 memset(&s_r_opt
, 0, sizeof(s_r_opt
));
1149 s_r_opt
.def
= "HEAD";
1150 s_r_opt
.revarg_opt
= REVARG_COMMITTISH
;
1152 if (default_attach
) {
1153 rev
.mime_boundary
= default_attach
;
1158 * Parse the arguments before setup_revisions(), or something
1159 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1160 * possibly a valid SHA1.
1162 argc
= parse_options(argc
, argv
, prefix
, builtin_format_patch_options
,
1163 builtin_format_patch_usage
,
1164 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
1165 PARSE_OPT_KEEP_DASHDASH
);
1168 const char *committer
;
1170 committer
= git_committer_info(IDENT_STRICT
);
1171 endpos
= strchr(committer
, '>');
1173 die(_("bogus committer info %s"), committer
);
1174 add_signoff
= xmemdupz(committer
, endpos
- committer
+ 1);
1177 for (i
= 0; i
< extra_hdr
.nr
; i
++) {
1178 strbuf_addstr(&buf
, extra_hdr
.items
[i
].string
);
1179 strbuf_addch(&buf
, '\n');
1183 strbuf_addstr(&buf
, "To: ");
1184 for (i
= 0; i
< extra_to
.nr
; i
++) {
1186 strbuf_addstr(&buf
, " ");
1187 strbuf_addstr(&buf
, extra_to
.items
[i
].string
);
1188 if (i
+ 1 < extra_to
.nr
)
1189 strbuf_addch(&buf
, ',');
1190 strbuf_addch(&buf
, '\n');
1194 strbuf_addstr(&buf
, "Cc: ");
1195 for (i
= 0; i
< extra_cc
.nr
; i
++) {
1197 strbuf_addstr(&buf
, " ");
1198 strbuf_addstr(&buf
, extra_cc
.items
[i
].string
);
1199 if (i
+ 1 < extra_cc
.nr
)
1200 strbuf_addch(&buf
, ',');
1201 strbuf_addch(&buf
, '\n');
1204 rev
.extra_headers
= strbuf_detach(&buf
, NULL
);
1206 if (start_number
< 0)
1210 * If numbered is set solely due to format.numbered in config,
1211 * and it would conflict with --keep-subject (-k) from the
1212 * command line, reset "numbered".
1214 if (numbered
&& keep_subject
&& !numbered_cmdline_opt
)
1217 if (numbered
&& keep_subject
)
1218 die (_("-n and -k are mutually exclusive."));
1219 if (keep_subject
&& subject_prefix
)
1220 die (_("--subject-prefix and -k are mutually exclusive."));
1221 rev
.preserve_subject
= keep_subject
;
1223 argc
= setup_revisions(argc
, argv
, &rev
, &s_r_opt
);
1225 die (_("unrecognized argument: %s"), argv
[1]);
1227 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME
)
1228 die(_("--name-only does not make sense"));
1229 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME_STATUS
)
1230 die(_("--name-status does not make sense"));
1231 if (rev
.diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
)
1232 die(_("--check does not make sense"));
1234 if (!use_patch_format
&&
1235 (!rev
.diffopt
.output_format
||
1236 rev
.diffopt
.output_format
== DIFF_FORMAT_PATCH
))
1237 rev
.diffopt
.output_format
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_SUMMARY
;
1239 /* Always generate a patch */
1240 rev
.diffopt
.output_format
|= DIFF_FORMAT_PATCH
;
1242 if (!DIFF_OPT_TST(&rev
.diffopt
, TEXT
) && !no_binary_diff
)
1243 DIFF_OPT_SET(&rev
.diffopt
, BINARY
);
1246 init_display_notes(&rev
.notes_opt
);
1249 output_directory
= set_outdir(prefix
, output_directory
);
1253 if (output_directory
) {
1255 die(_("standard output, or directory, which one?"));
1256 if (mkdir(output_directory
, 0777) < 0 && errno
!= EEXIST
)
1257 die_errno(_("Could not create directory '%s'"),
1261 if (rev
.pending
.nr
== 1) {
1262 if (rev
.max_count
< 0 && !rev
.show_root_diff
) {
1264 * This is traditional behaviour of "git format-patch
1265 * origin" that prepares what the origin side still
1268 unsigned char sha1
[20];
1271 rev
.pending
.objects
[0].item
->flags
|= UNINTERESTING
;
1272 add_head_to_pending(&rev
);
1273 ref
= resolve_ref_unsafe("HEAD", sha1
, 1, NULL
);
1274 if (ref
&& !prefixcmp(ref
, "refs/heads/"))
1275 branch_name
= xstrdup(ref
+ strlen("refs/heads/"));
1277 branch_name
= xstrdup(""); /* no branch */
1280 * Otherwise, it is "format-patch -22 HEAD", and/or
1281 * "format-patch --root HEAD". The user wants
1282 * get_revision() to do the usual traversal.
1287 * We cannot move this anywhere earlier because we do want to
1288 * know if --root was given explicitly from the command line.
1290 rev
.show_root_diff
= 1;
1294 * NEEDSWORK:randomly pick one positive commit to show
1295 * diffstat; this is often the tip and the command
1296 * happens to do the right thing in most cases, but a
1297 * complex command like "--cover-letter a b c ^bottom"
1298 * picks "c" and shows diffstat between bottom..c
1299 * which may not match what the series represents at
1300 * all and totally broken.
1303 for (i
= 0; i
< rev
.pending
.nr
; i
++) {
1304 struct object
*o
= rev
.pending
.objects
[i
].item
;
1305 if (!(o
->flags
& UNINTERESTING
))
1306 head
= (struct commit
*)o
;
1308 /* There is nothing to show; it is not an error, though. */
1312 branch_name
= find_branch_name(&rev
);
1315 if (ignore_if_in_upstream
) {
1316 /* Don't say anything if head and upstream are the same. */
1317 if (rev
.pending
.nr
== 2) {
1318 struct object_array_entry
*o
= rev
.pending
.objects
;
1319 if (hashcmp(o
[0].item
->sha1
, o
[1].item
->sha1
) == 0)
1322 get_patch_ids(&rev
, &ids
);
1326 realstdout
= xfdopen(xdup(1), "w");
1328 if (prepare_revision_walk(&rev
))
1329 die(_("revision walk setup failed"));
1331 while ((commit
= get_revision(&rev
)) != NULL
) {
1332 if (commit
->object
.flags
& BOUNDARY
) {
1334 origin
= (boundary_count
== 1) ? commit
: NULL
;
1338 if (ignore_if_in_upstream
&&
1339 has_commit_patch_id(commit
, &ids
))
1343 list
= xrealloc(list
, nr
* sizeof(list
[0]));
1344 list
[nr
- 1] = commit
;
1347 if (!keep_subject
&& auto_number
&& total
> 1)
1350 rev
.total
= total
+ start_number
- 1;
1351 if (in_reply_to
|| thread
|| cover_letter
)
1352 rev
.ref_message_ids
= xcalloc(1, sizeof(struct string_list
));
1354 const char *msgid
= clean_message_id(in_reply_to
);
1355 string_list_append(rev
.ref_message_ids
, msgid
);
1357 rev
.numbered_files
= numbered_files
;
1358 rev
.patch_suffix
= fmt_patch_suffix
;
1361 gen_message_id(&rev
, "cover");
1362 make_cover_letter(&rev
, use_stdout
, numbered
, numbered_files
,
1363 origin
, nr
, list
, head
, branch_name
, quiet
);
1367 rev
.add_signoff
= add_signoff
;
1371 rev
.nr
= total
- nr
+ (start_number
- 1);
1372 /* Make the second and subsequent mails replies to the first */
1374 /* Have we already had a message ID? */
1375 if (rev
.message_id
) {
1377 * For deep threading: make every mail
1378 * a reply to the previous one, no
1379 * matter what other options are set.
1381 * For shallow threading:
1383 * Without --cover-letter and
1384 * --in-reply-to, make every mail a
1385 * reply to the one before.
1387 * With --in-reply-to but no
1388 * --cover-letter, make every mail a
1389 * reply to the <reply-to>.
1391 * With --cover-letter, make every
1392 * mail but the cover letter a reply
1393 * to the cover letter. The cover
1394 * letter is a reply to the
1395 * --in-reply-to, if specified.
1397 if (thread
== THREAD_SHALLOW
1398 && rev
.ref_message_ids
->nr
> 0
1399 && (!cover_letter
|| rev
.nr
> 1))
1400 free(rev
.message_id
);
1402 string_list_append(rev
.ref_message_ids
,
1405 gen_message_id(&rev
, sha1_to_hex(commit
->object
.sha1
));
1409 reopen_stdout(numbered_files
? NULL
: commit
, NULL
, &rev
, quiet
))
1410 die(_("Failed to create output files"));
1411 shown
= log_tree_commit(&rev
, commit
);
1412 free(commit
->buffer
);
1413 commit
->buffer
= NULL
;
1415 /* We put one extra blank line between formatted
1416 * patches and this flag is used by log-tree code
1417 * to see if it needs to emit a LF before showing
1418 * the log; when using one file per patch, we do
1419 * not want the extra blank line.
1424 if (rev
.mime_boundary
)
1425 printf("\n--%s%s--\n\n\n",
1426 mime_boundary_leader
,
1436 string_list_clear(&extra_to
, 0);
1437 string_list_clear(&extra_cc
, 0);
1438 string_list_clear(&extra_hdr
, 0);
1439 if (ignore_if_in_upstream
)
1440 free_patch_ids(&ids
);
1444 static int add_pending_commit(const char *arg
, struct rev_info
*revs
, int flags
)
1446 unsigned char sha1
[20];
1447 if (get_sha1(arg
, sha1
) == 0) {
1448 struct commit
*commit
= lookup_commit_reference(sha1
);
1450 commit
->object
.flags
|= flags
;
1451 add_pending_object(revs
, &commit
->object
, arg
);
1458 static const char * const cherry_usage
[] = {
1459 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1463 static void print_commit(char sign
, struct commit
*commit
, int verbose
,
1467 printf("%c %s\n", sign
,
1468 find_unique_abbrev(commit
->object
.sha1
, abbrev
));
1470 struct strbuf buf
= STRBUF_INIT
;
1471 pp_commit_easy(CMIT_FMT_ONELINE
, commit
, &buf
);
1472 printf("%c %s %s\n", sign
,
1473 find_unique_abbrev(commit
->object
.sha1
, abbrev
),
1475 strbuf_release(&buf
);
1479 int cmd_cherry(int argc
, const char **argv
, const char *prefix
)
1481 struct rev_info revs
;
1482 struct patch_ids ids
;
1483 struct commit
*commit
;
1484 struct commit_list
*list
= NULL
;
1485 struct branch
*current_branch
;
1486 const char *upstream
;
1487 const char *head
= "HEAD";
1488 const char *limit
= NULL
;
1489 int verbose
= 0, abbrev
= 0;
1491 struct option options
[] = {
1492 OPT__ABBREV(&abbrev
),
1493 OPT__VERBOSE(&verbose
, N_("be verbose")),
1497 argc
= parse_options(argc
, argv
, prefix
, options
, cherry_usage
, 0);
1510 current_branch
= branch_get(NULL
);
1511 if (!current_branch
|| !current_branch
->merge
1512 || !current_branch
->merge
[0]
1513 || !current_branch
->merge
[0]->dst
) {
1514 fprintf(stderr
, _("Could not find a tracked"
1515 " remote branch, please"
1516 " specify <upstream> manually.\n"));
1517 usage_with_options(cherry_usage
, options
);
1520 upstream
= current_branch
->merge
[0]->dst
;
1523 init_revisions(&revs
, prefix
);
1524 revs
.max_parents
= 1;
1526 if (add_pending_commit(head
, &revs
, 0))
1527 die(_("Unknown commit %s"), head
);
1528 if (add_pending_commit(upstream
, &revs
, UNINTERESTING
))
1529 die(_("Unknown commit %s"), upstream
);
1531 /* Don't say anything if head and upstream are the same. */
1532 if (revs
.pending
.nr
== 2) {
1533 struct object_array_entry
*o
= revs
.pending
.objects
;
1534 if (hashcmp(o
[0].item
->sha1
, o
[1].item
->sha1
) == 0)
1538 get_patch_ids(&revs
, &ids
);
1540 if (limit
&& add_pending_commit(limit
, &revs
, UNINTERESTING
))
1541 die(_("Unknown commit %s"), limit
);
1543 /* reverse the list of commits */
1544 if (prepare_revision_walk(&revs
))
1545 die(_("revision walk setup failed"));
1546 while ((commit
= get_revision(&revs
)) != NULL
) {
1547 commit_list_insert(commit
, &list
);
1553 commit
= list
->item
;
1554 if (has_commit_patch_id(commit
, &ids
))
1556 print_commit(sign
, commit
, verbose
, abbrev
);
1560 free_patch_ids(&ids
);