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