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