format-patch: make newline after signature conditional
[git/git.git] / builtin / log.c
CommitLineData
70827b15
LT
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"
6b2f2d98 8#include "color.h"
70827b15
LT
9#include "commit.h"
10#include "diff.h"
11#include "revision.h"
12#include "log-tree.h"
91efcf60 13#include "builtin.h"
5d7eeee2 14#include "tag.h"
cf39f54e 15#include "reflog-walk.h"
5d23e133 16#include "patch-ids.h"
a5a27c79 17#include "run-command.h"
2bda2cf4 18#include "shortlog.h"
f2968022 19#include "remote.h"
b079c50e 20#include "string-list.h"
fff02ee6 21#include "parse-options.h"
12da1d1f 22#include "line-log.h"
739453a3 23#include "branch.h"
74775a09 24#include "streaming.h"
816fb46b 25#include "version.h"
ea57bc0d 26#include "mailmap.h"
6005dbb9 27#include "gpg-interface.h"
70827b15 28
dd0ffd5b
HO
29/* Set a default date-time format for git log ("log.date" config variable) */
30static const char *default_date_mode = NULL;
31
0c47695a 32static int default_abbrev_commit;
0f03ca94 33static int default_show_root = 1;
8a3d203b 34static int decoration_style;
1c40c36b 35static int decoration_given;
e6bb5f78 36static int use_mailmap_config;
d54276f2 37static const char *fmt_patch_subject_prefix = "PATCH";
94c22a5e 38static const char *fmt_pretty;
0f03ca94 39
1c40c36b 40static const char * const builtin_log_usage[] = {
e495afcd 41 N_("git log [<options>] [<revision range>] [[--] <path>...]\n")
e62cd35a 42 N_(" or: git show [options] <object>..."),
1c40c36b
CMN
43 NULL
44};
1c370ea4 45
12da1d1f
TR
46struct line_opt_callback_data {
47 struct rev_info *rev;
48 const char *prefix;
49 struct string_list args;
50};
51
8a3d203b
JH
52static int parse_decoration_style(const char *var, const char *value)
53{
54 switch (git_config_maybe_bool(var, value)) {
55 case 1:
56 return DECORATE_SHORT_REFS;
57 case 0:
58 return 0;
59 default:
60 break;
61 }
62 if (!strcmp(value, "full"))
63 return DECORATE_FULL_REFS;
64 else if (!strcmp(value, "short"))
65 return DECORATE_SHORT_REFS;
66 return -1;
67}
68
1c40c36b
CMN
69static int decorate_callback(const struct option *opt, const char *arg, int unset)
70{
71 if (unset)
72 decoration_style = 0;
73 else if (arg)
74 decoration_style = parse_decoration_style("command line", arg);
75 else
76 decoration_style = DECORATE_SHORT_REFS;
77
78 if (decoration_style < 0)
79 die("invalid --decorate option: %s", arg);
80
81 decoration_given = 1;
82
83 return 0;
84}
85
12da1d1f
TR
86static int log_line_range_callback(const struct option *option, const char *arg, int unset)
87{
88 struct line_opt_callback_data *data = option->value;
89
90 if (!arg)
91 return -1;
92
93 data->rev->line_level_traverse = 1;
94 string_list_append(&data->args, arg);
95
96 return 0;
97}
98
ef803fd4 99static void cmd_log_init_defaults(struct rev_info *rev)
70827b15 100{
94c22a5e 101 if (fmt_pretty)
4da45bef 102 get_commit_format(fmt_pretty, rev);
70827b15 103 rev->verbose_header = 1;
8f67f8ae 104 DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
5e0ec15e 105 rev->diffopt.stat_width = -1; /* use full terminal width */
df44483a 106 rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
0c47695a 107 rev->abbrev_commit = default_abbrev_commit;
0f03ca94 108 rev->show_root_diff = default_show_root;
d54276f2 109 rev->subject_prefix = fmt_patch_subject_prefix;
5ec11af6 110 DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
dd0ffd5b
HO
111
112 if (default_date_mode)
113 rev->date_mode = parse_date_format(default_date_mode);
6c374008 114 rev->diffopt.touched_flags = 0;
ef803fd4 115}
dd0ffd5b 116
ef803fd4
MG
117static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
118 struct rev_info *rev, struct setup_revision_opt *opt)
119{
ef803fd4 120 struct userformat_want w;
ea57bc0d 121 int quiet = 0, source = 0, mailmap = 0;
12da1d1f 122 static struct line_opt_callback_data line_cb = {NULL, NULL, STRING_LIST_INIT_DUP};
1c40c36b
CMN
123
124 const struct option builtin_log_options[] = {
b7df098c 125 OPT__QUIET(&quiet, N_("suppress diff output")),
aa089cd9
FC
126 OPT_BOOL(0, "source", &source, N_("show source")),
127 OPT_BOOL(0, "use-mailmap", &mailmap, N_("Use mail map file")),
e62cd35a 128 { OPTION_CALLBACK, 0, "decorate", NULL, NULL, N_("decorate options"),
1c40c36b 129 PARSE_OPT_OPTARG, decorate_callback},
12da1d1f
TR
130 OPT_CALLBACK('L', NULL, &line_cb, "n,m:file",
131 "Process line range n,m in file, counting from 1",
132 log_line_range_callback),
1c40c36b
CMN
133 OPT_END()
134 };
135
12da1d1f
TR
136 line_cb.rev = rev;
137 line_cb.prefix = prefix;
138
e6bb5f78 139 mailmap = use_mailmap_config;
1c40c36b
CMN
140 argc = parse_options(argc, argv, prefix,
141 builtin_log_options, builtin_log_usage,
142 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
143 PARSE_OPT_KEEP_DASHDASH);
52883fbd 144
01771a8e
JH
145 if (quiet)
146 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
f9c75d85 147 argc = setup_revisions(argc, argv, rev, opt);
dd0ffd5b 148
1c40c36b
CMN
149 /* Any arguments at this point are not recognized */
150 if (argc > 1)
151 die("unrecognized argument: %s", argv[1]);
152
5b163603
JG
153 memset(&w, 0, sizeof(w));
154 userformat_find_requirements(NULL, &w);
155
156 if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
66b2ed09 157 rev->show_notes = 1;
894a9d33
TR
158 if (rev->show_notes)
159 init_display_notes(&rev->notes_opt);
66b2ed09 160
9dafea26
TH
161 if (rev->diffopt.pickaxe || rev->diffopt.filter)
162 rev->always_show_header = 0;
8f67f8ae 163 if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
750f7b66 164 rev->always_show_header = 0;
66f13625 165 if (rev->diffopt.pathspec.nr != 1)
750f7b66
LT
166 usage("git logs can only follow renames on one pathname at a time");
167 }
1c40c36b
CMN
168
169 if (source)
170 rev->show_source = 1;
635530a2 171
ea57bc0d
AP
172 if (mailmap) {
173 rev->mailmap = xcalloc(1, sizeof(struct string_list));
174 read_mailmap(rev->mailmap, NULL);
175 }
176
0c47695a
JS
177 if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
178 /*
179 * "log --pretty=raw" is special; ignore UI oriented
180 * configuration variables such as decoration.
181 */
182 if (!decoration_given)
183 decoration_style = 0;
184 if (!rev->abbrev_commit_given)
185 rev->abbrev_commit = 0;
186 }
635530a2 187
33e7018c
LH
188 if (decoration_style) {
189 rev->show_decorations = 1;
190 load_ref_decorations(decoration_style);
191 }
12da1d1f
TR
192
193 if (rev->line_level_traverse)
194 line_log_init(rev, line_cb.prefix, &line_cb.args);
195
1fda91b5 196 setup_pager();
9dafea26
TH
197}
198
ef803fd4
MG
199static void cmd_log_init(int argc, const char **argv, const char *prefix,
200 struct rev_info *rev, struct setup_revision_opt *opt)
201{
202 cmd_log_init_defaults(rev);
203 cmd_log_init_finish(argc, argv, prefix, rev, opt);
204}
205
252a7c02
LT
206/*
207 * This gives a rough estimate for how many commits we
208 * will print out in the list.
209 */
210static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
211{
212 int n = 0;
213
214 while (list) {
215 struct commit *commit = list->item;
216 unsigned int flags = commit->object.flags;
252a7c02 217 list = list->next;
7dc0fe3b 218 if (!(flags & (TREESAME | UNINTERESTING)))
53b2c823 219 n++;
252a7c02
LT
220 }
221 return n;
222}
223
224static void show_early_header(struct rev_info *rev, const char *stage, int nr)
225{
226 if (rev->shown_one) {
227 rev->shown_one = 0;
228 if (rev->commit_format != CMIT_FMT_ONELINE)
229 putchar(rev->diffopt.line_termination);
230 }
5c5f1d7c 231 printf(_("Final output: %d %s\n"), nr, stage);
252a7c02
LT
232}
233
2af202be 234static struct itimerval early_output_timer;
252a7c02 235
cdcefbc9
LT
236static void log_show_early(struct rev_info *revs, struct commit_list *list)
237{
238 int i = revs->early_output;
252a7c02 239 int show_header = 1;
cdcefbc9 240
08f704f2 241 sort_in_topological_order(&list, revs->sort_order);
cdcefbc9
LT
242 while (list && i) {
243 struct commit *commit = list->item;
252a7c02
LT
244 switch (simplify_commit(revs, commit)) {
245 case commit_show:
246 if (show_header) {
247 int n = estimate_commit_count(revs, list);
248 show_early_header(revs, "incomplete", n);
249 show_header = 0;
250 }
251 log_tree_commit(revs, commit);
252 i--;
253 break;
254 case commit_ignore:
255 break;
256 case commit_error:
257 return;
258 }
cdcefbc9 259 list = list->next;
cdcefbc9 260 }
252a7c02
LT
261
262 /* Did we already get enough commits for the early output? */
263 if (!i)
264 return;
265
266 /*
267 * ..if no, then repeat it twice a second until we
268 * do.
269 *
270 * NOTE! We don't use "it_interval", because if the
271 * reader isn't listening, we want our output to be
272 * throttled by the writing, and not have the timer
273 * trigger every second even if we're blocked on a
274 * reader!
275 */
276 early_output_timer.it_value.tv_sec = 0;
277 early_output_timer.it_value.tv_usec = 500000;
278 setitimer(ITIMER_REAL, &early_output_timer, NULL);
cdcefbc9
LT
279}
280
281static void early_output(int signal)
282{
283 show_early_output = log_show_early;
284}
285
286static void setup_early_output(struct rev_info *rev)
287{
288 struct sigaction sa;
cdcefbc9
LT
289
290 /*
291 * Set up the signal handler, minimally intrusively:
292 * we only set a single volatile integer word (not
293 * using sigatomic_t - trying to avoid unnecessary
294 * system dependencies and headers), and using
295 * SA_RESTART.
296 */
297 memset(&sa, 0, sizeof(sa));
298 sa.sa_handler = early_output;
299 sigemptyset(&sa.sa_mask);
300 sa.sa_flags = SA_RESTART;
301 sigaction(SIGALRM, &sa, NULL);
302
303 /*
304 * If we can get the whole output in less than a
305 * tenth of a second, don't even bother doing the
306 * early-output thing..
307 *
308 * This is a one-time-only trigger.
309 */
252a7c02
LT
310 early_output_timer.it_value.tv_sec = 0;
311 early_output_timer.it_value.tv_usec = 100000;
312 setitimer(ITIMER_REAL, &early_output_timer, NULL);
cdcefbc9
LT
313}
314
315static void finish_early_output(struct rev_info *rev)
316{
252a7c02 317 int n = estimate_commit_count(rev, rev->commits);
cdcefbc9 318 signal(SIGALRM, SIG_IGN);
252a7c02 319 show_early_header(rev, "done", n);
cdcefbc9
LT
320}
321
9dafea26
TH
322static int cmd_log_walk(struct rev_info *rev)
323{
324 struct commit *commit;
f31027c9
JH
325 int saved_nrl = 0;
326 int saved_dcctc = 0;
70827b15 327
cdcefbc9
LT
328 if (rev->early_output)
329 setup_early_output(rev);
330
3d51e1b5 331 if (prepare_revision_walk(rev))
5c5f1d7c 332 die(_("revision walk setup failed"));
cdcefbc9
LT
333
334 if (rev->early_output)
335 finish_early_output(rev);
336
036d17fe 337 /*
84102a33
PVM
338 * For --check and --exit-code, the exit code is based on CHECK_FAILED
339 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
340 * retain that state information if replacing rev->diffopt in this loop
036d17fe 341 */
70827b15 342 while ((commit = get_revision(rev)) != NULL) {
251df09b
MM
343 if (!log_tree_commit(rev, commit) &&
344 rev->max_count >= 0)
345 /*
346 * We decremented max_count in get_revision,
347 * but we didn't actually show the commit.
348 */
349 rev->max_count++;
a6c73064
JS
350 if (!rev->reflog_info) {
351 /* we allow cycles in reflog ancestry */
352 free(commit->buffer);
353 commit->buffer = NULL;
354 }
cb115748
LT
355 free_commit_list(commit->parents);
356 commit->parents = NULL;
f31027c9
JH
357 if (saved_nrl < rev->diffopt.needed_rename_limit)
358 saved_nrl = rev->diffopt.needed_rename_limit;
359 if (rev->diffopt.degraded_cc_to_c)
360 saved_dcctc = 1;
70827b15 361 }
f31027c9
JH
362 rev->diffopt.degraded_cc_to_c = saved_dcctc;
363 rev->diffopt.needed_rename_limit = saved_nrl;
364
036d17fe
PVM
365 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
366 DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
367 return 02;
368 }
84102a33 369 return diff_result_code(&rev->diffopt, 0);
70827b15
LT
370}
371
ef90d6d4 372static int git_log_config(const char *var, const char *value, void *cb)
0f03ca94 373{
94c22a5e
CR
374 if (!strcmp(var, "format.pretty"))
375 return git_config_string(&fmt_pretty, var, value);
70cff3ac
BH
376 if (!strcmp(var, "format.subjectprefix"))
377 return git_config_string(&fmt_patch_subject_prefix, var, value);
0c47695a
JS
378 if (!strcmp(var, "log.abbrevcommit")) {
379 default_abbrev_commit = git_config_bool(var, value);
380 return 0;
381 }
dd0ffd5b
HO
382 if (!strcmp(var, "log.date"))
383 return git_config_string(&default_date_mode, var, value);
eb734454 384 if (!strcmp(var, "log.decorate")) {
8a3d203b
JH
385 decoration_style = parse_decoration_style(var, value);
386 if (decoration_style < 0)
387 decoration_style = 0; /* maybe warn? */
eb734454
SD
388 return 0;
389 }
0f03ca94
PB
390 if (!strcmp(var, "log.showroot")) {
391 default_show_root = git_config_bool(var, value);
392 return 0;
393 }
59556548 394 if (starts_with(var, "color.decorate."))
5e11bee6 395 return parse_decorate_color_config(var, 15, value);
e6bb5f78
AP
396 if (!strcmp(var, "log.mailmap")) {
397 use_mailmap_config = git_config_bool(var, value);
398 return 0;
399 }
400
0657bcbf
JH
401 if (grep_config(var, value, cb) < 0)
402 return -1;
6005dbb9 403 if (git_gpg_config(var, value, cb) < 0)
0657bcbf 404 return -1;
ef90d6d4 405 return git_diff_ui_config(var, value, cb);
0f03ca94
PB
406}
407
a633fca0 408int cmd_whatchanged(int argc, const char **argv, const char *prefix)
70827b15
LT
409{
410 struct rev_info rev;
32962c9b 411 struct setup_revision_opt opt;
70827b15 412
0657bcbf 413 init_grep_defaults();
ef90d6d4 414 git_config(git_log_config, NULL);
6b2f2d98 415
db6296a5 416 init_revisions(&rev, prefix);
70827b15 417 rev.diff = 1;
9202434c 418 rev.simplify_history = 0;
32962c9b
JH
419 memset(&opt, 0, sizeof(opt));
420 opt.def = "HEAD";
d5f6b1d7 421 opt.revarg_opt = REVARG_COMMITTISH;
32962c9b 422 cmd_log_init(argc, argv, prefix, &rev, &opt);
9dafea26
TH
423 if (!rev.diffopt.output_format)
424 rev.diffopt.output_format = DIFF_FORMAT_RAW;
425 return cmd_log_walk(&rev);
70827b15
LT
426}
427
56122ed8
JS
428static void show_tagger(char *buf, int len, struct rev_info *rev)
429{
ea718e65 430 struct strbuf out = STRBUF_INIT;
6bf13944 431 struct pretty_print_context pp = {0};
56122ed8 432
6bf13944
JK
433 pp.fmt = rev->commit_format;
434 pp.date_mode = rev->date_mode;
435 pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
ca4ca9ed 436 printf("%s", out.buf);
ea718e65 437 strbuf_release(&out);
56122ed8
JS
438}
439
083b9931 440static int show_blob_object(const unsigned char *sha1, struct rev_info *rev, const char *obj_name)
74775a09 441{
083b9931
MG
442 unsigned char sha1c[20];
443 struct object_context obj_context;
444 char *buf;
445 unsigned long size;
446
74775a09 447 fflush(stdout);
083b9931
MG
448 if (!DIFF_OPT_TOUCHED(&rev->diffopt, ALLOW_TEXTCONV) ||
449 !DIFF_OPT_TST(&rev->diffopt, ALLOW_TEXTCONV))
450 return stream_blob_to_fd(1, sha1, NULL, 0);
451
452 if (get_sha1_with_context(obj_name, 0, sha1c, &obj_context))
453 die("Not a valid object name %s", obj_name);
454 if (!obj_context.path[0] ||
455 !textconv_object(obj_context.path, obj_context.mode, sha1c, 1, &buf, &size))
456 return stream_blob_to_fd(1, sha1, NULL, 0);
457
458 if (!buf)
459 die("git show %s: bad file", obj_name);
460
461 write_or_die(1, buf, size);
462 return 0;
74775a09
NTND
463}
464
465static int show_tag_object(const unsigned char *sha1, struct rev_info *rev)
5d7eeee2
JS
466{
467 unsigned long size;
21666f1a
NP
468 enum object_type type;
469 char *buf = read_sha1_file(sha1, &type, &size);
5d7eeee2
JS
470 int offset = 0;
471
472 if (!buf)
5c5f1d7c 473 return error(_("Could not read object %s"), sha1_to_hex(sha1));
5d7eeee2 474
74775a09
NTND
475 assert(type == OBJ_TAG);
476 while (offset < size && buf[offset] != '\n') {
477 int new_offset = offset + 1;
478 while (new_offset < size && buf[new_offset++] != '\n')
479 ; /* do nothing */
59556548 480 if (starts_with(buf + offset, "tagger "))
74775a09
NTND
481 show_tagger(buf + offset + 7,
482 new_offset - offset - 7, rev);
483 offset = new_offset;
484 }
5d7eeee2
JS
485
486 if (offset < size)
487 fwrite(buf + offset, size - offset, 1, stdout);
488 free(buf);
489 return 0;
490}
491
492static int show_tree_object(const unsigned char *sha1,
493 const char *base, int baselen,
671f0707 494 const char *pathname, unsigned mode, int stage, void *context)
5d7eeee2
JS
495{
496 printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
497 return 0;
498}
499
b4490059
JH
500static void show_rev_tweak_rev(struct rev_info *rev, struct setup_revision_opt *opt)
501{
2bf65873
JH
502 if (rev->ignore_merges) {
503 /* There was no "-m" on the command line */
504 rev->ignore_merges = 0;
505 if (!rev->first_parent_only && !rev->combine_merges) {
01689909 506 /* No "--first-parent", "-c", or "--cc" */
2bf65873
JH
507 rev->combine_merges = 1;
508 rev->dense_combined_merges = 1;
509 }
510 }
b4490059
JH
511 if (!rev->diffopt.output_format)
512 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
513}
514
a633fca0 515int cmd_show(int argc, const char **argv, const char *prefix)
70827b15
LT
516{
517 struct rev_info rev;
5d7eeee2 518 struct object_array_entry *objects;
32962c9b 519 struct setup_revision_opt opt;
f0096c06 520 struct pathspec match_all;
5d7eeee2 521 int i, count, ret = 0;
70827b15 522
0657bcbf 523 init_grep_defaults();
ef90d6d4 524 git_config(git_log_config, NULL);
6b2f2d98 525
9a087274 526 memset(&match_all, 0, sizeof(match_all));
db6296a5 527 init_revisions(&rev, prefix);
70827b15 528 rev.diff = 1;
70827b15 529 rev.always_show_header = 1;
ca92e59e 530 rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
666c92a2
ZJS
531 rev.diffopt.stat_width = -1; /* Scale to real terminal size */
532
32962c9b
JH
533 memset(&opt, 0, sizeof(opt));
534 opt.def = "HEAD";
b4490059 535 opt.tweak = show_rev_tweak_rev;
32962c9b 536 cmd_log_init(argc, argv, prefix, &rev, &opt);
5d7eeee2 537
c5941f1a
JH
538 if (!rev.no_walk)
539 return cmd_log_walk(&rev);
540
5d7eeee2
JS
541 count = rev.pending.nr;
542 objects = rev.pending.objects;
543 for (i = 0; i < count && !ret; i++) {
544 struct object *o = objects[i].item;
545 const char *name = objects[i].name;
546 switch (o->type) {
547 case OBJ_BLOB:
083b9931 548 ret = show_blob_object(o->sha1, &rev, name);
5d7eeee2
JS
549 break;
550 case OBJ_TAG: {
551 struct tag *t = (struct tag *)o;
552
ae03ee64
JK
553 if (rev.shown_one)
554 putchar('\n');
56122ed8 555 printf("%stag %s%s\n",
8f67f8ae 556 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
5d7eeee2 557 t->tag,
8f67f8ae 558 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
74775a09 559 ret = show_tag_object(o->sha1, &rev);
ae03ee64 560 rev.shown_one = 1;
d2dadfe8
JH
561 if (ret)
562 break;
563 o = parse_object(t->tagged->sha1);
564 if (!o)
5c5f1d7c 565 ret = error(_("Could not read object %s"),
d2dadfe8
JH
566 sha1_to_hex(t->tagged->sha1));
567 objects[i].item = o;
5d7eeee2
JS
568 i--;
569 break;
570 }
571 case OBJ_TREE:
ae03ee64
JK
572 if (rev.shown_one)
573 putchar('\n');
5d7eeee2 574 printf("%stree %s%s\n\n",
8f67f8ae 575 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
5d7eeee2 576 name,
8f67f8ae 577 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
f0096c06 578 read_tree_recursive((struct tree *)o, "", 0, 0, &match_all,
671f0707 579 show_tree_object, NULL);
ae03ee64 580 rev.shown_one = 1;
5d7eeee2
JS
581 break;
582 case OBJ_COMMIT:
583 rev.pending.nr = rev.pending.alloc = 0;
584 rev.pending.objects = NULL;
585 add_object_array(o, name, &rev.pending);
586 ret = cmd_log_walk(&rev);
587 break;
588 default:
5c5f1d7c 589 ret = error(_("Unknown type: %d"), o->type);
5d7eeee2
JS
590 }
591 }
592 free(objects);
593 return ret;
70827b15
LT
594}
595
cf39f54e
LT
596/*
597 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
598 */
599int cmd_log_reflog(int argc, const char **argv, const char *prefix)
600{
601 struct rev_info rev;
32962c9b 602 struct setup_revision_opt opt;
cf39f54e 603
0657bcbf 604 init_grep_defaults();
ef90d6d4 605 git_config(git_log_config, NULL);
6b2f2d98 606
cf39f54e
LT
607 init_revisions(&rev, prefix);
608 init_reflog_walk(&rev.reflog_info);
cf39f54e 609 rev.verbose_header = 1;
32962c9b
JH
610 memset(&opt, 0, sizeof(opt));
611 opt.def = "HEAD";
4b56cf58 612 cmd_log_init_defaults(&rev);
0c47695a 613 rev.abbrev_commit = 1;
cf39f54e 614 rev.commit_format = CMIT_FMT_ONELINE;
4da45bef 615 rev.use_terminator = 1;
cf39f54e 616 rev.always_show_header = 1;
4b56cf58 617 cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
cf39f54e 618
cf39f54e
LT
619 return cmd_log_walk(&rev);
620}
621
a633fca0 622int cmd_log(int argc, const char **argv, const char *prefix)
70827b15
LT
623{
624 struct rev_info rev;
32962c9b 625 struct setup_revision_opt opt;
70827b15 626
0657bcbf 627 init_grep_defaults();
ef90d6d4 628 git_config(git_log_config, NULL);
6b2f2d98 629
db6296a5 630 init_revisions(&rev, prefix);
70827b15 631 rev.always_show_header = 1;
32962c9b
JH
632 memset(&opt, 0, sizeof(opt));
633 opt.def = "HEAD";
d5f6b1d7 634 opt.revarg_opt = REVARG_COMMITTISH;
32962c9b 635 cmd_log_init(argc, argv, prefix, &rev, &opt);
9dafea26 636 return cmd_log_walk(&rev);
70827b15 637}
91efcf60 638
c06d2daa 639/* format-patch */
0377db77 640
917a8f89 641static const char *fmt_patch_suffix = ".patch";
49604a4d 642static int numbered = 0;
a567fdcb 643static int auto_number = 1;
20ff0680 644
0db5260b
JW
645static char *default_attach = NULL;
646
ca9e0a1b
SB
647static struct string_list extra_hdr;
648static struct string_list extra_to;
649static struct string_list extra_cc;
3ee79d9f
DB
650
651static void add_header(const char *value)
652{
ca9e0a1b 653 struct string_list_item *item;
3ee79d9f 654 int len = strlen(value);
c8c4450e 655 while (len && value[len - 1] == '\n')
3ee79d9f 656 len--;
ca9e0a1b 657
3ee79d9f 658 if (!strncasecmp(value, "to: ", 4)) {
1d2f80fa 659 item = string_list_append(&extra_to, value + 4);
ca9e0a1b
SB
660 len -= 4;
661 } else if (!strncasecmp(value, "cc: ", 4)) {
1d2f80fa 662 item = string_list_append(&extra_cc, value + 4);
ca9e0a1b
SB
663 len -= 4;
664 } else {
1d2f80fa 665 item = string_list_append(&extra_hdr, value);
3ee79d9f 666 }
ca9e0a1b
SB
667
668 item->string[len] = '\0';
3ee79d9f
DB
669}
670
30984ed2
TR
671#define THREAD_SHALLOW 1
672#define THREAD_DEEP 2
6622d9c7
SB
673static int thread;
674static int do_signoff;
675static const char *signature = git_version_string;
2a4c2607
FC
676static int config_cover_letter;
677
678enum {
679 COVER_UNSET,
680 COVER_OFF,
681 COVER_ON,
682 COVER_AUTO
683};
30984ed2 684
ef90d6d4 685static int git_format_config(const char *var, const char *value, void *cb)
20ff0680
JS
686{
687 if (!strcmp(var, "format.headers")) {
d7fb91c6 688 if (!value)
5c5f1d7c 689 die(_("format.headers without value"));
3ee79d9f 690 add_header(value);
20ff0680
JS
691 return 0;
692 }
70cff3ac
BH
693 if (!strcmp(var, "format.suffix"))
694 return git_config_string(&fmt_patch_suffix, var, value);
ae6c098f
SD
695 if (!strcmp(var, "format.to")) {
696 if (!value)
697 return config_error_nonbool(var);
1d2f80fa 698 string_list_append(&extra_to, value);
ae6c098f
SD
699 return 0;
700 }
fe8928e6
MV
701 if (!strcmp(var, "format.cc")) {
702 if (!value)
703 return config_error_nonbool(var);
1d2f80fa 704 string_list_append(&extra_cc, value);
fe8928e6
MV
705 return 0;
706 }
787570c7
PYH
707 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
708 !strcmp(var, "color.ui")) {
f3aafa4d
RA
709 return 0;
710 }
49604a4d 711 if (!strcmp(var, "format.numbered")) {
90f5c186 712 if (value && !strcasecmp(value, "auto")) {
49604a4d
BG
713 auto_number = 1;
714 return 0;
715 }
49604a4d 716 numbered = git_config_bool(var, value);
a567fdcb 717 auto_number = auto_number && numbered;
49604a4d
BG
718 return 0;
719 }
0db5260b
JW
720 if (!strcmp(var, "format.attach")) {
721 if (value && *value)
722 default_attach = xstrdup(value);
723 else
724 default_attach = xstrdup(git_version_string);
725 return 0;
726 }
30984ed2
TR
727 if (!strcmp(var, "format.thread")) {
728 if (value && !strcasecmp(value, "deep")) {
729 thread = THREAD_DEEP;
730 return 0;
731 }
732 if (value && !strcasecmp(value, "shallow")) {
733 thread = THREAD_SHALLOW;
734 return 0;
735 }
736 thread = git_config_bool(var, value) && THREAD_SHALLOW;
737 return 0;
738 }
1d1876e9
HV
739 if (!strcmp(var, "format.signoff")) {
740 do_signoff = git_config_bool(var, value);
741 return 0;
742 }
6622d9c7
SB
743 if (!strcmp(var, "format.signature"))
744 return git_config_string(&signature, var, value);
2a4c2607
FC
745 if (!strcmp(var, "format.coverletter")) {
746 if (value && !strcasecmp(value, "auto")) {
747 config_cover_letter = COVER_AUTO;
748 return 0;
749 }
750 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
751 return 0;
752 }
dbd21447 753
ef90d6d4 754 return git_log_config(var, value, cb);
20ff0680
JS
755}
756
81f3a188 757static FILE *realstdout = NULL;
efd02016 758static const char *output_directory = NULL;
9800a754 759static int outdir_offset;
81f3a188 760
a21c2f94
JK
761static int reopen_stdout(struct commit *commit, const char *subject,
762 struct rev_info *rev, int quiet)
0377db77 763{
cd2ef591 764 struct strbuf filename = STRBUF_INIT;
68cb7b6f 765 int suffix_len = strlen(rev->patch_suffix) + 1;
0377db77 766
2448482b 767 if (output_directory) {
cd2ef591
SB
768 strbuf_addstr(&filename, output_directory);
769 if (filename.len >=
770 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
5c5f1d7c 771 return error(_("name of output directory is too long"));
cd2ef591
SB
772 if (filename.buf[filename.len - 1] != '/')
773 strbuf_addch(&filename, '/');
2448482b 774 }
0377db77 775
38ec23ac
JH
776 if (rev->numbered_files)
777 strbuf_addf(&filename, "%d", rev->nr);
d28b5d47
JH
778 else if (commit)
779 fmt_output_commit(&filename, commit, rev);
38ec23ac 780 else
d28b5d47 781 fmt_output_subject(&filename, subject, rev);
e6ff0f42 782
250087f2 783 if (!quiet)
cd2ef591 784 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
ec2956df 785
cd2ef591 786 if (freopen(filename.buf, "w", stdout) == NULL)
5c5f1d7c 787 return error(_("Cannot open patch file %s"), filename.buf);
c06d2daa 788
cd2ef591 789 strbuf_release(&filename);
e6ff0f42 790 return 0;
0377db77
JS
791}
792
811929f1 793static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
9c6efa36
JS
794{
795 struct rev_info check_rev;
796 struct commit *commit;
797 struct object *o1, *o2;
798 unsigned flags1, flags2;
9c6efa36
JS
799
800 if (rev->pending.nr != 2)
5c5f1d7c 801 die(_("Need exactly one range."));
9c6efa36
JS
802
803 o1 = rev->pending.objects[0].item;
804 flags1 = o1->flags;
805 o2 = rev->pending.objects[1].item;
806 flags2 = o2->flags;
807
808 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
5c5f1d7c 809 die(_("Not a range."));
9c6efa36 810
5d23e133 811 init_patch_ids(ids);
9c6efa36
JS
812
813 /* given a range a..b get all patch ids for b..a */
811929f1 814 init_revisions(&check_rev, rev->prefix);
51f4de3a 815 check_rev.max_parents = 1;
9c6efa36
JS
816 o1->flags ^= UNINTERESTING;
817 o2->flags ^= UNINTERESTING;
818 add_pending_object(&check_rev, o1, "o1");
819 add_pending_object(&check_rev, o2, "o2");
3d51e1b5 820 if (prepare_revision_walk(&check_rev))
5c5f1d7c 821 die(_("revision walk setup failed"));
9c6efa36
JS
822
823 while ((commit = get_revision(&check_rev)) != NULL) {
5d23e133 824 add_commit_patch_id(commit, ids);
9c6efa36
JS
825 }
826
827 /* reset for next revision walk */
81db0941
JS
828 clear_commit_marks((struct commit *)o1,
829 SEEN | UNINTERESTING | SHOWN | ADDED);
830 clear_commit_marks((struct commit *)o2,
831 SEEN | UNINTERESTING | SHOWN | ADDED);
9c6efa36
JS
832 o1->flags = flags1;
833 o2->flags = flags2;
834}
835
e1a37346 836static void gen_message_id(struct rev_info *info, char *base)
d1566f78 837{
f285a2d7 838 struct strbuf buf = STRBUF_INIT;
43ae9f47 839 strbuf_addf(&buf, "%s.%lu.git.%s", base,
c73f384f 840 (unsigned long) time(NULL),
59f9b8a9 841 git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
e1a37346 842 info->message_id = strbuf_detach(&buf, NULL);
d1566f78
JT
843}
844
6622d9c7
SB
845static void print_signature(void)
846{
c6076e2b
JK
847 if (!signature || !*signature)
848 return;
849
850 printf("-- \n%s", signature);
851 if (signature[strlen(signature)-1] != '\n')
852 putchar('\n');
853 putchar('\n');
6622d9c7
SB
854}
855
739453a3
JH
856static void add_branch_description(struct strbuf *buf, const char *branch_name)
857{
858 struct strbuf desc = STRBUF_INIT;
859 if (!branch_name || !*branch_name)
860 return;
861 read_branch_desc(&desc, branch_name);
862 if (desc.len) {
863 strbuf_addch(buf, '\n');
864 strbuf_add(buf, desc.buf, desc.len);
865 strbuf_addch(buf, '\n');
866 }
867}
868
d7ddad01
FC
869static char *find_branch_name(struct rev_info *rev)
870{
871 int i, positive = -1;
872 unsigned char branch_sha1[20];
873 const unsigned char *tip_sha1;
874 const char *ref;
875 char *full_ref, *branch = NULL;
876
877 for (i = 0; i < rev->cmdline.nr; i++) {
878 if (rev->cmdline.rev[i].flags & UNINTERESTING)
879 continue;
880 if (positive < 0)
881 positive = i;
882 else
883 return NULL;
884 }
885 if (positive < 0)
886 return NULL;
887 ref = rev->cmdline.rev[positive].name;
888 tip_sha1 = rev->cmdline.rev[positive].item->sha1;
889 if (dwim_ref(ref, strlen(ref), branch_sha1, &full_ref) &&
59556548 890 starts_with(full_ref, "refs/heads/") &&
d7ddad01
FC
891 !hashcmp(tip_sha1, branch_sha1))
892 branch = xstrdup(full_ref + strlen("refs/heads/"));
893 free(full_ref);
894 return branch;
895}
896
2bda2cf4 897static void make_cover_letter(struct rev_info *rev, int use_stdout,
2bda2cf4 898 struct commit *origin,
d7ddad01 899 int nr, struct commit **list,
739453a3 900 const char *branch_name,
250087f2 901 int quiet)
a5a27c79
DB
902{
903 const char *committer;
a5a27c79
DB
904 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
905 const char *msg;
2bda2cf4 906 struct shortlog log;
f285a2d7 907 struct strbuf sb = STRBUF_INIT;
2bda2cf4 908 int i;
330db18c 909 const char *encoding = "UTF-8";
39fe578b 910 struct diff_options opts;
267123b4 911 int need_8bit_cte = 0;
6bf13944 912 struct pretty_print_context pp = {0};
d7ddad01 913 struct commit *head = list[0];
a5a27c79
DB
914
915 if (rev->commit_format != CMIT_FMT_EMAIL)
5c5f1d7c 916 die(_("Cover letter needs email format"));
a5a27c79 917
cd2ef591 918 committer = git_committer_info(0);
6df514af 919
a21c2f94 920 if (!use_stdout &&
ce37596c 921 reopen_stdout(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
a5a27c79
DB
922 return;
923
6bf13944 924 log_write_email_headers(rev, head, &pp.subject, &pp.after_subject,
267123b4 925 &need_8bit_cte);
a5a27c79 926
0a7f4483
JS
927 for (i = 0; !need_8bit_cte && i < nr; i++)
928 if (has_non_ascii(list[i]->buffer))
929 need_8bit_cte = 1;
930
d7ddad01
FC
931 if (!branch_name)
932 branch_name = find_branch_name(rev);
933
a5a27c79 934 msg = body;
6bf13944
JK
935 pp.fmt = CMIT_FMT_EMAIL;
936 pp.date_mode = DATE_RFC2822;
937 pp_user_info(&pp, NULL, &sb, committer, encoding);
938 pp_title_line(&pp, &msg, &sb, encoding, need_8bit_cte);
939 pp_remainder(&pp, &msg, &sb, 0);
739453a3 940 add_branch_description(&sb, branch_name);
a5a27c79
DB
941 printf("%s\n", sb.buf);
942
943 strbuf_release(&sb);
944
2bda2cf4 945 shortlog_init(&log);
859c4fbe
JS
946 log.wrap_lines = 1;
947 log.wrap = 72;
948 log.in1 = 2;
949 log.in2 = 4;
2bda2cf4
DB
950 for (i = 0; i < nr; i++)
951 shortlog_add_commit(&log, list[i]);
952
953 shortlog_output(&log);
954
a5a27c79 955 /*
2bda2cf4 956 * We can only do diffstat with a unique reference point
a5a27c79
DB
957 */
958 if (!origin)
959 return;
960
5d02294c
JS
961 memcpy(&opts, &rev->diffopt, sizeof(opts));
962 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
a5a27c79 963
39fe578b
DB
964 diff_setup_done(&opts);
965
966 diff_tree_sha1(origin->tree->object.sha1,
967 head->tree->object.sha1,
968 "", &opts);
969 diffcore_std(&opts);
970 diff_flush(&opts);
a5a27c79 971
a5a27c79 972 printf("\n");
6622d9c7 973 print_signature();
d1566f78
JT
974}
975
8419d2ee
JH
976static const char *clean_message_id(const char *msg_id)
977{
978 char ch;
979 const char *a, *z, *m;
8419d2ee
JH
980
981 m = msg_id;
982 while ((ch = *m) && (isspace(ch) || (ch == '<')))
983 m++;
984 a = m;
985 z = NULL;
986 while ((ch = *m)) {
987 if (!isspace(ch) && (ch != '>'))
988 z = m;
989 m++;
990 }
991 if (!z)
5c5f1d7c 992 die(_("insane in-reply-to: %s"), msg_id);
8419d2ee
JH
993 if (++z == m)
994 return a;
182af834 995 return xmemdupz(a, z - a);
8419d2ee
JH
996}
997
9800a754
JH
998static const char *set_outdir(const char *prefix, const char *output_directory)
999{
1000 if (output_directory && is_absolute_path(output_directory))
1001 return output_directory;
1002
1003 if (!prefix || !*prefix) {
1004 if (output_directory)
1005 return output_directory;
1006 /* The user did not explicitly ask for "./" */
1007 outdir_offset = 2;
1008 return "./";
1009 }
1010
1011 outdir_offset = strlen(prefix);
1012 if (!output_directory)
1013 return prefix;
1014
1015 return xstrdup(prefix_filename(prefix, outdir_offset,
1016 output_directory));
1017}
1018
fff02ee6 1019static const char * const builtin_format_patch_usage[] = {
61007a58 1020 N_("git format-patch [options] [<since> | <revision range>]"),
fff02ee6
SB
1021 NULL
1022};
1023
1024static int keep_subject = 0;
1025
1026static int keep_callback(const struct option *opt, const char *arg, int unset)
1027{
1028 ((struct rev_info *)opt->value)->total = -1;
1029 keep_subject = 1;
1030 return 0;
1031}
1032
1033static int subject_prefix = 0;
1034
1035static int subject_prefix_callback(const struct option *opt, const char *arg,
1036 int unset)
1037{
1038 subject_prefix = 1;
1039 ((struct rev_info *)opt->value)->subject_prefix = arg;
1040 return 0;
1041}
1042
1af4731b
JH
1043static int numbered_cmdline_opt = 0;
1044
fff02ee6
SB
1045static int numbered_callback(const struct option *opt, const char *arg,
1046 int unset)
1047{
1af4731b 1048 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
fff02ee6
SB
1049 if (unset)
1050 auto_number = 0;
1051 return 0;
1052}
1053
1054static int no_numbered_callback(const struct option *opt, const char *arg,
1055 int unset)
1056{
1057 return numbered_callback(opt, arg, 1);
1058}
1059
1060static int output_directory_callback(const struct option *opt, const char *arg,
1061 int unset)
1062{
1063 const char **dir = (const char **)opt->value;
1064 if (*dir)
5c5f1d7c 1065 die(_("Two output directories?"));
fff02ee6
SB
1066 *dir = arg;
1067 return 0;
1068}
1069
1070static int thread_callback(const struct option *opt, const char *arg, int unset)
1071{
1072 int *thread = (int *)opt->value;
1073 if (unset)
1074 *thread = 0;
1075 else if (!arg || !strcmp(arg, "shallow"))
1076 *thread = THREAD_SHALLOW;
1077 else if (!strcmp(arg, "deep"))
1078 *thread = THREAD_DEEP;
1079 else
1080 return 1;
1081 return 0;
1082}
1083
1084static int attach_callback(const struct option *opt, const char *arg, int unset)
1085{
1086 struct rev_info *rev = (struct rev_info *)opt->value;
1087 if (unset)
1088 rev->mime_boundary = NULL;
1089 else if (arg)
1090 rev->mime_boundary = arg;
1091 else
1092 rev->mime_boundary = git_version_string;
1093 rev->no_inline = unset ? 0 : 1;
1094 return 0;
1095}
1096
1097static int inline_callback(const struct option *opt, const char *arg, int unset)
1098{
1099 struct rev_info *rev = (struct rev_info *)opt->value;
1100 if (unset)
1101 rev->mime_boundary = NULL;
1102 else if (arg)
1103 rev->mime_boundary = arg;
1104 else
1105 rev->mime_boundary = git_version_string;
1106 rev->no_inline = 0;
1107 return 0;
1108}
1109
1110static int header_callback(const struct option *opt, const char *arg, int unset)
1111{
c4260034
SB
1112 if (unset) {
1113 string_list_clear(&extra_hdr, 0);
1114 string_list_clear(&extra_to, 0);
1115 string_list_clear(&extra_cc, 0);
1116 } else {
1117 add_header(arg);
1118 }
fff02ee6
SB
1119 return 0;
1120}
1121
ae6c098f
SD
1122static int to_callback(const struct option *opt, const char *arg, int unset)
1123{
c4260034
SB
1124 if (unset)
1125 string_list_clear(&extra_to, 0);
1126 else
1d2f80fa 1127 string_list_append(&extra_to, arg);
fff02ee6
SB
1128 return 0;
1129}
1130
1131static int cc_callback(const struct option *opt, const char *arg, int unset)
1132{
c4260034
SB
1133 if (unset)
1134 string_list_clear(&extra_cc, 0);
1135 else
1d2f80fa 1136 string_list_append(&extra_cc, arg);
fff02ee6
SB
1137 return 0;
1138}
1139
a9080475
JK
1140static int from_callback(const struct option *opt, const char *arg, int unset)
1141{
1142 char **from = opt->value;
1143
1144 free(*from);
1145
1146 if (unset)
1147 *from = NULL;
1148 else if (arg)
1149 *from = xstrdup(arg);
1150 else
1151 *from = xstrdup(git_committer_info(IDENT_NO_DATE));
1152 return 0;
1153}
1154
a633fca0 1155int cmd_format_patch(int argc, const char **argv, const char *prefix)
91efcf60
JH
1156{
1157 struct commit *commit;
1158 struct commit **list = NULL;
1159 struct rev_info rev;
32962c9b 1160 struct setup_revision_opt s_r_opt;
fff02ee6 1161 int nr = 0, total, i;
0377db77 1162 int use_stdout = 0;
fa0f02df 1163 int start_number = -1;
ce37596c 1164 int just_numbers = 0;
9c6efa36 1165 int ignore_if_in_upstream = 0;
2a4c2607 1166 int cover_letter = -1;
2bda2cf4 1167 int boundary_count = 0;
37c22a4b 1168 int no_binary_diff = 0;
d7ddad01 1169 struct commit *origin = NULL;
76af0734 1170 const char *in_reply_to = NULL;
5d23e133 1171 struct patch_ids ids;
f285a2d7 1172 struct strbuf buf = STRBUF_INIT;
1d46f2ea 1173 int use_patch_format = 0;
250087f2 1174 int quiet = 0;
5fe10fe8 1175 int reroll_count = -1;
739453a3 1176 char *branch_name = NULL;
a9080475 1177 char *from = NULL;
fff02ee6
SB
1178 const struct option builtin_format_patch_options[] = {
1179 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
61007a58 1180 N_("use [PATCH n/m] even with a single patch"),
fff02ee6
SB
1181 PARSE_OPT_NOARG, numbered_callback },
1182 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
61007a58 1183 N_("use [PATCH] even with multiple patches"),
fff02ee6 1184 PARSE_OPT_NOARG, no_numbered_callback },
aa089cd9
FC
1185 OPT_BOOL('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
1186 OPT_BOOL(0, "stdout", &use_stdout,
61007a58 1187 N_("print patches to standard out")),
aa089cd9 1188 OPT_BOOL(0, "cover-letter", &cover_letter,
61007a58 1189 N_("generate a cover letter")),
aa089cd9 1190 OPT_BOOL(0, "numbered-files", &just_numbers,
61007a58
NTND
1191 N_("use simple number sequence for output file names")),
1192 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1193 N_("use <sfx> instead of '.patch'")),
fff02ee6 1194 OPT_INTEGER(0, "start-number", &start_number,
61007a58 1195 N_("start numbering patches at <n> instead of 1")),
7952ea66 1196 OPT_INTEGER('v', "reroll-count", &reroll_count,
5fe10fe8 1197 N_("mark the series as Nth re-roll")),
61007a58
NTND
1198 { OPTION_CALLBACK, 0, "subject-prefix", &rev, N_("prefix"),
1199 N_("Use [<prefix>] instead of [PATCH]"),
fff02ee6
SB
1200 PARSE_OPT_NONEG, subject_prefix_callback },
1201 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
61007a58 1202 N_("dir"), N_("store resulting files in <dir>"),
fff02ee6
SB
1203 PARSE_OPT_NONEG, output_directory_callback },
1204 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
61007a58 1205 N_("don't strip/add [PATCH]"),
fff02ee6 1206 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
d5d09d47
SB
1207 OPT_BOOL(0, "no-binary", &no_binary_diff,
1208 N_("don't output binary diffs")),
1209 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1210 N_("don't include a patch matching a commit upstream")),
4741edd5 1211 { OPTION_SET_INT, 'p', "no-stat", &use_patch_format, NULL,
61007a58 1212 N_("show patch format instead of default (patch + stat)"),
4741edd5 1213 PARSE_OPT_NONEG | PARSE_OPT_NOARG, NULL, 1},
61007a58
NTND
1214 OPT_GROUP(N_("Messaging")),
1215 { OPTION_CALLBACK, 0, "add-header", NULL, N_("header"),
1216 N_("add email header"), 0, header_callback },
1217 { OPTION_CALLBACK, 0, "to", NULL, N_("email"), N_("add To: header"),
c4260034 1218 0, to_callback },
61007a58 1219 { OPTION_CALLBACK, 0, "cc", NULL, N_("email"), N_("add Cc: header"),
c4260034 1220 0, cc_callback },
a9080475
JK
1221 { OPTION_CALLBACK, 0, "from", &from, N_("ident"),
1222 N_("set From address to <ident> (or committer ident if absent)"),
1223 PARSE_OPT_OPTARG, from_callback },
61007a58
NTND
1224 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1225 N_("make first mail a reply to <message-id>")),
1226 { OPTION_CALLBACK, 0, "attach", &rev, N_("boundary"),
1227 N_("attach the patch"), PARSE_OPT_OPTARG,
fff02ee6 1228 attach_callback },
61007a58
NTND
1229 { OPTION_CALLBACK, 0, "inline", &rev, N_("boundary"),
1230 N_("inline the patch"),
fff02ee6
SB
1231 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1232 inline_callback },
61007a58
NTND
1233 { OPTION_CALLBACK, 0, "thread", &thread, N_("style"),
1234 N_("enable message threading, styles: shallow, deep"),
fff02ee6 1235 PARSE_OPT_OPTARG, thread_callback },
61007a58
NTND
1236 OPT_STRING(0, "signature", &signature, N_("signature"),
1237 N_("add a signature")),
b7df098c 1238 OPT__QUIET(&quiet, N_("don't print the patch filenames")),
fff02ee6
SB
1239 OPT_END()
1240 };
91efcf60 1241
ca9e0a1b
SB
1242 extra_hdr.strdup_strings = 1;
1243 extra_to.strdup_strings = 1;
1244 extra_cc.strdup_strings = 1;
0657bcbf 1245 init_grep_defaults();
ef90d6d4 1246 git_config(git_format_config, NULL);
db6296a5 1247 init_revisions(&rev, prefix);
91efcf60
JH
1248 rev.commit_format = CMIT_FMT_EMAIL;
1249 rev.verbose_header = 1;
1250 rev.diff = 1;
ad5aeede 1251 rev.max_parents = 1;
8f67f8ae 1252 DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
dbd21447 1253 rev.subject_prefix = fmt_patch_subject_prefix;
32962c9b
JH
1254 memset(&s_r_opt, 0, sizeof(s_r_opt));
1255 s_r_opt.def = "HEAD";
d5f6b1d7 1256 s_r_opt.revarg_opt = REVARG_COMMITTISH;
20ff0680 1257
0db5260b
JW
1258 if (default_attach) {
1259 rev.mime_boundary = default_attach;
1260 rev.no_inline = 1;
1261 }
1262
2448482b
JS
1263 /*
1264 * Parse the arguments before setup_revisions(), or something
2dc189a3 1265 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
2448482b
JS
1266 * possibly a valid SHA1.
1267 */
37782920 1268 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
fff02ee6 1269 builtin_format_patch_usage,
382da402
FC
1270 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1271 PARSE_OPT_KEEP_DASHDASH);
2448482b 1272
5fe10fe8
JH
1273 if (0 < reroll_count) {
1274 struct strbuf sprefix = STRBUF_INIT;
1275 strbuf_addf(&sprefix, "%s v%d",
1276 rev.subject_prefix, reroll_count);
1277 rev.reroll_count = reroll_count;
1278 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1279 }
1280
ca9e0a1b
SB
1281 for (i = 0; i < extra_hdr.nr; i++) {
1282 strbuf_addstr(&buf, extra_hdr.items[i].string);
3ee79d9f
DB
1283 strbuf_addch(&buf, '\n');
1284 }
1285
ca9e0a1b 1286 if (extra_to.nr)
3ee79d9f 1287 strbuf_addstr(&buf, "To: ");
ca9e0a1b 1288 for (i = 0; i < extra_to.nr; i++) {
3ee79d9f
DB
1289 if (i)
1290 strbuf_addstr(&buf, " ");
ca9e0a1b
SB
1291 strbuf_addstr(&buf, extra_to.items[i].string);
1292 if (i + 1 < extra_to.nr)
3ee79d9f
DB
1293 strbuf_addch(&buf, ',');
1294 strbuf_addch(&buf, '\n');
1295 }
1296
ca9e0a1b 1297 if (extra_cc.nr)
3ee79d9f 1298 strbuf_addstr(&buf, "Cc: ");
ca9e0a1b 1299 for (i = 0; i < extra_cc.nr; i++) {
3ee79d9f
DB
1300 if (i)
1301 strbuf_addstr(&buf, " ");
ca9e0a1b
SB
1302 strbuf_addstr(&buf, extra_cc.items[i].string);
1303 if (i + 1 < extra_cc.nr)
3ee79d9f
DB
1304 strbuf_addch(&buf, ',');
1305 strbuf_addch(&buf, '\n');
1306 }
1307
2af202be 1308 rev.extra_headers = strbuf_detach(&buf, NULL);
3ee79d9f 1309
a9080475
JK
1310 if (from) {
1311 if (split_ident_line(&rev.from_ident, from, strlen(from)))
1312 die(_("invalid ident line: %s"), from);
1313 }
1314
add5c8a5 1315 if (start_number < 0)
fa0f02df 1316 start_number = 1;
ca6b91d2
JM
1317
1318 /*
1319 * If numbered is set solely due to format.numbered in config,
1320 * and it would conflict with --keep-subject (-k) from the
1321 * command line, reset "numbered".
1322 */
1323 if (numbered && keep_subject && !numbered_cmdline_opt)
1324 numbered = 0;
1325
63b398a4 1326 if (numbered && keep_subject)
5c5f1d7c 1327 die (_("-n and -k are mutually exclusive."));
2d9e4a47 1328 if (keep_subject && subject_prefix)
5c5f1d7c 1329 die (_("--subject-prefix and -k are mutually exclusive."));
9553d2b2 1330 rev.preserve_subject = keep_subject;
8ac80a57 1331
32962c9b 1332 argc = setup_revisions(argc, argv, &rev, &s_r_opt);
2448482b 1333 if (argc > 1)
5c5f1d7c 1334 die (_("unrecognized argument: %s"), argv[1]);
0377db77 1335
02bc5b03 1336 if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
f338cb83 1337 die(_("--name-only does not make sense"));
02bc5b03 1338 if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
f338cb83 1339 die(_("--name-status does not make sense"));
02bc5b03 1340 if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
f338cb83 1341 die(_("--check does not make sense"));
02bc5b03
BG
1342
1343 if (!use_patch_format &&
1344 (!rev.diffopt.output_format ||
1345 rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1346 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1347
1348 /* Always generate a patch */
1349 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
c9b5ef99 1350
37c22a4b 1351 if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
8f67f8ae 1352 DIFF_OPT_SET(&rev.diffopt, BINARY);
e47f306d 1353
894a9d33
TR
1354 if (rev.show_notes)
1355 init_display_notes(&rev.notes_opt);
1356
9800a754
JH
1357 if (!use_stdout)
1358 output_directory = set_outdir(prefix, output_directory);
38a94bb6
TRC
1359 else
1360 setup_pager();
77e565d8 1361
efd02016
JH
1362 if (output_directory) {
1363 if (use_stdout)
5c5f1d7c 1364 die(_("standard output, or directory, which one?"));
efd02016 1365 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
5c5f1d7c 1366 die_errno(_("Could not create directory '%s'"),
0721c314 1367 output_directory);
efd02016
JH
1368 }
1369
1f1e895f 1370 if (rev.pending.nr == 1) {
427a8ec5
FC
1371 int check_head = 0;
1372
8a1d076e
JH
1373 if (rev.max_count < 0 && !rev.show_root_diff) {
1374 /*
1375 * This is traditional behaviour of "git format-patch
1376 * origin" that prepares what the origin side still
1377 * does not have.
1378 */
7c496280 1379 rev.pending.objects[0].item->flags |= UNINTERESTING;
3384a2df 1380 add_head_to_pending(&rev);
427a8ec5 1381 check_head = 1;
7c496280 1382 }
8a1d076e
JH
1383 /*
1384 * Otherwise, it is "format-patch -22 HEAD", and/or
1385 * "format-patch --root HEAD". The user wants
1386 * get_revision() to do the usual traversal.
7c496280 1387 */
427a8ec5
FC
1388
1389 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
1390 check_head = 1;
1391
1392 if (check_head) {
1393 unsigned char sha1[20];
1394 const char *ref;
1395 ref = resolve_ref_unsafe("HEAD", sha1, 1, NULL);
59556548 1396 if (ref && starts_with(ref, "refs/heads/"))
427a8ec5
FC
1397 branch_name = xstrdup(ref + strlen("refs/heads/"));
1398 else
1399 branch_name = xstrdup(""); /* no branch */
1400 }
e686eb98 1401 }
68c2ec7f
JH
1402
1403 /*
1404 * We cannot move this anywhere earlier because we do want to
9517e6b8 1405 * know if --root was given explicitly from the command line.
68c2ec7f
JH
1406 */
1407 rev.show_root_diff = 1;
1408
657ab61e
KB
1409 if (ignore_if_in_upstream) {
1410 /* Don't say anything if head and upstream are the same. */
1411 if (rev.pending.nr == 2) {
1412 struct object_array_entry *o = rev.pending.objects;
1413 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1414 return 0;
1415 }
811929f1 1416 get_patch_ids(&rev, &ids);
657ab61e 1417 }
9c6efa36 1418
81f3a188 1419 if (!use_stdout)
f5788250 1420 realstdout = xfdopen(xdup(1), "w");
81f3a188 1421
3d51e1b5 1422 if (prepare_revision_walk(&rev))
5c5f1d7c 1423 die(_("revision walk setup failed"));
2bda2cf4 1424 rev.boundary = 1;
91efcf60 1425 while ((commit = get_revision(&rev)) != NULL) {
2bda2cf4 1426 if (commit->object.flags & BOUNDARY) {
2bda2cf4
DB
1427 boundary_count++;
1428 origin = (boundary_count == 1) ? commit : NULL;
1429 continue;
1430 }
1431
9c6efa36 1432 if (ignore_if_in_upstream &&
5d23e133 1433 has_commit_patch_id(commit, &ids))
9c6efa36
JS
1434 continue;
1435
91efcf60 1436 nr++;
83572c1a 1437 list = xrealloc(list, nr * sizeof(list[0]));
91efcf60
JH
1438 list[nr - 1] = commit;
1439 }
80d35ca0
FC
1440 if (nr == 0)
1441 /* nothing to do */
1442 return 0;
0377db77 1443 total = nr;
49604a4d
BG
1444 if (!keep_subject && auto_number && total > 1)
1445 numbered = 1;
596524b3 1446 if (numbered)
fa0f02df 1447 rev.total = total + start_number - 1;
2a4c2607
FC
1448 if (cover_letter == -1) {
1449 if (config_cover_letter == COVER_AUTO)
1450 cover_letter = (total > 1);
1451 else
1452 cover_letter = (config_cover_letter == COVER_ON);
1453 }
1454
b079c50e
TR
1455 if (in_reply_to || thread || cover_letter)
1456 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1457 if (in_reply_to) {
1458 const char *msgid = clean_message_id(in_reply_to);
1d2f80fa 1459 string_list_append(rev.ref_message_ids, msgid);
b079c50e 1460 }
ce37596c 1461 rev.numbered_files = just_numbers;
108dab28 1462 rev.patch_suffix = fmt_patch_suffix;
a5a27c79
DB
1463 if (cover_letter) {
1464 if (thread)
1465 gen_message_id(&rev, "cover");
ce37596c 1466 make_cover_letter(&rev, use_stdout,
d7ddad01 1467 origin, nr, list, branch_name, quiet);
a5a27c79
DB
1468 total++;
1469 start_number--;
1470 }
5289c56a 1471 rev.add_signoff = do_signoff;
91efcf60
JH
1472 while (0 <= --nr) {
1473 int shown;
1474 commit = list[nr];
add5c8a5 1475 rev.nr = total - nr + (start_number - 1);
d1566f78 1476 /* Make the second and subsequent mails replies to the first */
cc35de84 1477 if (thread) {
a5a27c79 1478 /* Have we already had a message ID? */
e1a37346 1479 if (rev.message_id) {
a5a27c79 1480 /*
30984ed2
TR
1481 * For deep threading: make every mail
1482 * a reply to the previous one, no
1483 * matter what other options are set.
1484 *
1485 * For shallow threading:
1486 *
2175c10d
TR
1487 * Without --cover-letter and
1488 * --in-reply-to, make every mail a
1489 * reply to the one before.
1490 *
1491 * With --in-reply-to but no
1492 * --cover-letter, make every mail a
1493 * reply to the <reply-to>.
1494 *
1495 * With --cover-letter, make every
1496 * mail but the cover letter a reply
1497 * to the cover letter. The cover
1498 * letter is a reply to the
1499 * --in-reply-to, if specified.
a5a27c79 1500 */
30984ed2
TR
1501 if (thread == THREAD_SHALLOW
1502 && rev.ref_message_ids->nr > 0
2175c10d 1503 && (!cover_letter || rev.nr > 1))
e1a37346
DB
1504 free(rev.message_id);
1505 else
1d2f80fa
JP
1506 string_list_append(rev.ref_message_ids,
1507 rev.message_id);
cc35de84 1508 }
e1a37346 1509 gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
d1566f78 1510 }
6df514af 1511
a21c2f94 1512 if (!use_stdout &&
ce37596c 1513 reopen_stdout(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
5c5f1d7c 1514 die(_("Failed to create output files"));
91efcf60
JH
1515 shown = log_tree_commit(&rev, commit);
1516 free(commit->buffer);
1517 commit->buffer = NULL;
add5c8a5
JH
1518
1519 /* We put one extra blank line between formatted
1520 * patches and this flag is used by log-tree code
1521 * to see if it needs to emit a LF before showing
1522 * the log; when using one file per patch, we do
1523 * not want the extra blank line.
1524 */
1525 if (!use_stdout)
1526 rev.shown_one = 0;
698ce6f8
JS
1527 if (shown) {
1528 if (rev.mime_boundary)
1529 printf("\n--%s%s--\n\n\n",
1530 mime_boundary_leader,
1531 rev.mime_boundary);
1532 else
6622d9c7 1533 print_signature();
698ce6f8 1534 }
0377db77
JS
1535 if (!use_stdout)
1536 fclose(stdout);
91efcf60
JH
1537 }
1538 free(list);
739453a3 1539 free(branch_name);
ca9e0a1b
SB
1540 string_list_clear(&extra_to, 0);
1541 string_list_clear(&extra_cc, 0);
1542 string_list_clear(&extra_hdr, 0);
5d23e133
JH
1543 if (ignore_if_in_upstream)
1544 free_patch_ids(&ids);
91efcf60
JH
1545 return 0;
1546}
1547
e827633a
RS
1548static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1549{
1550 unsigned char sha1[20];
1551 if (get_sha1(arg, sha1) == 0) {
1552 struct commit *commit = lookup_commit_reference(sha1);
1553 if (commit) {
1554 commit->object.flags |= flags;
1555 add_pending_object(revs, &commit->object, arg);
1556 return 0;
1557 }
1558 }
1559 return -1;
1560}
1561
28a53178 1562static const char * const cherry_usage[] = {
986d1bb8 1563 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
28a53178
EFL
1564 NULL
1565};
1566
a3a32e7f
JN
1567static void print_commit(char sign, struct commit *commit, int verbose,
1568 int abbrev)
1569{
1570 if (!verbose) {
1571 printf("%c %s\n", sign,
1572 find_unique_abbrev(commit->object.sha1, abbrev));
1573 } else {
1574 struct strbuf buf = STRBUF_INIT;
f67d2e82 1575 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
a3a32e7f
JN
1576 printf("%c %s %s\n", sign,
1577 find_unique_abbrev(commit->object.sha1, abbrev),
1578 buf.buf);
1579 strbuf_release(&buf);
1580 }
1581}
1582
e827633a
RS
1583int cmd_cherry(int argc, const char **argv, const char *prefix)
1584{
1585 struct rev_info revs;
5d23e133 1586 struct patch_ids ids;
e827633a
RS
1587 struct commit *commit;
1588 struct commit_list *list = NULL;
f2968022 1589 struct branch *current_branch;
e827633a
RS
1590 const char *upstream;
1591 const char *head = "HEAD";
1592 const char *limit = NULL;
28a53178 1593 int verbose = 0, abbrev = 0;
e827633a 1594
28a53178
EFL
1595 struct option options[] = {
1596 OPT__ABBREV(&abbrev),
986d1bb8 1597 OPT__VERBOSE(&verbose, N_("be verbose")),
28a53178
EFL
1598 OPT_END()
1599 };
e827633a 1600
28a53178 1601 argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
fef34270 1602
e827633a 1603 switch (argc) {
e827633a 1604 case 3:
28a53178 1605 limit = argv[2];
e827633a
RS
1606 /* FALLTHROUGH */
1607 case 2:
28a53178
EFL
1608 head = argv[1];
1609 /* FALLTHROUGH */
1610 case 1:
1611 upstream = argv[0];
e827633a
RS
1612 break;
1613 default:
f2968022
MH
1614 current_branch = branch_get(NULL);
1615 if (!current_branch || !current_branch->merge
1616 || !current_branch->merge[0]
1617 || !current_branch->merge[0]->dst) {
5c5f1d7c 1618 fprintf(stderr, _("Could not find a tracked"
f2968022 1619 " remote branch, please"
5c5f1d7c 1620 " specify <upstream> manually.\n"));
28a53178 1621 usage_with_options(cherry_usage, options);
f2968022
MH
1622 }
1623
1624 upstream = current_branch->merge[0]->dst;
e827633a
RS
1625 }
1626
1627 init_revisions(&revs, prefix);
51f4de3a 1628 revs.max_parents = 1;
e827633a
RS
1629
1630 if (add_pending_commit(head, &revs, 0))
5c5f1d7c 1631 die(_("Unknown commit %s"), head);
e827633a 1632 if (add_pending_commit(upstream, &revs, UNINTERESTING))
5c5f1d7c 1633 die(_("Unknown commit %s"), upstream);
e827633a
RS
1634
1635 /* Don't say anything if head and upstream are the same. */
1636 if (revs.pending.nr == 2) {
1637 struct object_array_entry *o = revs.pending.objects;
1638 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1639 return 0;
1640 }
1641
811929f1 1642 get_patch_ids(&revs, &ids);
e827633a
RS
1643
1644 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
5c5f1d7c 1645 die(_("Unknown commit %s"), limit);
e827633a
RS
1646
1647 /* reverse the list of commits */
3d51e1b5 1648 if (prepare_revision_walk(&revs))
5c5f1d7c 1649 die(_("revision walk setup failed"));
e827633a 1650 while ((commit = get_revision(&revs)) != NULL) {
e827633a
RS
1651 commit_list_insert(commit, &list);
1652 }
1653
1654 while (list) {
e827633a
RS
1655 char sign = '+';
1656
1657 commit = list->item;
5d23e133 1658 if (has_commit_patch_id(commit, &ids))
e827633a 1659 sign = '-';
a3a32e7f 1660 print_commit(sign, commit, verbose, abbrev);
e827633a
RS
1661 list = list->next;
1662 }
1663
5d23e133 1664 free_patch_ids(&ids);
e827633a
RS
1665 return 0;
1666}