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