tree.c: make read_tree*() take 'struct repository *'
[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"
b2141fc1 8#include "config.h"
fb58c8d5 9#include "refs.h"
cbd53a21 10#include "object-store.h"
6b2f2d98 11#include "color.h"
70827b15
LT
12#include "commit.h"
13#include "diff.h"
14#include "revision.h"
15#include "log-tree.h"
91efcf60 16#include "builtin.h"
5d7eeee2 17#include "tag.h"
cf39f54e 18#include "reflog-walk.h"
5d23e133 19#include "patch-ids.h"
a5a27c79 20#include "run-command.h"
2bda2cf4 21#include "shortlog.h"
f2968022 22#include "remote.h"
b079c50e 23#include "string-list.h"
fff02ee6 24#include "parse-options.h"
12da1d1f 25#include "line-log.h"
739453a3 26#include "branch.h"
74775a09 27#include "streaming.h"
816fb46b 28#include "version.h"
ea57bc0d 29#include "mailmap.h"
6005dbb9 30#include "gpg-interface.h"
738e88a2 31#include "progress.h"
7b680d32 32#include "commit-slab.h"
109cd76d 33#include "repository.h"
64043556 34#include "commit-reach.h"
126facf8 35#include "interdiff.h"
31e2617a 36#include "range-diff.h"
70827b15 37
43662b23
NTND
38#define MAIL_DEFAULT_WRAP 72
39
dd0ffd5b
HO
40/* Set a default date-time format for git log ("log.date" config variable) */
41static const char *default_date_mode = NULL;
42
0c47695a 43static int default_abbrev_commit;
0f03ca94 44static int default_show_root = 1;
076c9837 45static int default_follow;
fce04c3c 46static int default_show_signature;
8a3d203b 47static int decoration_style;
1c40c36b 48static int decoration_given;
e6bb5f78 49static int use_mailmap_config;
d54276f2 50static const char *fmt_patch_subject_prefix = "PATCH";
94c22a5e 51static const char *fmt_pretty;
0f03ca94 52
1c40c36b 53static const char * const builtin_log_usage[] = {
ce41720c 54 N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
bb831db6 55 N_("git show [<options>] <object>..."),
1c40c36b
CMN
56 NULL
57};
1c370ea4 58
12da1d1f
TR
59struct line_opt_callback_data {
60 struct rev_info *rev;
61 const char *prefix;
62 struct string_list args;
63};
64
940a911f
AH
65static int auto_decoration_style(void)
66{
67 return (isatty(1) || pager_in_use()) ? DECORATE_SHORT_REFS : 0;
68}
69
f094b89a 70static int parse_decoration_style(const char *value)
8a3d203b 71{
89576613 72 switch (git_parse_maybe_bool(value)) {
8a3d203b
JH
73 case 1:
74 return DECORATE_SHORT_REFS;
75 case 0:
76 return 0;
77 default:
78 break;
79 }
80 if (!strcmp(value, "full"))
81 return DECORATE_FULL_REFS;
82 else if (!strcmp(value, "short"))
83 return DECORATE_SHORT_REFS;
15715866 84 else if (!strcmp(value, "auto"))
940a911f 85 return auto_decoration_style();
8a3d203b
JH
86 return -1;
87}
88
1c40c36b
CMN
89static int decorate_callback(const struct option *opt, const char *arg, int unset)
90{
91 if (unset)
92 decoration_style = 0;
93 else if (arg)
f094b89a 94 decoration_style = parse_decoration_style(arg);
1c40c36b
CMN
95 else
96 decoration_style = DECORATE_SHORT_REFS;
97
98 if (decoration_style < 0)
e4a590ef 99 die(_("invalid --decorate option: %s"), arg);
1c40c36b
CMN
100
101 decoration_given = 1;
102
103 return 0;
104}
105
12da1d1f
TR
106static int log_line_range_callback(const struct option *option, const char *arg, int unset)
107{
108 struct line_opt_callback_data *data = option->value;
109
517fe807
JK
110 BUG_ON_OPT_NEG(unset);
111
12da1d1f
TR
112 if (!arg)
113 return -1;
114
115 data->rev->line_level_traverse = 1;
116 string_list_append(&data->args, arg);
117
118 return 0;
119}
120
9501d191
MM
121static void init_log_defaults(void)
122{
38bbc2ea 123 init_grep_defaults(the_repository);
5404c116 124 init_diff_ui_defaults();
c74271aa 125
126 decoration_style = auto_decoration_style();
9501d191
MM
127}
128
ef803fd4 129static void cmd_log_init_defaults(struct rev_info *rev)
70827b15 130{
94c22a5e 131 if (fmt_pretty)
4da45bef 132 get_commit_format(fmt_pretty, rev);
076c9837 133 if (default_follow)
0d1e0e78 134 rev->diffopt.flags.default_follow_renames = 1;
70827b15 135 rev->verbose_header = 1;
0d1e0e78 136 rev->diffopt.flags.recursive = 1;
5e0ec15e 137 rev->diffopt.stat_width = -1; /* use full terminal width */
df44483a 138 rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
0c47695a 139 rev->abbrev_commit = default_abbrev_commit;
0f03ca94 140 rev->show_root_diff = default_show_root;
d54276f2 141 rev->subject_prefix = fmt_patch_subject_prefix;
fce04c3c 142 rev->show_signature = default_show_signature;
0d1e0e78 143 rev->diffopt.flags.allow_textconv = 1;
dd0ffd5b
HO
144
145 if (default_date_mode)
a5481a6c 146 parse_date_format(default_date_mode, &rev->date_mode);
ef803fd4 147}
dd0ffd5b 148
ef803fd4
MG
149static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
150 struct rev_info *rev, struct setup_revision_opt *opt)
151{
ef803fd4 152 struct userformat_want w;
ea57bc0d 153 int quiet = 0, source = 0, mailmap = 0;
12da1d1f 154 static struct line_opt_callback_data line_cb = {NULL, NULL, STRING_LIST_INIT_DUP};
65516f58
RA
155 static struct string_list decorate_refs_exclude = STRING_LIST_INIT_NODUP;
156 static struct string_list decorate_refs_include = STRING_LIST_INIT_NODUP;
157 struct decoration_filter decoration_filter = {&decorate_refs_include,
158 &decorate_refs_exclude};
87be2523 159 static struct revision_sources revision_sources;
1c40c36b
CMN
160
161 const struct option builtin_log_options[] = {
b7df098c 162 OPT__QUIET(&quiet, N_("suppress diff output")),
aa089cd9
FC
163 OPT_BOOL(0, "source", &source, N_("show source")),
164 OPT_BOOL(0, "use-mailmap", &mailmap, N_("Use mail map file")),
65516f58
RA
165 OPT_STRING_LIST(0, "decorate-refs", &decorate_refs_include,
166 N_("pattern"), N_("only decorate refs that match <pattern>")),
167 OPT_STRING_LIST(0, "decorate-refs-exclude", &decorate_refs_exclude,
168 N_("pattern"), N_("do not decorate refs that match <pattern>")),
e62cd35a 169 { OPTION_CALLBACK, 0, "decorate", NULL, NULL, N_("decorate options"),
1c40c36b 170 PARSE_OPT_OPTARG, decorate_callback},
12da1d1f 171 OPT_CALLBACK('L', NULL, &line_cb, "n,m:file",
e4a590ef 172 N_("Process line range n,m in file, counting from 1"),
12da1d1f 173 log_line_range_callback),
1c40c36b
CMN
174 OPT_END()
175 };
176
12da1d1f
TR
177 line_cb.rev = rev;
178 line_cb.prefix = prefix;
179
e6bb5f78 180 mailmap = use_mailmap_config;
1c40c36b
CMN
181 argc = parse_options(argc, argv, prefix,
182 builtin_log_options, builtin_log_usage,
183 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
184 PARSE_OPT_KEEP_DASHDASH);
52883fbd 185
01771a8e
JH
186 if (quiet)
187 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
f9c75d85 188 argc = setup_revisions(argc, argv, rev, opt);
dd0ffd5b 189
1c40c36b
CMN
190 /* Any arguments at this point are not recognized */
191 if (argc > 1)
e4a590ef 192 die(_("unrecognized argument: %s"), argv[1]);
1c40c36b 193
5b163603
JG
194 memset(&w, 0, sizeof(w));
195 userformat_find_requirements(NULL, &w);
196
197 if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
66b2ed09 198 rev->show_notes = 1;
894a9d33
TR
199 if (rev->show_notes)
200 init_display_notes(&rev->notes_opt);
66b2ed09 201
cf63051a
SB
202 if ((rev->diffopt.pickaxe_opts & DIFF_PICKAXE_KINDS_MASK) ||
203 rev->diffopt.filter || rev->diffopt.flags.follow_renames)
9dafea26 204 rev->always_show_header = 0;
1c40c36b 205
87be2523
NTND
206 if (source) {
207 init_revision_sources(&revision_sources);
208 rev->sources = &revision_sources;
209 }
635530a2 210
ea57bc0d
AP
211 if (mailmap) {
212 rev->mailmap = xcalloc(1, sizeof(struct string_list));
213 read_mailmap(rev->mailmap, NULL);
214 }
215
0c47695a
JS
216 if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
217 /*
218 * "log --pretty=raw" is special; ignore UI oriented
219 * configuration variables such as decoration.
220 */
221 if (!decoration_given)
222 decoration_style = 0;
223 if (!rev->abbrev_commit_given)
224 rev->abbrev_commit = 0;
225 }
635530a2 226
33e7018c
LH
227 if (decoration_style) {
228 rev->show_decorations = 1;
65516f58 229 load_ref_decorations(&decoration_filter, decoration_style);
33e7018c 230 }
12da1d1f
TR
231
232 if (rev->line_level_traverse)
233 line_log_init(rev, line_cb.prefix, &line_cb.args);
234
1fda91b5 235 setup_pager();
9dafea26
TH
236}
237
ef803fd4
MG
238static void cmd_log_init(int argc, const char **argv, const char *prefix,
239 struct rev_info *rev, struct setup_revision_opt *opt)
240{
241 cmd_log_init_defaults(rev);
242 cmd_log_init_finish(argc, argv, prefix, rev, opt);
243}
244
252a7c02
LT
245/*
246 * This gives a rough estimate for how many commits we
247 * will print out in the list.
248 */
249static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
250{
251 int n = 0;
252
253 while (list) {
254 struct commit *commit = list->item;
255 unsigned int flags = commit->object.flags;
252a7c02 256 list = list->next;
7dc0fe3b 257 if (!(flags & (TREESAME | UNINTERESTING)))
53b2c823 258 n++;
252a7c02
LT
259 }
260 return n;
261}
262
263static void show_early_header(struct rev_info *rev, const char *stage, int nr)
264{
265 if (rev->shown_one) {
266 rev->shown_one = 0;
267 if (rev->commit_format != CMIT_FMT_ONELINE)
268 putchar(rev->diffopt.line_termination);
269 }
95235f5b 270 fprintf(rev->diffopt.file, _("Final output: %d %s\n"), nr, stage);
252a7c02
LT
271}
272
2af202be 273static struct itimerval early_output_timer;
252a7c02 274
cdcefbc9
LT
275static void log_show_early(struct rev_info *revs, struct commit_list *list)
276{
6ea57703 277 int i = revs->early_output, close_file = revs->diffopt.close_file;
252a7c02 278 int show_header = 1;
cdcefbc9 279
6ea57703 280 revs->diffopt.close_file = 0;
08f704f2 281 sort_in_topological_order(&list, revs->sort_order);
cdcefbc9
LT
282 while (list && i) {
283 struct commit *commit = list->item;
252a7c02
LT
284 switch (simplify_commit(revs, commit)) {
285 case commit_show:
286 if (show_header) {
287 int n = estimate_commit_count(revs, list);
288 show_early_header(revs, "incomplete", n);
289 show_header = 0;
290 }
291 log_tree_commit(revs, commit);
292 i--;
293 break;
294 case commit_ignore:
295 break;
296 case commit_error:
6ea57703
JS
297 if (close_file)
298 fclose(revs->diffopt.file);
252a7c02
LT
299 return;
300 }
cdcefbc9 301 list = list->next;
cdcefbc9 302 }
252a7c02
LT
303
304 /* Did we already get enough commits for the early output? */
6ea57703
JS
305 if (!i) {
306 if (close_file)
307 fclose(revs->diffopt.file);
252a7c02 308 return;
6ea57703 309 }
252a7c02
LT
310
311 /*
312 * ..if no, then repeat it twice a second until we
313 * do.
314 *
315 * NOTE! We don't use "it_interval", because if the
316 * reader isn't listening, we want our output to be
317 * throttled by the writing, and not have the timer
318 * trigger every second even if we're blocked on a
319 * reader!
320 */
321 early_output_timer.it_value.tv_sec = 0;
322 early_output_timer.it_value.tv_usec = 500000;
323 setitimer(ITIMER_REAL, &early_output_timer, NULL);
cdcefbc9
LT
324}
325
326static void early_output(int signal)
327{
328 show_early_output = log_show_early;
329}
330
331static void setup_early_output(struct rev_info *rev)
332{
333 struct sigaction sa;
cdcefbc9
LT
334
335 /*
336 * Set up the signal handler, minimally intrusively:
337 * we only set a single volatile integer word (not
338 * using sigatomic_t - trying to avoid unnecessary
339 * system dependencies and headers), and using
340 * SA_RESTART.
341 */
342 memset(&sa, 0, sizeof(sa));
343 sa.sa_handler = early_output;
344 sigemptyset(&sa.sa_mask);
345 sa.sa_flags = SA_RESTART;
346 sigaction(SIGALRM, &sa, NULL);
347
348 /*
349 * If we can get the whole output in less than a
350 * tenth of a second, don't even bother doing the
351 * early-output thing..
352 *
353 * This is a one-time-only trigger.
354 */
252a7c02
LT
355 early_output_timer.it_value.tv_sec = 0;
356 early_output_timer.it_value.tv_usec = 100000;
357 setitimer(ITIMER_REAL, &early_output_timer, NULL);
cdcefbc9
LT
358}
359
360static void finish_early_output(struct rev_info *rev)
361{
252a7c02 362 int n = estimate_commit_count(rev, rev->commits);
cdcefbc9 363 signal(SIGALRM, SIG_IGN);
252a7c02 364 show_early_header(rev, "done", n);
cdcefbc9
LT
365}
366
9dafea26
TH
367static int cmd_log_walk(struct rev_info *rev)
368{
369 struct commit *commit;
f31027c9 370 int saved_nrl = 0;
6ea57703 371 int saved_dcctc = 0, close_file = rev->diffopt.close_file;
70827b15 372
cdcefbc9
LT
373 if (rev->early_output)
374 setup_early_output(rev);
375
3d51e1b5 376 if (prepare_revision_walk(rev))
5c5f1d7c 377 die(_("revision walk setup failed"));
cdcefbc9
LT
378
379 if (rev->early_output)
380 finish_early_output(rev);
381
036d17fe 382 /*
84102a33
PVM
383 * For --check and --exit-code, the exit code is based on CHECK_FAILED
384 * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
385 * retain that state information if replacing rev->diffopt in this loop
036d17fe 386 */
6ea57703 387 rev->diffopt.close_file = 0;
70827b15 388 while ((commit = get_revision(rev)) != NULL) {
3acf8dd8 389 if (!log_tree_commit(rev, commit) && rev->max_count >= 0)
251df09b
MM
390 /*
391 * We decremented max_count in get_revision,
392 * but we didn't actually show the commit.
393 */
394 rev->max_count++;
a6c73064 395 if (!rev->reflog_info) {
822601e8
JK
396 /*
397 * We may show a given commit multiple times when
398 * walking the reflogs.
399 */
0fb370da 400 free_commit_buffer(commit);
f35650df
JK
401 free_commit_list(commit->parents);
402 commit->parents = NULL;
a6c73064 403 }
f31027c9
JH
404 if (saved_nrl < rev->diffopt.needed_rename_limit)
405 saved_nrl = rev->diffopt.needed_rename_limit;
406 if (rev->diffopt.degraded_cc_to_c)
407 saved_dcctc = 1;
70827b15 408 }
f31027c9
JH
409 rev->diffopt.degraded_cc_to_c = saved_dcctc;
410 rev->diffopt.needed_rename_limit = saved_nrl;
6ea57703
JS
411 if (close_file)
412 fclose(rev->diffopt.file);
f31027c9 413
036d17fe 414 if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
0d1e0e78 415 rev->diffopt.flags.check_failed) {
036d17fe
PVM
416 return 02;
417 }
84102a33 418 return diff_result_code(&rev->diffopt, 0);
70827b15
LT
419}
420
ef90d6d4 421static int git_log_config(const char *var, const char *value, void *cb)
0f03ca94 422{
e3f1da98
RS
423 const char *slot_name;
424
94c22a5e
CR
425 if (!strcmp(var, "format.pretty"))
426 return git_config_string(&fmt_pretty, var, value);
70cff3ac
BH
427 if (!strcmp(var, "format.subjectprefix"))
428 return git_config_string(&fmt_patch_subject_prefix, var, value);
0c47695a
JS
429 if (!strcmp(var, "log.abbrevcommit")) {
430 default_abbrev_commit = git_config_bool(var, value);
431 return 0;
432 }
dd0ffd5b
HO
433 if (!strcmp(var, "log.date"))
434 return git_config_string(&default_date_mode, var, value);
eb734454 435 if (!strcmp(var, "log.decorate")) {
f094b89a 436 decoration_style = parse_decoration_style(value);
8a3d203b
JH
437 if (decoration_style < 0)
438 decoration_style = 0; /* maybe warn? */
eb734454
SD
439 return 0;
440 }
0f03ca94
PB
441 if (!strcmp(var, "log.showroot")) {
442 default_show_root = git_config_bool(var, value);
443 return 0;
444 }
076c9837
DT
445 if (!strcmp(var, "log.follow")) {
446 default_follow = git_config_bool(var, value);
447 return 0;
448 }
e3f1da98 449 if (skip_prefix(var, "color.decorate.", &slot_name))
b9465768 450 return parse_decorate_color_config(var, slot_name, value);
e6bb5f78
AP
451 if (!strcmp(var, "log.mailmap")) {
452 use_mailmap_config = git_config_bool(var, value);
453 return 0;
454 }
fce04c3c
MJ
455 if (!strcmp(var, "log.showsignature")) {
456 default_show_signature = git_config_bool(var, value);
457 return 0;
458 }
e6bb5f78 459
0657bcbf
JH
460 if (grep_config(var, value, cb) < 0)
461 return -1;
6005dbb9 462 if (git_gpg_config(var, value, cb) < 0)
0657bcbf 463 return -1;
ef90d6d4 464 return git_diff_ui_config(var, value, cb);
0f03ca94
PB
465}
466
a633fca0 467int cmd_whatchanged(int argc, const char **argv, const char *prefix)
70827b15
LT
468{
469 struct rev_info rev;
32962c9b 470 struct setup_revision_opt opt;
70827b15 471
9501d191 472 init_log_defaults();
ef90d6d4 473 git_config(git_log_config, NULL);
6b2f2d98 474
2abf3503 475 repo_init_revisions(the_repository, &rev, prefix);
70827b15 476 rev.diff = 1;
9202434c 477 rev.simplify_history = 0;
32962c9b
JH
478 memset(&opt, 0, sizeof(opt));
479 opt.def = "HEAD";
d5f6b1d7 480 opt.revarg_opt = REVARG_COMMITTISH;
32962c9b 481 cmd_log_init(argc, argv, prefix, &rev, &opt);
9dafea26
TH
482 if (!rev.diffopt.output_format)
483 rev.diffopt.output_format = DIFF_FORMAT_RAW;
484 return cmd_log_walk(&rev);
70827b15
LT
485}
486
56122ed8
JS
487static void show_tagger(char *buf, int len, struct rev_info *rev)
488{
ea718e65 489 struct strbuf out = STRBUF_INIT;
6bf13944 490 struct pretty_print_context pp = {0};
56122ed8 491
6bf13944
JK
492 pp.fmt = rev->commit_format;
493 pp.date_mode = rev->date_mode;
494 pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
95235f5b 495 fprintf(rev->diffopt.file, "%s", out.buf);
ea718e65 496 strbuf_release(&out);
56122ed8
JS
497}
498
d801627b 499static int show_blob_object(const struct object_id *oid, struct rev_info *rev, const char *obj_name)
74775a09 500{
d801627b 501 struct object_id oidc;
083b9931
MG
502 struct object_context obj_context;
503 char *buf;
504 unsigned long size;
505
95235f5b 506 fflush(rev->diffopt.file);
0d1e0e78
BW
507 if (!rev->diffopt.flags.textconv_set_via_cmdline ||
508 !rev->diffopt.flags.allow_textconv)
7eda0e4f 509 return stream_blob_to_fd(1, oid, NULL, 0);
083b9931 510
321c89bf 511 if (get_oid_with_context(obj_name, GET_OID_RECORD_PATH,
e82caf38 512 &oidc, &obj_context))
e4a590ef 513 die(_("Not a valid object name %s"), obj_name);
dc944b65 514 if (!obj_context.path ||
6afaf807
NTND
515 !textconv_object(the_repository, obj_context.path,
516 obj_context.mode, &oidc, 1, &buf, &size)) {
dc944b65 517 free(obj_context.path);
7eda0e4f 518 return stream_blob_to_fd(1, oid, NULL, 0);
dc944b65 519 }
083b9931
MG
520
521 if (!buf)
e4a590ef 522 die(_("git show %s: bad file"), obj_name);
083b9931
MG
523
524 write_or_die(1, buf, size);
dc944b65 525 free(obj_context.path);
083b9931 526 return 0;
74775a09
NTND
527}
528
d801627b 529static int show_tag_object(const struct object_id *oid, struct rev_info *rev)
5d7eeee2
JS
530{
531 unsigned long size;
21666f1a 532 enum object_type type;
b4f5aca4 533 char *buf = read_object_file(oid, &type, &size);
5d7eeee2
JS
534 int offset = 0;
535
536 if (!buf)
d801627b 537 return error(_("Could not read object %s"), oid_to_hex(oid));
5d7eeee2 538
74775a09
NTND
539 assert(type == OBJ_TAG);
540 while (offset < size && buf[offset] != '\n') {
541 int new_offset = offset + 1;
542 while (new_offset < size && buf[new_offset++] != '\n')
543 ; /* do nothing */
59556548 544 if (starts_with(buf + offset, "tagger "))
74775a09
NTND
545 show_tagger(buf + offset + 7,
546 new_offset - offset - 7, rev);
547 offset = new_offset;
548 }
5d7eeee2
JS
549
550 if (offset < size)
95235f5b 551 fwrite(buf + offset, size - offset, 1, rev->diffopt.file);
5d7eeee2
JS
552 free(buf);
553 return 0;
554}
555
df46d77e 556static int show_tree_object(const struct object_id *oid,
6a0b0b6d 557 struct strbuf *base,
671f0707 558 const char *pathname, unsigned mode, int stage, void *context)
5d7eeee2 559{
95235f5b
JS
560 FILE *file = context;
561 fprintf(file, "%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
5d7eeee2
JS
562 return 0;
563}
564
b130c706
JH
565static void show_setup_revisions_tweak(struct rev_info *rev,
566 struct setup_revision_opt *opt)
b4490059 567{
2bf65873
JH
568 if (rev->ignore_merges) {
569 /* There was no "-m" on the command line */
570 rev->ignore_merges = 0;
571 if (!rev->first_parent_only && !rev->combine_merges) {
01689909 572 /* No "--first-parent", "-c", or "--cc" */
2bf65873
JH
573 rev->combine_merges = 1;
574 rev->dense_combined_merges = 1;
575 }
576 }
b4490059
JH
577 if (!rev->diffopt.output_format)
578 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
579}
580
a633fca0 581int cmd_show(int argc, const char **argv, const char *prefix)
70827b15
LT
582{
583 struct rev_info rev;
5d7eeee2 584 struct object_array_entry *objects;
32962c9b 585 struct setup_revision_opt opt;
f0096c06 586 struct pathspec match_all;
5d7eeee2 587 int i, count, ret = 0;
70827b15 588
9501d191 589 init_log_defaults();
ef90d6d4 590 git_config(git_log_config, NULL);
6b2f2d98 591
9a087274 592 memset(&match_all, 0, sizeof(match_all));
2abf3503 593 repo_init_revisions(the_repository, &rev, prefix);
70827b15 594 rev.diff = 1;
70827b15 595 rev.always_show_header = 1;
ca92e59e 596 rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
666c92a2
ZJS
597 rev.diffopt.stat_width = -1; /* Scale to real terminal size */
598
32962c9b
JH
599 memset(&opt, 0, sizeof(opt));
600 opt.def = "HEAD";
b130c706 601 opt.tweak = show_setup_revisions_tweak;
32962c9b 602 cmd_log_init(argc, argv, prefix, &rev, &opt);
5d7eeee2 603
c5941f1a
JH
604 if (!rev.no_walk)
605 return cmd_log_walk(&rev);
606
5d7eeee2
JS
607 count = rev.pending.nr;
608 objects = rev.pending.objects;
609 for (i = 0; i < count && !ret; i++) {
610 struct object *o = objects[i].item;
611 const char *name = objects[i].name;
612 switch (o->type) {
613 case OBJ_BLOB:
d801627b 614 ret = show_blob_object(&o->oid, &rev, name);
5d7eeee2
JS
615 break;
616 case OBJ_TAG: {
617 struct tag *t = (struct tag *)o;
618
ae03ee64
JK
619 if (rev.shown_one)
620 putchar('\n');
95235f5b 621 fprintf(rev.diffopt.file, "%stag %s%s\n",
8f67f8ae 622 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
5d7eeee2 623 t->tag,
8f67f8ae 624 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
d801627b 625 ret = show_tag_object(&o->oid, &rev);
ae03ee64 626 rev.shown_one = 1;
d2dadfe8
JH
627 if (ret)
628 break;
109cd76d 629 o = parse_object(the_repository, &t->tagged->oid);
d2dadfe8 630 if (!o)
5c5f1d7c 631 ret = error(_("Could not read object %s"),
f2fd0760 632 oid_to_hex(&t->tagged->oid));
d2dadfe8 633 objects[i].item = o;
5d7eeee2
JS
634 i--;
635 break;
636 }
637 case OBJ_TREE:
ae03ee64
JK
638 if (rev.shown_one)
639 putchar('\n');
95235f5b 640 fprintf(rev.diffopt.file, "%stree %s%s\n\n",
8f67f8ae 641 diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
5d7eeee2 642 name,
8f67f8ae 643 diff_get_color_opt(&rev.diffopt, DIFF_RESET));
e092073d
NTND
644 read_tree_recursive(the_repository, (struct tree *)o, "",
645 0, 0, &match_all, show_tree_object,
646 rev.diffopt.file);
ae03ee64 647 rev.shown_one = 1;
5d7eeee2
JS
648 break;
649 case OBJ_COMMIT:
650 rev.pending.nr = rev.pending.alloc = 0;
651 rev.pending.objects = NULL;
652 add_object_array(o, name, &rev.pending);
653 ret = cmd_log_walk(&rev);
654 break;
655 default:
5c5f1d7c 656 ret = error(_("Unknown type: %d"), o->type);
5d7eeee2
JS
657 }
658 }
659 free(objects);
660 return ret;
70827b15
LT
661}
662
cf39f54e
LT
663/*
664 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
665 */
666int cmd_log_reflog(int argc, const char **argv, const char *prefix)
667{
668 struct rev_info rev;
32962c9b 669 struct setup_revision_opt opt;
cf39f54e 670
9501d191 671 init_log_defaults();
ef90d6d4 672 git_config(git_log_config, NULL);
6b2f2d98 673
2abf3503 674 repo_init_revisions(the_repository, &rev, prefix);
cf39f54e 675 init_reflog_walk(&rev.reflog_info);
cf39f54e 676 rev.verbose_header = 1;
32962c9b
JH
677 memset(&opt, 0, sizeof(opt));
678 opt.def = "HEAD";
4b56cf58 679 cmd_log_init_defaults(&rev);
0c47695a 680 rev.abbrev_commit = 1;
cf39f54e 681 rev.commit_format = CMIT_FMT_ONELINE;
4da45bef 682 rev.use_terminator = 1;
cf39f54e 683 rev.always_show_header = 1;
4b56cf58 684 cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
cf39f54e 685
cf39f54e
LT
686 return cmd_log_walk(&rev);
687}
688
b130c706
JH
689static void log_setup_revisions_tweak(struct rev_info *rev,
690 struct setup_revision_opt *opt)
076c9837 691{
0d1e0e78 692 if (rev->diffopt.flags.default_follow_renames &&
076c9837 693 rev->prune_data.nr == 1)
0d1e0e78 694 rev->diffopt.flags.follow_renames = 1;
c7eaf8b4
JH
695
696 /* Turn --cc/-c into -p --cc/-c when -p was not given */
697 if (!rev->diffopt.output_format && rev->combine_merges)
698 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
82dee416
JH
699
700 /* Turn -m on when --cc/-c was given */
701 if (rev->combine_merges)
702 rev->ignore_merges = 0;
076c9837
DT
703}
704
a633fca0 705int cmd_log(int argc, const char **argv, const char *prefix)
70827b15
LT
706{
707 struct rev_info rev;
32962c9b 708 struct setup_revision_opt opt;
70827b15 709
9501d191 710 init_log_defaults();
ef90d6d4 711 git_config(git_log_config, NULL);
6b2f2d98 712
2abf3503 713 repo_init_revisions(the_repository, &rev, prefix);
70827b15 714 rev.always_show_header = 1;
32962c9b
JH
715 memset(&opt, 0, sizeof(opt));
716 opt.def = "HEAD";
d5f6b1d7 717 opt.revarg_opt = REVARG_COMMITTISH;
b130c706 718 opt.tweak = log_setup_revisions_tweak;
32962c9b 719 cmd_log_init(argc, argv, prefix, &rev, &opt);
9dafea26 720 return cmd_log_walk(&rev);
70827b15 721}
91efcf60 722
c06d2daa 723/* format-patch */
0377db77 724
917a8f89 725static const char *fmt_patch_suffix = ".patch";
49604a4d 726static int numbered = 0;
a567fdcb 727static int auto_number = 1;
20ff0680 728
0db5260b
JW
729static char *default_attach = NULL;
730
2721ce21
JK
731static struct string_list extra_hdr = STRING_LIST_INIT_NODUP;
732static struct string_list extra_to = STRING_LIST_INIT_NODUP;
733static struct string_list extra_cc = STRING_LIST_INIT_NODUP;
3ee79d9f
DB
734
735static void add_header(const char *value)
736{
ca9e0a1b 737 struct string_list_item *item;
3ee79d9f 738 int len = strlen(value);
c8c4450e 739 while (len && value[len - 1] == '\n')
3ee79d9f 740 len--;
ca9e0a1b 741
3ee79d9f 742 if (!strncasecmp(value, "to: ", 4)) {
1d2f80fa 743 item = string_list_append(&extra_to, value + 4);
ca9e0a1b
SB
744 len -= 4;
745 } else if (!strncasecmp(value, "cc: ", 4)) {
1d2f80fa 746 item = string_list_append(&extra_cc, value + 4);
ca9e0a1b
SB
747 len -= 4;
748 } else {
1d2f80fa 749 item = string_list_append(&extra_hdr, value);
3ee79d9f 750 }
ca9e0a1b
SB
751
752 item->string[len] = '\0';
3ee79d9f
DB
753}
754
30984ed2
TR
755#define THREAD_SHALLOW 1
756#define THREAD_DEEP 2
6622d9c7
SB
757static int thread;
758static int do_signoff;
bb52995f 759static int base_auto;
6bc6b6c0 760static char *from;
6622d9c7 761static const char *signature = git_version_string;
7022650f 762static const char *signature_file;
2a4c2607 763static int config_cover_letter;
bc6bf2d7 764static const char *config_output_directory;
2a4c2607
FC
765
766enum {
767 COVER_UNSET,
768 COVER_OFF,
769 COVER_ON,
770 COVER_AUTO
771};
30984ed2 772
ef90d6d4 773static int git_format_config(const char *var, const char *value, void *cb)
20ff0680
JS
774{
775 if (!strcmp(var, "format.headers")) {
d7fb91c6 776 if (!value)
5c5f1d7c 777 die(_("format.headers without value"));
3ee79d9f 778 add_header(value);
20ff0680
JS
779 return 0;
780 }
70cff3ac
BH
781 if (!strcmp(var, "format.suffix"))
782 return git_config_string(&fmt_patch_suffix, var, value);
ae6c098f
SD
783 if (!strcmp(var, "format.to")) {
784 if (!value)
785 return config_error_nonbool(var);
1d2f80fa 786 string_list_append(&extra_to, value);
ae6c098f
SD
787 return 0;
788 }
fe8928e6
MV
789 if (!strcmp(var, "format.cc")) {
790 if (!value)
791 return config_error_nonbool(var);
1d2f80fa 792 string_list_append(&extra_cc, value);
fe8928e6
MV
793 return 0;
794 }
787570c7 795 if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
339de508 796 !strcmp(var, "color.ui") || !strcmp(var, "diff.submodule")) {
f3aafa4d
RA
797 return 0;
798 }
49604a4d 799 if (!strcmp(var, "format.numbered")) {
90f5c186 800 if (value && !strcasecmp(value, "auto")) {
49604a4d
BG
801 auto_number = 1;
802 return 0;
803 }
49604a4d 804 numbered = git_config_bool(var, value);
a567fdcb 805 auto_number = auto_number && numbered;
49604a4d
BG
806 return 0;
807 }
0db5260b
JW
808 if (!strcmp(var, "format.attach")) {
809 if (value && *value)
810 default_attach = xstrdup(value);
811 else
812 default_attach = xstrdup(git_version_string);
813 return 0;
814 }
30984ed2
TR
815 if (!strcmp(var, "format.thread")) {
816 if (value && !strcasecmp(value, "deep")) {
817 thread = THREAD_DEEP;
818 return 0;
819 }
820 if (value && !strcasecmp(value, "shallow")) {
821 thread = THREAD_SHALLOW;
822 return 0;
823 }
824 thread = git_config_bool(var, value) && THREAD_SHALLOW;
825 return 0;
826 }
1d1876e9
HV
827 if (!strcmp(var, "format.signoff")) {
828 do_signoff = git_config_bool(var, value);
829 return 0;
830 }
6622d9c7
SB
831 if (!strcmp(var, "format.signature"))
832 return git_config_string(&signature, var, value);
7022650f
JM
833 if (!strcmp(var, "format.signaturefile"))
834 return git_config_pathname(&signature_file, var, value);
2a4c2607
FC
835 if (!strcmp(var, "format.coverletter")) {
836 if (value && !strcasecmp(value, "auto")) {
837 config_cover_letter = COVER_AUTO;
838 return 0;
839 }
840 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
841 return 0;
842 }
bc6bf2d7
AK
843 if (!strcmp(var, "format.outputdirectory"))
844 return git_config_string(&config_output_directory, var, value);
bb52995f
XY
845 if (!strcmp(var, "format.useautobase")) {
846 base_auto = git_config_bool(var, value);
847 return 0;
848 }
6bc6b6c0 849 if (!strcmp(var, "format.from")) {
89576613 850 int b = git_parse_maybe_bool(value);
6bc6b6c0
JT
851 free(from);
852 if (b < 0)
853 from = xstrdup(value);
854 else if (b)
855 from = xstrdup(git_committer_info(IDENT_NO_DATE));
856 else
857 from = NULL;
858 return 0;
859 }
dbd21447 860
ef90d6d4 861 return git_log_config(var, value, cb);
20ff0680
JS
862}
863
efd02016 864static const char *output_directory = NULL;
9800a754 865static int outdir_offset;
81f3a188 866
95235f5b 867static int open_next_file(struct commit *commit, const char *subject,
a21c2f94 868 struct rev_info *rev, int quiet)
0377db77 869{
cd2ef591 870 struct strbuf filename = STRBUF_INIT;
68cb7b6f 871 int suffix_len = strlen(rev->patch_suffix) + 1;
0377db77 872
2448482b 873 if (output_directory) {
cd2ef591
SB
874 strbuf_addstr(&filename, output_directory);
875 if (filename.len >=
15d980a7
NTND
876 PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len) {
877 strbuf_release(&filename);
5c5f1d7c 878 return error(_("name of output directory is too long"));
15d980a7 879 }
00b6c178 880 strbuf_complete(&filename, '/');
2448482b 881 }
0377db77 882
38ec23ac
JH
883 if (rev->numbered_files)
884 strbuf_addf(&filename, "%d", rev->nr);
d28b5d47
JH
885 else if (commit)
886 fmt_output_commit(&filename, commit, rev);
38ec23ac 887 else
d28b5d47 888 fmt_output_subject(&filename, subject, rev);
e6ff0f42 889
250087f2 890 if (!quiet)
36a4d905 891 printf("%s\n", filename.buf + outdir_offset);
ec2956df 892
15d980a7
NTND
893 if ((rev->diffopt.file = fopen(filename.buf, "w")) == NULL) {
894 error_errno(_("Cannot open patch file %s"), filename.buf);
895 strbuf_release(&filename);
896 return -1;
897 }
c06d2daa 898
cd2ef591 899 strbuf_release(&filename);
e6ff0f42 900 return 0;
0377db77
JS
901}
902
811929f1 903static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
9c6efa36
JS
904{
905 struct rev_info check_rev;
9b7a61d7 906 struct commit *commit, *c1, *c2;
9c6efa36
JS
907 struct object *o1, *o2;
908 unsigned flags1, flags2;
9c6efa36
JS
909
910 if (rev->pending.nr != 2)
5c5f1d7c 911 die(_("Need exactly one range."));
9c6efa36
JS
912
913 o1 = rev->pending.objects[0].item;
9c6efa36 914 o2 = rev->pending.objects[1].item;
9b7a61d7 915 flags1 = o1->flags;
9c6efa36 916 flags2 = o2->flags;
2122f675
SB
917 c1 = lookup_commit_reference(the_repository, &o1->oid);
918 c2 = lookup_commit_reference(the_repository, &o2->oid);
9c6efa36
JS
919
920 if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
5c5f1d7c 921 die(_("Not a range."));
9c6efa36 922
a7edadda 923 init_patch_ids(the_repository, ids);
9c6efa36
JS
924
925 /* given a range a..b get all patch ids for b..a */
2abf3503 926 repo_init_revisions(the_repository, &check_rev, rev->prefix);
51f4de3a 927 check_rev.max_parents = 1;
9c6efa36
JS
928 o1->flags ^= UNINTERESTING;
929 o2->flags ^= UNINTERESTING;
930 add_pending_object(&check_rev, o1, "o1");
931 add_pending_object(&check_rev, o2, "o2");
3d51e1b5 932 if (prepare_revision_walk(&check_rev))
5c5f1d7c 933 die(_("revision walk setup failed"));
9c6efa36
JS
934
935 while ((commit = get_revision(&check_rev)) != NULL) {
5d23e133 936 add_commit_patch_id(commit, ids);
9c6efa36
JS
937 }
938
939 /* reset for next revision walk */
9b7a61d7
JH
940 clear_commit_marks(c1, SEEN | UNINTERESTING | SHOWN | ADDED);
941 clear_commit_marks(c2, SEEN | UNINTERESTING | SHOWN | ADDED);
9c6efa36
JS
942 o1->flags = flags1;
943 o2->flags = flags2;
944}
945
e1a37346 946static void gen_message_id(struct rev_info *info, char *base)
d1566f78 947{
f285a2d7 948 struct strbuf buf = STRBUF_INIT;
cb71f8bd 949 strbuf_addf(&buf, "%s.%"PRItime".git.%s", base,
dddbad72 950 (timestamp_t) time(NULL),
59f9b8a9 951 git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
e1a37346 952 info->message_id = strbuf_detach(&buf, NULL);
d1566f78
JT
953}
954
95235f5b 955static void print_signature(FILE *file)
6622d9c7 956{
c6076e2b
JK
957 if (!signature || !*signature)
958 return;
959
95235f5b 960 fprintf(file, "-- \n%s", signature);
c6076e2b 961 if (signature[strlen(signature)-1] != '\n')
95235f5b
JS
962 putc('\n', file);
963 putc('\n', file);
6622d9c7
SB
964}
965
739453a3
JH
966static void add_branch_description(struct strbuf *buf, const char *branch_name)
967{
968 struct strbuf desc = STRBUF_INIT;
969 if (!branch_name || !*branch_name)
970 return;
971 read_branch_desc(&desc, branch_name);
972 if (desc.len) {
973 strbuf_addch(buf, '\n');
e992d1eb 974 strbuf_addbuf(buf, &desc);
739453a3
JH
975 strbuf_addch(buf, '\n');
976 }
94204bf5 977 strbuf_release(&desc);
739453a3
JH
978}
979
d7ddad01
FC
980static char *find_branch_name(struct rev_info *rev)
981{
982 int i, positive = -1;
f2fd0760 983 struct object_id branch_oid;
984 const struct object_id *tip_oid;
95b567c7 985 const char *ref, *v;
d7ddad01
FC
986 char *full_ref, *branch = NULL;
987
988 for (i = 0; i < rev->cmdline.nr; i++) {
989 if (rev->cmdline.rev[i].flags & UNINTERESTING)
990 continue;
991 if (positive < 0)
992 positive = i;
993 else
994 return NULL;
995 }
996 if (positive < 0)
997 return NULL;
998 ref = rev->cmdline.rev[positive].name;
f2fd0760 999 tip_oid = &rev->cmdline.rev[positive].item->oid;
cca5fa64 1000 if (dwim_ref(ref, strlen(ref), &branch_oid, &full_ref) &&
95b567c7 1001 skip_prefix(full_ref, "refs/heads/", &v) &&
4a7e27e9 1002 oideq(tip_oid, &branch_oid))
95b567c7 1003 branch = xstrdup(v);
d7ddad01
FC
1004 free(full_ref);
1005 return branch;
1006}
1007
fa5b7ea6
ES
1008static void show_diffstat(struct rev_info *rev,
1009 struct commit *origin, struct commit *head)
1010{
1011 struct diff_options opts;
1012
1013 memcpy(&opts, &rev->diffopt, sizeof(opts));
1014 opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1015 opts.stat_width = MAIL_DEFAULT_WRAP;
1016
1017 diff_setup_done(&opts);
1018
1019 diff_tree_oid(get_commit_tree_oid(origin),
1020 get_commit_tree_oid(head),
1021 "", &opts);
1022 diffcore_std(&opts);
1023 diff_flush(&opts);
1024
1025 fprintf(rev->diffopt.file, "\n");
1026}
1027
2bda2cf4 1028static void make_cover_letter(struct rev_info *rev, int use_stdout,
2bda2cf4 1029 struct commit *origin,
d7ddad01 1030 int nr, struct commit **list,
739453a3 1031 const char *branch_name,
250087f2 1032 int quiet)
a5a27c79
DB
1033{
1034 const char *committer;
a5a27c79
DB
1035 const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
1036 const char *msg;
2bda2cf4 1037 struct shortlog log;
f285a2d7 1038 struct strbuf sb = STRBUF_INIT;
2bda2cf4 1039 int i;
330db18c 1040 const char *encoding = "UTF-8";
267123b4 1041 int need_8bit_cte = 0;
6bf13944 1042 struct pretty_print_context pp = {0};
d7ddad01 1043 struct commit *head = list[0];
a5a27c79 1044
9f23e040 1045 if (!cmit_fmt_is_mail(rev->commit_format))
5c5f1d7c 1046 die(_("Cover letter needs email format"));
a5a27c79 1047
cd2ef591 1048 committer = git_committer_info(0);
6df514af 1049
a21c2f94 1050 if (!use_stdout &&
95235f5b 1051 open_next_file(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
a5a27c79
DB
1052 return;
1053
50cd54ef 1054 log_write_email_headers(rev, head, &pp.after_subject, &need_8bit_cte, 0);
a5a27c79 1055
bc6b8fc1 1056 for (i = 0; !need_8bit_cte && i < nr; i++) {
8597ea3a 1057 const char *buf = get_commit_buffer(list[i], NULL);
bc6b8fc1 1058 if (has_non_ascii(buf))
0a7f4483 1059 need_8bit_cte = 1;
bc6b8fc1
JK
1060 unuse_commit_buffer(list[i], buf);
1061 }
0a7f4483 1062
d7ddad01
FC
1063 if (!branch_name)
1064 branch_name = find_branch_name(rev);
1065
a5a27c79 1066 msg = body;
6bf13944 1067 pp.fmt = CMIT_FMT_EMAIL;
a5481a6c 1068 pp.date_mode.type = DATE_RFC2822;
6d167fd7
RS
1069 pp.rev = rev;
1070 pp.print_email_subject = 1;
6bf13944
JK
1071 pp_user_info(&pp, NULL, &sb, committer, encoding);
1072 pp_title_line(&pp, &msg, &sb, encoding, need_8bit_cte);
1073 pp_remainder(&pp, &msg, &sb, 0);
739453a3 1074 add_branch_description(&sb, branch_name);
95235f5b 1075 fprintf(rev->diffopt.file, "%s\n", sb.buf);
a5a27c79
DB
1076
1077 strbuf_release(&sb);
1078
2bda2cf4 1079 shortlog_init(&log);
859c4fbe 1080 log.wrap_lines = 1;
43662b23 1081 log.wrap = MAIL_DEFAULT_WRAP;
859c4fbe
JS
1082 log.in1 = 2;
1083 log.in2 = 4;
95235f5b 1084 log.file = rev->diffopt.file;
2bda2cf4
DB
1085 for (i = 0; i < nr; i++)
1086 shortlog_add_commit(&log, list[i]);
1087
1088 shortlog_output(&log);
1089
fa5b7ea6
ES
1090 /* We can only do diffstat with a unique reference point */
1091 if (origin)
1092 show_diffstat(rev, origin, head);
a5a27c79 1093
126facf8 1094 if (rev->idiff_oid1) {
5ac290f9 1095 fprintf_ln(rev->diffopt.file, "%s", rev->idiff_title);
3b026417 1096 show_interdiff(rev, 0);
126facf8 1097 }
31e2617a
ES
1098
1099 if (rev->rdiff1) {
4ee99689 1100 fprintf_ln(rev->diffopt.file, "%s", rev->rdiff_title);
31e2617a
ES
1101 show_range_diff(rev->rdiff1, rev->rdiff2,
1102 rev->creation_factor, 1, &rev->diffopt);
1103 }
d1566f78
JT
1104}
1105
8419d2ee
JH
1106static const char *clean_message_id(const char *msg_id)
1107{
1108 char ch;
1109 const char *a, *z, *m;
8419d2ee
JH
1110
1111 m = msg_id;
1112 while ((ch = *m) && (isspace(ch) || (ch == '<')))
1113 m++;
1114 a = m;
1115 z = NULL;
1116 while ((ch = *m)) {
1117 if (!isspace(ch) && (ch != '>'))
1118 z = m;
1119 m++;
1120 }
1121 if (!z)
5c5f1d7c 1122 die(_("insane in-reply-to: %s"), msg_id);
8419d2ee
JH
1123 if (++z == m)
1124 return a;
182af834 1125 return xmemdupz(a, z - a);
8419d2ee
JH
1126}
1127
9800a754
JH
1128static const char *set_outdir(const char *prefix, const char *output_directory)
1129{
1130 if (output_directory && is_absolute_path(output_directory))
1131 return output_directory;
1132
1133 if (!prefix || !*prefix) {
1134 if (output_directory)
1135 return output_directory;
1136 /* The user did not explicitly ask for "./" */
1137 outdir_offset = 2;
1138 return "./";
1139 }
1140
1141 outdir_offset = strlen(prefix);
1142 if (!output_directory)
1143 return prefix;
1144
e4da43b1 1145 return prefix_filename(prefix, output_directory);
9800a754
JH
1146}
1147
fff02ee6 1148static const char * const builtin_format_patch_usage[] = {
9c9b4f2f 1149 N_("git format-patch [<options>] [<since> | <revision-range>]"),
fff02ee6
SB
1150 NULL
1151};
1152
1153static int keep_subject = 0;
1154
1155static int keep_callback(const struct option *opt, const char *arg, int unset)
1156{
517fe807
JK
1157 BUG_ON_OPT_NEG(unset);
1158 BUG_ON_OPT_ARG(arg);
fff02ee6
SB
1159 ((struct rev_info *)opt->value)->total = -1;
1160 keep_subject = 1;
1161 return 0;
1162}
1163
1164static int subject_prefix = 0;
1165
1166static int subject_prefix_callback(const struct option *opt, const char *arg,
1167 int unset)
1168{
517fe807 1169 BUG_ON_OPT_NEG(unset);
fff02ee6
SB
1170 subject_prefix = 1;
1171 ((struct rev_info *)opt->value)->subject_prefix = arg;
1172 return 0;
1173}
1174
68e83a5b
JT
1175static int rfc_callback(const struct option *opt, const char *arg, int unset)
1176{
517fe807
JK
1177 BUG_ON_OPT_NEG(unset);
1178 BUG_ON_OPT_ARG(arg);
68e83a5b
JT
1179 return subject_prefix_callback(opt, "RFC PATCH", unset);
1180}
1181
1af4731b
JH
1182static int numbered_cmdline_opt = 0;
1183
fff02ee6
SB
1184static int numbered_callback(const struct option *opt, const char *arg,
1185 int unset)
1186{
517fe807 1187 BUG_ON_OPT_ARG(arg);
1af4731b 1188 *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
fff02ee6
SB
1189 if (unset)
1190 auto_number = 0;
1191 return 0;
1192}
1193
1194static int no_numbered_callback(const struct option *opt, const char *arg,
1195 int unset)
1196{
517fe807 1197 BUG_ON_OPT_NEG(unset);
fff02ee6
SB
1198 return numbered_callback(opt, arg, 1);
1199}
1200
1201static int output_directory_callback(const struct option *opt, const char *arg,
1202 int unset)
1203{
1204 const char **dir = (const char **)opt->value;
517fe807 1205 BUG_ON_OPT_NEG(unset);
fff02ee6 1206 if (*dir)
5c5f1d7c 1207 die(_("Two output directories?"));
fff02ee6
SB
1208 *dir = arg;
1209 return 0;
1210}
1211
1212static int thread_callback(const struct option *opt, const char *arg, int unset)
1213{
1214 int *thread = (int *)opt->value;
1215 if (unset)
1216 *thread = 0;
1217 else if (!arg || !strcmp(arg, "shallow"))
1218 *thread = THREAD_SHALLOW;
1219 else if (!strcmp(arg, "deep"))
1220 *thread = THREAD_DEEP;
1221 else
1222 return 1;
1223 return 0;
1224}
1225
1226static int attach_callback(const struct option *opt, const char *arg, int unset)
1227{
1228 struct rev_info *rev = (struct rev_info *)opt->value;
1229 if (unset)
1230 rev->mime_boundary = NULL;
1231 else if (arg)
1232 rev->mime_boundary = arg;
1233 else
1234 rev->mime_boundary = git_version_string;
1235 rev->no_inline = unset ? 0 : 1;
1236 return 0;
1237}
1238
1239static int inline_callback(const struct option *opt, const char *arg, int unset)
1240{
1241 struct rev_info *rev = (struct rev_info *)opt->value;
1242 if (unset)
1243 rev->mime_boundary = NULL;
1244 else if (arg)
1245 rev->mime_boundary = arg;
1246 else
1247 rev->mime_boundary = git_version_string;
1248 rev->no_inline = 0;
1249 return 0;
1250}
1251
1252static int header_callback(const struct option *opt, const char *arg, int unset)
1253{
c4260034
SB
1254 if (unset) {
1255 string_list_clear(&extra_hdr, 0);
1256 string_list_clear(&extra_to, 0);
1257 string_list_clear(&extra_cc, 0);
1258 } else {
1259 add_header(arg);
1260 }
fff02ee6
SB
1261 return 0;
1262}
1263
ae6c098f
SD
1264static int to_callback(const struct option *opt, const char *arg, int unset)
1265{
c4260034
SB
1266 if (unset)
1267 string_list_clear(&extra_to, 0);
1268 else
1d2f80fa 1269 string_list_append(&extra_to, arg);
fff02ee6
SB
1270 return 0;
1271}
1272
1273static int cc_callback(const struct option *opt, const char *arg, int unset)
1274{
c4260034
SB
1275 if (unset)
1276 string_list_clear(&extra_cc, 0);
1277 else
1d2f80fa 1278 string_list_append(&extra_cc, arg);
fff02ee6
SB
1279 return 0;
1280}
1281
a9080475
JK
1282static int from_callback(const struct option *opt, const char *arg, int unset)
1283{
1284 char **from = opt->value;
1285
1286 free(*from);
1287
1288 if (unset)
1289 *from = NULL;
1290 else if (arg)
1291 *from = xstrdup(arg);
1292 else
1293 *from = xstrdup(git_committer_info(IDENT_NO_DATE));
1294 return 0;
1295}
1296
fa2ab86d
XY
1297struct base_tree_info {
1298 struct object_id base_commit;
1299 int nr_patch_id, alloc_patch_id;
1300 struct object_id *patch_id;
1301};
1302
1303static struct commit *get_base_commit(const char *base_commit,
1304 struct commit **list,
1305 int total)
1306{
1307 struct commit *base = NULL;
1308 struct commit **rev;
1309 int i = 0, rev_nr = 0;
1310
bb52995f
XY
1311 if (base_commit && strcmp(base_commit, "auto")) {
1312 base = lookup_commit_reference_by_name(base_commit);
1313 if (!base)
1314 die(_("Unknown commit %s"), base_commit);
1315 } else if ((base_commit && !strcmp(base_commit, "auto")) || base_auto) {
3de66517
XY
1316 struct branch *curr_branch = branch_get(NULL);
1317 const char *upstream = branch_get_upstream(curr_branch, NULL);
1318 if (upstream) {
1319 struct commit_list *base_list;
1320 struct commit *commit;
d801627b 1321 struct object_id oid;
3de66517 1322
d801627b 1323 if (get_oid(upstream, &oid))
3de66517 1324 die(_("Failed to resolve '%s' as a valid ref."), upstream);
bc83266a 1325 commit = lookup_commit_or_die(&oid, "upstream base");
3de66517
XY
1326 base_list = get_merge_bases_many(commit, total, list);
1327 /* There should be one and only one merge base. */
1328 if (!base_list || base_list->next)
1329 die(_("Could not find exact merge base."));
1330 base = base_list->item;
1331 free_commit_list(base_list);
1332 } else {
1333 die(_("Failed to get upstream, if you want to record base commit automatically,\n"
1334 "please use git branch --set-upstream-to to track a remote branch.\n"
1335 "Or you could specify base commit by --base=<base-commit-id> manually."));
1336 }
3de66517 1337 }
fa2ab86d
XY
1338
1339 ALLOC_ARRAY(rev, total);
1340 for (i = 0; i < total; i++)
1341 rev[i] = list[i];
1342
1343 rev_nr = total;
1344 /*
1345 * Get merge base through pair-wise computations
1346 * and store it in rev[0].
1347 */
1348 while (rev_nr > 1) {
1349 for (i = 0; i < rev_nr / 2; i++) {
1350 struct commit_list *merge_base;
1351 merge_base = get_merge_bases(rev[2 * i], rev[2 * i + 1]);
1352 if (!merge_base || merge_base->next)
1353 die(_("Failed to find exact merge base"));
1354
1355 rev[i] = merge_base->item;
1356 }
1357
1358 if (rev_nr % 2)
1359 rev[i] = rev[2 * i];
42c78a21 1360 rev_nr = DIV_ROUND_UP(rev_nr, 2);
fa2ab86d
XY
1361 }
1362
1363 if (!in_merge_bases(base, rev[0]))
1364 die(_("base commit should be the ancestor of revision list"));
1365
1366 for (i = 0; i < total; i++) {
1367 if (base == list[i])
1368 die(_("base commit shouldn't be in revision list"));
1369 }
1370
1371 free(rev);
1372 return base;
1373}
1374
7b680d32
NTND
1375define_commit_slab(commit_base, int);
1376
fa2ab86d
XY
1377static void prepare_bases(struct base_tree_info *bases,
1378 struct commit *base,
1379 struct commit **list,
1380 int total)
1381{
1382 struct commit *commit;
1383 struct rev_info revs;
1384 struct diff_options diffopt;
7b680d32 1385 struct commit_base commit_base;
fa2ab86d
XY
1386 int i;
1387
1388 if (!base)
1389 return;
1390
7b680d32 1391 init_commit_base(&commit_base);
e6757652 1392 repo_diff_setup(the_repository, &diffopt);
0d1e0e78 1393 diffopt.flags.recursive = 1;
fa2ab86d
XY
1394 diff_setup_done(&diffopt);
1395
1396 oidcpy(&bases->base_commit, &base->object.oid);
1397
2abf3503 1398 repo_init_revisions(the_repository, &revs, NULL);
fa2ab86d
XY
1399 revs.max_parents = 1;
1400 revs.topo_order = 1;
1401 for (i = 0; i < total; i++) {
1402 list[i]->object.flags &= ~UNINTERESTING;
1403 add_pending_object(&revs, &list[i]->object, "rev_list");
7b680d32 1404 *commit_base_at(&commit_base, list[i]) = 1;
fa2ab86d
XY
1405 }
1406 base->object.flags |= UNINTERESTING;
1407 add_pending_object(&revs, &base->object, "base");
1408
1409 if (prepare_revision_walk(&revs))
1410 die(_("revision walk setup failed"));
1411 /*
1412 * Traverse the commits list, get prerequisite patch ids
1413 * and stuff them in bases structure.
1414 */
1415 while ((commit = get_revision(&revs)) != NULL) {
d801627b 1416 struct object_id oid;
fa2ab86d 1417 struct object_id *patch_id;
7b680d32 1418 if (*commit_base_at(&commit_base, commit))
fa2ab86d 1419 continue;
34f3c0eb 1420 if (commit_patch_id(commit, &diffopt, &oid, 0))
fa2ab86d
XY
1421 die(_("cannot get patch id"));
1422 ALLOC_GROW(bases->patch_id, bases->nr_patch_id + 1, bases->alloc_patch_id);
1423 patch_id = bases->patch_id + bases->nr_patch_id;
d801627b 1424 oidcpy(patch_id, &oid);
fa2ab86d
XY
1425 bases->nr_patch_id++;
1426 }
7b680d32 1427 clear_commit_base(&commit_base);
fa2ab86d
XY
1428}
1429
95235f5b 1430static void print_bases(struct base_tree_info *bases, FILE *file)
fa2ab86d
XY
1431{
1432 int i;
1433
1434 /* Only do this once, either for the cover or for the first one */
1435 if (is_null_oid(&bases->base_commit))
1436 return;
1437
1438 /* Show the base commit */
480871e0 1439 fprintf(file, "\nbase-commit: %s\n", oid_to_hex(&bases->base_commit));
fa2ab86d
XY
1440
1441 /* Show the prerequisite patches */
1442 for (i = bases->nr_patch_id - 1; i >= 0; i--)
95235f5b 1443 fprintf(file, "prerequisite-patch-id: %s\n", oid_to_hex(&bases->patch_id[i]));
fa2ab86d
XY
1444
1445 free(bases->patch_id);
1446 bases->nr_patch_id = 0;
1447 bases->alloc_patch_id = 0;
1448 oidclr(&bases->base_commit);
1449}
1450
5ac290f9
ES
1451static const char *diff_title(struct strbuf *sb, int reroll_count,
1452 const char *generic, const char *rerolled)
1453{
1454 if (reroll_count <= 0)
1455 strbuf_addstr(sb, generic);
1456 else /* RFC may be v0, so allow -v1 to diff against v0 */
1457 strbuf_addf(sb, rerolled, reroll_count - 1);
1458 return sb->buf;
1459}
1460
31e2617a
ES
1461static void infer_range_diff_ranges(struct strbuf *r1,
1462 struct strbuf *r2,
1463 const char *prev,
2e6fd71a 1464 struct commit *origin,
31e2617a
ES
1465 struct commit *head)
1466{
1467 const char *head_oid = oid_to_hex(&head->object.oid);
1468
2e6fd71a
ES
1469 if (!strstr(prev, "..")) {
1470 strbuf_addf(r1, "%s..%s", head_oid, prev);
1471 strbuf_addf(r2, "%s..%s", prev, head_oid);
1472 } else if (!origin) {
1473 die(_("failed to infer range-diff ranges"));
1474 } else {
1475 strbuf_addstr(r1, prev);
1476 strbuf_addf(r2, "%s..%s",
1477 oid_to_hex(&origin->object.oid), head_oid);
1478 }
31e2617a
ES
1479}
1480
a633fca0 1481int cmd_format_patch(int argc, const char **argv, const char *prefix)
91efcf60
JH
1482{
1483 struct commit *commit;
1484 struct commit **list = NULL;
1485 struct rev_info rev;
32962c9b 1486 struct setup_revision_opt s_r_opt;
fff02ee6 1487 int nr = 0, total, i;
0377db77 1488 int use_stdout = 0;
fa0f02df 1489 int start_number = -1;
ce37596c 1490 int just_numbers = 0;
9c6efa36 1491 int ignore_if_in_upstream = 0;
2a4c2607 1492 int cover_letter = -1;
2bda2cf4 1493 int boundary_count = 0;
37c22a4b 1494 int no_binary_diff = 0;
3a30aa17 1495 int zero_commit = 0;
d7ddad01 1496 struct commit *origin = NULL;
76af0734 1497 const char *in_reply_to = NULL;
5d23e133 1498 struct patch_ids ids;
f285a2d7 1499 struct strbuf buf = STRBUF_INIT;
1d46f2ea 1500 int use_patch_format = 0;
250087f2 1501 int quiet = 0;
5fe10fe8 1502 int reroll_count = -1;
739453a3 1503 char *branch_name = NULL;
fa2ab86d
XY
1504 char *base_commit = NULL;
1505 struct base_tree_info bases;
738e88a2
KW
1506 int show_progress = 0;
1507 struct progress *progress = NULL;
126facf8 1508 struct oid_array idiff_prev = OID_ARRAY_INIT;
5ac290f9 1509 struct strbuf idiff_title = STRBUF_INIT;
31e2617a
ES
1510 const char *rdiff_prev = NULL;
1511 struct strbuf rdiff1 = STRBUF_INIT;
1512 struct strbuf rdiff2 = STRBUF_INIT;
4ee99689 1513 struct strbuf rdiff_title = STRBUF_INIT;
8631bf1c 1514 int creation_factor = -1;
fa2ab86d 1515
fff02ee6
SB
1516 const struct option builtin_format_patch_options[] = {
1517 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
61007a58 1518 N_("use [PATCH n/m] even with a single patch"),
fff02ee6
SB
1519 PARSE_OPT_NOARG, numbered_callback },
1520 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
61007a58 1521 N_("use [PATCH] even with multiple patches"),
964fd83b 1522 PARSE_OPT_NOARG | PARSE_OPT_NONEG, no_numbered_callback },
aa089cd9
FC
1523 OPT_BOOL('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
1524 OPT_BOOL(0, "stdout", &use_stdout,
61007a58 1525 N_("print patches to standard out")),
aa089cd9 1526 OPT_BOOL(0, "cover-letter", &cover_letter,
61007a58 1527 N_("generate a cover letter")),
aa089cd9 1528 OPT_BOOL(0, "numbered-files", &just_numbers,
61007a58
NTND
1529 N_("use simple number sequence for output file names")),
1530 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1531 N_("use <sfx> instead of '.patch'")),
fff02ee6 1532 OPT_INTEGER(0, "start-number", &start_number,
61007a58 1533 N_("start numbering patches at <n> instead of 1")),
7952ea66 1534 OPT_INTEGER('v', "reroll-count", &reroll_count,
5fe10fe8 1535 N_("mark the series as Nth re-roll")),
68e83a5b
JT
1536 { OPTION_CALLBACK, 0, "rfc", &rev, NULL,
1537 N_("Use [RFC PATCH] instead of [PATCH]"),
1538 PARSE_OPT_NOARG | PARSE_OPT_NONEG, rfc_callback },
61007a58
NTND
1539 { OPTION_CALLBACK, 0, "subject-prefix", &rev, N_("prefix"),
1540 N_("Use [<prefix>] instead of [PATCH]"),
fff02ee6
SB
1541 PARSE_OPT_NONEG, subject_prefix_callback },
1542 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
61007a58 1543 N_("dir"), N_("store resulting files in <dir>"),
fff02ee6
SB
1544 PARSE_OPT_NONEG, output_directory_callback },
1545 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
61007a58 1546 N_("don't strip/add [PATCH]"),
fff02ee6 1547 PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
d5d09d47
SB
1548 OPT_BOOL(0, "no-binary", &no_binary_diff,
1549 N_("don't output binary diffs")),
3a30aa17 1550 OPT_BOOL(0, "zero-commit", &zero_commit,
1551 N_("output all-zero hash in From header")),
d5d09d47
SB
1552 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1553 N_("don't include a patch matching a commit upstream")),
3e4a67b4
NTND
1554 OPT_SET_INT_F('p', "no-stat", &use_patch_format,
1555 N_("show patch format instead of default (patch + stat)"),
1556 1, PARSE_OPT_NONEG),
61007a58
NTND
1557 OPT_GROUP(N_("Messaging")),
1558 { OPTION_CALLBACK, 0, "add-header", NULL, N_("header"),
1559 N_("add email header"), 0, header_callback },
1560 { OPTION_CALLBACK, 0, "to", NULL, N_("email"), N_("add To: header"),
c4260034 1561 0, to_callback },
61007a58 1562 { OPTION_CALLBACK, 0, "cc", NULL, N_("email"), N_("add Cc: header"),
c4260034 1563 0, cc_callback },
a9080475
JK
1564 { OPTION_CALLBACK, 0, "from", &from, N_("ident"),
1565 N_("set From address to <ident> (or committer ident if absent)"),
1566 PARSE_OPT_OPTARG, from_callback },
61007a58
NTND
1567 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1568 N_("make first mail a reply to <message-id>")),
1569 { OPTION_CALLBACK, 0, "attach", &rev, N_("boundary"),
1570 N_("attach the patch"), PARSE_OPT_OPTARG,
fff02ee6 1571 attach_callback },
61007a58
NTND
1572 { OPTION_CALLBACK, 0, "inline", &rev, N_("boundary"),
1573 N_("inline the patch"),
fff02ee6
SB
1574 PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1575 inline_callback },
61007a58
NTND
1576 { OPTION_CALLBACK, 0, "thread", &thread, N_("style"),
1577 N_("enable message threading, styles: shallow, deep"),
fff02ee6 1578 PARSE_OPT_OPTARG, thread_callback },
61007a58
NTND
1579 OPT_STRING(0, "signature", &signature, N_("signature"),
1580 N_("add a signature")),
fa2ab86d
XY
1581 OPT_STRING(0, "base", &base_commit, N_("base-commit"),
1582 N_("add prerequisite tree info to the patch series")),
7022650f
JM
1583 OPT_FILENAME(0, "signature-file", &signature_file,
1584 N_("add a signature from a file")),
b7df098c 1585 OPT__QUIET(&quiet, N_("don't print the patch filenames")),
738e88a2
KW
1586 OPT_BOOL(0, "progress", &show_progress,
1587 N_("show progress while generating patches")),
126facf8 1588 OPT_CALLBACK(0, "interdiff", &idiff_prev, N_("rev"),
ee6cbf71 1589 N_("show changes against <rev> in cover letter or single patch"),
126facf8 1590 parse_opt_object_name),
31e2617a 1591 OPT_STRING(0, "range-diff", &rdiff_prev, N_("refspec"),
40ce4160 1592 N_("show changes against <refspec> in cover letter or single patch")),
8631bf1c
ES
1593 OPT_INTEGER(0, "creation-factor", &creation_factor,
1594 N_("percentage by which creation is weighted")),
fff02ee6
SB
1595 OPT_END()
1596 };
91efcf60 1597
ca9e0a1b
SB
1598 extra_hdr.strdup_strings = 1;
1599 extra_to.strdup_strings = 1;
1600 extra_cc.strdup_strings = 1;
9501d191 1601 init_log_defaults();
ef90d6d4 1602 git_config(git_format_config, NULL);
2abf3503 1603 repo_init_revisions(the_repository, &rev, prefix);
91efcf60 1604 rev.commit_format = CMIT_FMT_EMAIL;
0893eec8 1605 rev.expand_tabs_in_log_default = 0;
91efcf60
JH
1606 rev.verbose_header = 1;
1607 rev.diff = 1;
ad5aeede 1608 rev.max_parents = 1;
0d1e0e78 1609 rev.diffopt.flags.recursive = 1;
dbd21447 1610 rev.subject_prefix = fmt_patch_subject_prefix;
32962c9b
JH
1611 memset(&s_r_opt, 0, sizeof(s_r_opt));
1612 s_r_opt.def = "HEAD";
d5f6b1d7 1613 s_r_opt.revarg_opt = REVARG_COMMITTISH;
20ff0680 1614
0db5260b
JW
1615 if (default_attach) {
1616 rev.mime_boundary = default_attach;
1617 rev.no_inline = 1;
1618 }
1619
2448482b
JS
1620 /*
1621 * Parse the arguments before setup_revisions(), or something
2dc189a3 1622 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
2448482b
JS
1623 * possibly a valid SHA1.
1624 */
37782920 1625 argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
fff02ee6 1626 builtin_format_patch_usage,
382da402
FC
1627 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1628 PARSE_OPT_KEEP_DASHDASH);
2448482b 1629
5fe10fe8
JH
1630 if (0 < reroll_count) {
1631 struct strbuf sprefix = STRBUF_INIT;
1632 strbuf_addf(&sprefix, "%s v%d",
1633 rev.subject_prefix, reroll_count);
1634 rev.reroll_count = reroll_count;
1635 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1636 }
1637
ca9e0a1b
SB
1638 for (i = 0; i < extra_hdr.nr; i++) {
1639 strbuf_addstr(&buf, extra_hdr.items[i].string);
3ee79d9f
DB
1640 strbuf_addch(&buf, '\n');
1641 }
1642
ca9e0a1b 1643 if (extra_to.nr)
3ee79d9f 1644 strbuf_addstr(&buf, "To: ");
ca9e0a1b 1645 for (i = 0; i < extra_to.nr; i++) {
3ee79d9f
DB
1646 if (i)
1647 strbuf_addstr(&buf, " ");
ca9e0a1b
SB
1648 strbuf_addstr(&buf, extra_to.items[i].string);
1649 if (i + 1 < extra_to.nr)
3ee79d9f
DB
1650 strbuf_addch(&buf, ',');
1651 strbuf_addch(&buf, '\n');
1652 }
1653
ca9e0a1b 1654 if (extra_cc.nr)
3ee79d9f 1655 strbuf_addstr(&buf, "Cc: ");
ca9e0a1b 1656 for (i = 0; i < extra_cc.nr; i++) {
3ee79d9f
DB
1657 if (i)
1658 strbuf_addstr(&buf, " ");
ca9e0a1b
SB
1659 strbuf_addstr(&buf, extra_cc.items[i].string);
1660 if (i + 1 < extra_cc.nr)
3ee79d9f
DB
1661 strbuf_addch(&buf, ',');
1662 strbuf_addch(&buf, '\n');
1663 }
1664
2af202be 1665 rev.extra_headers = strbuf_detach(&buf, NULL);
3ee79d9f 1666
a9080475
JK
1667 if (from) {
1668 if (split_ident_line(&rev.from_ident, from, strlen(from)))
1669 die(_("invalid ident line: %s"), from);
1670 }
1671
add5c8a5 1672 if (start_number < 0)
fa0f02df 1673 start_number = 1;
ca6b91d2
JM
1674
1675 /*
1676 * If numbered is set solely due to format.numbered in config,
1677 * and it would conflict with --keep-subject (-k) from the
1678 * command line, reset "numbered".
1679 */
1680 if (numbered && keep_subject && !numbered_cmdline_opt)
1681 numbered = 0;
1682
63b398a4 1683 if (numbered && keep_subject)
1a07e59c 1684 die(_("-n and -k are mutually exclusive"));
2d9e4a47 1685 if (keep_subject && subject_prefix)
1a07e59c 1686 die(_("--subject-prefix/--rfc and -k are mutually exclusive"));
9553d2b2 1687 rev.preserve_subject = keep_subject;
8ac80a57 1688
32962c9b 1689 argc = setup_revisions(argc, argv, &rev, &s_r_opt);
2448482b 1690 if (argc > 1)
1a07e59c 1691 die(_("unrecognized argument: %s"), argv[1]);
0377db77 1692
02bc5b03 1693 if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
f338cb83 1694 die(_("--name-only does not make sense"));
02bc5b03 1695 if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
f338cb83 1696 die(_("--name-status does not make sense"));
02bc5b03 1697 if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
f338cb83 1698 die(_("--check does not make sense"));
02bc5b03
BG
1699
1700 if (!use_patch_format &&
1701 (!rev.diffopt.output_format ||
1702 rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1703 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
071dd0ba
NTND
1704 if (!rev.diffopt.stat_width)
1705 rev.diffopt.stat_width = MAIL_DEFAULT_WRAP;
02bc5b03
BG
1706
1707 /* Always generate a patch */
1708 rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
c9b5ef99 1709
3a30aa17 1710 rev.zero_commit = zero_commit;
1711
0d1e0e78
BW
1712 if (!rev.diffopt.flags.text && !no_binary_diff)
1713 rev.diffopt.flags.binary = 1;
e47f306d 1714
894a9d33
TR
1715 if (rev.show_notes)
1716 init_display_notes(&rev.notes_opt);
1717
bc6bf2d7
AK
1718 if (!output_directory && !use_stdout)
1719 output_directory = config_output_directory;
1720
9800a754
JH
1721 if (!use_stdout)
1722 output_directory = set_outdir(prefix, output_directory);
38a94bb6
TRC
1723 else
1724 setup_pager();
77e565d8 1725
efd02016 1726 if (output_directory) {
11f4eb19
JS
1727 if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
1728 rev.diffopt.use_color = GIT_COLOR_NEVER;
efd02016 1729 if (use_stdout)
5c5f1d7c 1730 die(_("standard output, or directory, which one?"));
efd02016 1731 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
5c5f1d7c 1732 die_errno(_("Could not create directory '%s'"),
0721c314 1733 output_directory);
efd02016
JH
1734 }
1735
1f1e895f 1736 if (rev.pending.nr == 1) {
427a8ec5
FC
1737 int check_head = 0;
1738
8a1d076e
JH
1739 if (rev.max_count < 0 && !rev.show_root_diff) {
1740 /*
1741 * This is traditional behaviour of "git format-patch
1742 * origin" that prepares what the origin side still
1743 * does not have.
1744 */
7c496280 1745 rev.pending.objects[0].item->flags |= UNINTERESTING;
3384a2df 1746 add_head_to_pending(&rev);
427a8ec5 1747 check_head = 1;
7c496280 1748 }
8a1d076e
JH
1749 /*
1750 * Otherwise, it is "format-patch -22 HEAD", and/or
1751 * "format-patch --root HEAD". The user wants
1752 * get_revision() to do the usual traversal.
7c496280 1753 */
427a8ec5
FC
1754
1755 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
1756 check_head = 1;
1757
1758 if (check_head) {
95b567c7 1759 const char *ref, *v;
7695d118 1760 ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
744c040b 1761 NULL, NULL);
95b567c7
JK
1762 if (ref && skip_prefix(ref, "refs/heads/", &v))
1763 branch_name = xstrdup(v);
427a8ec5
FC
1764 else
1765 branch_name = xstrdup(""); /* no branch */
1766 }
e686eb98 1767 }
68c2ec7f
JH
1768
1769 /*
1770 * We cannot move this anywhere earlier because we do want to
9517e6b8 1771 * know if --root was given explicitly from the command line.
68c2ec7f
JH
1772 */
1773 rev.show_root_diff = 1;
1774
657ab61e
KB
1775 if (ignore_if_in_upstream) {
1776 /* Don't say anything if head and upstream are the same. */
1777 if (rev.pending.nr == 2) {
1778 struct object_array_entry *o = rev.pending.objects;
4a7e27e9 1779 if (oideq(&o[0].item->oid, &o[1].item->oid))
126facf8 1780 goto done;
657ab61e 1781 }
811929f1 1782 get_patch_ids(&rev, &ids);
657ab61e 1783 }
9c6efa36 1784
3d51e1b5 1785 if (prepare_revision_walk(&rev))
5c5f1d7c 1786 die(_("revision walk setup failed"));
2bda2cf4 1787 rev.boundary = 1;
91efcf60 1788 while ((commit = get_revision(&rev)) != NULL) {
2bda2cf4 1789 if (commit->object.flags & BOUNDARY) {
2bda2cf4
DB
1790 boundary_count++;
1791 origin = (boundary_count == 1) ? commit : NULL;
1792 continue;
1793 }
1794
3acf8dd8 1795 if (ignore_if_in_upstream && has_commit_patch_id(commit, &ids))
9c6efa36
JS
1796 continue;
1797
91efcf60 1798 nr++;
2756ca43 1799 REALLOC_ARRAY(list, nr);
91efcf60
JH
1800 list[nr - 1] = commit;
1801 }
80d35ca0
FC
1802 if (nr == 0)
1803 /* nothing to do */
126facf8 1804 goto done;
0377db77 1805 total = nr;
2a4c2607
FC
1806 if (cover_letter == -1) {
1807 if (config_cover_letter == COVER_AUTO)
1808 cover_letter = (total > 1);
1809 else
1810 cover_letter = (config_cover_letter == COVER_ON);
1811 }
957ed3a5
JK
1812 if (!keep_subject && auto_number && (total > 1 || cover_letter))
1813 numbered = 1;
1814 if (numbered)
1815 rev.total = total + start_number - 1;
2a4c2607 1816
126facf8 1817 if (idiff_prev.nr) {
ee6cbf71
ES
1818 if (!cover_letter && total != 1)
1819 die(_("--interdiff requires --cover-letter or single patch"));
126facf8
ES
1820 rev.idiff_oid1 = &idiff_prev.oid[idiff_prev.nr - 1];
1821 rev.idiff_oid2 = get_commit_tree_oid(list[0]);
5ac290f9
ES
1822 rev.idiff_title = diff_title(&idiff_title, reroll_count,
1823 _("Interdiff:"),
1824 _("Interdiff against v%d:"));
126facf8
ES
1825 }
1826
8631bf1c
ES
1827 if (creation_factor < 0)
1828 creation_factor = RANGE_DIFF_CREATION_FACTOR_DEFAULT;
1829 else if (!rdiff_prev)
1830 die(_("--creation-factor requires --range-diff"));
1831
31e2617a 1832 if (rdiff_prev) {
40ce4160
ES
1833 if (!cover_letter && total != 1)
1834 die(_("--range-diff requires --cover-letter or single patch"));
31e2617a 1835
2e6fd71a
ES
1836 infer_range_diff_ranges(&rdiff1, &rdiff2, rdiff_prev,
1837 origin, list[0]);
31e2617a
ES
1838 rev.rdiff1 = rdiff1.buf;
1839 rev.rdiff2 = rdiff2.buf;
8631bf1c 1840 rev.creation_factor = creation_factor;
4ee99689
ES
1841 rev.rdiff_title = diff_title(&rdiff_title, reroll_count,
1842 _("Range-diff:"),
1843 _("Range-diff against v%d:"));
31e2617a
ES
1844 }
1845
7022650f
JM
1846 if (!signature) {
1847 ; /* --no-signature inhibits all signatures */
1848 } else if (signature && signature != git_version_string) {
1849 ; /* non-default signature already set */
1850 } else if (signature_file) {
1851 struct strbuf buf = STRBUF_INIT;
1852
1853 if (strbuf_read_file(&buf, signature_file, 128) < 0)
1854 die_errno(_("unable to read signature file '%s'"), signature_file);
1855 signature = strbuf_detach(&buf, NULL);
1856 }
1857
fa2ab86d 1858 memset(&bases, 0, sizeof(bases));
bb52995f 1859 if (base_commit || base_auto) {
fa2ab86d
XY
1860 struct commit *base = get_base_commit(base_commit, list, nr);
1861 reset_revision_walk();
15b76c1f 1862 clear_object_flags(UNINTERESTING);
fa2ab86d
XY
1863 prepare_bases(&bases, base, list, nr);
1864 }
1865
b079c50e
TR
1866 if (in_reply_to || thread || cover_letter)
1867 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1868 if (in_reply_to) {
1869 const char *msgid = clean_message_id(in_reply_to);
1d2f80fa 1870 string_list_append(rev.ref_message_ids, msgid);
b079c50e 1871 }
ce37596c 1872 rev.numbered_files = just_numbers;
108dab28 1873 rev.patch_suffix = fmt_patch_suffix;
a5a27c79
DB
1874 if (cover_letter) {
1875 if (thread)
1876 gen_message_id(&rev, "cover");
ce37596c 1877 make_cover_letter(&rev, use_stdout,
d7ddad01 1878 origin, nr, list, branch_name, quiet);
95235f5b 1879 print_bases(&bases, rev.diffopt.file);
480871e0 1880 print_signature(rev.diffopt.file);
a5a27c79
DB
1881 total++;
1882 start_number--;
40ce4160 1883 /* interdiff/range-diff in cover-letter; omit from patches */
ee6cbf71 1884 rev.idiff_oid1 = NULL;
40ce4160 1885 rev.rdiff1 = NULL;
a5a27c79 1886 }
5289c56a 1887 rev.add_signoff = do_signoff;
738e88a2
KW
1888
1889 if (show_progress)
d33a4332 1890 progress = start_delayed_progress(_("Generating patches"), total);
91efcf60
JH
1891 while (0 <= --nr) {
1892 int shown;
738e88a2 1893 display_progress(progress, total - nr);
91efcf60 1894 commit = list[nr];
add5c8a5 1895 rev.nr = total - nr + (start_number - 1);
d1566f78 1896 /* Make the second and subsequent mails replies to the first */
cc35de84 1897 if (thread) {
a5a27c79 1898 /* Have we already had a message ID? */
e1a37346 1899 if (rev.message_id) {
a5a27c79 1900 /*
30984ed2
TR
1901 * For deep threading: make every mail
1902 * a reply to the previous one, no
1903 * matter what other options are set.
1904 *
1905 * For shallow threading:
1906 *
2175c10d
TR
1907 * Without --cover-letter and
1908 * --in-reply-to, make every mail a
1909 * reply to the one before.
1910 *
1911 * With --in-reply-to but no
1912 * --cover-letter, make every mail a
1913 * reply to the <reply-to>.
1914 *
1915 * With --cover-letter, make every
1916 * mail but the cover letter a reply
1917 * to the cover letter. The cover
1918 * letter is a reply to the
1919 * --in-reply-to, if specified.
a5a27c79 1920 */
30984ed2
TR
1921 if (thread == THREAD_SHALLOW
1922 && rev.ref_message_ids->nr > 0
2175c10d 1923 && (!cover_letter || rev.nr > 1))
e1a37346
DB
1924 free(rev.message_id);
1925 else
1d2f80fa
JP
1926 string_list_append(rev.ref_message_ids,
1927 rev.message_id);
cc35de84 1928 }
f2fd0760 1929 gen_message_id(&rev, oid_to_hex(&commit->object.oid));
d1566f78 1930 }
6df514af 1931
a21c2f94 1932 if (!use_stdout &&
95235f5b 1933 open_next_file(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
5c5f1d7c 1934 die(_("Failed to create output files"));
91efcf60 1935 shown = log_tree_commit(&rev, commit);
0fb370da 1936 free_commit_buffer(commit);
add5c8a5
JH
1937
1938 /* We put one extra blank line between formatted
1939 * patches and this flag is used by log-tree code
1940 * to see if it needs to emit a LF before showing
1941 * the log; when using one file per patch, we do
1942 * not want the extra blank line.
1943 */
1944 if (!use_stdout)
1945 rev.shown_one = 0;
698ce6f8 1946 if (shown) {
480871e0 1947 print_bases(&bases, rev.diffopt.file);
698ce6f8 1948 if (rev.mime_boundary)
95235f5b 1949 fprintf(rev.diffopt.file, "\n--%s%s--\n\n\n",
698ce6f8
JS
1950 mime_boundary_leader,
1951 rev.mime_boundary);
1952 else
95235f5b 1953 print_signature(rev.diffopt.file);
698ce6f8 1954 }
0377db77 1955 if (!use_stdout)
95235f5b 1956 fclose(rev.diffopt.file);
91efcf60 1957 }
738e88a2 1958 stop_progress(&progress);
91efcf60 1959 free(list);
739453a3 1960 free(branch_name);
ca9e0a1b
SB
1961 string_list_clear(&extra_to, 0);
1962 string_list_clear(&extra_cc, 0);
1963 string_list_clear(&extra_hdr, 0);
5d23e133
JH
1964 if (ignore_if_in_upstream)
1965 free_patch_ids(&ids);
126facf8
ES
1966
1967done:
1968 oid_array_clear(&idiff_prev);
5ac290f9 1969 strbuf_release(&idiff_title);
31e2617a
ES
1970 strbuf_release(&rdiff1);
1971 strbuf_release(&rdiff2);
4ee99689 1972 strbuf_release(&rdiff_title);
91efcf60
JH
1973 return 0;
1974}
1975
e827633a
RS
1976static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1977{
d801627b 1978 struct object_id oid;
1979 if (get_oid(arg, &oid) == 0) {
2122f675
SB
1980 struct commit *commit = lookup_commit_reference(the_repository,
1981 &oid);
e827633a
RS
1982 if (commit) {
1983 commit->object.flags |= flags;
1984 add_pending_object(revs, &commit->object, arg);
1985 return 0;
1986 }
1987 }
1988 return -1;
1989}
1990
28a53178 1991static const char * const cherry_usage[] = {
986d1bb8 1992 N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
28a53178
EFL
1993 NULL
1994};
1995
a3a32e7f 1996static void print_commit(char sign, struct commit *commit, int verbose,
95235f5b 1997 int abbrev, FILE *file)
a3a32e7f
JN
1998{
1999 if (!verbose) {
95235f5b 2000 fprintf(file, "%c %s\n", sign,
aab9583f 2001 find_unique_abbrev(&commit->object.oid, abbrev));
a3a32e7f
JN
2002 } else {
2003 struct strbuf buf = STRBUF_INIT;
f67d2e82 2004 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
95235f5b 2005 fprintf(file, "%c %s %s\n", sign,
aab9583f 2006 find_unique_abbrev(&commit->object.oid, abbrev),
a3a32e7f
JN
2007 buf.buf);
2008 strbuf_release(&buf);
2009 }
2010}
2011
e827633a
RS
2012int cmd_cherry(int argc, const char **argv, const char *prefix)
2013{
2014 struct rev_info revs;
5d23e133 2015 struct patch_ids ids;
e827633a
RS
2016 struct commit *commit;
2017 struct commit_list *list = NULL;
f2968022 2018 struct branch *current_branch;
e827633a
RS
2019 const char *upstream;
2020 const char *head = "HEAD";
2021 const char *limit = NULL;
28a53178 2022 int verbose = 0, abbrev = 0;
e827633a 2023
28a53178
EFL
2024 struct option options[] = {
2025 OPT__ABBREV(&abbrev),
986d1bb8 2026 OPT__VERBOSE(&verbose, N_("be verbose")),
28a53178
EFL
2027 OPT_END()
2028 };
e827633a 2029
28a53178 2030 argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
fef34270 2031
e827633a 2032 switch (argc) {
e827633a 2033 case 3:
28a53178 2034 limit = argv[2];
e827633a
RS
2035 /* FALLTHROUGH */
2036 case 2:
28a53178
EFL
2037 head = argv[1];
2038 /* FALLTHROUGH */
2039 case 1:
2040 upstream = argv[0];
e827633a
RS
2041 break;
2042 default:
f2968022 2043 current_branch = branch_get(NULL);
3a429d0a 2044 upstream = branch_get_upstream(current_branch, NULL);
a9f9f8cc 2045 if (!upstream) {
5c5f1d7c 2046 fprintf(stderr, _("Could not find a tracked"
f2968022 2047 " remote branch, please"
5c5f1d7c 2048 " specify <upstream> manually.\n"));
28a53178 2049 usage_with_options(cherry_usage, options);
f2968022 2050 }
e827633a
RS
2051 }
2052
2abf3503 2053 repo_init_revisions(the_repository, &revs, prefix);
51f4de3a 2054 revs.max_parents = 1;
e827633a
RS
2055
2056 if (add_pending_commit(head, &revs, 0))
5c5f1d7c 2057 die(_("Unknown commit %s"), head);
e827633a 2058 if (add_pending_commit(upstream, &revs, UNINTERESTING))
5c5f1d7c 2059 die(_("Unknown commit %s"), upstream);
e827633a
RS
2060
2061 /* Don't say anything if head and upstream are the same. */
2062 if (revs.pending.nr == 2) {
2063 struct object_array_entry *o = revs.pending.objects;
4a7e27e9 2064 if (oideq(&o[0].item->oid, &o[1].item->oid))
e827633a
RS
2065 return 0;
2066 }
2067
811929f1 2068 get_patch_ids(&revs, &ids);
e827633a
RS
2069
2070 if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
5c5f1d7c 2071 die(_("Unknown commit %s"), limit);
e827633a
RS
2072
2073 /* reverse the list of commits */
3d51e1b5 2074 if (prepare_revision_walk(&revs))
5c5f1d7c 2075 die(_("revision walk setup failed"));
e827633a 2076 while ((commit = get_revision(&revs)) != NULL) {
e827633a
RS
2077 commit_list_insert(commit, &list);
2078 }
2079
2080 while (list) {
e827633a
RS
2081 char sign = '+';
2082
2083 commit = list->item;
5d23e133 2084 if (has_commit_patch_id(commit, &ids))
e827633a 2085 sign = '-';
95235f5b 2086 print_commit(sign, commit, verbose, abbrev, revs.diffopt.file);
e827633a
RS
2087 list = list->next;
2088 }
2089
5d23e133 2090 free_patch_ids(&ids);
e827633a
RS
2091 return 0;
2092}