?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
git-svn: document svn.authorsProg in config
[git/git-svn.git] / builtin / log.c
blob0b6f7392b9fac31fe08f3e8743b44d018f6d4740
1 /*
2 * Builtin "git log" and related commands (show, whatchanged)
3 *
4 * (C) Copyright 2006 Linus Torvalds
5 * 2006 Junio Hamano
6 */
7 #include "cache.h"
8 #include "refs.h"
9 #include "color.h"
10 #include "commit.h"
11 #include "diff.h"
12 #include "revision.h"
13 #include "log-tree.h"
14 #include "builtin.h"
15 #include "tag.h"
16 #include "reflog-walk.h"
17 #include "patch-ids.h"
18 #include "run-command.h"
19 #include "shortlog.h"
20 #include "remote.h"
21 #include "string-list.h"
22 #include "parse-options.h"
23 #include "line-log.h"
24 #include "branch.h"
25 #include "streaming.h"
26 #include "version.h"
27 #include "mailmap.h"
28 #include "gpg-interface.h"
29
30 /* Set a default date-time format for git log ("log.date" config variable) */
31 static const char *default_date_mode = NULL;
32
33 static int default_abbrev_commit;
34 static int default_show_root = 1;
35 static int default_follow;
36 static int default_show_signature;
37 static int decoration_style;
38 static int decoration_given;
39 static int use_mailmap_config;
40 static const char *fmt_patch_subject_prefix = "PATCH";
41 static const char *fmt_pretty;
42
43 static const char * const builtin_log_usage[] = {
44 N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
45 N_("git show [<options>] <object>..."),
46 NULL
47 };
48
49 struct line_opt_callback_data {
50 struct rev_info *rev;
51 const char *prefix;
52 struct string_list args;
53 };
54
55 static int parse_decoration_style(const char *var, const char *value)
56 {
57 switch (git_config_maybe_bool(var, value)) {
58 case 1:
59 return DECORATE_SHORT_REFS;
60 case 0:
61 return 0;
62 default:
63 break;
64 }
65 if (!strcmp(value, "full"))
66 return DECORATE_FULL_REFS;
67 else if (!strcmp(value, "short"))
68 return DECORATE_SHORT_REFS;
69 else if (!strcmp(value, "auto"))
70 return (isatty(1) || pager_in_use()) ? DECORATE_SHORT_REFS : 0;
71 return -1;
72 }
73
74 static int decorate_callback(const struct option *opt, const char *arg, int unset)
75 {
76 if (unset)
77 decoration_style = 0;
78 else if (arg)
79 decoration_style = parse_decoration_style("command line", arg);
80 else
81 decoration_style = DECORATE_SHORT_REFS;
82
83 if (decoration_style < 0)
84 die(_("invalid --decorate option: %s"), arg);
85
86 decoration_given = 1;
87
88 return 0;
89 }
90
91 static int log_line_range_callback(const struct option *option, const char *arg, int unset)
92 {
93 struct line_opt_callback_data *data = option->value;
94
95 if (!arg)
96 return -1;
97
98 data->rev->line_level_traverse = 1;
99 string_list_append(&data->args, arg);
100
101 return 0;
102 }
103
104 static void init_log_defaults(void)
105 {
106 init_grep_defaults();
107 init_diff_ui_defaults();
108 }
109
110 static void cmd_log_init_defaults(struct rev_info *rev)
111 {
112 if (fmt_pretty)
113 get_commit_format(fmt_pretty, rev);
114 if (default_follow)
115 DIFF_OPT_SET(&rev->diffopt, DEFAULT_FOLLOW_RENAMES);
116 rev->verbose_header = 1;
117 DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
118 rev->diffopt.stat_width = -1; /* use full terminal width */
119 rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
120 rev->abbrev_commit = default_abbrev_commit;
121 rev->show_root_diff = default_show_root;
122 rev->subject_prefix = fmt_patch_subject_prefix;
123 rev->show_signature = default_show_signature;
124 DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
125
126 if (default_date_mode)
127 parse_date_format(default_date_mode, &rev->date_mode);
128 rev->diffopt.touched_flags = 0;
129 }
130
131 static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
132 struct rev_info *rev, struct setup_revision_opt *opt)
133 {
134 struct userformat_want w;
135 int quiet = 0, source = 0, mailmap = 0;
136 static struct line_opt_callback_data line_cb = {NULL, NULL, STRING_LIST_INIT_DUP};
137
138 const struct option builtin_log_options[] = {
139 OPT__QUIET(&quiet, N_("suppress diff output")),
140 OPT_BOOL(0, "source", &source, N_("show source")),
141 OPT_BOOL(0, "use-mailmap", &mailmap, N_("Use mail map file")),
142 { OPTION_CALLBACK, 0, "decorate", NULL, NULL, N_("decorate options"),
143 PARSE_OPT_OPTARG, decorate_callback},
144 OPT_CALLBACK('L', NULL, &line_cb, "n,m:file",
145 N_("Process line range n,m in file, counting from 1"),
146 log_line_range_callback),
147 OPT_END()
148 };
149
150 line_cb.rev = rev;
151 line_cb.prefix = prefix;
152
153 mailmap = use_mailmap_config;
154 argc = parse_options(argc, argv, prefix,
155 builtin_log_options, builtin_log_usage,
156 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
157 PARSE_OPT_KEEP_DASHDASH);
158
159 if (quiet)
160 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
161 argc = setup_revisions(argc, argv, rev, opt);
162
163 /* Any arguments at this point are not recognized */
164 if (argc > 1)
165 die(_("unrecognized argument: %s"), argv[1]);
166
167 memset(&w, 0, sizeof(w));
168 userformat_find_requirements(NULL, &w);
169
170 if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
171 rev->show_notes = 1;
172 if (rev->show_notes)
173 init_display_notes(&rev->notes_opt);
174
175 if (rev->diffopt.pickaxe || rev->diffopt.filter ||
176 DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES))
177 rev->always_show_header = 0;
178
179 if (source)
180 rev->show_source = 1;
181
182 if (mailmap) {
183 rev->mailmap = xcalloc(1, sizeof(struct string_list));
184 read_mailmap(rev->mailmap, NULL);
185 }
186
187 if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
188 /*
189 * "log --pretty=raw" is special; ignore UI oriented
190 * configuration variables such as decoration.
191 */
192 if (!decoration_given)
193 decoration_style = 0;
194 if (!rev->abbrev_commit_given)
195 rev->abbrev_commit = 0;
196 }
197
198 if (decoration_style) {
199 rev->show_decorations = 1;
200 load_ref_decorations(decoration_style);
201 }
202
203 if (rev->line_level_traverse)
204 line_log_init(rev, line_cb.prefix, &line_cb.args);
205
206 setup_pager();
207 }
208
209 static void cmd_log_init(int argc, const char **argv, const char *prefix,
210 struct rev_info *rev, struct setup_revision_opt *opt)
211 {
212 cmd_log_init_defaults(rev);
213 cmd_log_init_finish(argc, argv, prefix, rev, opt);
214 }
215
216 /*
217 * This gives a rough estimate for how many commits we
218 * will print out in the list.
219 */
220 static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
221 {
222 int n = 0;
223
224 while (list) {
225 struct commit *commit = list->item;
226 unsigned int flags = commit->object.flags;
227 list = list->next;
228 if (!(flags & (TREESAME | UNINTERESTING)))
229 n++;
230 }
231 return n;
232 }
233
234 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
235 {
236 if (rev->shown_one) {
237 rev->shown_one = 0;
238 if (rev->commit_format != CMIT_FMT_ONELINE)
239 putchar(rev->diffopt.line_termination);
240 }
241 printf(_("Final output: %d %s\n"), nr, stage);
242 }
243
244 static struct itimerval early_output_timer;
245
246 static void log_show_early(struct rev_info *revs, struct commit_list *list)
247 {
248 int i = revs->early_output;
249 int show_header = 1;
250
251 sort_in_topological_order(&list, revs->sort_order);
252 while (list && i) {
253 struct commit *commit = list->item;
254 switch (simplify_commit(revs, commit)) {
255 case commit_show:
256 if (show_header) {
257 int n = estimate_commit_count(revs, list);
258 show_early_header(revs, "incomplete", n);
259 show_header = 0;
260 }
261 log_tree_commit(revs, commit);
262 i--;
263 break;
264 case commit_ignore:
265 break;
266 case commit_error:
267 return;
268 }
269 list = list->next;
270 }
271
272 /* Did we already get enough commits for the early output? */
273 if (!i)
274 return;
275
276 /*
277 * ..if no, then repeat it twice a second until we
278 * do.
279 *
280 * NOTE! We don't use "it_interval", because if the
281 * reader isn't listening, we want our output to be
282 * throttled by the writing, and not have the timer
283 * trigger every second even if we're blocked on a
284 * reader!
285 */
286 early_output_timer.it_value.tv_sec = 0;
287 early_output_timer.it_value.tv_usec = 500000;
288 setitimer(ITIMER_REAL, &early_output_timer, NULL);
289 }
290
291 static void early_output(int signal)
292 {
293 show_early_output = log_show_early;
294 }
295
296 static void setup_early_output(struct rev_info *rev)
297 {
298 struct sigaction sa;
299
300 /*
301 * Set up the signal handler, minimally intrusively:
302 * we only set a single volatile integer word (not
303 * using sigatomic_t - trying to avoid unnecessary
304 * system dependencies and headers), and using
305 * SA_RESTART.
306 */
307 memset(&sa, 0, sizeof(sa));
308 sa.sa_handler = early_output;
309 sigemptyset(&sa.sa_mask);
310 sa.sa_flags = SA_RESTART;
311 sigaction(SIGALRM, &sa, NULL);
312
313 /*
314 * If we can get the whole output in less than a
315 * tenth of a second, don't even bother doing the
316 * early-output thing..
317 *
318 * This is a one-time-only trigger.
319 */
320 early_output_timer.it_value.tv_sec = 0;
321 early_output_timer.it_value.tv_usec = 100000;
322 setitimer(ITIMER_REAL, &early_output_timer, NULL);
323 }
324
325 static void finish_early_output(struct rev_info *rev)
326 {
327 int n = estimate_commit_count(rev, rev->commits);
328 signal(SIGALRM, SIG_IGN);
329 show_early_header(rev, "done", n);
330 }
331
332 static int cmd_log_walk(struct rev_info *rev)
333 {
334 struct commit *commit;
335 int saved_nrl = 0;
336 int saved_dcctc = 0;
337
338 if (rev->early_output)
339 setup_early_output(rev);
340
341 if (prepare_revision_walk(rev))
342 die(_("revision walk setup failed"));
343
344 if (rev->early_output)
345 finish_early_output(rev);
346
347 /*
348 * For --check and --exit-code, the exit code is based on CHECK_FAILED
349 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
350 * retain that state information if replacing rev->diffopt in this loop
351 */
352 while ((commit = get_revision(rev)) != NULL) {
353 if (!log_tree_commit(rev, commit) && rev->max_count >= 0)
354 /*
355 * We decremented max_count in get_revision,
356 * but we didn't actually show the commit.
357 */
358 rev->max_count++;
359 if (!rev->reflog_info) {
360 /* we allow cycles in reflog ancestry */
361 free_commit_buffer(commit);
362 }
363 free_commit_list(commit->parents);
364 commit->parents = NULL;
365 if (saved_nrl < rev->diffopt.needed_rename_limit)
366 saved_nrl = rev->diffopt.needed_rename_limit;
367 if (rev->diffopt.degraded_cc_to_c)
368 saved_dcctc = 1;
369 }
370 rev->diffopt.degraded_cc_to_c = saved_dcctc;
371 rev->diffopt.needed_rename_limit = saved_nrl;
372
373 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
374 DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
375 return 02;
376 }
377 return diff_result_code(&rev->diffopt, 0);
378 }
379
380 static int git_log_config(const char *var, const char *value, void *cb)
381 {
382 const char *slot_name;
383
384 if (!strcmp(var, "format.pretty"))
385 return git_config_string(&fmt_pretty, var, value);
386 if (!strcmp(var, "format.subjectprefix"))
387 return git_config_string(&fmt_patch_subject_prefix, var, value);
388 if (!strcmp(var, "log.abbrevcommit")) {
389 default_abbrev_commit = git_config_bool(var, value);
390 return 0;
391 }
392 if (!strcmp(var, "log.date"))
393 return git_config_string(&default_date_mode, var, value);
394 if (!strcmp(var, "log.decorate")) {
395 decoration_style = parse_decoration_style(var, value);
396 if (decoration_style < 0)
397 decoration_style = 0; /* maybe warn? */
398 return 0;
399 }
400 if (!strcmp(var, "log.showroot")) {
401 default_show_root = git_config_bool(var, value);
402 return 0;
403 }
404 if (!strcmp(var, "log.follow")) {
405 default_follow = git_config_bool(var, value);
406 return 0;
407 }
408 if (skip_prefix(var, "color.decorate.", &slot_name))
409 return parse_decorate_color_config(var, slot_name, value);
410 if (!strcmp(var, "log.mailmap")) {
411 use_mailmap_config = git_config_bool(var, value);
412 return 0;
413 }
414 if (!strcmp(var, "log.showsignature")) {
415 default_show_signature = git_config_bool(var, value);
416 return 0;
417 }
418
419 if (grep_config(var, value, cb) < 0)
420 return -1;
421 if (git_gpg_config(var, value, cb) < 0)
422 return -1;
423 return git_diff_ui_config(var, value, cb);
424 }
425
426 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
427 {
428 struct rev_info rev;
429 struct setup_revision_opt opt;
430
431 init_log_defaults();
432 git_config(git_log_config, NULL);
433
434 init_revisions(&rev, prefix);
435 rev.diff = 1;
436 rev.simplify_history = 0;
437 memset(&opt, 0, sizeof(opt));
438 opt.def = "HEAD";
439 opt.revarg_opt = REVARG_COMMITTISH;
440 cmd_log_init(argc, argv, prefix, &rev, &opt);
441 if (!rev.diffopt.output_format)
442 rev.diffopt.output_format = DIFF_FORMAT_RAW;
443 return cmd_log_walk(&rev);
444 }
445
446 static void show_tagger(char *buf, int len, struct rev_info *rev)
447 {
448 struct strbuf out = STRBUF_INIT;
449 struct pretty_print_context pp = {0};
450
451 pp.fmt = rev->commit_format;
452 pp.date_mode = rev->date_mode;
453 pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
454 printf("%s", out.buf);
455 strbuf_release(&out);
456 }
457
458 static int show_blob_object(const unsigned char *sha1, struct rev_info *rev, const char *obj_name)
459 {
460 unsigned char sha1c[20];
461 struct object_context obj_context;
462 char *buf;
463 unsigned long size;
464
465 fflush(stdout);
466 if (!DIFF_OPT_TOUCHED(&rev->diffopt, ALLOW_TEXTCONV) ||
467 !DIFF_OPT_TST(&rev->diffopt, ALLOW_TEXTCONV))
468 return stream_blob_to_fd(1, sha1, NULL, 0);
469
470 if (get_sha1_with_context(obj_name, 0, sha1c, &obj_context))
471 die(_("Not a valid object name %s"), obj_name);
472 if (!obj_context.path[0] ||
473 !textconv_object(obj_context.path, obj_context.mode, sha1c, 1, &buf, &size))
474 return stream_blob_to_fd(1, sha1, NULL, 0);
475
476 if (!buf)
477 die(_("git show %s: bad file"), obj_name);
478
479 write_or_die(1, buf, size);
480 return 0;
481 }
482
483 static int show_tag_object(const unsigned char *sha1, struct rev_info *rev)
484 {
485 unsigned long size;
486 enum object_type type;
487 char *buf = read_sha1_file(sha1, &type, &size);
488 int offset = 0;
489
490 if (!buf)
491 return error(_("Could not read object %s"), sha1_to_hex(sha1));
492
493 assert(type == OBJ_TAG);
494 while (offset < size && buf[offset] != '\n') {
495 int new_offset = offset + 1;
496 while (new_offset < size && buf[new_offset++] != '\n')
497 ; /* do nothing */
498 if (starts_with(buf + offset, "tagger "))
499 show_tagger(buf + offset + 7,
500 new_offset - offset - 7, rev);
501 offset = new_offset;
502 }
503
504 if (offset < size)
505 fwrite(buf + offset, size - offset, 1, stdout);
506 free(buf);
507 return 0;
508 }
509
510 static int show_tree_object(const unsigned char *sha1,
511 struct strbuf *base,
512 const char *pathname, unsigned mode, int stage, void *context)
513 {
514 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
515 return 0;
516 }
517
518 static void show_setup_revisions_tweak(struct rev_info *rev,
519 struct setup_revision_opt *opt)
520 {
521 if (rev->ignore_merges) {
522 /* There was no "-m" on the command line */
523 rev->ignore_merges = 0;
524 if (!rev->first_parent_only && !rev->combine_merges) {
525 /* No "--first-parent", "-c", or "--cc" */
526 rev->combine_merges = 1;
527 rev->dense_combined_merges = 1;
528 }
529 }
530 if (!rev->diffopt.output_format)
531 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
532 }
533
534 int cmd_show(int argc, const char **argv, const char *prefix)
535 {
536 struct rev_info rev;
537 struct object_array_entry *objects;
538 struct setup_revision_opt opt;
539 struct pathspec match_all;
540 int i, count, ret = 0;
541
542 init_log_defaults();
543 git_config(git_log_config, NULL);
544
545 memset(&match_all, 0, sizeof(match_all));
546 init_revisions(&rev, prefix);
547 rev.diff = 1;
548 rev.always_show_header = 1;
549 rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
550 rev.diffopt.stat_width = -1; /* Scale to real terminal size */
551
552 memset(&opt, 0, sizeof(opt));
553 opt.def = "HEAD";
554 opt.tweak = show_setup_revisions_tweak;
555 cmd_log_init(argc, argv, prefix, &rev, &opt);
556
557 if (!rev.no_walk)
558 return cmd_log_walk(&rev);
559
560 count = rev.pending.nr;
561 objects = rev.pending.objects;
562 for (i = 0; i < count && !ret; i++) {
563 struct object *o = objects[i].item;
564 const char *name = objects[i].name;
565 switch (o->type) {
566 case OBJ_BLOB:
567 ret = show_blob_object(o->oid.hash, &rev, name);
568 break;
569 case OBJ_TAG: {
570 struct tag *t = (struct tag *)o;
571
572 if (rev.shown_one)
573 putchar('\n');
574 printf("%stag %s%s\n",
575 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
576 t->tag,
577 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
578 ret = show_tag_object(o->oid.hash, &rev);
579 rev.shown_one = 1;
580 if (ret)
581 break;
582 o = parse_object(t->tagged->oid.hash);
583 if (!o)
584 ret = error(_("Could not read object %s"),
585 oid_to_hex(&t->tagged->oid));
586 objects[i].item = o;
587 i--;
588 break;
589 }
590 case OBJ_TREE:
591 if (rev.shown_one)
592 putchar('\n');
593 printf("%stree %s%s\n\n",
594 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
595 name,
596 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
597 read_tree_recursive((struct tree *)o, "", 0, 0, &match_all,
598 show_tree_object, NULL);
599 rev.shown_one = 1;
600 break;
601 case OBJ_COMMIT:
602 rev.pending.nr = rev.pending.alloc = 0;
603 rev.pending.objects = NULL;
604 add_object_array(o, name, &rev.pending);
605 ret = cmd_log_walk(&rev);
606 break;
607 default:
608 ret = error(_("Unknown type: %d"), o->type);
609 }
610 }
611 free(objects);
612 return ret;
613 }
614
615 /*
616 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
617 */
618 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
619 {
620 struct rev_info rev;
621 struct setup_revision_opt opt;
622
623 init_log_defaults();
624 git_config(git_log_config, NULL);
625
626 init_revisions(&rev, prefix);
627 init_reflog_walk(&rev.reflog_info);
628 rev.verbose_header = 1;
629 memset(&opt, 0, sizeof(opt));
630 opt.def = "HEAD";
631 cmd_log_init_defaults(&rev);
632 rev.abbrev_commit = 1;
633 rev.commit_format = CMIT_FMT_ONELINE;
634 rev.use_terminator = 1;
635 rev.always_show_header = 1;
636 cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
637
638 return cmd_log_walk(&rev);
639 }
640
641 static void log_setup_revisions_tweak(struct rev_info *rev,
642 struct setup_revision_opt *opt)
643 {
644 if (DIFF_OPT_TST(&rev->diffopt, DEFAULT_FOLLOW_RENAMES) &&
645 rev->prune_data.nr == 1)
646 DIFF_OPT_SET(&rev->diffopt, FOLLOW_RENAMES);
647
648 /* Turn --cc/-c into -p --cc/-c when -p was not given */
649 if (!rev->diffopt.output_format && rev->combine_merges)
650 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
651
652 /* Turn -m on when --cc/-c was given */
653 if (rev->combine_merges)
654 rev->ignore_merges = 0;
655 }
656
657 int cmd_log(int argc, const char **argv, const char *prefix)
658 {
659 struct rev_info rev;
660 struct setup_revision_opt opt;
661
662 init_log_defaults();
663 git_config(git_log_config, NULL);
664
665 init_revisions(&rev, prefix);
666 rev.always_show_header = 1;
667 memset(&opt, 0, sizeof(opt));
668 opt.def = "HEAD";
669 opt.revarg_opt = REVARG_COMMITTISH;
670 opt.tweak = log_setup_revisions_tweak;
671 cmd_log_init(argc, argv, prefix, &rev, &opt);
672 return cmd_log_walk(&rev);
673 }
674
675 /* format-patch */
676
677 static const char *fmt_patch_suffix = ".patch";
678 static int numbered = 0;
679 static int auto_number = 1;
680
681 static char *default_attach = NULL;
682
683 static struct string_list extra_hdr = STRING_LIST_INIT_NODUP;
684 static struct string_list extra_to = STRING_LIST_INIT_NODUP;
685 static struct string_list extra_cc = STRING_LIST_INIT_NODUP;
686
687 static void add_header(const char *value)
688 {
689 struct string_list_item *item;
690 int len = strlen(value);
691 while (len && value[len - 1] == '\n')
692 len--;
693
694 if (!strncasecmp(value, "to: ", 4)) {
695 item = string_list_append(&extra_to, value + 4);
696 len -= 4;
697 } else if (!strncasecmp(value, "cc: ", 4)) {
698 item = string_list_append(&extra_cc, value + 4);
699 len -= 4;
700 } else {
701 item = string_list_append(&extra_hdr, value);
702 }
703
704 item->string[len] = '\0';
705 }
706
707 #define THREAD_SHALLOW 1
708 #define THREAD_DEEP 2
709 static int thread;
710 static int do_signoff;
711 static int base_auto;
712 static const char *signature = git_version_string;
713 static const char *signature_file;
714 static int config_cover_letter;
715 static const char *config_output_directory;
716
717 enum {
718 COVER_UNSET,
719 COVER_OFF,
720 COVER_ON,
721 COVER_AUTO
722 };
723
724 static int git_format_config(const char *var, const char *value, void *cb)
725 {
726 if (!strcmp(var, "format.headers")) {
727 if (!value)
728 die(_("format.headers without value"));
729 add_header(value);
730 return 0;
731 }
732 if (!strcmp(var, "format.suffix"))
733 return git_config_string(&fmt_patch_suffix, var, value);
734 if (!strcmp(var, "format.to")) {
735 if (!value)
736 return config_error_nonbool(var);
737 string_list_append(&extra_to, value);
738 return 0;
739 }
740 if (!strcmp(var, "format.cc")) {
741 if (!value)
742 return config_error_nonbool(var);
743 string_list_append(&extra_cc, value);
744 return 0;
745 }
746 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
747 !strcmp(var, "color.ui") || !strcmp(var, "diff.submodule")) {
748 return 0;
749 }
750 if (!strcmp(var, "format.numbered")) {
751 if (value && !strcasecmp(value, "auto")) {
752 auto_number = 1;
753 return 0;
754 }
755 numbered = git_config_bool(var, value);
756 auto_number = auto_number && numbered;
757 return 0;
758 }
759 if (!strcmp(var, "format.attach")) {
760 if (value && *value)
761 default_attach = xstrdup(value);
762 else
763 default_attach = xstrdup(git_version_string);
764 return 0;
765 }
766 if (!strcmp(var, "format.thread")) {
767 if (value && !strcasecmp(value, "deep")) {
768 thread = THREAD_DEEP;
769 return 0;
770 }
771 if (value && !strcasecmp(value, "shallow")) {
772 thread = THREAD_SHALLOW;
773 return 0;
774 }
775 thread = git_config_bool(var, value) && THREAD_SHALLOW;
776 return 0;
777 }
778 if (!strcmp(var, "format.signoff")) {
779 do_signoff = git_config_bool(var, value);
780 return 0;
781 }
782 if (!strcmp(var, "format.signature"))
783 return git_config_string(&signature, var, value);
784 if (!strcmp(var, "format.signaturefile"))
785 return git_config_pathname(&signature_file, var, value);
786 if (!strcmp(var, "format.coverletter")) {
787 if (value && !strcasecmp(value, "auto")) {
788 config_cover_letter = COVER_AUTO;
789 return 0;
790 }
791 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
792 return 0;
793 }
794 if (!strcmp(var, "format.outputdirectory"))
795 return git_config_string(&config_output_directory, var, value);
796 if (!strcmp(var, "format.useautobase")) {
797 base_auto = git_config_bool(var, value);
798 return 0;
799 }
800
801 return git_log_config(var, value, cb);
802 }
803
804 static FILE *realstdout = NULL;
805 static const char *output_directory = NULL;
806 static int outdir_offset;
807
808 static int reopen_stdout(struct commit *commit, const char *subject,
809 struct rev_info *rev, int quiet)
810 {
811 struct strbuf filename = STRBUF_INIT;
812 int suffix_len = strlen(rev->patch_suffix) + 1;
813
814 if (output_directory) {
815 strbuf_addstr(&filename, output_directory);
816 if (filename.len >=
817 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
818 return error(_("name of output directory is too long"));
819 strbuf_complete(&filename, '/');
820 }
821
822 if (rev->numbered_files)
823 strbuf_addf(&filename, "%d", rev->nr);
824 else if (commit)
825 fmt_output_commit(&filename, commit, rev);
826 else
827 fmt_output_subject(&filename, subject, rev);
828
829 if (!quiet)
830 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
831
832 if (freopen(filename.buf, "w", stdout) == NULL)
833 return error(_("Cannot open patch file %s"), filename.buf);
834
835 strbuf_release(&filename);
836 return 0;
837 }
838
839 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
840 {
841 struct rev_info check_rev;
842 struct commit *commit, *c1, *c2;
843 struct object *o1, *o2;
844 unsigned flags1, flags2;
845
846 if (rev->pending.nr != 2)
847 die(_("Need exactly one range."));
848
849 o1 = rev->pending.objects[0].item;
850 o2 = rev->pending.objects[1].item;
851 flags1 = o1->flags;
852 flags2 = o2->flags;
853 c1 = lookup_commit_reference(o1->oid.hash);
854 c2 = lookup_commit_reference(o2->oid.hash);
855
856 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
857 die(_("Not a range."));
858
859 init_patch_ids(ids);
860
861 /* given a range a..b get all patch ids for b..a */
862 init_revisions(&check_rev, rev->prefix);
863 check_rev.max_parents = 1;
864 o1->flags ^= UNINTERESTING;
865 o2->flags ^= UNINTERESTING;
866 add_pending_object(&check_rev, o1, "o1");
867 add_pending_object(&check_rev, o2, "o2");
868 if (prepare_revision_walk(&check_rev))
869 die(_("revision walk setup failed"));
870
871 while ((commit = get_revision(&check_rev)) != NULL) {
872 add_commit_patch_id(commit, ids);
873 }
874
875 /* reset for next revision walk */
876 clear_commit_marks(c1, SEEN | UNINTERESTING | SHOWN | ADDED);
877 clear_commit_marks(c2, SEEN | UNINTERESTING | SHOWN | ADDED);
878 o1->flags = flags1;
879 o2->flags = flags2;
880 }
881
882 static void gen_message_id(struct rev_info *info, char *base)
883 {
884 struct strbuf buf = STRBUF_INIT;
885 strbuf_addf(&buf, "%s.%lu.git.%s", base,
886 (unsigned long) time(NULL),
887 git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
888 info->message_id = strbuf_detach(&buf, NULL);
889 }
890
891 static void print_signature(void)
892 {
893 if (!signature || !*signature)
894 return;
895
896 printf("-- \n%s", signature);
897 if (signature[strlen(signature)-1] != '\n')
898 putchar('\n');
899 putchar('\n');
900 }
901
902 static void add_branch_description(struct strbuf *buf, const char *branch_name)
903 {
904 struct strbuf desc = STRBUF_INIT;
905 if (!branch_name || !*branch_name)
906 return;
907 read_branch_desc(&desc, branch_name);
908 if (desc.len) {
909 strbuf_addch(buf, '\n');
910 strbuf_addbuf(buf, &desc);
911 strbuf_addch(buf, '\n');
912 }
913 strbuf_release(&desc);
914 }
915
916 static char *find_branch_name(struct rev_info *rev)
917 {
918 int i, positive = -1;
919 struct object_id branch_oid;
920 const struct object_id *tip_oid;
921 const char *ref, *v;
922 char *full_ref, *branch = NULL;
923
924 for (i = 0; i < rev->cmdline.nr; i++) {
925 if (rev->cmdline.rev[i].flags & UNINTERESTING)
926 continue;
927 if (positive < 0)
928 positive = i;
929 else
930 return NULL;
931 }
932 if (positive < 0)
933 return NULL;
934 ref = rev->cmdline.rev[positive].name;
935 tip_oid = &rev->cmdline.rev[positive].item->oid;
936 if (dwim_ref(ref, strlen(ref), branch_oid.hash, &full_ref) &&
937 skip_prefix(full_ref, "refs/heads/", &v) &&
938 !oidcmp(tip_oid, &branch_oid))
939 branch = xstrdup(v);
940 free(full_ref);
941 return branch;
942 }
943
944 static void make_cover_letter(struct rev_info *rev, int use_stdout,
945 struct commit *origin,
946 int nr, struct commit **list,
947 const char *branch_name,
948 int quiet)
949 {
950 const char *committer;
951 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
952 const char *msg;
953 struct shortlog log;
954 struct strbuf sb = STRBUF_INIT;
955 int i;
956 const char *encoding = "UTF-8";
957 struct diff_options opts;
958 int need_8bit_cte = 0;
959 struct pretty_print_context pp = {0};
960 struct commit *head = list[0];
961
962 if (!cmit_fmt_is_mail(rev->commit_format))
963 die(_("Cover letter needs email format"));
964
965 committer = git_committer_info(0);
966
967 if (!use_stdout &&
968 reopen_stdout(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
969 return;
970
971 log_write_email_headers(rev, head, &pp.subject, &pp.after_subject,
972 &need_8bit_cte);
973
974 for (i = 0; !need_8bit_cte && i < nr; i++) {
975 const char *buf = get_commit_buffer(list[i], NULL);
976 if (has_non_ascii(buf))
977 need_8bit_cte = 1;
978 unuse_commit_buffer(list[i], buf);
979 }
980
981 if (!branch_name)
982 branch_name = find_branch_name(rev);
983
984 msg = body;
985 pp.fmt = CMIT_FMT_EMAIL;
986 pp.date_mode.type = DATE_RFC2822;
987 pp_user_info(&pp, NULL, &sb, committer, encoding);
988 pp_title_line(&pp, &msg, &sb, encoding, need_8bit_cte);
989 pp_remainder(&pp, &msg, &sb, 0);
990 add_branch_description(&sb, branch_name);
991 printf("%s\n", sb.buf);
992
993 strbuf_release(&sb);
994
995 shortlog_init(&log);
996 log.wrap_lines = 1;
997 log.wrap = 72;
998 log.in1 = 2;
999 log.in2 = 4;
1000 for (i = 0; i < nr; i++)
1001 shortlog_add_commit(&log, list[i]);
1002
1003 shortlog_output(&log);
1004
1005 /*
1006 * We can only do diffstat with a unique reference point
1007 */
1008 if (!origin)
1009 return;
1010
1011 memcpy(&opts, &rev->diffopt, sizeof(opts));
1012 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1013
1014 diff_setup_done(&opts);
1015
1016 diff_tree_sha1(origin->tree->object.oid.hash,
1017 head->tree->object.oid.hash,
1018 "", &opts);
1019 diffcore_std(&opts);
1020 diff_flush(&opts);
1021
1022 printf("\n");
1023 print_signature();
1024 }
1025
1026 static const char *clean_message_id(const char *msg_id)
1027 {
1028 char ch;
1029 const char *a, *z, *m;
1030
1031 m = msg_id;
1032 while ((ch = *m) && (isspace(ch) || (ch == '<')))
1033 m++;
1034 a = m;
1035 z = NULL;
1036 while ((ch = *m)) {
1037 if (!isspace(ch) && (ch != '>'))
1038 z = m;
1039 m++;
1040 }
1041 if (!z)
1042 die(_("insane in-reply-to: %s"), msg_id);
1043 if (++z == m)
1044 return a;
1045 return xmemdupz(a, z - a);
1046 }
1047
1048 static const char *set_outdir(const char *prefix, const char *output_directory)
1049 {
1050 if (output_directory && is_absolute_path(output_directory))
1051 return output_directory;
1052
1053 if (!prefix || !*prefix) {
1054 if (output_directory)
1055 return output_directory;
1056 /* The user did not explicitly ask for "./" */
1057 outdir_offset = 2;
1058 return "./";
1059 }
1060
1061 outdir_offset = strlen(prefix);
1062 if (!output_directory)
1063 return prefix;
1064
1065 return xstrdup(prefix_filename(prefix, outdir_offset,
1066 output_directory));
1067 }
1068
1069 static const char * const builtin_format_patch_usage[] = {
1070 N_("git format-patch [<options>] [<since> | <revision-range>]"),
1071 NULL
1072 };
1073
1074 static int keep_subject = 0;
1075
1076 static int keep_callback(const struct option *opt, const char *arg, int unset)
1077 {
1078 ((struct rev_info *)opt->value)->total = -1;
1079 keep_subject = 1;
1080 return 0;
1081 }
1082
1083 static int subject_prefix = 0;
1084
1085 static int subject_prefix_callback(const struct option *opt, const char *arg,
1086 int unset)
1087 {
1088 subject_prefix = 1;
1089 ((struct rev_info *)opt->value)->subject_prefix = arg;
1090 return 0;
1091 }
1092
1093 static int numbered_cmdline_opt = 0;
1094
1095 static int numbered_callback(const struct option *opt, const char *arg,
1096 int unset)
1097 {
1098 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
1099 if (unset)
1100 auto_number = 0;
1101 return 0;
1102 }
1103
1104 static int no_numbered_callback(const struct option *opt, const char *arg,
1105 int unset)
1106 {
1107 return numbered_callback(opt, arg, 1);
1108 }
1109
1110 static int output_directory_callback(const struct option *opt, const char *arg,
1111 int unset)
1112 {
1113 const char **dir = (const char **)opt->value;
1114 if (*dir)
1115 die(_("Two output directories?"));
1116 *dir = arg;
1117 return 0;
1118 }
1119
1120 static int thread_callback(const struct option *opt, const char *arg, int unset)
1121 {
1122 int *thread = (int *)opt->value;
1123 if (unset)
1124 *thread = 0;
1125 else if (!arg || !strcmp(arg, "shallow"))
1126 *thread = THREAD_SHALLOW;
1127 else if (!strcmp(arg, "deep"))
1128 *thread = THREAD_DEEP;
1129 else
1130 return 1;
1131 return 0;
1132 }
1133
1134 static int attach_callback(const struct option *opt, const char *arg, int unset)
1135 {
1136 struct rev_info *rev = (struct rev_info *)opt->value;
1137 if (unset)
1138 rev->mime_boundary = NULL;
1139 else if (arg)
1140 rev->mime_boundary = arg;
1141 else
1142 rev->mime_boundary = git_version_string;
1143 rev->no_inline = unset ? 0 : 1;
1144 return 0;
1145 }
1146
1147 static int inline_callback(const struct option *opt, const char *arg, int unset)
1148 {
1149 struct rev_info *rev = (struct rev_info *)opt->value;
1150 if (unset)
1151 rev->mime_boundary = NULL;
1152 else if (arg)
1153 rev->mime_boundary = arg;
1154 else
1155 rev->mime_boundary = git_version_string;
1156 rev->no_inline = 0;
1157 return 0;
1158 }
1159
1160 static int header_callback(const struct option *opt, const char *arg, int unset)
1161 {
1162 if (unset) {
1163 string_list_clear(&extra_hdr, 0);
1164 string_list_clear(&extra_to, 0);
1165 string_list_clear(&extra_cc, 0);
1166 } else {
1167 add_header(arg);
1168 }
1169 return 0;
1170 }
1171
1172 static int to_callback(const struct option *opt, const char *arg, int unset)
1173 {
1174 if (unset)
1175 string_list_clear(&extra_to, 0);
1176 else
1177 string_list_append(&extra_to, arg);
1178 return 0;
1179 }
1180
1181 static int cc_callback(const struct option *opt, const char *arg, int unset)
1182 {
1183 if (unset)
1184 string_list_clear(&extra_cc, 0);
1185 else
1186 string_list_append(&extra_cc, arg);
1187 return 0;
1188 }
1189
1190 static int from_callback(const struct option *opt, const char *arg, int unset)
1191 {
1192 char **from = opt->value;
1193
1194 free(*from);
1195
1196 if (unset)
1197 *from = NULL;
1198 else if (arg)
1199 *from = xstrdup(arg);
1200 else
1201 *from = xstrdup(git_committer_info(IDENT_NO_DATE));
1202 return 0;
1203 }
1204
1205 struct base_tree_info {
1206 struct object_id base_commit;
1207 int nr_patch_id, alloc_patch_id;
1208 struct object_id *patch_id;
1209 };
1210
1211 static struct commit *get_base_commit(const char *base_commit,
1212 struct commit **list,
1213 int total)
1214 {
1215 struct commit *base = NULL;
1216 struct commit **rev;
1217 int i = 0, rev_nr = 0;
1218
1219 if (base_commit && strcmp(base_commit, "auto")) {
1220 base = lookup_commit_reference_by_name(base_commit);
1221 if (!base)
1222 die(_("Unknown commit %s"), base_commit);
1223 } else if ((base_commit && !strcmp(base_commit, "auto")) || base_auto) {
1224 struct branch *curr_branch = branch_get(NULL);
1225 const char *upstream = branch_get_upstream(curr_branch, NULL);
1226 if (upstream) {
1227 struct commit_list *base_list;
1228 struct commit *commit;
1229 unsigned char sha1[20];
1230
1231 if (get_sha1(upstream, sha1))
1232 die(_("Failed to resolve '%s' as a valid ref."), upstream);
1233 commit = lookup_commit_or_die(sha1, "upstream base");
1234 base_list = get_merge_bases_many(commit, total, list);
1235 /* There should be one and only one merge base. */
1236 if (!base_list || base_list->next)
1237 die(_("Could not find exact merge base."));
1238 base = base_list->item;
1239 free_commit_list(base_list);
1240 } else {
1241 die(_("Failed to get upstream, if you want to record base commit automatically,\n"
1242 "please use git branch --set-upstream-to to track a remote branch.\n"
1243 "Or you could specify base commit by --base=<base-commit-id> manually."));
1244 }
1245 }
1246
1247 ALLOC_ARRAY(rev, total);
1248 for (i = 0; i < total; i++)
1249 rev[i] = list[i];
1250
1251 rev_nr = total;
1252 /*
1253 * Get merge base through pair-wise computations
1254 * and store it in rev[0].
1255 */
1256 while (rev_nr > 1) {
1257 for (i = 0; i < rev_nr / 2; i++) {
1258 struct commit_list *merge_base;
1259 merge_base = get_merge_bases(rev[2 * i], rev[2 * i + 1]);
1260 if (!merge_base || merge_base->next)
1261 die(_("Failed to find exact merge base"));
1262
1263 rev[i] = merge_base->item;
1264 }
1265
1266 if (rev_nr % 2)
1267 rev[i] = rev[2 * i];
1268 rev_nr = (rev_nr + 1) / 2;
1269 }
1270
1271 if (!in_merge_bases(base, rev[0]))
1272 die(_("base commit should be the ancestor of revision list"));
1273
1274 for (i = 0; i < total; i++) {
1275 if (base == list[i])
1276 die(_("base commit shouldn't be in revision list"));
1277 }
1278
1279 free(rev);
1280 return base;
1281 }
1282
1283 static void prepare_bases(struct base_tree_info *bases,
1284 struct commit *base,
1285 struct commit **list,
1286 int total)
1287 {
1288 struct commit *commit;
1289 struct rev_info revs;
1290 struct diff_options diffopt;
1291 int i;
1292
1293 if (!base)
1294 return;
1295
1296 diff_setup(&diffopt);
1297 DIFF_OPT_SET(&diffopt, RECURSIVE);
1298 diff_setup_done(&diffopt);
1299
1300 oidcpy(&bases->base_commit, &base->object.oid);
1301
1302 init_revisions(&revs, NULL);
1303 revs.max_parents = 1;
1304 revs.topo_order = 1;
1305 for (i = 0; i < total; i++) {
1306 list[i]->object.flags &= ~UNINTERESTING;
1307 add_pending_object(&revs, &list[i]->object, "rev_list");
1308 list[i]->util = (void *)1;
1309 }
1310 base->object.flags |= UNINTERESTING;
1311 add_pending_object(&revs, &base->object, "base");
1312
1313 if (prepare_revision_walk(&revs))
1314 die(_("revision walk setup failed"));
1315 /*
1316 * Traverse the commits list, get prerequisite patch ids
1317 * and stuff them in bases structure.
1318 */
1319 while ((commit = get_revision(&revs)) != NULL) {
1320 unsigned char sha1[20];
1321 struct object_id *patch_id;
1322 if (commit->util)
1323 continue;
1324 if (commit_patch_id(commit, &diffopt, sha1))
1325 die(_("cannot get patch id"));
1326 ALLOC_GROW(bases->patch_id, bases->nr_patch_id + 1, bases->alloc_patch_id);
1327 patch_id = bases->patch_id + bases->nr_patch_id;
1328 hashcpy(patch_id->hash, sha1);
1329 bases->nr_patch_id++;
1330 }
1331 }
1332
1333 static void print_bases(struct base_tree_info *bases)
1334 {
1335 int i;
1336
1337 /* Only do this once, either for the cover or for the first one */
1338 if (is_null_oid(&bases->base_commit))
1339 return;
1340
1341 /* Show the base commit */
1342 printf("base-commit: %s\n", oid_to_hex(&bases->base_commit));
1343
1344 /* Show the prerequisite patches */
1345 for (i = bases->nr_patch_id - 1; i >= 0; i--)
1346 printf("prerequisite-patch-id: %s\n", oid_to_hex(&bases->patch_id[i]));
1347
1348 free(bases->patch_id);
1349 bases->nr_patch_id = 0;
1350 bases->alloc_patch_id = 0;
1351 oidclr(&bases->base_commit);
1352 }
1353
1354 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1355 {
1356 struct commit *commit;
1357 struct commit **list = NULL;
1358 struct rev_info rev;
1359 struct setup_revision_opt s_r_opt;
1360 int nr = 0, total, i;
1361 int use_stdout = 0;
1362 int start_number = -1;
1363 int just_numbers = 0;
1364 int ignore_if_in_upstream = 0;
1365 int cover_letter = -1;
1366 int boundary_count = 0;
1367 int no_binary_diff = 0;
1368 int zero_commit = 0;
1369 struct commit *origin = NULL;
1370 const char *in_reply_to = NULL;
1371 struct patch_ids ids;
1372 struct strbuf buf = STRBUF_INIT;
1373 int use_patch_format = 0;
1374 int quiet = 0;
1375 int reroll_count = -1;
1376 char *branch_name = NULL;
1377 char *from = NULL;
1378 char *base_commit = NULL;
1379 struct base_tree_info bases;
1380
1381 const struct option builtin_format_patch_options[] = {
1382 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
1383 N_("use [PATCH n/m] even with a single patch"),
1384 PARSE_OPT_NOARG, numbered_callback },
1385 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
1386 N_("use [PATCH] even with multiple patches"),
1387 PARSE_OPT_NOARG, no_numbered_callback },
1388 OPT_BOOL('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
1389 OPT_BOOL(0, "stdout", &use_stdout,
1390 N_("print patches to standard out")),
1391 OPT_BOOL(0, "cover-letter", &cover_letter,
1392 N_("generate a cover letter")),
1393 OPT_BOOL(0, "numbered-files", &just_numbers,
1394 N_("use simple number sequence for output file names")),
1395 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1396 N_("use <sfx> instead of '.patch'")),
1397 OPT_INTEGER(0, "start-number", &start_number,
1398 N_("start numbering patches at <n> instead of 1")),
1399 OPT_INTEGER('v', "reroll-count", &reroll_count,
1400 N_("mark the series as Nth re-roll")),
1401 { OPTION_CALLBACK, 0, "subject-prefix", &rev, N_("prefix"),
1402 N_("Use [<prefix>] instead of [PATCH]"),
1403 PARSE_OPT_NONEG, subject_prefix_callback },
1404 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
1405 N_("dir"), N_("store resulting files in <dir>"),
1406 PARSE_OPT_NONEG, output_directory_callback },
1407 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
1408 N_("don't strip/add [PATCH]"),
1409 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
1410 OPT_BOOL(0, "no-binary", &no_binary_diff,
1411 N_("don't output binary diffs")),
1412 OPT_BOOL(0, "zero-commit", &zero_commit,
1413 N_("output all-zero hash in From header")),
1414 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1415 N_("don't include a patch matching a commit upstream")),
1416 { OPTION_SET_INT, 'p', "no-stat", &use_patch_format, NULL,
1417 N_("show patch format instead of default (patch + stat)"),
1418 PARSE_OPT_NONEG | PARSE_OPT_NOARG, NULL, 1},
1419 OPT_GROUP(N_("Messaging")),
1420 { OPTION_CALLBACK, 0, "add-header", NULL, N_("header"),
1421 N_("add email header"), 0, header_callback },
1422 { OPTION_CALLBACK, 0, "to", NULL, N_("email"), N_("add To: header"),
1423 0, to_callback },
1424 { OPTION_CALLBACK, 0, "cc", NULL, N_("email"), N_("add Cc: header"),
1425 0, cc_callback },
1426 { OPTION_CALLBACK, 0, "from", &from, N_("ident"),
1427 N_("set From address to <ident> (or committer ident if absent)"),
1428 PARSE_OPT_OPTARG, from_callback },
1429 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1430 N_("make first mail a reply to <message-id>")),
1431 { OPTION_CALLBACK, 0, "attach", &rev, N_("boundary"),
1432 N_("attach the patch"), PARSE_OPT_OPTARG,
1433 attach_callback },
1434 { OPTION_CALLBACK, 0, "inline", &rev, N_("boundary"),
1435 N_("inline the patch"),
1436 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1437 inline_callback },
1438 { OPTION_CALLBACK, 0, "thread", &thread, N_("style"),
1439 N_("enable message threading, styles: shallow, deep"),
1440 PARSE_OPT_OPTARG, thread_callback },
1441 OPT_STRING(0, "signature", &signature, N_("signature"),
1442 N_("add a signature")),
1443 OPT_STRING(0, "base", &base_commit, N_("base-commit"),
1444 N_("add prerequisite tree info to the patch series")),
1445 OPT_FILENAME(0, "signature-file", &signature_file,
1446 N_("add a signature from a file")),
1447 OPT__QUIET(&quiet, N_("don't print the patch filenames")),
1448 OPT_END()
1449 };
1450
1451 extra_hdr.strdup_strings = 1;
1452 extra_to.strdup_strings = 1;
1453 extra_cc.strdup_strings = 1;
1454 init_log_defaults();
1455 git_config(git_format_config, NULL);
1456 init_revisions(&rev, prefix);
1457 rev.commit_format = CMIT_FMT_EMAIL;
1458 rev.expand_tabs_in_log_default = 0;
1459 rev.verbose_header = 1;
1460 rev.diff = 1;
1461 rev.max_parents = 1;
1462 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
1463 rev.subject_prefix = fmt_patch_subject_prefix;
1464 memset(&s_r_opt, 0, sizeof(s_r_opt));
1465 s_r_opt.def = "HEAD";
1466 s_r_opt.revarg_opt = REVARG_COMMITTISH;
1467
1468 if (default_attach) {
1469 rev.mime_boundary = default_attach;
1470 rev.no_inline = 1;
1471 }
1472
1473 /*
1474 * Parse the arguments before setup_revisions(), or something
1475 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1476 * possibly a valid SHA1.
1477 */
1478 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1479 builtin_format_patch_usage,
1480 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1481 PARSE_OPT_KEEP_DASHDASH);
1482
1483 if (0 < reroll_count) {
1484 struct strbuf sprefix = STRBUF_INIT;
1485 strbuf_addf(&sprefix, "%s v%d",
1486 rev.subject_prefix, reroll_count);
1487 rev.reroll_count = reroll_count;
1488 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1489 }
1490
1491 for (i = 0; i < extra_hdr.nr; i++) {
1492 strbuf_addstr(&buf, extra_hdr.items[i].string);
1493 strbuf_addch(&buf, '\n');
1494 }
1495
1496 if (extra_to.nr)
1497 strbuf_addstr(&buf, "To: ");
1498 for (i = 0; i < extra_to.nr; i++) {
1499 if (i)
1500 strbuf_addstr(&buf, " ");
1501 strbuf_addstr(&buf, extra_to.items[i].string);
1502 if (i + 1 < extra_to.nr)
1503 strbuf_addch(&buf, ',');
1504 strbuf_addch(&buf, '\n');
1505 }
1506
1507 if (extra_cc.nr)
1508 strbuf_addstr(&buf, "Cc: ");
1509 for (i = 0; i < extra_cc.nr; i++) {
1510 if (i)
1511 strbuf_addstr(&buf, " ");
1512 strbuf_addstr(&buf, extra_cc.items[i].string);
1513 if (i + 1 < extra_cc.nr)
1514 strbuf_addch(&buf, ',');
1515 strbuf_addch(&buf, '\n');
1516 }
1517
1518 rev.extra_headers = strbuf_detach(&buf, NULL);
1519
1520 if (from) {
1521 if (split_ident_line(&rev.from_ident, from, strlen(from)))
1522 die(_("invalid ident line: %s"), from);
1523 }
1524
1525 if (start_number < 0)
1526 start_number = 1;
1527
1528 /*
1529 * If numbered is set solely due to format.numbered in config,
1530 * and it would conflict with --keep-subject (-k) from the
1531 * command line, reset "numbered".
1532 */
1533 if (numbered && keep_subject && !numbered_cmdline_opt)
1534 numbered = 0;
1535
1536 if (numbered && keep_subject)
1537 die (_("-n and -k are mutually exclusive."));
1538 if (keep_subject && subject_prefix)
1539 die (_("--subject-prefix and -k are mutually exclusive."));
1540 rev.preserve_subject = keep_subject;
1541
1542 argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1543 if (argc > 1)
1544 die (_("unrecognized argument: %s"), argv[1]);
1545
1546 if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1547 die(_("--name-only does not make sense"));
1548 if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1549 die(_("--name-status does not make sense"));
1550 if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1551 die(_("--check does not make sense"));
1552
1553 if (!use_patch_format &&
1554 (!rev.diffopt.output_format ||
1555 rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1556 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1557
1558 /* Always generate a patch */
1559 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1560
1561 rev.zero_commit = zero_commit;
1562
1563 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
1564 DIFF_OPT_SET(&rev.diffopt, BINARY);
1565
1566 if (rev.show_notes)
1567 init_display_notes(&rev.notes_opt);
1568
1569 if (!output_directory && !use_stdout)
1570 output_directory = config_output_directory;
1571
1572 if (!use_stdout)
1573 output_directory = set_outdir(prefix, output_directory);
1574 else
1575 setup_pager();
1576
1577 if (output_directory) {
1578 if (use_stdout)
1579 die(_("standard output, or directory, which one?"));
1580 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1581 die_errno(_("Could not create directory '%s'"),
1582 output_directory);
1583 }
1584
1585 if (rev.pending.nr == 1) {
1586 int check_head = 0;
1587
1588 if (rev.max_count < 0 && !rev.show_root_diff) {
1589 /*
1590 * This is traditional behaviour of "git format-patch
1591 * origin" that prepares what the origin side still
1592 * does not have.
1593 */
1594 rev.pending.objects[0].item->flags |= UNINTERESTING;
1595 add_head_to_pending(&rev);
1596 check_head = 1;
1597 }
1598 /*
1599 * Otherwise, it is "format-patch -22 HEAD", and/or
1600 * "format-patch --root HEAD". The user wants
1601 * get_revision() to do the usual traversal.
1602 */
1603
1604 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
1605 check_head = 1;
1606
1607 if (check_head) {
1608 unsigned char sha1[20];
1609 const char *ref, *v;
1610 ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
1611 sha1, NULL);
1612 if (ref && skip_prefix(ref, "refs/heads/", &v))
1613 branch_name = xstrdup(v);
1614 else
1615 branch_name = xstrdup(""); /* no branch */
1616 }
1617 }
1618
1619 /*
1620 * We cannot move this anywhere earlier because we do want to
1621 * know if --root was given explicitly from the command line.
1622 */
1623 rev.show_root_diff = 1;
1624
1625 if (ignore_if_in_upstream) {
1626 /* Don't say anything if head and upstream are the same. */
1627 if (rev.pending.nr == 2) {
1628 struct object_array_entry *o = rev.pending.objects;
1629 if (oidcmp(&o[0].item->oid, &o[1].item->oid) == 0)
1630 return 0;
1631 }
1632 get_patch_ids(&rev, &ids);
1633 }
1634
1635 if (!use_stdout)
1636 realstdout = xfdopen(xdup(1), "w");
1637
1638 if (prepare_revision_walk(&rev))
1639 die(_("revision walk setup failed"));
1640 rev.boundary = 1;
1641 while ((commit = get_revision(&rev)) != NULL) {
1642 if (commit->object.flags & BOUNDARY) {
1643 boundary_count++;
1644 origin = (boundary_count == 1) ? commit : NULL;
1645 continue;
1646 }
1647
1648 if (ignore_if_in_upstream && has_commit_patch_id(commit, &ids))
1649 continue;
1650
1651 nr++;
1652 REALLOC_ARRAY(list, nr);
1653 list[nr - 1] = commit;
1654 }
1655 if (nr == 0)
1656 /* nothing to do */
1657 return 0;
1658 total = nr;
1659 if (!keep_subject && auto_number && total > 1)
1660 numbered = 1;
1661 if (numbered)
1662 rev.total = total + start_number - 1;
1663 if (cover_letter == -1) {
1664 if (config_cover_letter == COVER_AUTO)
1665 cover_letter = (total > 1);
1666 else
1667 cover_letter = (config_cover_letter == COVER_ON);
1668 }
1669
1670 if (!signature) {
1671 ; /* --no-signature inhibits all signatures */
1672 } else if (signature && signature != git_version_string) {
1673 ; /* non-default signature already set */
1674 } else if (signature_file) {
1675 struct strbuf buf = STRBUF_INIT;
1676
1677 if (strbuf_read_file(&buf, signature_file, 128) < 0)
1678 die_errno(_("unable to read signature file '%s'"), signature_file);
1679 signature = strbuf_detach(&buf, NULL);
1680 }
1681
1682 memset(&bases, 0, sizeof(bases));
1683 if (base_commit || base_auto) {
1684 struct commit *base = get_base_commit(base_commit, list, nr);
1685 reset_revision_walk();
1686 prepare_bases(&bases, base, list, nr);
1687 }
1688
1689 if (in_reply_to || thread || cover_letter)
1690 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1691 if (in_reply_to) {
1692 const char *msgid = clean_message_id(in_reply_to);
1693 string_list_append(rev.ref_message_ids, msgid);
1694 }
1695 rev.numbered_files = just_numbers;
1696 rev.patch_suffix = fmt_patch_suffix;
1697 if (cover_letter) {
1698 if (thread)
1699 gen_message_id(&rev, "cover");
1700 make_cover_letter(&rev, use_stdout,
1701 origin, nr, list, branch_name, quiet);
1702 print_bases(&bases);
1703 total++;
1704 start_number--;
1705 }
1706 rev.add_signoff = do_signoff;
1707 while (0 <= --nr) {
1708 int shown;
1709 commit = list[nr];
1710 rev.nr = total - nr + (start_number - 1);
1711 /* Make the second and subsequent mails replies to the first */
1712 if (thread) {
1713 /* Have we already had a message ID? */
1714 if (rev.message_id) {
1715 /*
1716 * For deep threading: make every mail
1717 * a reply to the previous one, no
1718 * matter what other options are set.
1719 *
1720 * For shallow threading:
1721 *
1722 * Without --cover-letter and
1723 * --in-reply-to, make every mail a
1724 * reply to the one before.
1725 *
1726 * With --in-reply-to but no
1727 * --cover-letter, make every mail a
1728 * reply to the <reply-to>.
1729 *
1730 * With --cover-letter, make every
1731 * mail but the cover letter a reply
1732 * to the cover letter. The cover
1733 * letter is a reply to the
1734 * --in-reply-to, if specified.
1735 */
1736 if (thread == THREAD_SHALLOW
1737 && rev.ref_message_ids->nr > 0
1738 && (!cover_letter || rev.nr > 1))
1739 free(rev.message_id);
1740 else
1741 string_list_append(rev.ref_message_ids,
1742 rev.message_id);
1743 }
1744 gen_message_id(&rev, oid_to_hex(&commit->object.oid));
1745 }
1746
1747 if (!use_stdout &&
1748 reopen_stdout(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
1749 die(_("Failed to create output files"));
1750 shown = log_tree_commit(&rev, commit);
1751 free_commit_buffer(commit);
1752
1753 /* We put one extra blank line between formatted
1754 * patches and this flag is used by log-tree code
1755 * to see if it needs to emit a LF before showing
1756 * the log; when using one file per patch, we do
1757 * not want the extra blank line.
1758 */
1759 if (!use_stdout)
1760 rev.shown_one = 0;
1761 if (shown) {
1762 if (rev.mime_boundary)
1763 printf("\n--%s%s--\n\n\n",
1764 mime_boundary_leader,
1765 rev.mime_boundary);
1766 else
1767 print_signature();
1768 print_bases(&bases);
1769 }
1770 if (!use_stdout)
1771 fclose(stdout);
1772 }
1773 free(list);
1774 free(branch_name);
1775 string_list_clear(&extra_to, 0);
1776 string_list_clear(&extra_cc, 0);
1777 string_list_clear(&extra_hdr, 0);
1778 if (ignore_if_in_upstream)
1779 free_patch_ids(&ids);
1780 return 0;
1781 }
1782
1783 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1784 {
1785 unsigned char sha1[20];
1786 if (get_sha1(arg, sha1) == 0) {
1787 struct commit *commit = lookup_commit_reference(sha1);
1788 if (commit) {
1789 commit->object.flags |= flags;
1790 add_pending_object(revs, &commit->object, arg);
1791 return 0;
1792 }
1793 }
1794 return -1;
1795 }
1796
1797 static const char * const cherry_usage[] = {
1798 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1799 NULL
1800 };
1801
1802 static void print_commit(char sign, struct commit *commit, int verbose,
1803 int abbrev)
1804 {
1805 if (!verbose) {
1806 printf("%c %s\n", sign,
1807 find_unique_abbrev(commit->object.oid.hash, abbrev));
1808 } else {
1809 struct strbuf buf = STRBUF_INIT;
1810 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
1811 printf("%c %s %s\n", sign,
1812 find_unique_abbrev(commit->object.oid.hash, abbrev),
1813 buf.buf);
1814 strbuf_release(&buf);
1815 }
1816 }
1817
1818 int cmd_cherry(int argc, const char **argv, const char *prefix)
1819 {
1820 struct rev_info revs;
1821 struct patch_ids ids;
1822 struct commit *commit;
1823 struct commit_list *list = NULL;
1824 struct branch *current_branch;
1825 const char *upstream;
1826 const char *head = "HEAD";
1827 const char *limit = NULL;
1828 int verbose = 0, abbrev = 0;
1829
1830 struct option options[] = {
1831 OPT__ABBREV(&abbrev),
1832 OPT__VERBOSE(&verbose, N_("be verbose")),
1833 OPT_END()
1834 };
1835
1836 argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
1837
1838 switch (argc) {
1839 case 3:
1840 limit = argv[2];
1841 /* FALLTHROUGH */
1842 case 2:
1843 head = argv[1];
1844 /* FALLTHROUGH */
1845 case 1:
1846 upstream = argv[0];
1847 break;
1848 default:
1849 current_branch = branch_get(NULL);
1850 upstream = branch_get_upstream(current_branch, NULL);
1851 if (!upstream) {
1852 fprintf(stderr, _("Could not find a tracked"
1853 " remote branch, please"
1854 " specify <upstream> manually.\n"));
1855 usage_with_options(cherry_usage, options);
1856 }
1857 }
1858
1859 init_revisions(&revs, prefix);
1860 revs.max_parents = 1;
1861
1862 if (add_pending_commit(head, &revs, 0))
1863 die(_("Unknown commit %s"), head);
1864 if (add_pending_commit(upstream, &revs, UNINTERESTING))
1865 die(_("Unknown commit %s"), upstream);
1866
1867 /* Don't say anything if head and upstream are the same. */
1868 if (revs.pending.nr == 2) {
1869 struct object_array_entry *o = revs.pending.objects;
1870 if (oidcmp(&o[0].item->oid, &o[1].item->oid) == 0)
1871 return 0;
1872 }
1873
1874 get_patch_ids(&revs, &ids);
1875
1876 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1877 die(_("Unknown commit %s"), limit);
1878
1879 /* reverse the list of commits */
1880 if (prepare_revision_walk(&revs))
1881 die(_("revision walk setup failed"));
1882 while ((commit = get_revision(&revs)) != NULL) {
1883 commit_list_insert(commit, &list);
1884 }
1885
1886 while (list) {
1887 char sign = '+';
1888
1889 commit = list->item;
1890 if (has_commit_patch_id(commit, &ids))
1891 sign = '-';
1892 print_commit(sign, commit, verbose, abbrev);
1893 list = list->next;
1894 }
1895
1896 free_patch_ids(&ids);
1897 return 0;
1898 }
Eric Wong's git-svn branch