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