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