Change prettify_ref to prettify_refname
[git/dkf.git] / builtin-log.c
blob5eaec5d24e6ca70af2879ce9439eb2ba831211b6
1 /*
2 * Builtin "git log" and related commands (show, whatchanged)
4 * (C) Copyright 2006 Linus Torvalds
5 * 2006 Junio Hamano
6 */
7 #include "cache.h"
8 #include "color.h"
9 #include "commit.h"
10 #include "diff.h"
11 #include "revision.h"
12 #include "log-tree.h"
13 #include "builtin.h"
14 #include "tag.h"
15 #include "reflog-walk.h"
16 #include "patch-ids.h"
17 #include "run-command.h"
18 #include "shortlog.h"
19 #include "remote.h"
20 #include "string-list.h"
22 /* Set a default date-time format for git log ("log.date" config variable) */
23 static const char *default_date_mode = NULL;
25 static int default_show_root = 1;
26 static const char *fmt_patch_subject_prefix = "PATCH";
27 static const char *fmt_pretty;
29 static void cmd_log_init(int argc, const char **argv, const char *prefix,
30 struct rev_info *rev)
32 int i;
34 rev->abbrev = DEFAULT_ABBREV;
35 rev->commit_format = CMIT_FMT_DEFAULT;
36 if (fmt_pretty)
37 get_commit_format(fmt_pretty, rev);
38 rev->verbose_header = 1;
39 DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
40 rev->show_root_diff = default_show_root;
41 rev->subject_prefix = fmt_patch_subject_prefix;
42 DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
44 if (default_date_mode)
45 rev->date_mode = parse_date_format(default_date_mode);
47 argc = setup_revisions(argc, argv, rev, "HEAD");
49 if (rev->diffopt.pickaxe || rev->diffopt.filter)
50 rev->always_show_header = 0;
51 if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
52 rev->always_show_header = 0;
53 if (rev->diffopt.nr_paths != 1)
54 usage("git logs can only follow renames on one pathname at a time");
56 for (i = 1; i < argc; i++) {
57 const char *arg = argv[i];
58 if (!strcmp(arg, "--decorate")) {
59 load_ref_decorations();
60 rev->show_decorations = 1;
61 } else if (!strcmp(arg, "--source")) {
62 rev->show_source = 1;
63 } else
64 die("unrecognized argument: %s", arg);
69 * This gives a rough estimate for how many commits we
70 * will print out in the list.
72 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
74 int n = 0;
76 while (list) {
77 struct commit *commit = list->item;
78 unsigned int flags = commit->object.flags;
79 list = list->next;
80 if (!(flags & (TREESAME | UNINTERESTING)))
81 n++;
83 return n;
86 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
88 if (rev->shown_one) {
89 rev->shown_one = 0;
90 if (rev->commit_format != CMIT_FMT_ONELINE)
91 putchar(rev->diffopt.line_termination);
93 printf("Final output: %d %s\n", nr, stage);
96 struct itimerval early_output_timer;
98 static void log_show_early(struct rev_info *revs, struct commit_list *list)
100 int i = revs->early_output;
101 int show_header = 1;
103 sort_in_topological_order(&list, revs->lifo);
104 while (list && i) {
105 struct commit *commit = list->item;
106 switch (simplify_commit(revs, commit)) {
107 case commit_show:
108 if (show_header) {
109 int n = estimate_commit_count(revs, list);
110 show_early_header(revs, "incomplete", n);
111 show_header = 0;
113 log_tree_commit(revs, commit);
114 i--;
115 break;
116 case commit_ignore:
117 break;
118 case commit_error:
119 return;
121 list = list->next;
124 /* Did we already get enough commits for the early output? */
125 if (!i)
126 return;
129 * ..if no, then repeat it twice a second until we
130 * do.
132 * NOTE! We don't use "it_interval", because if the
133 * reader isn't listening, we want our output to be
134 * throttled by the writing, and not have the timer
135 * trigger every second even if we're blocked on a
136 * reader!
138 early_output_timer.it_value.tv_sec = 0;
139 early_output_timer.it_value.tv_usec = 500000;
140 setitimer(ITIMER_REAL, &early_output_timer, NULL);
143 static void early_output(int signal)
145 show_early_output = log_show_early;
148 static void setup_early_output(struct rev_info *rev)
150 struct sigaction sa;
153 * Set up the signal handler, minimally intrusively:
154 * we only set a single volatile integer word (not
155 * using sigatomic_t - trying to avoid unnecessary
156 * system dependencies and headers), and using
157 * SA_RESTART.
159 memset(&sa, 0, sizeof(sa));
160 sa.sa_handler = early_output;
161 sigemptyset(&sa.sa_mask);
162 sa.sa_flags = SA_RESTART;
163 sigaction(SIGALRM, &sa, NULL);
166 * If we can get the whole output in less than a
167 * tenth of a second, don't even bother doing the
168 * early-output thing..
170 * This is a one-time-only trigger.
172 early_output_timer.it_value.tv_sec = 0;
173 early_output_timer.it_value.tv_usec = 100000;
174 setitimer(ITIMER_REAL, &early_output_timer, NULL);
177 static void finish_early_output(struct rev_info *rev)
179 int n = estimate_commit_count(rev, rev->commits);
180 signal(SIGALRM, SIG_IGN);
181 show_early_header(rev, "done", n);
184 static int cmd_log_walk(struct rev_info *rev)
186 struct commit *commit;
188 if (rev->early_output)
189 setup_early_output(rev);
191 if (prepare_revision_walk(rev))
192 die("revision walk setup failed");
194 if (rev->early_output)
195 finish_early_output(rev);
198 * For --check and --exit-code, the exit code is based on CHECK_FAILED
199 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
200 * retain that state information if replacing rev->diffopt in this loop
202 while ((commit = get_revision(rev)) != NULL) {
203 log_tree_commit(rev, commit);
204 if (!rev->reflog_info) {
205 /* we allow cycles in reflog ancestry */
206 free(commit->buffer);
207 commit->buffer = NULL;
209 free_commit_list(commit->parents);
210 commit->parents = NULL;
212 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
213 DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
214 return 02;
216 return diff_result_code(&rev->diffopt, 0);
219 static int git_log_config(const char *var, const char *value, void *cb)
221 if (!strcmp(var, "format.pretty"))
222 return git_config_string(&fmt_pretty, var, value);
223 if (!strcmp(var, "format.subjectprefix"))
224 return git_config_string(&fmt_patch_subject_prefix, var, value);
225 if (!strcmp(var, "log.date"))
226 return git_config_string(&default_date_mode, var, value);
227 if (!strcmp(var, "log.showroot")) {
228 default_show_root = git_config_bool(var, value);
229 return 0;
231 return git_diff_ui_config(var, value, cb);
234 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
236 struct rev_info rev;
238 git_config(git_log_config, NULL);
240 if (diff_use_color_default == -1)
241 diff_use_color_default = git_use_color_default;
243 init_revisions(&rev, prefix);
244 rev.diff = 1;
245 rev.simplify_history = 0;
246 cmd_log_init(argc, argv, prefix, &rev);
247 if (!rev.diffopt.output_format)
248 rev.diffopt.output_format = DIFF_FORMAT_RAW;
249 return cmd_log_walk(&rev);
252 static void show_tagger(char *buf, int len, struct rev_info *rev)
254 struct strbuf out = STRBUF_INIT;
256 pp_user_info("Tagger", rev->commit_format, &out, buf, rev->date_mode,
257 git_log_output_encoding ?
258 git_log_output_encoding: git_commit_encoding);
259 printf("%s\n", out.buf);
260 strbuf_release(&out);
263 static int show_object(const unsigned char *sha1, int show_tag_object,
264 struct rev_info *rev)
266 unsigned long size;
267 enum object_type type;
268 char *buf = read_sha1_file(sha1, &type, &size);
269 int offset = 0;
271 if (!buf)
272 return error("Could not read object %s", sha1_to_hex(sha1));
274 if (show_tag_object)
275 while (offset < size && buf[offset] != '\n') {
276 int new_offset = offset + 1;
277 while (new_offset < size && buf[new_offset++] != '\n')
278 ; /* do nothing */
279 if (!prefixcmp(buf + offset, "tagger "))
280 show_tagger(buf + offset + 7,
281 new_offset - offset - 7, rev);
282 offset = new_offset;
285 if (offset < size)
286 fwrite(buf + offset, size - offset, 1, stdout);
287 free(buf);
288 return 0;
291 static int show_tree_object(const unsigned char *sha1,
292 const char *base, int baselen,
293 const char *pathname, unsigned mode, int stage, void *context)
295 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
296 return 0;
299 int cmd_show(int argc, const char **argv, const char *prefix)
301 struct rev_info rev;
302 struct object_array_entry *objects;
303 int i, count, ret = 0;
305 git_config(git_log_config, NULL);
307 if (diff_use_color_default == -1)
308 diff_use_color_default = git_use_color_default;
310 init_revisions(&rev, prefix);
311 rev.diff = 1;
312 rev.combine_merges = 1;
313 rev.dense_combined_merges = 1;
314 rev.always_show_header = 1;
315 rev.ignore_merges = 0;
316 rev.no_walk = 1;
317 cmd_log_init(argc, argv, prefix, &rev);
319 count = rev.pending.nr;
320 objects = rev.pending.objects;
321 for (i = 0; i < count && !ret; i++) {
322 struct object *o = objects[i].item;
323 const char *name = objects[i].name;
324 switch (o->type) {
325 case OBJ_BLOB:
326 ret = show_object(o->sha1, 0, NULL);
327 break;
328 case OBJ_TAG: {
329 struct tag *t = (struct tag *)o;
331 printf("%stag %s%s\n",
332 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
333 t->tag,
334 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
335 ret = show_object(o->sha1, 1, &rev);
336 if (ret)
337 break;
338 o = parse_object(t->tagged->sha1);
339 if (!o)
340 ret = error("Could not read object %s",
341 sha1_to_hex(t->tagged->sha1));
342 objects[i].item = o;
343 i--;
344 break;
346 case OBJ_TREE:
347 printf("%stree %s%s\n\n",
348 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
349 name,
350 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
351 read_tree_recursive((struct tree *)o, "", 0, 0, NULL,
352 show_tree_object, NULL);
353 break;
354 case OBJ_COMMIT:
355 rev.pending.nr = rev.pending.alloc = 0;
356 rev.pending.objects = NULL;
357 add_object_array(o, name, &rev.pending);
358 ret = cmd_log_walk(&rev);
359 break;
360 default:
361 ret = error("Unknown type: %d", o->type);
364 free(objects);
365 return ret;
369 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
371 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
373 struct rev_info rev;
375 git_config(git_log_config, NULL);
377 if (diff_use_color_default == -1)
378 diff_use_color_default = git_use_color_default;
380 init_revisions(&rev, prefix);
381 init_reflog_walk(&rev.reflog_info);
382 rev.abbrev_commit = 1;
383 rev.verbose_header = 1;
384 cmd_log_init(argc, argv, prefix, &rev);
387 * This means that we override whatever commit format the user gave
388 * on the cmd line. Sad, but cmd_log_init() currently doesn't
389 * allow us to set a different default.
391 rev.commit_format = CMIT_FMT_ONELINE;
392 rev.use_terminator = 1;
393 rev.always_show_header = 1;
396 * We get called through "git reflog", so unlike the other log
397 * routines, we need to set up our pager manually..
399 setup_pager();
401 return cmd_log_walk(&rev);
404 int cmd_log(int argc, const char **argv, const char *prefix)
406 struct rev_info rev;
408 git_config(git_log_config, NULL);
410 if (diff_use_color_default == -1)
411 diff_use_color_default = git_use_color_default;
413 init_revisions(&rev, prefix);
414 rev.always_show_header = 1;
415 cmd_log_init(argc, argv, prefix, &rev);
416 return cmd_log_walk(&rev);
419 /* format-patch */
421 static const char *fmt_patch_suffix = ".patch";
422 static int numbered = 0;
423 static int auto_number = 1;
425 static char *default_attach = NULL;
427 static char **extra_hdr;
428 static int extra_hdr_nr;
429 static int extra_hdr_alloc;
431 static char **extra_to;
432 static int extra_to_nr;
433 static int extra_to_alloc;
435 static char **extra_cc;
436 static int extra_cc_nr;
437 static int extra_cc_alloc;
439 static void add_header(const char *value)
441 int len = strlen(value);
442 while (len && value[len - 1] == '\n')
443 len--;
444 if (!strncasecmp(value, "to: ", 4)) {
445 ALLOC_GROW(extra_to, extra_to_nr + 1, extra_to_alloc);
446 extra_to[extra_to_nr++] = xstrndup(value + 4, len - 4);
447 return;
449 if (!strncasecmp(value, "cc: ", 4)) {
450 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
451 extra_cc[extra_cc_nr++] = xstrndup(value + 4, len - 4);
452 return;
454 ALLOC_GROW(extra_hdr, extra_hdr_nr + 1, extra_hdr_alloc);
455 extra_hdr[extra_hdr_nr++] = xstrndup(value, len);
458 #define THREAD_SHALLOW 1
459 #define THREAD_DEEP 2
460 static int thread = 0;
461 static int do_signoff = 0;
463 static int git_format_config(const char *var, const char *value, void *cb)
465 if (!strcmp(var, "format.headers")) {
466 if (!value)
467 die("format.headers without value");
468 add_header(value);
469 return 0;
471 if (!strcmp(var, "format.suffix"))
472 return git_config_string(&fmt_patch_suffix, var, value);
473 if (!strcmp(var, "format.cc")) {
474 if (!value)
475 return config_error_nonbool(var);
476 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
477 extra_cc[extra_cc_nr++] = xstrdup(value);
478 return 0;
480 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff")) {
481 return 0;
483 if (!strcmp(var, "format.numbered")) {
484 if (value && !strcasecmp(value, "auto")) {
485 auto_number = 1;
486 return 0;
488 numbered = git_config_bool(var, value);
489 auto_number = auto_number && numbered;
490 return 0;
492 if (!strcmp(var, "format.attach")) {
493 if (value && *value)
494 default_attach = xstrdup(value);
495 else
496 default_attach = xstrdup(git_version_string);
497 return 0;
499 if (!strcmp(var, "format.thread")) {
500 if (value && !strcasecmp(value, "deep")) {
501 thread = THREAD_DEEP;
502 return 0;
504 if (value && !strcasecmp(value, "shallow")) {
505 thread = THREAD_SHALLOW;
506 return 0;
508 thread = git_config_bool(var, value) && THREAD_SHALLOW;
509 return 0;
511 if (!strcmp(var, "format.signoff")) {
512 do_signoff = git_config_bool(var, value);
513 return 0;
516 return git_log_config(var, value, cb);
519 static FILE *realstdout = NULL;
520 static const char *output_directory = NULL;
521 static int outdir_offset;
523 static int reopen_stdout(struct commit *commit, struct rev_info *rev)
525 struct strbuf filename = STRBUF_INIT;
526 int suffix_len = strlen(fmt_patch_suffix) + 1;
528 if (output_directory) {
529 strbuf_addstr(&filename, output_directory);
530 if (filename.len >=
531 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
532 return error("name of output directory is too long");
533 if (filename.buf[filename.len - 1] != '/')
534 strbuf_addch(&filename, '/');
537 get_patch_filename(commit, rev->nr, fmt_patch_suffix, &filename);
539 if (!DIFF_OPT_TST(&rev->diffopt, QUIET))
540 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
542 if (freopen(filename.buf, "w", stdout) == NULL)
543 return error("Cannot open patch file %s", filename.buf);
545 strbuf_release(&filename);
546 return 0;
549 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids, const char *prefix)
551 struct rev_info check_rev;
552 struct commit *commit;
553 struct object *o1, *o2;
554 unsigned flags1, flags2;
556 if (rev->pending.nr != 2)
557 die("Need exactly one range.");
559 o1 = rev->pending.objects[0].item;
560 flags1 = o1->flags;
561 o2 = rev->pending.objects[1].item;
562 flags2 = o2->flags;
564 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
565 die("Not a range.");
567 init_patch_ids(ids);
569 /* given a range a..b get all patch ids for b..a */
570 init_revisions(&check_rev, prefix);
571 o1->flags ^= UNINTERESTING;
572 o2->flags ^= UNINTERESTING;
573 add_pending_object(&check_rev, o1, "o1");
574 add_pending_object(&check_rev, o2, "o2");
575 if (prepare_revision_walk(&check_rev))
576 die("revision walk setup failed");
578 while ((commit = get_revision(&check_rev)) != NULL) {
579 /* ignore merges */
580 if (commit->parents && commit->parents->next)
581 continue;
583 add_commit_patch_id(commit, ids);
586 /* reset for next revision walk */
587 clear_commit_marks((struct commit *)o1,
588 SEEN | UNINTERESTING | SHOWN | ADDED);
589 clear_commit_marks((struct commit *)o2,
590 SEEN | UNINTERESTING | SHOWN | ADDED);
591 o1->flags = flags1;
592 o2->flags = flags2;
595 static void gen_message_id(struct rev_info *info, char *base)
597 const char *committer = git_committer_info(IDENT_WARN_ON_NO_NAME);
598 const char *email_start = strrchr(committer, '<');
599 const char *email_end = strrchr(committer, '>');
600 struct strbuf buf = STRBUF_INIT;
601 if (!email_start || !email_end || email_start > email_end - 1)
602 die("Could not extract email from committer identity.");
603 strbuf_addf(&buf, "%s.%lu.git.%.*s", base,
604 (unsigned long) time(NULL),
605 (int)(email_end - email_start - 1), email_start + 1);
606 info->message_id = strbuf_detach(&buf, NULL);
609 static void make_cover_letter(struct rev_info *rev, int use_stdout,
610 int numbered, int numbered_files,
611 struct commit *origin,
612 int nr, struct commit **list, struct commit *head)
614 const char *committer;
615 const char *subject_start = NULL;
616 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
617 const char *msg;
618 const char *extra_headers = rev->extra_headers;
619 struct shortlog log;
620 struct strbuf sb = STRBUF_INIT;
621 int i;
622 const char *encoding = "utf-8";
623 struct diff_options opts;
624 int need_8bit_cte = 0;
625 struct commit *commit = NULL;
627 if (rev->commit_format != CMIT_FMT_EMAIL)
628 die("Cover letter needs email format");
630 committer = git_committer_info(0);
632 if (!numbered_files) {
634 * We fake a commit for the cover letter so we get the filename
635 * desired.
637 commit = xcalloc(1, sizeof(*commit));
638 commit->buffer = xmalloc(400);
639 snprintf(commit->buffer, 400,
640 "tree 0000000000000000000000000000000000000000\n"
641 "parent %s\n"
642 "author %s\n"
643 "committer %s\n\n"
644 "cover letter\n",
645 sha1_to_hex(head->object.sha1), committer, committer);
648 if (!use_stdout && reopen_stdout(commit, rev))
649 return;
651 if (commit) {
653 free(commit->buffer);
654 free(commit);
657 log_write_email_headers(rev, head, &subject_start, &extra_headers,
658 &need_8bit_cte);
660 msg = body;
661 pp_user_info(NULL, CMIT_FMT_EMAIL, &sb, committer, DATE_RFC2822,
662 encoding);
663 pp_title_line(CMIT_FMT_EMAIL, &msg, &sb, subject_start, extra_headers,
664 encoding, need_8bit_cte);
665 pp_remainder(CMIT_FMT_EMAIL, &msg, &sb, 0);
666 printf("%s\n", sb.buf);
668 strbuf_release(&sb);
670 shortlog_init(&log);
671 log.wrap_lines = 1;
672 log.wrap = 72;
673 log.in1 = 2;
674 log.in2 = 4;
675 for (i = 0; i < nr; i++)
676 shortlog_add_commit(&log, list[i]);
678 shortlog_output(&log);
681 * We can only do diffstat with a unique reference point
683 if (!origin)
684 return;
686 memcpy(&opts, &rev->diffopt, sizeof(opts));
687 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
689 diff_setup_done(&opts);
691 diff_tree_sha1(origin->tree->object.sha1,
692 head->tree->object.sha1,
693 "", &opts);
694 diffcore_std(&opts);
695 diff_flush(&opts);
697 printf("\n");
700 static const char *clean_message_id(const char *msg_id)
702 char ch;
703 const char *a, *z, *m;
705 m = msg_id;
706 while ((ch = *m) && (isspace(ch) || (ch == '<')))
707 m++;
708 a = m;
709 z = NULL;
710 while ((ch = *m)) {
711 if (!isspace(ch) && (ch != '>'))
712 z = m;
713 m++;
715 if (!z)
716 die("insane in-reply-to: %s", msg_id);
717 if (++z == m)
718 return a;
719 return xmemdupz(a, z - a);
722 static const char *set_outdir(const char *prefix, const char *output_directory)
724 if (output_directory && is_absolute_path(output_directory))
725 return output_directory;
727 if (!prefix || !*prefix) {
728 if (output_directory)
729 return output_directory;
730 /* The user did not explicitly ask for "./" */
731 outdir_offset = 2;
732 return "./";
735 outdir_offset = strlen(prefix);
736 if (!output_directory)
737 return prefix;
739 return xstrdup(prefix_filename(prefix, outdir_offset,
740 output_directory));
743 int cmd_format_patch(int argc, const char **argv, const char *prefix)
745 struct commit *commit;
746 struct commit **list = NULL;
747 struct rev_info rev;
748 int nr = 0, total, i, j;
749 int use_stdout = 0;
750 int start_number = -1;
751 int keep_subject = 0;
752 int numbered_files = 0; /* _just_ numbers */
753 int subject_prefix = 0;
754 int ignore_if_in_upstream = 0;
755 int cover_letter = 0;
756 int boundary_count = 0;
757 int no_binary_diff = 0;
758 struct commit *origin = NULL, *head = NULL;
759 const char *in_reply_to = NULL;
760 struct patch_ids ids;
761 char *add_signoff = NULL;
762 struct strbuf buf = STRBUF_INIT;
764 git_config(git_format_config, NULL);
765 init_revisions(&rev, prefix);
766 rev.commit_format = CMIT_FMT_EMAIL;
767 rev.verbose_header = 1;
768 rev.diff = 1;
769 rev.combine_merges = 0;
770 rev.ignore_merges = 1;
771 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
773 rev.subject_prefix = fmt_patch_subject_prefix;
775 if (default_attach) {
776 rev.mime_boundary = default_attach;
777 rev.no_inline = 1;
781 * Parse the arguments before setup_revisions(), or something
782 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
783 * possibly a valid SHA1.
785 for (i = 1, j = 1; i < argc; i++) {
786 if (!strcmp(argv[i], "--stdout"))
787 use_stdout = 1;
788 else if (!strcmp(argv[i], "-n") ||
789 !strcmp(argv[i], "--numbered"))
790 numbered = 1;
791 else if (!strcmp(argv[i], "-N") ||
792 !strcmp(argv[i], "--no-numbered")) {
793 numbered = 0;
794 auto_number = 0;
796 else if (!prefixcmp(argv[i], "--start-number="))
797 start_number = strtol(argv[i] + 15, NULL, 10);
798 else if (!strcmp(argv[i], "--numbered-files"))
799 numbered_files = 1;
800 else if (!strcmp(argv[i], "--start-number")) {
801 i++;
802 if (i == argc)
803 die("Need a number for --start-number");
804 start_number = strtol(argv[i], NULL, 10);
806 else if (!prefixcmp(argv[i], "--cc=")) {
807 ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
808 extra_cc[extra_cc_nr++] = xstrdup(argv[i] + 5);
810 else if (!strcmp(argv[i], "-k") ||
811 !strcmp(argv[i], "--keep-subject")) {
812 keep_subject = 1;
813 rev.total = -1;
815 else if (!strcmp(argv[i], "--output-directory") ||
816 !strcmp(argv[i], "-o")) {
817 i++;
818 if (argc <= i)
819 die("Which directory?");
820 if (output_directory)
821 die("Two output directories?");
822 output_directory = argv[i];
824 else if (!strcmp(argv[i], "--signoff") ||
825 !strcmp(argv[i], "-s")) {
826 do_signoff = 1;
828 else if (!strcmp(argv[i], "--attach")) {
829 rev.mime_boundary = git_version_string;
830 rev.no_inline = 1;
832 else if (!prefixcmp(argv[i], "--attach=")) {
833 rev.mime_boundary = argv[i] + 9;
834 rev.no_inline = 1;
836 else if (!strcmp(argv[i], "--no-attach")) {
837 rev.mime_boundary = NULL;
838 rev.no_inline = 0;
840 else if (!strcmp(argv[i], "--inline")) {
841 rev.mime_boundary = git_version_string;
842 rev.no_inline = 0;
844 else if (!prefixcmp(argv[i], "--inline=")) {
845 rev.mime_boundary = argv[i] + 9;
846 rev.no_inline = 0;
848 else if (!strcmp(argv[i], "--ignore-if-in-upstream"))
849 ignore_if_in_upstream = 1;
850 else if (!strcmp(argv[i], "--thread")
851 || !strcmp(argv[i], "--thread=shallow"))
852 thread = THREAD_SHALLOW;
853 else if (!strcmp(argv[i], "--thread=deep"))
854 thread = THREAD_DEEP;
855 else if (!strcmp(argv[i], "--no-thread"))
856 thread = 0;
857 else if (!prefixcmp(argv[i], "--in-reply-to="))
858 in_reply_to = argv[i] + 14;
859 else if (!strcmp(argv[i], "--in-reply-to")) {
860 i++;
861 if (i == argc)
862 die("Need a Message-Id for --in-reply-to");
863 in_reply_to = argv[i];
864 } else if (!prefixcmp(argv[i], "--subject-prefix=")) {
865 subject_prefix = 1;
866 rev.subject_prefix = argv[i] + 17;
867 } else if (!prefixcmp(argv[i], "--suffix="))
868 fmt_patch_suffix = argv[i] + 9;
869 else if (!strcmp(argv[i], "--cover-letter"))
870 cover_letter = 1;
871 else if (!strcmp(argv[i], "--no-binary"))
872 no_binary_diff = 1;
873 else if (!prefixcmp(argv[i], "--add-header="))
874 add_header(argv[i] + 13);
875 else
876 argv[j++] = argv[i];
878 argc = j;
880 if (do_signoff) {
881 const char *committer;
882 const char *endpos;
883 committer = git_committer_info(IDENT_ERROR_ON_NO_NAME);
884 endpos = strchr(committer, '>');
885 if (!endpos)
886 die("bogus committer info %s", committer);
887 add_signoff = xmemdupz(committer, endpos - committer + 1);
890 for (i = 0; i < extra_hdr_nr; i++) {
891 strbuf_addstr(&buf, extra_hdr[i]);
892 strbuf_addch(&buf, '\n');
895 if (extra_to_nr)
896 strbuf_addstr(&buf, "To: ");
897 for (i = 0; i < extra_to_nr; i++) {
898 if (i)
899 strbuf_addstr(&buf, " ");
900 strbuf_addstr(&buf, extra_to[i]);
901 if (i + 1 < extra_to_nr)
902 strbuf_addch(&buf, ',');
903 strbuf_addch(&buf, '\n');
906 if (extra_cc_nr)
907 strbuf_addstr(&buf, "Cc: ");
908 for (i = 0; i < extra_cc_nr; i++) {
909 if (i)
910 strbuf_addstr(&buf, " ");
911 strbuf_addstr(&buf, extra_cc[i]);
912 if (i + 1 < extra_cc_nr)
913 strbuf_addch(&buf, ',');
914 strbuf_addch(&buf, '\n');
917 rev.extra_headers = strbuf_detach(&buf, 0);
919 if (start_number < 0)
920 start_number = 1;
921 if (numbered && keep_subject)
922 die ("-n and -k are mutually exclusive.");
923 if (keep_subject && subject_prefix)
924 die ("--subject-prefix and -k are mutually exclusive.");
926 argc = setup_revisions(argc, argv, &rev, "HEAD");
927 if (argc > 1)
928 die ("unrecognized argument: %s", argv[1]);
930 if (!rev.diffopt.output_format
931 || rev.diffopt.output_format == DIFF_FORMAT_PATCH)
932 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY | DIFF_FORMAT_PATCH;
934 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
935 DIFF_OPT_SET(&rev.diffopt, BINARY);
937 if (!use_stdout)
938 output_directory = set_outdir(prefix, output_directory);
940 if (output_directory) {
941 if (use_stdout)
942 die("standard output, or directory, which one?");
943 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
944 die("Could not create directory %s",
945 output_directory);
948 if (rev.pending.nr == 1) {
949 if (rev.max_count < 0 && !rev.show_root_diff) {
951 * This is traditional behaviour of "git format-patch
952 * origin" that prepares what the origin side still
953 * does not have.
955 rev.pending.objects[0].item->flags |= UNINTERESTING;
956 add_head_to_pending(&rev);
959 * Otherwise, it is "format-patch -22 HEAD", and/or
960 * "format-patch --root HEAD". The user wants
961 * get_revision() to do the usual traversal.
966 * We cannot move this anywhere earlier because we do want to
967 * know if --root was given explicitly from the comand line.
969 rev.show_root_diff = 1;
971 if (cover_letter) {
972 /* remember the range */
973 int i;
974 for (i = 0; i < rev.pending.nr; i++) {
975 struct object *o = rev.pending.objects[i].item;
976 if (!(o->flags & UNINTERESTING))
977 head = (struct commit *)o;
979 /* We can't generate a cover letter without any patches */
980 if (!head)
981 return 0;
984 if (ignore_if_in_upstream)
985 get_patch_ids(&rev, &ids, prefix);
987 if (!use_stdout)
988 realstdout = xfdopen(xdup(1), "w");
990 if (prepare_revision_walk(&rev))
991 die("revision walk setup failed");
992 rev.boundary = 1;
993 while ((commit = get_revision(&rev)) != NULL) {
994 if (commit->object.flags & BOUNDARY) {
995 boundary_count++;
996 origin = (boundary_count == 1) ? commit : NULL;
997 continue;
1000 /* ignore merges */
1001 if (commit->parents && commit->parents->next)
1002 continue;
1004 if (ignore_if_in_upstream &&
1005 has_commit_patch_id(commit, &ids))
1006 continue;
1008 nr++;
1009 list = xrealloc(list, nr * sizeof(list[0]));
1010 list[nr - 1] = commit;
1012 total = nr;
1013 if (!keep_subject && auto_number && total > 1)
1014 numbered = 1;
1015 if (numbered)
1016 rev.total = total + start_number - 1;
1017 if (in_reply_to || thread || cover_letter)
1018 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1019 if (in_reply_to) {
1020 const char *msgid = clean_message_id(in_reply_to);
1021 string_list_append(msgid, rev.ref_message_ids);
1023 rev.numbered_files = numbered_files;
1024 rev.patch_suffix = fmt_patch_suffix;
1025 if (cover_letter) {
1026 if (thread)
1027 gen_message_id(&rev, "cover");
1028 make_cover_letter(&rev, use_stdout, numbered, numbered_files,
1029 origin, nr, list, head);
1030 total++;
1031 start_number--;
1033 rev.add_signoff = add_signoff;
1034 while (0 <= --nr) {
1035 int shown;
1036 commit = list[nr];
1037 rev.nr = total - nr + (start_number - 1);
1038 /* Make the second and subsequent mails replies to the first */
1039 if (thread) {
1040 /* Have we already had a message ID? */
1041 if (rev.message_id) {
1043 * For deep threading: make every mail
1044 * a reply to the previous one, no
1045 * matter what other options are set.
1047 * For shallow threading:
1049 * Without --cover-letter and
1050 * --in-reply-to, make every mail a
1051 * reply to the one before.
1053 * With --in-reply-to but no
1054 * --cover-letter, make every mail a
1055 * reply to the <reply-to>.
1057 * With --cover-letter, make every
1058 * mail but the cover letter a reply
1059 * to the cover letter. The cover
1060 * letter is a reply to the
1061 * --in-reply-to, if specified.
1063 if (thread == THREAD_SHALLOW
1064 && rev.ref_message_ids->nr > 0
1065 && (!cover_letter || rev.nr > 1))
1066 free(rev.message_id);
1067 else
1068 string_list_append(rev.message_id,
1069 rev.ref_message_ids);
1071 gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1074 if (!use_stdout && reopen_stdout(numbered_files ? NULL : commit,
1075 &rev))
1076 die("Failed to create output files");
1077 shown = log_tree_commit(&rev, commit);
1078 free(commit->buffer);
1079 commit->buffer = NULL;
1081 /* We put one extra blank line between formatted
1082 * patches and this flag is used by log-tree code
1083 * to see if it needs to emit a LF before showing
1084 * the log; when using one file per patch, we do
1085 * not want the extra blank line.
1087 if (!use_stdout)
1088 rev.shown_one = 0;
1089 if (shown) {
1090 if (rev.mime_boundary)
1091 printf("\n--%s%s--\n\n\n",
1092 mime_boundary_leader,
1093 rev.mime_boundary);
1094 else
1095 printf("-- \n%s\n\n", git_version_string);
1097 if (!use_stdout)
1098 fclose(stdout);
1100 free(list);
1101 if (ignore_if_in_upstream)
1102 free_patch_ids(&ids);
1103 return 0;
1106 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1108 unsigned char sha1[20];
1109 if (get_sha1(arg, sha1) == 0) {
1110 struct commit *commit = lookup_commit_reference(sha1);
1111 if (commit) {
1112 commit->object.flags |= flags;
1113 add_pending_object(revs, &commit->object, arg);
1114 return 0;
1117 return -1;
1120 static const char cherry_usage[] =
1121 "git cherry [-v] [<upstream> [<head> [<limit>]]]";
1122 int cmd_cherry(int argc, const char **argv, const char *prefix)
1124 struct rev_info revs;
1125 struct patch_ids ids;
1126 struct commit *commit;
1127 struct commit_list *list = NULL;
1128 struct branch *current_branch;
1129 const char *upstream;
1130 const char *head = "HEAD";
1131 const char *limit = NULL;
1132 int verbose = 0;
1134 if (argc > 1 && !strcmp(argv[1], "-v")) {
1135 verbose = 1;
1136 argc--;
1137 argv++;
1140 switch (argc) {
1141 case 4:
1142 limit = argv[3];
1143 /* FALLTHROUGH */
1144 case 3:
1145 head = argv[2];
1146 /* FALLTHROUGH */
1147 case 2:
1148 upstream = argv[1];
1149 break;
1150 default:
1151 current_branch = branch_get(NULL);
1152 if (!current_branch || !current_branch->merge
1153 || !current_branch->merge[0]
1154 || !current_branch->merge[0]->dst) {
1155 fprintf(stderr, "Could not find a tracked"
1156 " remote branch, please"
1157 " specify <upstream> manually.\n");
1158 usage(cherry_usage);
1161 upstream = current_branch->merge[0]->dst;
1164 init_revisions(&revs, prefix);
1165 revs.diff = 1;
1166 revs.combine_merges = 0;
1167 revs.ignore_merges = 1;
1168 DIFF_OPT_SET(&revs.diffopt, RECURSIVE);
1170 if (add_pending_commit(head, &revs, 0))
1171 die("Unknown commit %s", head);
1172 if (add_pending_commit(upstream, &revs, UNINTERESTING))
1173 die("Unknown commit %s", upstream);
1175 /* Don't say anything if head and upstream are the same. */
1176 if (revs.pending.nr == 2) {
1177 struct object_array_entry *o = revs.pending.objects;
1178 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1179 return 0;
1182 get_patch_ids(&revs, &ids, prefix);
1184 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1185 die("Unknown commit %s", limit);
1187 /* reverse the list of commits */
1188 if (prepare_revision_walk(&revs))
1189 die("revision walk setup failed");
1190 while ((commit = get_revision(&revs)) != NULL) {
1191 /* ignore merges */
1192 if (commit->parents && commit->parents->next)
1193 continue;
1195 commit_list_insert(commit, &list);
1198 while (list) {
1199 char sign = '+';
1201 commit = list->item;
1202 if (has_commit_patch_id(commit, &ids))
1203 sign = '-';
1205 if (verbose) {
1206 struct strbuf buf = STRBUF_INIT;
1207 pretty_print_commit(CMIT_FMT_ONELINE, commit,
1208 &buf, 0, NULL, NULL, 0, 0);
1209 printf("%c %s %s\n", sign,
1210 sha1_to_hex(commit->object.sha1), buf.buf);
1211 strbuf_release(&buf);
1213 else {
1214 printf("%c %s\n", sign,
1215 sha1_to_hex(commit->object.sha1));
1218 list = list->next;
1221 free_patch_ids(&ids);
1222 return 0;