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