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