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