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