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
,
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
);
53 argc
= setup_revisions(argc
, argv
, rev
, "HEAD");
55 if (rev
->diffopt
.pickaxe
|| rev
->diffopt
.filter
)
56 rev
->always_show_header
= 0;
57 if (DIFF_OPT_TST(&rev
->diffopt
, FOLLOW_RENAMES
)) {
58 rev
->always_show_header
= 0;
59 if (rev
->diffopt
.nr_paths
!= 1)
60 usage("git logs can only follow renames on one pathname at a time");
62 for (i
= 1; i
< argc
; i
++) {
63 const char *arg
= argv
[i
];
64 if (!strcmp(arg
, "--decorate")) {
65 decoration_style
= DECORATE_SHORT_REFS
;
66 } else if (!prefixcmp(arg
, "--decorate=")) {
67 const char *v
= skip_prefix(arg
, "--decorate=");
68 if (!strcmp(v
, "full"))
69 decoration_style
= DECORATE_FULL_REFS
;
70 else if (!strcmp(v
, "short"))
71 decoration_style
= DECORATE_SHORT_REFS
;
73 die("invalid --decorate option: %s", arg
);
74 } else if (!strcmp(arg
, "--source")) {
76 } else if (!strcmp(arg
, "-h")) {
77 usage(builtin_log_usage
);
79 die("unrecognized argument: %s", arg
);
81 if (decoration_style
) {
82 rev
->show_decorations
= 1;
83 load_ref_decorations(decoration_style
);
88 * This gives a rough estimate for how many commits we
89 * will print out in the list.
91 static int estimate_commit_count(struct rev_info
*rev
, struct commit_list
*list
)
96 struct commit
*commit
= list
->item
;
97 unsigned int flags
= commit
->object
.flags
;
99 if (!(flags
& (TREESAME
| UNINTERESTING
)))
105 static void show_early_header(struct rev_info
*rev
, const char *stage
, int nr
)
107 if (rev
->shown_one
) {
109 if (rev
->commit_format
!= CMIT_FMT_ONELINE
)
110 putchar(rev
->diffopt
.line_termination
);
112 printf("Final output: %d %s\n", nr
, stage
);
115 static struct itimerval early_output_timer
;
117 static void log_show_early(struct rev_info
*revs
, struct commit_list
*list
)
119 int i
= revs
->early_output
;
122 sort_in_topological_order(&list
, revs
->lifo
);
124 struct commit
*commit
= list
->item
;
125 switch (simplify_commit(revs
, commit
)) {
128 int n
= estimate_commit_count(revs
, list
);
129 show_early_header(revs
, "incomplete", n
);
132 log_tree_commit(revs
, commit
);
143 /* Did we already get enough commits for the early output? */
148 * ..if no, then repeat it twice a second until we
151 * NOTE! We don't use "it_interval", because if the
152 * reader isn't listening, we want our output to be
153 * throttled by the writing, and not have the timer
154 * trigger every second even if we're blocked on a
157 early_output_timer
.it_value
.tv_sec
= 0;
158 early_output_timer
.it_value
.tv_usec
= 500000;
159 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
162 static void early_output(int signal
)
164 show_early_output
= log_show_early
;
167 static void setup_early_output(struct rev_info
*rev
)
172 * Set up the signal handler, minimally intrusively:
173 * we only set a single volatile integer word (not
174 * using sigatomic_t - trying to avoid unnecessary
175 * system dependencies and headers), and using
178 memset(&sa
, 0, sizeof(sa
));
179 sa
.sa_handler
= early_output
;
180 sigemptyset(&sa
.sa_mask
);
181 sa
.sa_flags
= SA_RESTART
;
182 sigaction(SIGALRM
, &sa
, NULL
);
185 * If we can get the whole output in less than a
186 * tenth of a second, don't even bother doing the
187 * early-output thing..
189 * This is a one-time-only trigger.
191 early_output_timer
.it_value
.tv_sec
= 0;
192 early_output_timer
.it_value
.tv_usec
= 100000;
193 setitimer(ITIMER_REAL
, &early_output_timer
, NULL
);
196 static void finish_early_output(struct rev_info
*rev
)
198 int n
= estimate_commit_count(rev
, rev
->commits
);
199 signal(SIGALRM
, SIG_IGN
);
200 show_early_header(rev
, "done", n
);
203 static int cmd_log_walk(struct rev_info
*rev
)
205 struct commit
*commit
;
207 if (rev
->early_output
)
208 setup_early_output(rev
);
210 if (prepare_revision_walk(rev
))
211 die("revision walk setup failed");
213 if (rev
->early_output
)
214 finish_early_output(rev
);
217 * For --check and --exit-code, the exit code is based on CHECK_FAILED
218 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
219 * retain that state information if replacing rev->diffopt in this loop
221 while ((commit
= get_revision(rev
)) != NULL
) {
222 log_tree_commit(rev
, commit
);
223 if (!rev
->reflog_info
) {
224 /* we allow cycles in reflog ancestry */
225 free(commit
->buffer
);
226 commit
->buffer
= NULL
;
228 free_commit_list(commit
->parents
);
229 commit
->parents
= NULL
;
231 if (rev
->diffopt
.output_format
& DIFF_FORMAT_CHECKDIFF
&&
232 DIFF_OPT_TST(&rev
->diffopt
, CHECK_FAILED
)) {
235 return diff_result_code(&rev
->diffopt
, 0);
238 static int git_log_config(const char *var
, const char *value
, void *cb
)
240 if (!strcmp(var
, "format.pretty"))
241 return git_config_string(&fmt_pretty
, var
, value
);
242 if (!strcmp(var
, "format.subjectprefix"))
243 return git_config_string(&fmt_patch_subject_prefix
, var
, value
);
244 if (!strcmp(var
, "log.date"))
245 return git_config_string(&default_date_mode
, var
, value
);
246 if (!strcmp(var
, "log.showroot")) {
247 default_show_root
= git_config_bool(var
, value
);
250 return git_diff_ui_config(var
, value
, cb
);
253 int cmd_whatchanged(int argc
, const char **argv
, const char *prefix
)
257 git_config(git_log_config
, NULL
);
259 if (diff_use_color_default
== -1)
260 diff_use_color_default
= git_use_color_default
;
262 init_revisions(&rev
, prefix
);
264 rev
.simplify_history
= 0;
265 cmd_log_init(argc
, argv
, prefix
, &rev
);
266 if (!rev
.diffopt
.output_format
)
267 rev
.diffopt
.output_format
= DIFF_FORMAT_RAW
;
268 return cmd_log_walk(&rev
);
271 static void show_tagger(char *buf
, int len
, struct rev_info
*rev
)
273 struct strbuf out
= STRBUF_INIT
;
275 pp_user_info("Tagger", rev
->commit_format
, &out
, buf
, rev
->date_mode
,
276 git_log_output_encoding
?
277 git_log_output_encoding
: git_commit_encoding
);
278 printf("%s", out
.buf
);
279 strbuf_release(&out
);
282 static int show_object(const unsigned char *sha1
, int show_tag_object
,
283 struct rev_info
*rev
)
286 enum object_type type
;
287 char *buf
= read_sha1_file(sha1
, &type
, &size
);
291 return error("Could not read object %s", sha1_to_hex(sha1
));
294 while (offset
< size
&& buf
[offset
] != '\n') {
295 int new_offset
= offset
+ 1;
296 while (new_offset
< size
&& buf
[new_offset
++] != '\n')
298 if (!prefixcmp(buf
+ offset
, "tagger "))
299 show_tagger(buf
+ offset
+ 7,
300 new_offset
- offset
- 7, rev
);
305 fwrite(buf
+ offset
, size
- offset
, 1, stdout
);
310 static int show_tree_object(const unsigned char *sha1
,
311 const char *base
, int baselen
,
312 const char *pathname
, unsigned mode
, int stage
, void *context
)
314 printf("%s%s\n", pathname
, S_ISDIR(mode
) ? "/" : "");
318 int cmd_show(int argc
, const char **argv
, const char *prefix
)
321 struct object_array_entry
*objects
;
322 int i
, count
, ret
= 0;
324 git_config(git_log_config
, NULL
);
326 if (diff_use_color_default
== -1)
327 diff_use_color_default
= git_use_color_default
;
329 init_revisions(&rev
, prefix
);
331 rev
.combine_merges
= 1;
332 rev
.dense_combined_merges
= 1;
333 rev
.always_show_header
= 1;
334 rev
.ignore_merges
= 0;
336 cmd_log_init(argc
, argv
, prefix
, &rev
);
338 count
= rev
.pending
.nr
;
339 objects
= rev
.pending
.objects
;
340 for (i
= 0; i
< count
&& !ret
; i
++) {
341 struct object
*o
= objects
[i
].item
;
342 const char *name
= objects
[i
].name
;
345 ret
= show_object(o
->sha1
, 0, NULL
);
348 struct tag
*t
= (struct tag
*)o
;
352 printf("%stag %s%s\n",
353 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
355 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
356 ret
= show_object(o
->sha1
, 1, &rev
);
360 o
= parse_object(t
->tagged
->sha1
);
362 ret
= error("Could not read object %s",
363 sha1_to_hex(t
->tagged
->sha1
));
371 printf("%stree %s%s\n\n",
372 diff_get_color_opt(&rev
.diffopt
, DIFF_COMMIT
),
374 diff_get_color_opt(&rev
.diffopt
, DIFF_RESET
));
375 read_tree_recursive((struct tree
*)o
, "", 0, 0, NULL
,
376 show_tree_object
, NULL
);
380 rev
.pending
.nr
= rev
.pending
.alloc
= 0;
381 rev
.pending
.objects
= NULL
;
382 add_object_array(o
, name
, &rev
.pending
);
383 ret
= cmd_log_walk(&rev
);
386 ret
= error("Unknown type: %d", o
->type
);
394 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
396 int cmd_log_reflog(int argc
, const char **argv
, const char *prefix
)
400 git_config(git_log_config
, NULL
);
402 if (diff_use_color_default
== -1)
403 diff_use_color_default
= git_use_color_default
;
405 init_revisions(&rev
, prefix
);
406 init_reflog_walk(&rev
.reflog_info
);
407 rev
.abbrev_commit
= 1;
408 rev
.verbose_header
= 1;
409 cmd_log_init(argc
, argv
, prefix
, &rev
);
412 * This means that we override whatever commit format the user gave
413 * on the cmd line. Sad, but cmd_log_init() currently doesn't
414 * allow us to set a different default.
416 rev
.commit_format
= CMIT_FMT_ONELINE
;
417 rev
.use_terminator
= 1;
418 rev
.always_show_header
= 1;
421 * We get called through "git reflog", so unlike the other log
422 * routines, we need to set up our pager manually..
426 return cmd_log_walk(&rev
);
429 int cmd_log(int argc
, const char **argv
, const char *prefix
)
433 git_config(git_log_config
, NULL
);
435 if (diff_use_color_default
== -1)
436 diff_use_color_default
= git_use_color_default
;
438 init_revisions(&rev
, prefix
);
439 rev
.always_show_header
= 1;
440 cmd_log_init(argc
, argv
, prefix
, &rev
);
441 return cmd_log_walk(&rev
);
446 static const char *fmt_patch_suffix
= ".patch";
447 static int numbered
= 0;
448 static int auto_number
= 1;
450 static char *default_attach
= NULL
;
452 static char **extra_hdr
;
453 static int extra_hdr_nr
;
454 static int extra_hdr_alloc
;
456 static char **extra_to
;
457 static int extra_to_nr
;
458 static int extra_to_alloc
;
460 static char **extra_cc
;
461 static int extra_cc_nr
;
462 static int extra_cc_alloc
;
464 static void add_header(const char *value
)
466 int len
= strlen(value
);
467 while (len
&& value
[len
- 1] == '\n')
469 if (!strncasecmp(value
, "to: ", 4)) {
470 ALLOC_GROW(extra_to
, extra_to_nr
+ 1, extra_to_alloc
);
471 extra_to
[extra_to_nr
++] = xstrndup(value
+ 4, len
- 4);
474 if (!strncasecmp(value
, "cc: ", 4)) {
475 ALLOC_GROW(extra_cc
, extra_cc_nr
+ 1, extra_cc_alloc
);
476 extra_cc
[extra_cc_nr
++] = xstrndup(value
+ 4, len
- 4);
479 ALLOC_GROW(extra_hdr
, extra_hdr_nr
+ 1, extra_hdr_alloc
);
480 extra_hdr
[extra_hdr_nr
++] = xstrndup(value
, len
);
483 #define THREAD_SHALLOW 1
484 #define THREAD_DEEP 2
485 static int thread
= 0;
486 static int do_signoff
= 0;
488 static int git_format_config(const char *var
, const char *value
, void *cb
)
490 if (!strcmp(var
, "format.headers")) {
492 die("format.headers without value");
496 if (!strcmp(var
, "format.suffix"))
497 return git_config_string(&fmt_patch_suffix
, var
, value
);
498 if (!strcmp(var
, "format.cc")) {
500 return config_error_nonbool(var
);
501 ALLOC_GROW(extra_cc
, extra_cc_nr
+ 1, extra_cc_alloc
);
502 extra_cc
[extra_cc_nr
++] = xstrdup(value
);
505 if (!strcmp(var
, "diff.color") || !strcmp(var
, "color.diff")) {
508 if (!strcmp(var
, "format.numbered")) {
509 if (value
&& !strcasecmp(value
, "auto")) {
513 numbered
= git_config_bool(var
, value
);
514 auto_number
= auto_number
&& numbered
;
517 if (!strcmp(var
, "format.attach")) {
519 default_attach
= xstrdup(value
);
521 default_attach
= xstrdup(git_version_string
);
524 if (!strcmp(var
, "format.thread")) {
525 if (value
&& !strcasecmp(value
, "deep")) {
526 thread
= THREAD_DEEP
;
529 if (value
&& !strcasecmp(value
, "shallow")) {
530 thread
= THREAD_SHALLOW
;
533 thread
= git_config_bool(var
, value
) && THREAD_SHALLOW
;
536 if (!strcmp(var
, "format.signoff")) {
537 do_signoff
= git_config_bool(var
, value
);
541 return git_log_config(var
, value
, cb
);
544 static FILE *realstdout
= NULL
;
545 static const char *output_directory
= NULL
;
546 static int outdir_offset
;
548 static int reopen_stdout(struct commit
*commit
, struct rev_info
*rev
)
550 struct strbuf filename
= STRBUF_INIT
;
551 int suffix_len
= strlen(fmt_patch_suffix
) + 1;
553 if (output_directory
) {
554 strbuf_addstr(&filename
, output_directory
);
556 PATH_MAX
- FORMAT_PATCH_NAME_MAX
- suffix_len
)
557 return error("name of output directory is too long");
558 if (filename
.buf
[filename
.len
- 1] != '/')
559 strbuf_addch(&filename
, '/');
562 get_patch_filename(commit
, rev
->nr
, fmt_patch_suffix
, &filename
);
564 if (!DIFF_OPT_TST(&rev
->diffopt
, QUIET
))
565 fprintf(realstdout
, "%s\n", filename
.buf
+ outdir_offset
);
567 if (freopen(filename
.buf
, "w", stdout
) == NULL
)
568 return error("Cannot open patch file %s", filename
.buf
);
570 strbuf_release(&filename
);
574 static void get_patch_ids(struct rev_info
*rev
, struct patch_ids
*ids
, const char *prefix
)
576 struct rev_info check_rev
;
577 struct commit
*commit
;
578 struct object
*o1
, *o2
;
579 unsigned flags1
, flags2
;
581 if (rev
->pending
.nr
!= 2)
582 die("Need exactly one range.");
584 o1
= rev
->pending
.objects
[0].item
;
586 o2
= rev
->pending
.objects
[1].item
;
589 if ((flags1
& UNINTERESTING
) == (flags2
& UNINTERESTING
))
594 /* given a range a..b get all patch ids for b..a */
595 init_revisions(&check_rev
, prefix
);
596 o1
->flags
^= UNINTERESTING
;
597 o2
->flags
^= UNINTERESTING
;
598 add_pending_object(&check_rev
, o1
, "o1");
599 add_pending_object(&check_rev
, o2
, "o2");
600 if (prepare_revision_walk(&check_rev
))
601 die("revision walk setup failed");
603 while ((commit
= get_revision(&check_rev
)) != NULL
) {
605 if (commit
->parents
&& commit
->parents
->next
)
608 add_commit_patch_id(commit
, ids
);
611 /* reset for next revision walk */
612 clear_commit_marks((struct commit
*)o1
,
613 SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
614 clear_commit_marks((struct commit
*)o2
,
615 SEEN
| UNINTERESTING
| SHOWN
| ADDED
);
620 static void gen_message_id(struct rev_info
*info
, char *base
)
622 const char *committer
= git_committer_info(IDENT_WARN_ON_NO_NAME
);
623 const char *email_start
= strrchr(committer
, '<');
624 const char *email_end
= strrchr(committer
, '>');
625 struct strbuf buf
= STRBUF_INIT
;
626 if (!email_start
|| !email_end
|| email_start
> email_end
- 1)
627 die("Could not extract email from committer identity.");
628 strbuf_addf(&buf
, "%s.%lu.git.%.*s", base
,
629 (unsigned long) time(NULL
),
630 (int)(email_end
- email_start
- 1), email_start
+ 1);
631 info
->message_id
= strbuf_detach(&buf
, NULL
);
634 static void make_cover_letter(struct rev_info
*rev
, int use_stdout
,
635 int numbered
, int numbered_files
,
636 struct commit
*origin
,
637 int nr
, struct commit
**list
, struct commit
*head
)
639 const char *committer
;
640 const char *subject_start
= NULL
;
641 const char *body
= "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
643 const char *extra_headers
= rev
->extra_headers
;
645 struct strbuf sb
= STRBUF_INIT
;
647 const char *encoding
= "UTF-8";
648 struct diff_options opts
;
649 int need_8bit_cte
= 0;
650 struct commit
*commit
= NULL
;
652 if (rev
->commit_format
!= CMIT_FMT_EMAIL
)
653 die("Cover letter needs email format");
655 committer
= git_committer_info(0);
657 if (!numbered_files
) {
659 * We fake a commit for the cover letter so we get the filename
662 commit
= xcalloc(1, sizeof(*commit
));
663 commit
->buffer
= xmalloc(400);
664 snprintf(commit
->buffer
, 400,
665 "tree 0000000000000000000000000000000000000000\n"
670 sha1_to_hex(head
->object
.sha1
), committer
, committer
);
673 if (!use_stdout
&& reopen_stdout(commit
, rev
))
678 free(commit
->buffer
);
682 log_write_email_headers(rev
, head
, &subject_start
, &extra_headers
,
685 for (i
= 0; !need_8bit_cte
&& i
< nr
; i
++)
686 if (has_non_ascii(list
[i
]->buffer
))
690 pp_user_info(NULL
, CMIT_FMT_EMAIL
, &sb
, committer
, DATE_RFC2822
,
692 pp_title_line(CMIT_FMT_EMAIL
, &msg
, &sb
, subject_start
, extra_headers
,
693 encoding
, need_8bit_cte
);
694 pp_remainder(CMIT_FMT_EMAIL
, &msg
, &sb
, 0);
695 printf("%s\n", sb
.buf
);
704 for (i
= 0; i
< nr
; i
++)
705 shortlog_add_commit(&log
, list
[i
]);
707 shortlog_output(&log
);
710 * We can only do diffstat with a unique reference point
715 memcpy(&opts
, &rev
->diffopt
, sizeof(opts
));
716 opts
.output_format
= DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_DIFFSTAT
;
718 diff_setup_done(&opts
);
720 diff_tree_sha1(origin
->tree
->object
.sha1
,
721 head
->tree
->object
.sha1
,
729 static const char *clean_message_id(const char *msg_id
)
732 const char *a
, *z
, *m
;
735 while ((ch
= *m
) && (isspace(ch
) || (ch
== '<')))
740 if (!isspace(ch
) && (ch
!= '>'))
745 die("insane in-reply-to: %s", msg_id
);
748 return xmemdupz(a
, z
- a
);
751 static const char *set_outdir(const char *prefix
, const char *output_directory
)
753 if (output_directory
&& is_absolute_path(output_directory
))
754 return output_directory
;
756 if (!prefix
|| !*prefix
) {
757 if (output_directory
)
758 return output_directory
;
759 /* The user did not explicitly ask for "./" */
764 outdir_offset
= strlen(prefix
);
765 if (!output_directory
)
768 return xstrdup(prefix_filename(prefix
, outdir_offset
,
772 static const char * const builtin_format_patch_usage
[] = {
773 "git format-patch [options] [<since> | <revision range>]",
777 static int keep_subject
= 0;
779 static int keep_callback(const struct option
*opt
, const char *arg
, int unset
)
781 ((struct rev_info
*)opt
->value
)->total
= -1;
786 static int subject_prefix
= 0;
788 static int subject_prefix_callback(const struct option
*opt
, const char *arg
,
792 ((struct rev_info
*)opt
->value
)->subject_prefix
= arg
;
796 static int numbered_cmdline_opt
= 0;
798 static int numbered_callback(const struct option
*opt
, const char *arg
,
801 *(int *)opt
->value
= numbered_cmdline_opt
= unset
? 0 : 1;
807 static int no_numbered_callback(const struct option
*opt
, const char *arg
,
810 return numbered_callback(opt
, arg
, 1);
813 static int output_directory_callback(const struct option
*opt
, const char *arg
,
816 const char **dir
= (const char **)opt
->value
;
818 die("Two output directories?");
823 static int thread_callback(const struct option
*opt
, const char *arg
, int unset
)
825 int *thread
= (int *)opt
->value
;
828 else if (!arg
|| !strcmp(arg
, "shallow"))
829 *thread
= THREAD_SHALLOW
;
830 else if (!strcmp(arg
, "deep"))
831 *thread
= THREAD_DEEP
;
837 static int attach_callback(const struct option
*opt
, const char *arg
, int unset
)
839 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
841 rev
->mime_boundary
= NULL
;
843 rev
->mime_boundary
= arg
;
845 rev
->mime_boundary
= git_version_string
;
846 rev
->no_inline
= unset
? 0 : 1;
850 static int inline_callback(const struct option
*opt
, const char *arg
, int unset
)
852 struct rev_info
*rev
= (struct rev_info
*)opt
->value
;
854 rev
->mime_boundary
= NULL
;
856 rev
->mime_boundary
= arg
;
858 rev
->mime_boundary
= git_version_string
;
863 static int header_callback(const struct option
*opt
, const char *arg
, int unset
)
869 static int cc_callback(const struct option
*opt
, const char *arg
, int unset
)
871 ALLOC_GROW(extra_cc
, extra_cc_nr
+ 1, extra_cc_alloc
);
872 extra_cc
[extra_cc_nr
++] = xstrdup(arg
);
876 int cmd_format_patch(int argc
, const char **argv
, const char *prefix
)
878 struct commit
*commit
;
879 struct commit
**list
= NULL
;
881 int nr
= 0, total
, i
;
883 int start_number
= -1;
884 int numbered_files
= 0; /* _just_ numbers */
885 int ignore_if_in_upstream
= 0;
886 int cover_letter
= 0;
887 int boundary_count
= 0;
888 int no_binary_diff
= 0;
889 struct commit
*origin
= NULL
, *head
= NULL
;
890 const char *in_reply_to
= NULL
;
891 struct patch_ids ids
;
892 char *add_signoff
= NULL
;
893 struct strbuf buf
= STRBUF_INIT
;
894 const struct option builtin_format_patch_options
[] = {
895 { OPTION_CALLBACK
, 'n', "numbered", &numbered
, NULL
,
896 "use [PATCH n/m] even with a single patch",
897 PARSE_OPT_NOARG
, numbered_callback
},
898 { OPTION_CALLBACK
, 'N', "no-numbered", &numbered
, NULL
,
899 "use [PATCH] even with multiple patches",
900 PARSE_OPT_NOARG
, no_numbered_callback
},
901 OPT_BOOLEAN('s', "signoff", &do_signoff
, "add Signed-off-by:"),
902 OPT_BOOLEAN(0, "stdout", &use_stdout
,
903 "print patches to standard out"),
904 OPT_BOOLEAN(0, "cover-letter", &cover_letter
,
905 "generate a cover letter"),
906 OPT_BOOLEAN(0, "numbered-files", &numbered_files
,
907 "use simple number sequence for output file names"),
908 OPT_STRING(0, "suffix", &fmt_patch_suffix
, "sfx",
909 "use <sfx> instead of '.patch'"),
910 OPT_INTEGER(0, "start-number", &start_number
,
911 "start numbering patches at <n> instead of 1"),
912 { OPTION_CALLBACK
, 0, "subject-prefix", &rev
, "prefix",
913 "Use [<prefix>] instead of [PATCH]",
914 PARSE_OPT_NONEG
, subject_prefix_callback
},
915 { OPTION_CALLBACK
, 'o', "output-directory", &output_directory
,
916 "dir", "store resulting files in <dir>",
917 PARSE_OPT_NONEG
, output_directory_callback
},
918 { OPTION_CALLBACK
, 'k', "keep-subject", &rev
, NULL
,
919 "don't strip/add [PATCH]",
920 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, keep_callback
},
921 OPT_BOOLEAN(0, "no-binary", &no_binary_diff
,
922 "don't output binary diffs"),
923 OPT_BOOLEAN(0, "ignore-if-in-upstream", &ignore_if_in_upstream
,
924 "don't include a patch matching a commit upstream"),
925 OPT_GROUP("Messaging"),
926 { OPTION_CALLBACK
, 0, "add-header", NULL
, "header",
927 "add email header", PARSE_OPT_NONEG
,
929 { OPTION_CALLBACK
, 0, "cc", NULL
, "email", "add Cc: header",
930 PARSE_OPT_NONEG
, cc_callback
},
931 OPT_STRING(0, "in-reply-to", &in_reply_to
, "message-id",
932 "make first mail a reply to <message-id>"),
933 { OPTION_CALLBACK
, 0, "attach", &rev
, "boundary",
934 "attach the patch", PARSE_OPT_OPTARG
,
936 { OPTION_CALLBACK
, 0, "inline", &rev
, "boundary",
938 PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
,
940 { OPTION_CALLBACK
, 0, "thread", &thread
, "style",
941 "enable message threading, styles: shallow, deep",
942 PARSE_OPT_OPTARG
, thread_callback
},
946 git_config(git_format_config
, NULL
);
947 init_revisions(&rev
, prefix
);
948 rev
.commit_format
= CMIT_FMT_EMAIL
;
949 rev
.verbose_header
= 1;
951 rev
.combine_merges
= 0;
952 rev
.ignore_merges
= 1;
953 DIFF_OPT_SET(&rev
.diffopt
, RECURSIVE
);
955 rev
.subject_prefix
= fmt_patch_subject_prefix
;
957 if (default_attach
) {
958 rev
.mime_boundary
= default_attach
;
963 * Parse the arguments before setup_revisions(), or something
964 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
965 * possibly a valid SHA1.
967 argc
= parse_options(argc
, argv
, prefix
, builtin_format_patch_options
,
968 builtin_format_patch_usage
,
969 PARSE_OPT_KEEP_ARGV0
| PARSE_OPT_KEEP_UNKNOWN
|
970 PARSE_OPT_KEEP_DASHDASH
);
973 const char *committer
;
975 committer
= git_committer_info(IDENT_ERROR_ON_NO_NAME
);
976 endpos
= strchr(committer
, '>');
978 die("bogus committer info %s", committer
);
979 add_signoff
= xmemdupz(committer
, endpos
- committer
+ 1);
982 for (i
= 0; i
< extra_hdr_nr
; i
++) {
983 strbuf_addstr(&buf
, extra_hdr
[i
]);
984 strbuf_addch(&buf
, '\n');
988 strbuf_addstr(&buf
, "To: ");
989 for (i
= 0; i
< extra_to_nr
; i
++) {
991 strbuf_addstr(&buf
, " ");
992 strbuf_addstr(&buf
, extra_to
[i
]);
993 if (i
+ 1 < extra_to_nr
)
994 strbuf_addch(&buf
, ',');
995 strbuf_addch(&buf
, '\n');
999 strbuf_addstr(&buf
, "Cc: ");
1000 for (i
= 0; i
< extra_cc_nr
; i
++) {
1002 strbuf_addstr(&buf
, " ");
1003 strbuf_addstr(&buf
, extra_cc
[i
]);
1004 if (i
+ 1 < extra_cc_nr
)
1005 strbuf_addch(&buf
, ',');
1006 strbuf_addch(&buf
, '\n');
1009 rev
.extra_headers
= strbuf_detach(&buf
, NULL
);
1011 if (start_number
< 0)
1015 * If numbered is set solely due to format.numbered in config,
1016 * and it would conflict with --keep-subject (-k) from the
1017 * command line, reset "numbered".
1019 if (numbered
&& keep_subject
&& !numbered_cmdline_opt
)
1022 if (numbered
&& keep_subject
)
1023 die ("-n and -k are mutually exclusive.");
1024 if (keep_subject
&& subject_prefix
)
1025 die ("--subject-prefix and -k are mutually exclusive.");
1027 argc
= setup_revisions(argc
, argv
, &rev
, "HEAD");
1029 die ("unrecognized argument: %s", argv
[1]);
1031 if (!rev
.diffopt
.output_format
1032 || rev
.diffopt
.output_format
== DIFF_FORMAT_PATCH
)
1033 rev
.diffopt
.output_format
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_SUMMARY
| DIFF_FORMAT_PATCH
;
1035 if (!DIFF_OPT_TST(&rev
.diffopt
, TEXT
) && !no_binary_diff
)
1036 DIFF_OPT_SET(&rev
.diffopt
, BINARY
);
1039 output_directory
= set_outdir(prefix
, output_directory
);
1041 if (output_directory
) {
1043 die("standard output, or directory, which one?");
1044 if (mkdir(output_directory
, 0777) < 0 && errno
!= EEXIST
)
1045 die_errno("Could not create directory '%s'",
1049 if (rev
.pending
.nr
== 1) {
1050 if (rev
.max_count
< 0 && !rev
.show_root_diff
) {
1052 * This is traditional behaviour of "git format-patch
1053 * origin" that prepares what the origin side still
1056 rev
.pending
.objects
[0].item
->flags
|= UNINTERESTING
;
1057 add_head_to_pending(&rev
);
1060 * Otherwise, it is "format-patch -22 HEAD", and/or
1061 * "format-patch --root HEAD". The user wants
1062 * get_revision() to do the usual traversal.
1067 * We cannot move this anywhere earlier because we do want to
1068 * know if --root was given explicitly from the comand line.
1070 rev
.show_root_diff
= 1;
1073 /* remember the range */
1075 for (i
= 0; i
< rev
.pending
.nr
; i
++) {
1076 struct object
*o
= rev
.pending
.objects
[i
].item
;
1077 if (!(o
->flags
& UNINTERESTING
))
1078 head
= (struct commit
*)o
;
1080 /* We can't generate a cover letter without any patches */
1085 if (ignore_if_in_upstream
)
1086 get_patch_ids(&rev
, &ids
, prefix
);
1089 realstdout
= xfdopen(xdup(1), "w");
1091 if (prepare_revision_walk(&rev
))
1092 die("revision walk setup failed");
1094 while ((commit
= get_revision(&rev
)) != NULL
) {
1095 if (commit
->object
.flags
& BOUNDARY
) {
1097 origin
= (boundary_count
== 1) ? commit
: NULL
;
1102 if (commit
->parents
&& commit
->parents
->next
)
1105 if (ignore_if_in_upstream
&&
1106 has_commit_patch_id(commit
, &ids
))
1110 list
= xrealloc(list
, nr
* sizeof(list
[0]));
1111 list
[nr
- 1] = commit
;
1114 if (!keep_subject
&& auto_number
&& total
> 1)
1117 rev
.total
= total
+ start_number
- 1;
1118 if (in_reply_to
|| thread
|| cover_letter
)
1119 rev
.ref_message_ids
= xcalloc(1, sizeof(struct string_list
));
1121 const char *msgid
= clean_message_id(in_reply_to
);
1122 string_list_append(msgid
, rev
.ref_message_ids
);
1124 rev
.numbered_files
= numbered_files
;
1125 rev
.patch_suffix
= fmt_patch_suffix
;
1128 gen_message_id(&rev
, "cover");
1129 make_cover_letter(&rev
, use_stdout
, numbered
, numbered_files
,
1130 origin
, nr
, list
, head
);
1134 rev
.add_signoff
= add_signoff
;
1138 rev
.nr
= total
- nr
+ (start_number
- 1);
1139 /* Make the second and subsequent mails replies to the first */
1141 /* Have we already had a message ID? */
1142 if (rev
.message_id
) {
1144 * For deep threading: make every mail
1145 * a reply to the previous one, no
1146 * matter what other options are set.
1148 * For shallow threading:
1150 * Without --cover-letter and
1151 * --in-reply-to, make every mail a
1152 * reply to the one before.
1154 * With --in-reply-to but no
1155 * --cover-letter, make every mail a
1156 * reply to the <reply-to>.
1158 * With --cover-letter, make every
1159 * mail but the cover letter a reply
1160 * to the cover letter. The cover
1161 * letter is a reply to the
1162 * --in-reply-to, if specified.
1164 if (thread
== THREAD_SHALLOW
1165 && rev
.ref_message_ids
->nr
> 0
1166 && (!cover_letter
|| rev
.nr
> 1))
1167 free(rev
.message_id
);
1169 string_list_append(rev
.message_id
,
1170 rev
.ref_message_ids
);
1172 gen_message_id(&rev
, sha1_to_hex(commit
->object
.sha1
));
1175 if (!use_stdout
&& reopen_stdout(numbered_files
? NULL
: commit
,
1177 die("Failed to create output files");
1178 shown
= log_tree_commit(&rev
, commit
);
1179 free(commit
->buffer
);
1180 commit
->buffer
= NULL
;
1182 /* We put one extra blank line between formatted
1183 * patches and this flag is used by log-tree code
1184 * to see if it needs to emit a LF before showing
1185 * the log; when using one file per patch, we do
1186 * not want the extra blank line.
1191 if (rev
.mime_boundary
)
1192 printf("\n--%s%s--\n\n\n",
1193 mime_boundary_leader
,
1196 printf("-- \n%s\n\n", git_version_string
);
1202 if (ignore_if_in_upstream
)
1203 free_patch_ids(&ids
);
1207 static int add_pending_commit(const char *arg
, struct rev_info
*revs
, int flags
)
1209 unsigned char sha1
[20];
1210 if (get_sha1(arg
, sha1
) == 0) {
1211 struct commit
*commit
= lookup_commit_reference(sha1
);
1213 commit
->object
.flags
|= flags
;
1214 add_pending_object(revs
, &commit
->object
, arg
);
1221 static const char cherry_usage
[] =
1222 "git cherry [-v] [<upstream> [<head> [<limit>]]]";
1223 int cmd_cherry(int argc
, const char **argv
, const char *prefix
)
1225 struct rev_info revs
;
1226 struct patch_ids ids
;
1227 struct commit
*commit
;
1228 struct commit_list
*list
= NULL
;
1229 struct branch
*current_branch
;
1230 const char *upstream
;
1231 const char *head
= "HEAD";
1232 const char *limit
= NULL
;
1235 if (argc
> 1 && !strcmp(argv
[1], "-v")) {
1252 current_branch
= branch_get(NULL
);
1253 if (!current_branch
|| !current_branch
->merge
1254 || !current_branch
->merge
[0]
1255 || !current_branch
->merge
[0]->dst
) {
1256 fprintf(stderr
, "Could not find a tracked"
1257 " remote branch, please"
1258 " specify <upstream> manually.\n");
1259 usage(cherry_usage
);
1262 upstream
= current_branch
->merge
[0]->dst
;
1265 init_revisions(&revs
, prefix
);
1267 revs
.combine_merges
= 0;
1268 revs
.ignore_merges
= 1;
1269 DIFF_OPT_SET(&revs
.diffopt
, RECURSIVE
);
1271 if (add_pending_commit(head
, &revs
, 0))
1272 die("Unknown commit %s", head
);
1273 if (add_pending_commit(upstream
, &revs
, UNINTERESTING
))
1274 die("Unknown commit %s", upstream
);
1276 /* Don't say anything if head and upstream are the same. */
1277 if (revs
.pending
.nr
== 2) {
1278 struct object_array_entry
*o
= revs
.pending
.objects
;
1279 if (hashcmp(o
[0].item
->sha1
, o
[1].item
->sha1
) == 0)
1283 get_patch_ids(&revs
, &ids
, prefix
);
1285 if (limit
&& add_pending_commit(limit
, &revs
, UNINTERESTING
))
1286 die("Unknown commit %s", limit
);
1288 /* reverse the list of commits */
1289 if (prepare_revision_walk(&revs
))
1290 die("revision walk setup failed");
1291 while ((commit
= get_revision(&revs
)) != NULL
) {
1293 if (commit
->parents
&& commit
->parents
->next
)
1296 commit_list_insert(commit
, &list
);
1302 commit
= list
->item
;
1303 if (has_commit_patch_id(commit
, &ids
))
1307 struct strbuf buf
= STRBUF_INIT
;
1308 pretty_print_commit(CMIT_FMT_ONELINE
, commit
,
1309 &buf
, 0, NULL
, NULL
, 0, 0);
1310 printf("%c %s %s\n", sign
,
1311 sha1_to_hex(commit
->object
.sha1
), buf
.buf
);
1312 strbuf_release(&buf
);
1315 printf("%c %s\n", sign
,
1316 sha1_to_hex(commit
->object
.sha1
));
1322 free_patch_ids(&ids
);