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