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