git.oblomov.eu Git - git/blob - builtin/log.c

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