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 const char *fmt_patch_subject_prefix
= "PATCH";
28 static const char *fmt_pretty
;
30 static const char * const builtin_log_usage
=
31 "git log [<options>] [<since>..<until>] [[--] <path>...]\n"
32 " or: git show [options] <object>...";
34 static void cmd_log_init(int argc
, const char **argv
, const char *prefix
,
35 struct rev_info
*rev
, struct setup_revision_opt
*opt
)
38 int decoration_style
= 0;
40 rev
->abbrev
= DEFAULT_ABBREV
;
41 rev
->commit_format
= CMIT_FMT_DEFAULT
;
43 get_commit_format(fmt_pretty
, rev
);
44 rev
->verbose_header
= 1;
45 DIFF_OPT_SET(&rev
->diffopt
, RECURSIVE
);
46 rev
->show_root_diff
= default_show_root
;
47 rev
->subject_prefix
= fmt_patch_subject_prefix
;
48 DIFF_OPT_SET(&rev
->diffopt
, ALLOW_TEXTCONV
);
50 if (default_date_mode
)
51 rev
->date_mode
= parse_date_format(default_date_mode
);
54 * Check for -h before setup_revisions(), or "git log -h" will
55 * fail when run without a git directory.
57 if (argc
== 2 && !strcmp(argv
[1], "-h"))
58 usage(builtin_log_usage
);
59 argc
= setup_revisions(argc
, argv
, rev
, opt
);
61 if (!rev
->show_notes_given
&& !rev
->pretty_given
)
64 if (rev
->diffopt
.pickaxe
|| rev
->diffopt
.filter
)
65 rev
->always_show_header
= 0;
66 if (DIFF_OPT_TST(&rev
->diffopt
, FOLLOW_RENAMES
)) {
67 rev
->always_show_header
= 0;
68 if (rev
->diffopt
.nr_paths
!= 1)
69 usage("git logs can only follow renames on one pathname at a time");
71 for (i
= 1; i
< argc
; i
++) {
72 const char *arg
= argv
[i
];
73 if (!strcmp(arg
, "--decorate")) {
74 decoration_style
= DECORATE_SHORT_REFS
;
75 } else if (!prefixcmp(arg
, "--decorate=")) {
76 const char *v
= skip_prefix(arg
, "--decorate=");
77 if (!strcmp(v
, "full"))
78 decoration_style
= DECORATE_FULL_REFS
;
79 else if (!strcmp(v
, "short"))
80 decoration_style
= DECORATE_SHORT_REFS
;
82 die("invalid --decorate option: %s", arg
);
83 } else if (!strcmp(arg
, "--source")) {
85 } else if (!strcmp(arg
, "-h")) {
86 usage(builtin_log_usage
);
88 die("unrecognized argument: %s", arg
);
90 if (decoration_style
) {
91 rev
->show_decorations
= 1;
92 load_ref_decorations(decoration_style
);
97 * This gives a rough estimate for how many commits we
98 * will print out in the list.
100 static int estimate_commit_count(struct rev_info
*rev
, struct commit_list
*list
)
105 struct commit
*commit
= list
->item
;
106 unsigned int flags
= commit
->object
.flags
;
108 if (!(flags
& (TREESAME
| UNINTERESTING
)))
114 static void show_early_header(struct rev_info
*rev
, const char *stage
, int nr
)
116 if (rev
->shown_one
) {
118 if (rev
->commit_format
!= CMIT_FMT_ONELINE
)
119 putchar(rev
->diffopt
.line_termination
);
121 printf("Final output: %d %s\n", nr
, stage
);
124 static struct itimerval early_output_timer
;
126 static void log_show_early(struct rev_info
*revs
, struct commit_list
*list
)
128 int i
= revs
->early_output
;
131 sort_in_topological_order(&list
, revs
->lifo
);
133 struct commit
*commit
= list
->item
;
134 switch (simplify_commit(revs
, commit
)) {
137 int n
= estimate_commit_count(revs
, list
);
138 show_early_header(revs
, "incomplete", n
);
141 log_tree_commit(revs
, commit
);
152 /* Did we already get enough commits for the early output? */
157 * ..if no, then repeat it twice a second until we
160 * NOTE! We don't use "it_interval", because if the
161 * reader isn't listening, we want our output to be
162 * throttled by the writing, and not have the timer
163 * trigger every second even if we're blocked on a
166 early_output_timer
.it_value
.tv_sec
= 0;
167 early_output_timer
.it_value
.tv_usec
= 500000;
168 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
171 static void early_output(int signal
)
173 show_early_output
= log_show_early
;
176 static void setup_early_output(struct rev_info
*rev
)
181 * Set up the signal handler, minimally intrusively:
182 * we only set a single volatile integer word (not
183 * using sigatomic_t - trying to avoid unnecessary
184 * system dependencies and headers), and using
187 memset(&sa
, 0, sizeof(sa
));
188 sa
.sa_handler
= early_output
;
189 sigemptyset(&sa
.sa_mask
);
190 sa
.sa_flags
= SA_RESTART
;
191 sigaction(SIGALRM
, &sa
, NULL
);
194 * If we can get the whole output in less than a
195 * tenth of a second, don't even bother doing the
196 * early-output thing..
198 * This is a one-time-only trigger.
200 early_output_timer
.it_value
.tv_sec
= 0;
201 early_output_timer
.it_value
.tv_usec
= 100000;
202 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
205 static void finish_early_output(struct rev_info
*rev
)
207 int n
= estimate_commit_count(rev
, rev
->commits
);
208 signal(SIGALRM
, SIG_IGN
);
209 show_early_header(rev
, "done", n
);
212 static int cmd_log_walk(struct rev_info
*rev
)
214 struct commit
*commit
;
216 if (rev
->early_output
)
217 setup_early_output(rev
);
219 if (prepare_revision_walk(rev
))
220 die("revision walk setup failed");
222 if (rev
->early_output
)
223 finish_early_output(rev
);
226 * For --check and --exit-code, the exit code is based on CHECK_FAILED
227 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
228 * retain that state information if replacing rev->diffopt in this loop
230 while ((commit
= get_revision(rev
)) != NULL
) {
231 log_tree_commit(rev
, commit
);
232 if (!rev
->reflog_info
) {
233 /* we allow cycles in reflog ancestry */
234 free(commit
->buffer
);
235 commit
->buffer
= NULL
;
237 free_commit_list(commit
->parents
);
238 commit
->parents
= NULL
;
240 if (rev
->diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
&&
241 DIFF_OPT_TST(&rev
->diffopt
, CHECK_FAILED
)) {
244 return diff_result_code(&rev
->diffopt
, 0);
247 static int git_log_config(const char *var
, const char *value
, void *cb
)
249 if (!strcmp(var
, "format.pretty"))
250 return git_config_string(&fmt_pretty
, var
, value
);
251 if (!strcmp(var
, "format.subjectprefix"))
252 return git_config_string(&fmt_patch_subject_prefix
, var
, value
);
253 if (!strcmp(var
, "log.date"))
254 return git_config_string(&default_date_mode
, var
, value
);
255 if (!strcmp(var
, "log.showroot")) {
256 default_show_root
= git_config_bool(var
, value
);
259 return git_diff_ui_config(var
, value
, cb
);
262 int cmd_whatchanged(int argc
, const char **argv
, const char *prefix
)
265 struct setup_revision_opt opt
;
267 git_config(git_log_config
, NULL
);
269 if (diff_use_color_default
== -1)
270 diff_use_color_default
= git_use_color_default
;
272 init_revisions(&rev
, prefix
);
274 rev
.simplify_history
= 0;
275 memset(&opt
, 0, sizeof(opt
));
277 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
278 if (!rev
.diffopt
.output_format
)
279 rev
.diffopt
.output_format
= DIFF_FORMAT_RAW
;
280 return cmd_log_walk(&rev
);
283 static void show_tagger(char *buf
, int len
, struct rev_info
*rev
)
285 struct strbuf out
= STRBUF_INIT
;
287 pp_user_info("Tagger", rev
->commit_format
, &out
, buf
, rev
->date_mode
,
288 git_log_output_encoding
?
289 git_log_output_encoding
: git_commit_encoding
);
290 printf("%s", out
.buf
);
291 strbuf_release(&out
);
294 static int show_object(const unsigned char *sha1
, int show_tag_object
,
295 struct rev_info
*rev
)
298 enum object_type type
;
299 char *buf
= read_sha1_file(sha1
, &type
, &size
);
303 return error("Could not read object %s", sha1_to_hex(sha1
));
306 while (offset
< size
&& buf
[offset
] != '\n') {
307 int new_offset
= offset
+ 1;
308 while (new_offset
< size
&& buf
[new_offset
++] != '\n')
310 if (!prefixcmp(buf
+ offset
, "tagger "))
311 show_tagger(buf
+ offset
+ 7,
312 new_offset
- offset
- 7, rev
);
317 fwrite(buf
+ offset
, size
- offset
, 1, stdout
);
322 static int show_tree_object(const unsigned char *sha1
,
323 const char *base
, int baselen
,
324 const char *pathname
, unsigned mode
, int stage
, void *context
)
326 printf("%s%s\n", pathname
, S_ISDIR(mode
) ? "/" : "");
330 int cmd_show(int argc
, const char **argv
, const char *prefix
)
333 struct object_array_entry
*objects
;
334 struct setup_revision_opt opt
;
335 int i
, count
, ret
= 0;
337 git_config(git_log_config
, NULL
);
339 if (diff_use_color_default
== -1)
340 diff_use_color_default
= git_use_color_default
;
342 init_revisions(&rev
, prefix
);
344 rev
.combine_merges
= 1;
345 rev
.dense_combined_merges
= 1;
346 rev
.always_show_header
= 1;
347 rev
.ignore_merges
= 0;
349 memset(&opt
, 0, sizeof(opt
));
351 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
353 count
= rev
.pending
.nr
;
354 objects
= rev
.pending
.objects
;
355 for (i
= 0; i
< count
&& !ret
; i
++) {
356 struct object
*o
= objects
[i
].item
;
357 const char *name
= objects
[i
].name
;
360 ret
= show_object(o
->sha1
, 0, NULL
);
363 struct tag
*t
= (struct tag
*)o
;
367 printf("%stag %s%s\n",
368 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
370 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
371 ret
= show_object(o
->sha1
, 1, &rev
);
375 o
= parse_object(t
->tagged
->sha1
);
377 ret
= error("Could not read object %s",
378 sha1_to_hex(t
->tagged
->sha1
));
386 printf("%stree %s%s\n\n",
387 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
389 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
390 read_tree_recursive((struct tree
*)o
, "", 0, 0, NULL
,
391 show_tree_object
, NULL
);
395 rev
.pending
.nr
= rev
.pending
.alloc
= 0;
396 rev
.pending
.objects
= NULL
;
397 add_object_array(o
, name
, &rev
.pending
);
398 ret
= cmd_log_walk(&rev
);
401 ret
= error("Unknown type: %d", o
->type
);
409 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
411 int cmd_log_reflog(int argc
, const char **argv
, const char *prefix
)
414 struct setup_revision_opt opt
;
416 git_config(git_log_config
, NULL
);
418 if (diff_use_color_default
== -1)
419 diff_use_color_default
= git_use_color_default
;
421 init_revisions(&rev
, prefix
);
422 init_reflog_walk(&rev
.reflog_info
);
423 rev
.abbrev_commit
= 1;
424 rev
.verbose_header
= 1;
425 memset(&opt
, 0, sizeof(opt
));
427 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
430 * This means that we override whatever commit format the user gave
431 * on the cmd line. Sad, but cmd_log_init() currently doesn't
432 * allow us to set a different default.
434 rev
.commit_format
= CMIT_FMT_ONELINE
;
435 rev
.use_terminator
= 1;
436 rev
.always_show_header
= 1;
439 * We get called through "git reflog", so unlike the other log
440 * routines, we need to set up our pager manually..
444 return cmd_log_walk(&rev
);
447 int cmd_log(int argc
, const char **argv
, const char *prefix
)
450 struct setup_revision_opt opt
;
452 git_config(git_log_config
, NULL
);
454 if (diff_use_color_default
== -1)
455 diff_use_color_default
= git_use_color_default
;
457 init_revisions(&rev
, prefix
);
458 rev
.always_show_header
= 1;
459 memset(&opt
, 0, sizeof(opt
));
461 cmd_log_init(argc
, argv
, prefix
, &rev
, &opt
);
462 return cmd_log_walk(&rev
);
467 static const char *fmt_patch_suffix
= ".patch";
468 static int numbered
= 0;
469 static int auto_number
= 1;
471 static char *default_attach
= NULL
;
473 static char **extra_hdr
;
474 static int extra_hdr_nr
;
475 static int extra_hdr_alloc
;
477 static char **extra_to
;
478 static int extra_to_nr
;
479 static int extra_to_alloc
;
481 static char **extra_cc
;
482 static int extra_cc_nr
;
483 static int extra_cc_alloc
;
485 static void add_header(const char *value
)
487 int len
= strlen(value
);
488 while (len
&& value
[len
- 1] == '\n')
490 if (!strncasecmp(value
, "to: ", 4)) {
491 ALLOC_GROW(extra_to
, extra_to_nr
+ 1, extra_to_alloc
);
492 extra_to
[extra_to_nr
++] = xstrndup(value
+ 4, len
- 4);
495 if (!strncasecmp(value
, "cc: ", 4)) {
496 ALLOC_GROW(extra_cc
, extra_cc_nr
+ 1, extra_cc_alloc
);
497 extra_cc
[extra_cc_nr
++] = xstrndup(value
+ 4, len
- 4);
500 ALLOC_GROW(extra_hdr
, extra_hdr_nr
+ 1, extra_hdr_alloc
);
501 extra_hdr
[extra_hdr_nr
++] = xstrndup(value
, len
);
504 #define THREAD_SHALLOW 1
505 #define THREAD_DEEP 2
506 static int thread
= 0;
507 static int do_signoff
= 0;
509 static int git_format_config(const char *var
, const char *value
, void *cb
)
511 if (!strcmp(var
, "format.headers")) {
513 die("format.headers without value");
517 if (!strcmp(var
, "format.suffix"))
518 return git_config_string(&fmt_patch_suffix
, var
, value
);
519 if (!strcmp(var
, "format.cc")) {
521 return config_error_nonbool(var
);
522 ALLOC_GROW(extra_cc
, extra_cc_nr
+ 1, extra_cc_alloc
);
523 extra_cc
[extra_cc_nr
++] = xstrdup(value
);
526 if (!strcmp(var
, "diff.color") || !strcmp(var
, "color.diff")) {
529 if (!strcmp(var
, "format.numbered")) {
530 if (value
&& !strcasecmp(value
, "auto")) {
534 numbered
= git_config_bool(var
, value
);
535 auto_number
= auto_number
&& numbered
;
538 if (!strcmp(var
, "format.attach")) {
540 default_attach
= xstrdup(value
);
542 default_attach
= xstrdup(git_version_string
);
545 if (!strcmp(var
, "format.thread")) {
546 if (value
&& !strcasecmp(value
, "deep")) {
547 thread
= THREAD_DEEP
;
550 if (value
&& !strcasecmp(value
, "shallow")) {
551 thread
= THREAD_SHALLOW
;
554 thread
= git_config_bool(var
, value
) && THREAD_SHALLOW
;
557 if (!strcmp(var
, "format.signoff")) {
558 do_signoff
= git_config_bool(var
, value
);
562 return git_log_config(var
, value
, cb
);
565 static FILE *realstdout
= NULL
;
566 static const char *output_directory
= NULL
;
567 static int outdir_offset
;
569 static int reopen_stdout(struct commit
*commit
, struct rev_info
*rev
)
571 struct strbuf filename
= STRBUF_INIT
;
572 int suffix_len
= strlen(fmt_patch_suffix
) + 1;
574 if (output_directory
) {
575 strbuf_addstr(&filename
, output_directory
);
577 PATH_MAX
- FORMAT_PATCH_NAME_MAX
- suffix_len
)
578 return error("name of output directory is too long");
579 if (filename
.buf
[filename
.len
- 1] != '/')
580 strbuf_addch(&filename
, '/');
583 get_patch_filename(commit
, rev
->nr
, fmt_patch_suffix
, &filename
);
585 if (!DIFF_OPT_TST(&rev
->diffopt
, QUICK
))
586 fprintf(realstdout
, "%s\n", filename
.buf
+ outdir_offset
);
588 if (freopen(filename
.buf
, "w", stdout
) == NULL
)
589 return error("Cannot open patch file %s", filename
.buf
);
591 strbuf_release(&filename
);
595 static void get_patch_ids(struct rev_info
*rev
, struct patch_ids
*ids
, const char *prefix
)
597 struct rev_info check_rev
;
598 struct commit
*commit
;
599 struct object
*o1
, *o2
;
600 unsigned flags1
, flags2
;
602 if (rev
->pending
.nr
!= 2)
603 die("Need exactly one range.");
605 o1
= rev
->pending
.objects
[0].item
;
607 o2
= rev
->pending
.objects
[1].item
;
610 if ((flags1
& UNINTERESTING
) == (flags2
& UNINTERESTING
))
615 /* given a range a..b get all patch ids for b..a */
616 init_revisions(&check_rev
, prefix
);
617 o1
->flags
^= UNINTERESTING
;
618 o2
->flags
^= UNINTERESTING
;
619 add_pending_object(&check_rev
, o1
, "o1");
620 add_pending_object(&check_rev
, o2
, "o2");
621 if (prepare_revision_walk(&check_rev
))
622 die("revision walk setup failed");
624 while ((commit
= get_revision(&check_rev
)) != NULL
) {
626 if (commit
->parents
&& commit
->parents
->next
)
629 add_commit_patch_id(commit
, ids
);
632 /* reset for next revision walk */
633 clear_commit_marks((struct commit
*)o1
,
634 SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
635 clear_commit_marks((struct commit
*)o2
,
636 SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
641 static void gen_message_id(struct rev_info
*info
, char *base
)
643 const char *committer
= git_committer_info(IDENT_WARN_ON_NO_NAME
);
644 const char *email_start
= strrchr(committer
, '<');
645 const char *email_end
= strrchr(committer
, '>');
646 struct strbuf buf
= STRBUF_INIT
;
647 if (!email_start
|| !email_end
|| email_start
> email_end
- 1)
648 die("Could not extract email from committer identity.");
649 strbuf_addf(&buf
, "%s.%lu.git.%.*s", base
,
650 (unsigned long) time(NULL
),
651 (int)(email_end
- email_start
- 1), email_start
+ 1);
652 info
->message_id
= strbuf_detach(&buf
, NULL
);
655 static void make_cover_letter(struct rev_info
*rev
, int use_stdout
,
656 int numbered
, int numbered_files
,
657 struct commit
*origin
,
658 int nr
, struct commit
**list
, struct commit
*head
)
660 const char *committer
;
661 const char *subject_start
= NULL
;
662 const char *body
= "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
664 const char *extra_headers
= rev
->extra_headers
;
666 struct strbuf sb
= STRBUF_INIT
;
668 const char *encoding
= "UTF-8";
669 struct diff_options opts
;
670 int need_8bit_cte
= 0;
671 struct commit
*commit
= NULL
;
673 if (rev
->commit_format
!= CMIT_FMT_EMAIL
)
674 die("Cover letter needs email format");
676 committer
= git_committer_info(0);
678 if (!numbered_files
) {
680 * We fake a commit for the cover letter so we get the filename
683 commit
= xcalloc(1, sizeof(*commit
));
684 commit
->buffer
= xmalloc(400);
685 snprintf(commit
->buffer
, 400,
686 "tree 0000000000000000000000000000000000000000\n"
691 sha1_to_hex(head
->object
.sha1
), committer
, committer
);
694 if (!use_stdout
&& reopen_stdout(commit
, rev
))
699 free(commit
->buffer
);
703 log_write_email_headers(rev
, head
, &subject_start
, &extra_headers
,
706 for (i
= 0; !need_8bit_cte
&& i
< nr
; i
++)
707 if (has_non_ascii(list
[i
]->buffer
))
711 pp_user_info(NULL
, CMIT_FMT_EMAIL
, &sb
, committer
, DATE_RFC2822
,
713 pp_title_line(CMIT_FMT_EMAIL
, &msg
, &sb
, subject_start
, extra_headers
,
714 encoding
, need_8bit_cte
);
715 pp_remainder(CMIT_FMT_EMAIL
, &msg
, &sb
, 0);
716 printf("%s\n", sb
.buf
);
725 for (i
= 0; i
< nr
; i
++)
726 shortlog_add_commit(&log
, list
[i
]);
728 shortlog_output(&log
);
731 * We can only do diffstat with a unique reference point
736 memcpy(&opts
, &rev
->diffopt
, sizeof(opts
));
737 opts
.output_format
= DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
739 diff_setup_done(&opts
);
741 diff_tree_sha1(origin
->tree
->object
.sha1
,
742 head
->tree
->object
.sha1
,
750 static const char *clean_message_id(const char *msg_id
)
753 const char *a
, *z
, *m
;
756 while ((ch
= *m
) && (isspace(ch
) || (ch
== '<')))
761 if (!isspace(ch
) && (ch
!= '>'))
766 die("insane in-reply-to: %s", msg_id
);
769 return xmemdupz(a
, z
- a
);
772 static const char *set_outdir(const char *prefix
, const char *output_directory
)
774 if (output_directory
&& is_absolute_path(output_directory
))
775 return output_directory
;
777 if (!prefix
|| !*prefix
) {
778 if (output_directory
)
779 return output_directory
;
780 /* The user did not explicitly ask for "./" */
785 outdir_offset
= strlen(prefix
);
786 if (!output_directory
)
789 return xstrdup(prefix_filename(prefix
, outdir_offset
,
793 static const char * const builtin_format_patch_usage
[] = {
794 "git format-patch [options] [<since> | <revision range>]",
798 static int keep_subject
= 0;
800 static int keep_callback(const struct option
*opt
, const char *arg
, int unset
)
802 ((struct rev_info
*)opt
->value
)->total
= -1;
807 static int subject_prefix
= 0;
809 static int subject_prefix_callback(const struct option
*opt
, const char *arg
,
813 ((struct rev_info
*)opt
->value
)->subject_prefix
= arg
;
817 static int numbered_cmdline_opt
= 0;
819 static int numbered_callback(const struct option
*opt
, const char *arg
,
822 *(int *)opt
->value
= numbered_cmdline_opt
= unset
? 0 : 1;
828 static int no_numbered_callback(const struct option
*opt
, const char *arg
,
831 return numbered_callback(opt
, arg
, 1);
834 static int output_directory_callback(const struct option
*opt
, const char *arg
,
837 const char **dir
= (const char **)opt
->value
;
839 die("Two output directories?");
844 static int thread_callback(const struct option
*opt
, const char *arg
, int unset
)
846 int *thread
= (int *)opt
->value
;
849 else if (!arg
|| !strcmp(arg
, "shallow"))
850 *thread
= THREAD_SHALLOW
;
851 else if (!strcmp(arg
, "deep"))
852 *thread
= THREAD_DEEP
;
858 static int attach_callback(const struct option
*opt
, const char *arg
, int unset
)
860 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
862 rev
->mime_boundary
= NULL
;
864 rev
->mime_boundary
= arg
;
866 rev
->mime_boundary
= git_version_string
;
867 rev
->no_inline
= unset
? 0 : 1;
871 static int inline_callback(const struct option
*opt
, const char *arg
, int unset
)
873 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
875 rev
->mime_boundary
= NULL
;
877 rev
->mime_boundary
= arg
;
879 rev
->mime_boundary
= git_version_string
;
884 static int header_callback(const struct option
*opt
, const char *arg
, int unset
)
890 static int cc_callback(const struct option
*opt
, const char *arg
, int unset
)
892 ALLOC_GROW(extra_cc
, extra_cc_nr
+ 1, extra_cc_alloc
);
893 extra_cc
[extra_cc_nr
++] = xstrdup(arg
);
897 int cmd_format_patch(int argc
, const char **argv
, const char *prefix
)
899 struct commit
*commit
;
900 struct commit
**list
= NULL
;
902 struct setup_revision_opt s_r_opt
;
903 int nr
= 0, total
, i
;
905 int start_number
= -1;
906 int numbered_files
= 0; /* _just_ numbers */
907 int ignore_if_in_upstream
= 0;
908 int cover_letter
= 0;
909 int boundary_count
= 0;
910 int no_binary_diff
= 0;
911 struct commit
*origin
= NULL
, *head
= NULL
;
912 const char *in_reply_to
= NULL
;
913 struct patch_ids ids
;
914 char *add_signoff
= NULL
;
915 struct strbuf buf
= STRBUF_INIT
;
916 int use_patch_format
= 0;
917 const struct option builtin_format_patch_options
[] = {
918 { OPTION_CALLBACK
, 'n', "numbered", &numbered
, NULL
,
919 "use [PATCH n/m] even with a single patch",
920 PARSE_OPT_NOARG
, numbered_callback
},
921 { OPTION_CALLBACK
, 'N', "no-numbered", &numbered
, NULL
,
922 "use [PATCH] even with multiple patches",
923 PARSE_OPT_NOARG
, no_numbered_callback
},
924 OPT_BOOLEAN('s', "signoff", &do_signoff
, "add Signed-off-by:"),
925 OPT_BOOLEAN(0, "stdout", &use_stdout
,
926 "print patches to standard out"),
927 OPT_BOOLEAN(0, "cover-letter", &cover_letter
,
928 "generate a cover letter"),
929 OPT_BOOLEAN(0, "numbered-files", &numbered_files
,
930 "use simple number sequence for output file names"),
931 OPT_STRING(0, "suffix", &fmt_patch_suffix
, "sfx",
932 "use <sfx> instead of '.patch'"),
933 OPT_INTEGER(0, "start-number", &start_number
,
934 "start numbering patches at <n> instead of 1"),
935 { OPTION_CALLBACK
, 0, "subject-prefix", &rev
, "prefix",
936 "Use [<prefix>] instead of [PATCH]",
937 PARSE_OPT_NONEG
, subject_prefix_callback
},
938 { OPTION_CALLBACK
, 'o', "output-directory", &output_directory
,
939 "dir", "store resulting files in <dir>",
940 PARSE_OPT_NONEG
, output_directory_callback
},
941 { OPTION_CALLBACK
, 'k', "keep-subject", &rev
, NULL
,
942 "don't strip/add [PATCH]",
943 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, keep_callback
},
944 OPT_BOOLEAN(0, "no-binary", &no_binary_diff
,
945 "don't output binary diffs"),
946 OPT_BOOLEAN(0, "ignore-if-in-upstream", &ignore_if_in_upstream
,
947 "don't include a patch matching a commit upstream"),
948 { OPTION_BOOLEAN
, 'p', "no-stat", &use_patch_format
, NULL
,
949 "show patch format instead of default (patch + stat)",
950 PARSE_OPT_NONEG
| PARSE_OPT_NOARG
},
951 OPT_GROUP("Messaging"),
952 { OPTION_CALLBACK
, 0, "add-header", NULL
, "header",
953 "add email header", PARSE_OPT_NONEG
,
955 { OPTION_CALLBACK
, 0, "cc", NULL
, "email", "add Cc: header",
956 PARSE_OPT_NONEG
, cc_callback
},
957 OPT_STRING(0, "in-reply-to", &in_reply_to
, "message-id",
958 "make first mail a reply to <message-id>"),
959 { OPTION_CALLBACK
, 0, "attach", &rev
, "boundary",
960 "attach the patch", PARSE_OPT_OPTARG
,
962 { OPTION_CALLBACK
, 0, "inline", &rev
, "boundary",
964 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
966 { OPTION_CALLBACK
, 0, "thread", &thread
, "style",
967 "enable message threading, styles: shallow, deep",
968 PARSE_OPT_OPTARG
, thread_callback
},
972 git_config(git_format_config
, NULL
);
973 init_revisions(&rev
, prefix
);
974 rev
.commit_format
= CMIT_FMT_EMAIL
;
975 rev
.verbose_header
= 1;
977 rev
.combine_merges
= 0;
978 rev
.ignore_merges
= 1;
979 DIFF_OPT_SET(&rev
.diffopt
, RECURSIVE
);
980 rev
.subject_prefix
= fmt_patch_subject_prefix
;
981 memset(&s_r_opt
, 0, sizeof(s_r_opt
));
982 s_r_opt
.def
= "HEAD";
984 if (default_attach
) {
985 rev
.mime_boundary
= default_attach
;
990 * Parse the arguments before setup_revisions(), or something
991 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
992 * possibly a valid SHA1.
994 argc
= parse_options(argc
, argv
, prefix
, builtin_format_patch_options
,
995 builtin_format_patch_usage
,
996 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
997 PARSE_OPT_KEEP_DASHDASH
);
1000 const char *committer
;
1002 committer
= git_committer_info(IDENT_ERROR_ON_NO_NAME
);
1003 endpos
= strchr(committer
, '>');
1005 die("bogus committer info %s", committer
);
1006 add_signoff
= xmemdupz(committer
, endpos
- committer
+ 1);
1009 for (i
= 0; i
< extra_hdr_nr
; i
++) {
1010 strbuf_addstr(&buf
, extra_hdr
[i
]);
1011 strbuf_addch(&buf
, '\n');
1015 strbuf_addstr(&buf
, "To: ");
1016 for (i
= 0; i
< extra_to_nr
; i
++) {
1018 strbuf_addstr(&buf
, " ");
1019 strbuf_addstr(&buf
, extra_to
[i
]);
1020 if (i
+ 1 < extra_to_nr
)
1021 strbuf_addch(&buf
, ',');
1022 strbuf_addch(&buf
, '\n');
1026 strbuf_addstr(&buf
, "Cc: ");
1027 for (i
= 0; i
< extra_cc_nr
; i
++) {
1029 strbuf_addstr(&buf
, " ");
1030 strbuf_addstr(&buf
, extra_cc
[i
]);
1031 if (i
+ 1 < extra_cc_nr
)
1032 strbuf_addch(&buf
, ',');
1033 strbuf_addch(&buf
, '\n');
1036 rev
.extra_headers
= strbuf_detach(&buf
, NULL
);
1038 if (start_number
< 0)
1042 * If numbered is set solely due to format.numbered in config,
1043 * and it would conflict with --keep-subject (-k) from the
1044 * command line, reset "numbered".
1046 if (numbered
&& keep_subject
&& !numbered_cmdline_opt
)
1049 if (numbered
&& keep_subject
)
1050 die ("-n and -k are mutually exclusive.");
1051 if (keep_subject
&& subject_prefix
)
1052 die ("--subject-prefix and -k are mutually exclusive.");
1054 argc
= setup_revisions(argc
, argv
, &rev
, &s_r_opt
);
1056 die ("unrecognized argument: %s", argv
[1]);
1058 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME
)
1059 die("--name-only does not make sense");
1060 if (rev
.diffopt
.output_format
& DIFF_FORMAT_NAME_STATUS
)
1061 die("--name-status does not make sense");
1062 if (rev
.diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
)
1063 die("--check does not make sense");
1065 if (!use_patch_format
&&
1066 (!rev
.diffopt
.output_format
||
1067 rev
.diffopt
.output_format
== DIFF_FORMAT_PATCH
))
1068 rev
.diffopt
.output_format
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_SUMMARY
;
1070 /* Always generate a patch */
1071 rev
.diffopt
.output_format
|= DIFF_FORMAT_PATCH
;
1073 if (!DIFF_OPT_TST(&rev
.diffopt
, TEXT
) && !no_binary_diff
)
1074 DIFF_OPT_SET(&rev
.diffopt
, BINARY
);
1077 output_directory
= set_outdir(prefix
, output_directory
);
1079 if (output_directory
) {
1081 die("standard output, or directory, which one?");
1082 if (mkdir(output_directory
, 0777) < 0 && errno
!= EEXIST
)
1083 die_errno("Could not create directory '%s'",
1087 if (rev
.pending
.nr
== 1) {
1088 if (rev
.max_count
< 0 && !rev
.show_root_diff
) {
1090 * This is traditional behaviour of "git format-patch
1091 * origin" that prepares what the origin side still
1094 rev
.pending
.objects
[0].item
->flags
|= UNINTERESTING
;
1095 add_head_to_pending(&rev
);
1098 * Otherwise, it is "format-patch -22 HEAD", and/or
1099 * "format-patch --root HEAD". The user wants
1100 * get_revision() to do the usual traversal.
1105 * We cannot move this anywhere earlier because we do want to
1106 * know if --root was given explicitly from the comand line.
1108 rev
.show_root_diff
= 1;
1111 /* remember the range */
1113 for (i
= 0; i
< rev
.pending
.nr
; i
++) {
1114 struct object
*o
= rev
.pending
.objects
[i
].item
;
1115 if (!(o
->flags
& UNINTERESTING
))
1116 head
= (struct commit
*)o
;
1118 /* We can't generate a cover letter without any patches */
1123 if (ignore_if_in_upstream
)
1124 get_patch_ids(&rev
, &ids
, prefix
);
1127 realstdout
= xfdopen(xdup(1), "w");
1129 if (prepare_revision_walk(&rev
))
1130 die("revision walk setup failed");
1132 while ((commit
= get_revision(&rev
)) != NULL
) {
1133 if (commit
->object
.flags
& BOUNDARY
) {
1135 origin
= (boundary_count
== 1) ? commit
: NULL
;
1140 if (commit
->parents
&& commit
->parents
->next
)
1143 if (ignore_if_in_upstream
&&
1144 has_commit_patch_id(commit
, &ids
))
1148 list
= xrealloc(list
, nr
* sizeof(list
[0]));
1149 list
[nr
- 1] = commit
;
1152 if (!keep_subject
&& auto_number
&& total
> 1)
1155 rev
.total
= total
+ start_number
- 1;
1156 if (in_reply_to
|| thread
|| cover_letter
)
1157 rev
.ref_message_ids
= xcalloc(1, sizeof(struct string_list
));
1159 const char *msgid
= clean_message_id(in_reply_to
);
1160 string_list_append(msgid
, rev
.ref_message_ids
);
1162 rev
.numbered_files
= numbered_files
;
1163 rev
.patch_suffix
= fmt_patch_suffix
;
1166 gen_message_id(&rev
, "cover");
1167 make_cover_letter(&rev
, use_stdout
, numbered
, numbered_files
,
1168 origin
, nr
, list
, head
);
1172 rev
.add_signoff
= add_signoff
;
1176 rev
.nr
= total
- nr
+ (start_number
- 1);
1177 /* Make the second and subsequent mails replies to the first */
1179 /* Have we already had a message ID? */
1180 if (rev
.message_id
) {
1182 * For deep threading: make every mail
1183 * a reply to the previous one, no
1184 * matter what other options are set.
1186 * For shallow threading:
1188 * Without --cover-letter and
1189 * --in-reply-to, make every mail a
1190 * reply to the one before.
1192 * With --in-reply-to but no
1193 * --cover-letter, make every mail a
1194 * reply to the <reply-to>.
1196 * With --cover-letter, make every
1197 * mail but the cover letter a reply
1198 * to the cover letter. The cover
1199 * letter is a reply to the
1200 * --in-reply-to, if specified.
1202 if (thread
== THREAD_SHALLOW
1203 && rev
.ref_message_ids
->nr
> 0
1204 && (!cover_letter
|| rev
.nr
> 1))
1205 free(rev
.message_id
);
1207 string_list_append(rev
.message_id
,
1208 rev
.ref_message_ids
);
1210 gen_message_id(&rev
, sha1_to_hex(commit
->object
.sha1
));
1213 if (!use_stdout
&& reopen_stdout(numbered_files
? NULL
: commit
,
1215 die("Failed to create output files");
1216 shown
= log_tree_commit(&rev
, commit
);
1217 free(commit
->buffer
);
1218 commit
->buffer
= NULL
;
1220 /* We put one extra blank line between formatted
1221 * patches and this flag is used by log-tree code
1222 * to see if it needs to emit a LF before showing
1223 * the log; when using one file per patch, we do
1224 * not want the extra blank line.
1229 if (rev
.mime_boundary
)
1230 printf("\n--%s%s--\n\n\n",
1231 mime_boundary_leader
,
1234 printf("-- \n%s\n\n", git_version_string
);
1240 if (ignore_if_in_upstream
)
1241 free_patch_ids(&ids
);
1245 static int add_pending_commit(const char *arg
, struct rev_info
*revs
, int flags
)
1247 unsigned char sha1
[20];
1248 if (get_sha1(arg
, sha1
) == 0) {
1249 struct commit
*commit
= lookup_commit_reference(sha1
);
1251 commit
->object
.flags
|= flags
;
1252 add_pending_object(revs
, &commit
->object
, arg
);
1259 static const char cherry_usage
[] =
1260 "git cherry [-v] [<upstream> [<head> [<limit>]]]";
1261 int cmd_cherry(int argc
, const char **argv
, const char *prefix
)
1263 struct rev_info revs
;
1264 struct patch_ids ids
;
1265 struct commit
*commit
;
1266 struct commit_list
*list
= NULL
;
1267 struct branch
*current_branch
;
1268 const char *upstream
;
1269 const char *head
= "HEAD";
1270 const char *limit
= NULL
;
1273 if (argc
> 1 && !strcmp(argv
[1], "-v")) {
1279 if (argc
> 1 && !strcmp(argv
[1], "-h"))
1280 usage(cherry_usage
);
1293 current_branch
= branch_get(NULL
);
1294 if (!current_branch
|| !current_branch
->merge
1295 || !current_branch
->merge
[0]
1296 || !current_branch
->merge
[0]->dst
) {
1297 fprintf(stderr
, "Could not find a tracked"
1298 " remote branch, please"
1299 " specify <upstream> manually.\n");
1300 usage(cherry_usage
);
1303 upstream
= current_branch
->merge
[0]->dst
;
1306 init_revisions(&revs
, prefix
);
1308 revs
.combine_merges
= 0;
1309 revs
.ignore_merges
= 1;
1310 DIFF_OPT_SET(&revs
.diffopt
, RECURSIVE
);
1312 if (add_pending_commit(head
, &revs
, 0))
1313 die("Unknown commit %s", head
);
1314 if (add_pending_commit(upstream
, &revs
, UNINTERESTING
))
1315 die("Unknown commit %s", upstream
);
1317 /* Don't say anything if head and upstream are the same. */
1318 if (revs
.pending
.nr
== 2) {
1319 struct object_array_entry
*o
= revs
.pending
.objects
;
1320 if (hashcmp(o
[0].item
->sha1
, o
[1].item
->sha1
) == 0)
1324 get_patch_ids(&revs
, &ids
, prefix
);
1326 if (limit
&& add_pending_commit(limit
, &revs
, UNINTERESTING
))
1327 die("Unknown commit %s", limit
);
1329 /* reverse the list of commits */
1330 if (prepare_revision_walk(&revs
))
1331 die("revision walk setup failed");
1332 while ((commit
= get_revision(&revs
)) != NULL
) {
1334 if (commit
->parents
&& commit
->parents
->next
)
1337 commit_list_insert(commit
, &list
);
1343 commit
= list
->item
;
1344 if (has_commit_patch_id(commit
, &ids
))
1348 struct strbuf buf
= STRBUF_INIT
;
1349 struct pretty_print_context ctx
= {0};
1350 pretty_print_commit(CMIT_FMT_ONELINE
, commit
,
1352 printf("%c %s %s\n", sign
,
1353 sha1_to_hex(commit
->object
.sha1
), buf
.buf
);
1354 strbuf_release(&buf
);
1357 printf("%c %s\n", sign
,
1358 sha1_to_hex(commit
->object
.sha1
));
1364 free_patch_ids(&ids
);