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 const char *signature_file;
 673 static int config_cover_letter;
 674
 675 enum {
 676         COVER_UNSET,
 677         COVER_OFF,
 678         COVER_ON,
 679         COVER_AUTO
 680 };
 681
 682 static int git_format_config(const char *var, const char *value, void *cb)
 683 {
 684         if (!strcmp(var, "format.headers")) {
 685                 if (!value)
 686                         die(_("format.headers without value"));
 687                 add_header(value);
 688                 return 0;
 689         }
 690         if (!strcmp(var, "format.suffix"))
 691                 return git_config_string(&fmt_patch_suffix, var, value);
 692         if (!strcmp(var, "format.to")) {
 693                 if (!value)
 694                         return config_error_nonbool(var);
 695                 string_list_append(&extra_to, value);
 696                 return 0;
 697         }
 698         if (!strcmp(var, "format.cc")) {
 699                 if (!value)
 700                         return config_error_nonbool(var);
 701                 string_list_append(&extra_cc, value);
 702                 return 0;
 703         }
 704         if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
 705             !strcmp(var, "color.ui")) {
 706                 return 0;
 707         }
 708         if (!strcmp(var, "format.numbered")) {
 709                 if (value && !strcasecmp(value, "auto")) {
 710                         auto_number = 1;
 711                         return 0;
 712                 }
 713                 numbered = git_config_bool(var, value);
 714                 auto_number = auto_number && numbered;
 715                 return 0;
 716         }
 717         if (!strcmp(var, "format.attach")) {
 718                 if (value && *value)
 719                         default_attach = xstrdup(value);
 720                 else
 721                         default_attach = xstrdup(git_version_string);
 722                 return 0;
 723         }
 724         if (!strcmp(var, "format.thread")) {
 725                 if (value && !strcasecmp(value, "deep")) {
 726                         thread = THREAD_DEEP;
 727                         return 0;
 728                 }
 729                 if (value && !strcasecmp(value, "shallow")) {
 730                         thread = THREAD_SHALLOW;
 731                         return 0;
 732                 }
 733                 thread = git_config_bool(var, value) && THREAD_SHALLOW;
 734                 return 0;
 735         }
 736         if (!strcmp(var, "format.signoff")) {
 737                 do_signoff = git_config_bool(var, value);
 738                 return 0;
 739         }
 740         if (!strcmp(var, "format.signature"))
 741                 return git_config_string(&signature, var, value);
 742         if (!strcmp(var, "format.signaturefile"))
 743                 return git_config_pathname(&signature_file, var, value);
 744         if (!strcmp(var, "format.coverletter")) {
 745                 if (value && !strcasecmp(value, "auto")) {
 746                         config_cover_letter = COVER_AUTO;
 747                         return 0;
 748                 }
 749                 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
 750                 return 0;
 751         }
 752
 753         return git_log_config(var, value, cb);
 754 }
 755
 756 static FILE *realstdout = NULL;
 757 static const char *output_directory = NULL;
 758 static int outdir_offset;
 759
 760 static int reopen_stdout(struct commit *commit, const char *subject,
 761                          struct rev_info *rev, int quiet)
 762 {
 763         struct strbuf filename = STRBUF_INIT;
 764         int suffix_len = strlen(rev->patch_suffix) + 1;
 765
 766         if (output_directory) {
 767                 strbuf_addstr(&filename, output_directory);
 768                 if (filename.len >=
 769                     PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
 770                         return error(_("name of output directory is too long"));
 771                 if (filename.buf[filename.len - 1] != '/')
 772                         strbuf_addch(&filename, '/');
 773         }
 774
 775         if (rev->numbered_files)
 776                 strbuf_addf(&filename, "%d", rev->nr);
 777         else if (commit)
 778                 fmt_output_commit(&filename, commit, rev);
 779         else
 780                 fmt_output_subject(&filename, subject, rev);
 781
 782         if (!quiet)
 783                 fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
 784
 785         if (freopen(filename.buf, "w", stdout) == NULL)
 786                 return error(_("Cannot open patch file %s"), filename.buf);
 787
 788         strbuf_release(&filename);
 789         return 0;
 790 }
 791
 792 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
 793 {
 794         struct rev_info check_rev;
 795         struct commit *commit;
 796         struct object *o1, *o2;
 797         unsigned flags1, flags2;
 798
 799         if (rev->pending.nr != 2)
 800                 die(_("Need exactly one range."));
 801
 802         o1 = rev->pending.objects[0].item;
 803         flags1 = o1->flags;
 804         o2 = rev->pending.objects[1].item;
 805         flags2 = o2->flags;
 806
 807         if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
 808                 die(_("Not a range."));
 809
 810         init_patch_ids(ids);
 811
 812         /* given a range a..b get all patch ids for b..a */
 813         init_revisions(&check_rev, rev->prefix);
 814         check_rev.max_parents = 1;
 815         o1->flags ^= UNINTERESTING;
 816         o2->flags ^= UNINTERESTING;
 817         add_pending_object(&check_rev, o1, "o1");
 818         add_pending_object(&check_rev, o2, "o2");
 819         if (prepare_revision_walk(&check_rev))
 820                 die(_("revision walk setup failed"));
 821
 822         while ((commit = get_revision(&check_rev)) != NULL) {
 823                 add_commit_patch_id(commit, ids);
 824         }
 825
 826         /* reset for next revision walk */
 827         clear_commit_marks((struct commit *)o1,
 828                         SEEN | UNINTERESTING | SHOWN | ADDED);
 829         clear_commit_marks((struct commit *)o2,
 830                         SEEN | UNINTERESTING | SHOWN | ADDED);
 831         o1->flags = flags1;
 832         o2->flags = flags2;
 833 }
 834
 835 static void gen_message_id(struct rev_info *info, char *base)
 836 {
 837         struct strbuf buf = STRBUF_INIT;
 838         strbuf_addf(&buf, "%s.%lu.git.%s", base,
 839                     (unsigned long) time(NULL),
 840                     git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
 841         info->message_id = strbuf_detach(&buf, NULL);
 842 }
 843
 844 static void print_signature(void)
 845 {
 846         if (!signature || !*signature)
 847                 return;
 848
 849         printf("-- \n%s", signature);
 850         if (signature[strlen(signature)-1] != '\n')
 851                 putchar('\n');
 852         putchar('\n');
 853 }
 854
 855 static void add_branch_description(struct strbuf *buf, const char *branch_name)
 856 {
 857         struct strbuf desc = STRBUF_INIT;
 858         if (!branch_name || !*branch_name)
 859                 return;
 860         read_branch_desc(&desc, branch_name);
 861         if (desc.len) {
 862                 strbuf_addch(buf, '\n');
 863                 strbuf_add(buf, desc.buf, desc.len);
 864                 strbuf_addch(buf, '\n');
 865         }
 866 }
 867
 868 static char *find_branch_name(struct rev_info *rev)
 869 {
 870         int i, positive = -1;
 871         unsigned char branch_sha1[20];
 872         const unsigned char *tip_sha1;
 873         const char *ref;
 874         char *full_ref, *branch = NULL;
 875
 876         for (i = 0; i < rev->cmdline.nr; i++) {
 877                 if (rev->cmdline.rev[i].flags & UNINTERESTING)
 878                         continue;
 879                 if (positive < 0)
 880                         positive = i;
 881                 else
 882                         return NULL;
 883         }
 884         if (positive < 0)
 885                 return NULL;
 886         ref = rev->cmdline.rev[positive].name;
 887         tip_sha1 = rev->cmdline.rev[positive].item->sha1;
 888         if (dwim_ref(ref, strlen(ref), branch_sha1, &full_ref) &&
 889             starts_with(full_ref, "refs/heads/") &&
 890             !hashcmp(tip_sha1, branch_sha1))
 891                 branch = xstrdup(full_ref + strlen("refs/heads/"));
 892         free(full_ref);
 893         return branch;
 894 }
 895
 896 static void make_cover_letter(struct rev_info *rev, int use_stdout,
 897                               struct commit *origin,
 898                               int nr, struct commit **list,
 899                               const char *branch_name,
 900                               int quiet)
 901 {
 902         const char *committer;
 903         const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
 904         const char *msg;
 905         struct shortlog log;
 906         struct strbuf sb = STRBUF_INIT;
 907         int i;
 908         const char *encoding = "UTF-8";
 909         struct diff_options opts;
 910         int need_8bit_cte = 0;
 911         struct pretty_print_context pp = {0};
 912         struct commit *head = list[0];
 913
 914         if (rev->commit_format != CMIT_FMT_EMAIL)
 915                 die(_("Cover letter needs email format"));
 916
 917         committer = git_committer_info(0);
 918
 919         if (!use_stdout &&
 920             reopen_stdout(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
 921                 return;
 922
 923         log_write_email_headers(rev, head, &pp.subject, &pp.after_subject,
 924                                 &need_8bit_cte);
 925
 926         for (i = 0; !need_8bit_cte && i < nr; i++)
 927                 if (has_non_ascii(list[i]->buffer))
 928                         need_8bit_cte = 1;
 929
 930         if (!branch_name)
 931                 branch_name = find_branch_name(rev);
 932
 933         msg = body;
 934         pp.fmt = CMIT_FMT_EMAIL;
 935         pp.date_mode = DATE_RFC2822;
 936         pp_user_info(&pp, NULL, &sb, committer, encoding);
 937         pp_title_line(&pp, &msg, &sb, encoding, need_8bit_cte);
 938         pp_remainder(&pp, &msg, &sb, 0);
 939         add_branch_description(&sb, branch_name);
 940         printf("%s\n", sb.buf);
 941
 942         strbuf_release(&sb);
 943
 944         shortlog_init(&log);
 945         log.wrap_lines = 1;
 946         log.wrap = 72;
 947         log.in1 = 2;
 948         log.in2 = 4;
 949         for (i = 0; i < nr; i++)
 950                 shortlog_add_commit(&log, list[i]);
 951
 952         shortlog_output(&log);
 953
 954         /*
 955          * We can only do diffstat with a unique reference point
 956          */
 957         if (!origin)
 958                 return;
 959
 960         memcpy(&opts, &rev->diffopt, sizeof(opts));
 961         opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
 962
 963         diff_setup_done(&opts);
 964
 965         diff_tree_sha1(origin->tree->object.sha1,
 966                        head->tree->object.sha1,
 967                        "", &opts);
 968         diffcore_std(&opts);
 969         diff_flush(&opts);
 970
 971         printf("\n");
 972         print_signature();
 973 }
 974
 975 static const char *clean_message_id(const char *msg_id)
 976 {
 977         char ch;
 978         const char *a, *z, *m;
 979
 980         m = msg_id;
 981         while ((ch = *m) && (isspace(ch) || (ch == '<')))
 982                 m++;
 983         a = m;
 984         z = NULL;
 985         while ((ch = *m)) {
 986                 if (!isspace(ch) && (ch != '>'))
 987                         z = m;
 988                 m++;
 989         }
 990         if (!z)
 991                 die(_("insane in-reply-to: %s"), msg_id);
 992         if (++z == m)
 993                 return a;
 994         return xmemdupz(a, z - a);
 995 }
 996
 997 static const char *set_outdir(const char *prefix, const char *output_directory)
 998 {
 999         if (output_directory && is_absolute_path(output_directory))
1000                 return output_directory;
1001
1002         if (!prefix || !*prefix) {
1003                 if (output_directory)
1004                         return output_directory;
1005                 /* The user did not explicitly ask for "./" */
1006                 outdir_offset = 2;
1007                 return "./";
1008         }
1009
1010         outdir_offset = strlen(prefix);
1011         if (!output_directory)
1012                 return prefix;
1013
1014         return xstrdup(prefix_filename(prefix, outdir_offset,
1015                                        output_directory));
1016 }
1017
1018 static const char * const builtin_format_patch_usage[] = {
1019         N_("git format-patch [options] [<since> | <revision range>]"),
1020         NULL
1021 };
1022
1023 static int keep_subject = 0;
1024
1025 static int keep_callback(const struct option *opt, const char *arg, int unset)
1026 {
1027         ((struct rev_info *)opt->value)->total = -1;
1028         keep_subject = 1;
1029         return 0;
1030 }
1031
1032 static int subject_prefix = 0;
1033
1034 static int subject_prefix_callback(const struct option *opt, const char *arg,
1035                             int unset)
1036 {
1037         subject_prefix = 1;
1038         ((struct rev_info *)opt->value)->subject_prefix = arg;
1039         return 0;
1040 }
1041
1042 static int numbered_cmdline_opt = 0;
1043
1044 static int numbered_callback(const struct option *opt, const char *arg,
1045                              int unset)
1046 {
1047         *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
1048         if (unset)
1049                 auto_number =  0;
1050         return 0;
1051 }
1052
1053 static int no_numbered_callback(const struct option *opt, const char *arg,
1054                                 int unset)
1055 {
1056         return numbered_callback(opt, arg, 1);
1057 }
1058
1059 static int output_directory_callback(const struct option *opt, const char *arg,
1060                               int unset)
1061 {
1062         const char **dir = (const char **)opt->value;
1063         if (*dir)
1064                 die(_("Two output directories?"));
1065         *dir = arg;
1066         return 0;
1067 }
1068
1069 static int thread_callback(const struct option *opt, const char *arg, int unset)
1070 {
1071         int *thread = (int *)opt->value;
1072         if (unset)
1073                 *thread = 0;
1074         else if (!arg || !strcmp(arg, "shallow"))
1075                 *thread = THREAD_SHALLOW;
1076         else if (!strcmp(arg, "deep"))
1077                 *thread = THREAD_DEEP;
1078         else
1079                 return 1;
1080         return 0;
1081 }
1082
1083 static int attach_callback(const struct option *opt, const char *arg, int unset)
1084 {
1085         struct rev_info *rev = (struct rev_info *)opt->value;
1086         if (unset)
1087                 rev->mime_boundary = NULL;
1088         else if (arg)
1089                 rev->mime_boundary = arg;
1090         else
1091                 rev->mime_boundary = git_version_string;
1092         rev->no_inline = unset ? 0 : 1;
1093         return 0;
1094 }
1095
1096 static int inline_callback(const struct option *opt, const char *arg, int unset)
1097 {
1098         struct rev_info *rev = (struct rev_info *)opt->value;
1099         if (unset)
1100                 rev->mime_boundary = NULL;
1101         else if (arg)
1102                 rev->mime_boundary = arg;
1103         else
1104                 rev->mime_boundary = git_version_string;
1105         rev->no_inline = 0;
1106         return 0;
1107 }
1108
1109 static int header_callback(const struct option *opt, const char *arg, int unset)
1110 {
1111         if (unset) {
1112                 string_list_clear(&extra_hdr, 0);
1113                 string_list_clear(&extra_to, 0);
1114                 string_list_clear(&extra_cc, 0);
1115         } else {
1116             add_header(arg);
1117         }
1118         return 0;
1119 }
1120
1121 static int to_callback(const struct option *opt, const char *arg, int unset)
1122 {
1123         if (unset)
1124                 string_list_clear(&extra_to, 0);
1125         else
1126                 string_list_append(&extra_to, arg);
1127         return 0;
1128 }
1129
1130 static int cc_callback(const struct option *opt, const char *arg, int unset)
1131 {
1132         if (unset)
1133                 string_list_clear(&extra_cc, 0);
1134         else
1135                 string_list_append(&extra_cc, arg);
1136         return 0;
1137 }
1138
1139 static int from_callback(const struct option *opt, const char *arg, int unset)
1140 {
1141         char **from = opt->value;
1142
1143         free(*from);
1144
1145         if (unset)
1146                 *from = NULL;
1147         else if (arg)
1148                 *from = xstrdup(arg);
1149         else
1150                 *from = xstrdup(git_committer_info(IDENT_NO_DATE));
1151         return 0;
1152 }
1153
1154 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1155 {
1156         struct commit *commit;
1157         struct commit **list = NULL;
1158         struct rev_info rev;
1159         struct setup_revision_opt s_r_opt;
1160         int nr = 0, total, i;
1161         int use_stdout = 0;
1162         int start_number = -1;
1163         int just_numbers = 0;
1164         int ignore_if_in_upstream = 0;
1165         int cover_letter = -1;
1166         int boundary_count = 0;
1167         int no_binary_diff = 0;
1168         struct commit *origin = NULL;
1169         const char *in_reply_to = NULL;
1170         struct patch_ids ids;
1171         struct strbuf buf = STRBUF_INIT;
1172         int use_patch_format = 0;
1173         int quiet = 0;
1174         int reroll_count = -1;
1175         char *branch_name = NULL;
1176         char *from = NULL;
1177         const struct option builtin_format_patch_options[] = {
1178                 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
1179                             N_("use [PATCH n/m] even with a single patch"),
1180                             PARSE_OPT_NOARG, numbered_callback },
1181                 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
1182                             N_("use [PATCH] even with multiple patches"),
1183                             PARSE_OPT_NOARG, no_numbered_callback },
1184                 OPT_BOOL('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
1185                 OPT_BOOL(0, "stdout", &use_stdout,
1186                             N_("print patches to standard out")),
1187                 OPT_BOOL(0, "cover-letter", &cover_letter,
1188                             N_("generate a cover letter")),
1189                 OPT_BOOL(0, "numbered-files", &just_numbers,
1190                             N_("use simple number sequence for output file names")),
1191                 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1192                             N_("use <sfx> instead of '.patch'")),
1193                 OPT_INTEGER(0, "start-number", &start_number,
1194                             N_("start numbering patches at <n> instead of 1")),
1195                 OPT_INTEGER('v', "reroll-count", &reroll_count,
1196                             N_("mark the series as Nth re-roll")),
1197                 { OPTION_CALLBACK, 0, "subject-prefix", &rev, N_("prefix"),
1198                             N_("Use [<prefix>] instead of [PATCH]"),
1199                             PARSE_OPT_NONEG, subject_prefix_callback },
1200                 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
1201                             N_("dir"), N_("store resulting files in <dir>"),
1202                             PARSE_OPT_NONEG, output_directory_callback },
1203                 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
1204                             N_("don't strip/add [PATCH]"),
1205                             PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
1206                 OPT_BOOL(0, "no-binary", &no_binary_diff,
1207                          N_("don't output binary diffs")),
1208                 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1209                          N_("don't include a patch matching a commit upstream")),
1210                 { OPTION_SET_INT, 'p', "no-stat", &use_patch_format, NULL,
1211                   N_("show patch format instead of default (patch + stat)"),
1212                   PARSE_OPT_NONEG | PARSE_OPT_NOARG, NULL, 1},
1213                 OPT_GROUP(N_("Messaging")),
1214                 { OPTION_CALLBACK, 0, "add-header", NULL, N_("header"),
1215                             N_("add email header"), 0, header_callback },
1216                 { OPTION_CALLBACK, 0, "to", NULL, N_("email"), N_("add To: header"),
1217                             0, to_callback },
1218                 { OPTION_CALLBACK, 0, "cc", NULL, N_("email"), N_("add Cc: header"),
1219                             0, cc_callback },
1220                 { OPTION_CALLBACK, 0, "from", &from, N_("ident"),
1221                             N_("set From address to <ident> (or committer ident if absent)"),
1222                             PARSE_OPT_OPTARG, from_callback },
1223                 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1224                             N_("make first mail a reply to <message-id>")),
1225                 { OPTION_CALLBACK, 0, "attach", &rev, N_("boundary"),
1226                             N_("attach the patch"), PARSE_OPT_OPTARG,
1227                             attach_callback },
1228                 { OPTION_CALLBACK, 0, "inline", &rev, N_("boundary"),
1229                             N_("inline the patch"),
1230                             PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1231                             inline_callback },
1232                 { OPTION_CALLBACK, 0, "thread", &thread, N_("style"),
1233                             N_("enable message threading, styles: shallow, deep"),
1234                             PARSE_OPT_OPTARG, thread_callback },
1235                 OPT_STRING(0, "signature", &signature, N_("signature"),
1236                             N_("add a signature")),
1237                 OPT_FILENAME(0, "signature-file", &signature_file,
1238                                 N_("add a signature from a file")),
1239                 OPT__QUIET(&quiet, N_("don't print the patch filenames")),
1240                 OPT_END()
1241         };
1242
1243         extra_hdr.strdup_strings = 1;
1244         extra_to.strdup_strings = 1;
1245         extra_cc.strdup_strings = 1;
1246         init_grep_defaults();
1247         git_config(git_format_config, NULL);
1248         init_revisions(&rev, prefix);
1249         rev.commit_format = CMIT_FMT_EMAIL;
1250         rev.verbose_header = 1;
1251         rev.diff = 1;
1252         rev.max_parents = 1;
1253         DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
1254         rev.subject_prefix = fmt_patch_subject_prefix;
1255         memset(&s_r_opt, 0, sizeof(s_r_opt));
1256         s_r_opt.def = "HEAD";
1257         s_r_opt.revarg_opt = REVARG_COMMITTISH;
1258
1259         if (default_attach) {
1260                 rev.mime_boundary = default_attach;
1261                 rev.no_inline = 1;
1262         }
1263
1264         /*
1265          * Parse the arguments before setup_revisions(), or something
1266          * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1267          * possibly a valid SHA1.
1268          */
1269         argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1270                              builtin_format_patch_usage,
1271                              PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1272                              PARSE_OPT_KEEP_DASHDASH);
1273
1274         if (0 < reroll_count) {
1275                 struct strbuf sprefix = STRBUF_INIT;
1276                 strbuf_addf(&sprefix, "%s v%d",
1277                             rev.subject_prefix, reroll_count);
1278                 rev.reroll_count = reroll_count;
1279                 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1280         }
1281
1282         for (i = 0; i < extra_hdr.nr; i++) {
1283                 strbuf_addstr(&buf, extra_hdr.items[i].string);
1284                 strbuf_addch(&buf, '\n');
1285         }
1286
1287         if (extra_to.nr)
1288                 strbuf_addstr(&buf, "To: ");
1289         for (i = 0; i < extra_to.nr; i++) {
1290                 if (i)
1291                         strbuf_addstr(&buf, "    ");
1292                 strbuf_addstr(&buf, extra_to.items[i].string);
1293                 if (i + 1 < extra_to.nr)
1294                         strbuf_addch(&buf, ',');
1295                 strbuf_addch(&buf, '\n');
1296         }
1297
1298         if (extra_cc.nr)
1299                 strbuf_addstr(&buf, "Cc: ");
1300         for (i = 0; i < extra_cc.nr; i++) {
1301                 if (i)
1302                         strbuf_addstr(&buf, "    ");
1303                 strbuf_addstr(&buf, extra_cc.items[i].string);
1304                 if (i + 1 < extra_cc.nr)
1305                         strbuf_addch(&buf, ',');
1306                 strbuf_addch(&buf, '\n');
1307         }
1308
1309         rev.extra_headers = strbuf_detach(&buf, NULL);
1310
1311         if (from) {
1312                 if (split_ident_line(&rev.from_ident, from, strlen(from)))
1313                         die(_("invalid ident line: %s"), from);
1314         }
1315
1316         if (start_number < 0)
1317                 start_number = 1;
1318
1319         /*
1320          * If numbered is set solely due to format.numbered in config,
1321          * and it would conflict with --keep-subject (-k) from the
1322          * command line, reset "numbered".
1323          */
1324         if (numbered && keep_subject && !numbered_cmdline_opt)
1325                 numbered = 0;
1326
1327         if (numbered && keep_subject)
1328                 die (_("-n and -k are mutually exclusive."));
1329         if (keep_subject && subject_prefix)
1330                 die (_("--subject-prefix and -k are mutually exclusive."));
1331         rev.preserve_subject = keep_subject;
1332
1333         argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1334         if (argc > 1)
1335                 die (_("unrecognized argument: %s"), argv[1]);
1336
1337         if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1338                 die(_("--name-only does not make sense"));
1339         if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1340                 die(_("--name-status does not make sense"));
1341         if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1342                 die(_("--check does not make sense"));
1343
1344         if (!use_patch_format &&
1345                 (!rev.diffopt.output_format ||
1346                  rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1347                 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1348
1349         /* Always generate a patch */
1350         rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1351
1352         if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
1353                 DIFF_OPT_SET(&rev.diffopt, BINARY);
1354
1355         if (rev.show_notes)
1356                 init_display_notes(&rev.notes_opt);
1357
1358         if (!use_stdout)
1359                 output_directory = set_outdir(prefix, output_directory);
1360         else
1361                 setup_pager();
1362
1363         if (output_directory) {
1364                 if (use_stdout)
1365                         die(_("standard output, or directory, which one?"));
1366                 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1367                         die_errno(_("Could not create directory '%s'"),
1368                                   output_directory);
1369         }
1370
1371         if (rev.pending.nr == 1) {
1372                 int check_head = 0;
1373
1374                 if (rev.max_count < 0 && !rev.show_root_diff) {
1375                         /*
1376                          * This is traditional behaviour of "git format-patch
1377                          * origin" that prepares what the origin side still
1378                          * does not have.
1379                          */
1380                         rev.pending.objects[0].item->flags |= UNINTERESTING;
1381                         add_head_to_pending(&rev);
1382                         check_head = 1;
1383                 }
1384                 /*
1385                  * Otherwise, it is "format-patch -22 HEAD", and/or
1386                  * "format-patch --root HEAD".  The user wants
1387                  * get_revision() to do the usual traversal.
1388                  */
1389
1390                 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
1391                         check_head = 1;
1392
1393                 if (check_head) {
1394                         unsigned char sha1[20];
1395                         const char *ref;
1396                         ref = resolve_ref_unsafe("HEAD", sha1, 1, NULL);
1397                         if (ref && starts_with(ref, "refs/heads/"))
1398                                 branch_name = xstrdup(ref + strlen("refs/heads/"));
1399                         else
1400                                 branch_name = xstrdup(""); /* no branch */
1401                 }
1402         }
1403
1404         /*
1405          * We cannot move this anywhere earlier because we do want to
1406          * know if --root was given explicitly from the command line.
1407          */
1408         rev.show_root_diff = 1;
1409
1410         if (ignore_if_in_upstream) {
1411                 /* Don't say anything if head and upstream are the same. */
1412                 if (rev.pending.nr == 2) {
1413                         struct object_array_entry *o = rev.pending.objects;
1414                         if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1415                                 return 0;
1416                 }
1417                 get_patch_ids(&rev, &ids);
1418         }
1419
1420         if (!use_stdout)
1421                 realstdout = xfdopen(xdup(1), "w");
1422
1423         if (prepare_revision_walk(&rev))
1424                 die(_("revision walk setup failed"));
1425         rev.boundary = 1;
1426         while ((commit = get_revision(&rev)) != NULL) {
1427                 if (commit->object.flags & BOUNDARY) {
1428                         boundary_count++;
1429                         origin = (boundary_count == 1) ? commit : NULL;
1430                         continue;
1431                 }
1432
1433                 if (ignore_if_in_upstream &&
1434                                 has_commit_patch_id(commit, &ids))
1435                         continue;
1436
1437                 nr++;
1438                 list = xrealloc(list, nr * sizeof(list[0]));
1439                 list[nr - 1] = commit;
1440         }
1441         if (nr == 0)
1442                 /* nothing to do */
1443                 return 0;
1444         total = nr;
1445         if (!keep_subject && auto_number && total > 1)
1446                 numbered = 1;
1447         if (numbered)
1448                 rev.total = total + start_number - 1;
1449         if (cover_letter == -1) {
1450                 if (config_cover_letter == COVER_AUTO)
1451                         cover_letter = (total > 1);
1452                 else
1453                         cover_letter = (config_cover_letter == COVER_ON);
1454         }
1455
1456         if (!signature) {
1457                 ; /* --no-signature inhibits all signatures */
1458         } else if (signature && signature != git_version_string) {
1459                 ; /* non-default signature already set */
1460         } else if (signature_file) {
1461                 struct strbuf buf = STRBUF_INIT;
1462
1463                 if (strbuf_read_file(&buf, signature_file, 128) < 0)
1464                         die_errno(_("unable to read signature file '%s'"), signature_file);
1465                 signature = strbuf_detach(&buf, NULL);
1466         }
1467
1468         if (in_reply_to || thread || cover_letter)
1469                 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1470         if (in_reply_to) {
1471                 const char *msgid = clean_message_id(in_reply_to);
1472                 string_list_append(rev.ref_message_ids, msgid);
1473         }
1474         rev.numbered_files = just_numbers;
1475         rev.patch_suffix = fmt_patch_suffix;
1476         if (cover_letter) {
1477                 if (thread)
1478                         gen_message_id(&rev, "cover");
1479                 make_cover_letter(&rev, use_stdout,
1480                                   origin, nr, list, branch_name, quiet);
1481                 total++;
1482                 start_number--;
1483         }
1484         rev.add_signoff = do_signoff;
1485         while (0 <= --nr) {
1486                 int shown;
1487                 commit = list[nr];
1488                 rev.nr = total - nr + (start_number - 1);
1489                 /* Make the second and subsequent mails replies to the first */
1490                 if (thread) {
1491                         /* Have we already had a message ID? */
1492                         if (rev.message_id) {
1493                                 /*
1494                                  * For deep threading: make every mail
1495                                  * a reply to the previous one, no
1496                                  * matter what other options are set.
1497                                  *
1498                                  * For shallow threading:
1499                                  *
1500                                  * Without --cover-letter and
1501                                  * --in-reply-to, make every mail a
1502                                  * reply to the one before.
1503                                  *
1504                                  * With --in-reply-to but no
1505                                  * --cover-letter, make every mail a
1506                                  * reply to the <reply-to>.
1507                                  *
1508                                  * With --cover-letter, make every
1509                                  * mail but the cover letter a reply
1510                                  * to the cover letter.  The cover
1511                                  * letter is a reply to the
1512                                  * --in-reply-to, if specified.
1513                                  */
1514                                 if (thread == THREAD_SHALLOW
1515                                     && rev.ref_message_ids->nr > 0
1516                                     && (!cover_letter || rev.nr > 1))
1517                                         free(rev.message_id);
1518                                 else
1519                                         string_list_append(rev.ref_message_ids,
1520                                                            rev.message_id);
1521                         }
1522                         gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1523                 }
1524
1525                 if (!use_stdout &&
1526                     reopen_stdout(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
1527                         die(_("Failed to create output files"));
1528                 shown = log_tree_commit(&rev, commit);
1529                 free(commit->buffer);
1530                 commit->buffer = NULL;
1531
1532                 /* We put one extra blank line between formatted
1533                  * patches and this flag is used by log-tree code
1534                  * to see if it needs to emit a LF before showing
1535                  * the log; when using one file per patch, we do
1536                  * not want the extra blank line.
1537                  */
1538                 if (!use_stdout)
1539                         rev.shown_one = 0;
1540                 if (shown) {
1541                         if (rev.mime_boundary)
1542                                 printf("\n--%s%s--\n\n\n",
1543                                        mime_boundary_leader,
1544                                        rev.mime_boundary);
1545                         else
1546                                 print_signature();
1547                 }
1548                 if (!use_stdout)
1549                         fclose(stdout);
1550         }
1551         free(list);
1552         free(branch_name);
1553         string_list_clear(&extra_to, 0);
1554         string_list_clear(&extra_cc, 0);
1555         string_list_clear(&extra_hdr, 0);
1556         if (ignore_if_in_upstream)
1557                 free_patch_ids(&ids);
1558         return 0;
1559 }
1560
1561 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1562 {
1563         unsigned char sha1[20];
1564         if (get_sha1(arg, sha1) == 0) {
1565                 struct commit *commit = lookup_commit_reference(sha1);
1566                 if (commit) {
1567                         commit->object.flags |= flags;
1568                         add_pending_object(revs, &commit->object, arg);
1569                         return 0;
1570                 }
1571         }
1572         return -1;
1573 }
1574
1575 static const char * const cherry_usage[] = {
1576         N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
1577         NULL
1578 };
1579
1580 static void print_commit(char sign, struct commit *commit, int verbose,
1581                          int abbrev)
1582 {
1583         if (!verbose) {
1584                 printf("%c %s\n", sign,
1585                        find_unique_abbrev(commit->object.sha1, abbrev));
1586         } else {
1587                 struct strbuf buf = STRBUF_INIT;
1588                 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
1589                 printf("%c %s %s\n", sign,
1590                        find_unique_abbrev(commit->object.sha1, abbrev),
1591                        buf.buf);
1592                 strbuf_release(&buf);
1593         }
1594 }
1595
1596 int cmd_cherry(int argc, const char **argv, const char *prefix)
1597 {
1598         struct rev_info revs;
1599         struct patch_ids ids;
1600         struct commit *commit;
1601         struct commit_list *list = NULL;
1602         struct branch *current_branch;
1603         const char *upstream;
1604         const char *head = "HEAD";
1605         const char *limit = NULL;
1606         int verbose = 0, abbrev = 0;
1607
1608         struct option options[] = {
1609                 OPT__ABBREV(&abbrev),
1610                 OPT__VERBOSE(&verbose, N_("be verbose")),
1611                 OPT_END()
1612         };
1613
1614         argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
1615
1616         switch (argc) {
1617         case 3:
1618                 limit = argv[2];
1619                 /* FALLTHROUGH */
1620         case 2:
1621                 head = argv[1];
1622                 /* FALLTHROUGH */
1623         case 1:
1624                 upstream = argv[0];
1625                 break;
1626         default:
1627                 current_branch = branch_get(NULL);
1628                 if (!current_branch || !current_branch->merge
1629                                         || !current_branch->merge[0]
1630                                         || !current_branch->merge[0]->dst) {
1631                         fprintf(stderr, _("Could not find a tracked"
1632                                         " remote branch, please"
1633                                         " specify <upstream> manually.\n"));
1634                         usage_with_options(cherry_usage, options);
1635                 }
1636
1637                 upstream = current_branch->merge[0]->dst;
1638         }
1639
1640         init_revisions(&revs, prefix);
1641         revs.max_parents = 1;
1642
1643         if (add_pending_commit(head, &revs, 0))
1644                 die(_("Unknown commit %s"), head);
1645         if (add_pending_commit(upstream, &revs, UNINTERESTING))
1646                 die(_("Unknown commit %s"), upstream);
1647
1648         /* Don't say anything if head and upstream are the same. */
1649         if (revs.pending.nr == 2) {
1650                 struct object_array_entry *o = revs.pending.objects;
1651                 if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1652                         return 0;
1653         }
1654
1655         get_patch_ids(&revs, &ids);
1656
1657         if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1658                 die(_("Unknown commit %s"), limit);
1659
1660         /* reverse the list of commits */
1661         if (prepare_revision_walk(&revs))
1662                 die(_("revision walk setup failed"));
1663         while ((commit = get_revision(&revs)) != NULL) {
1664                 commit_list_insert(commit, &list);
1665         }
1666
1667         while (list) {
1668                 char sign = '+';
1669
1670                 commit = list->item;
1671                 if (has_commit_patch_id(commit, &ids))
1672                         sign = '-';
1673                 print_commit(sign, commit, verbose, abbrev);
1674                 list = list->next;
1675         }
1676
1677         free_patch_ids(&ids);
1678         return 0;
1679 }