builtin/log.c

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