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 #define USE_THE_INDEX_COMPATIBILITY_MACROS
   8 #include "cache.h"
   9 #include "config.h"
  10 #include "refs.h"
  11 #include "object-store.h"
  12 #include "color.h"
  13 #include "commit.h"
  14 #include "diff.h"
  15 #include "revision.h"
  16 #include "log-tree.h"
  17 #include "builtin.h"
  18 #include "tag.h"
  19 #include "reflog-walk.h"
  20 #include "patch-ids.h"
  21 #include "run-command.h"
  22 #include "shortlog.h"
  23 #include "remote.h"
  24 #include "string-list.h"
  25 #include "parse-options.h"
  26 #include "line-log.h"
  27 #include "branch.h"
  28 #include "streaming.h"
  29 #include "version.h"
  30 #include "mailmap.h"
  31 #include "gpg-interface.h"
  32 #include "progress.h"
  33 #include "commit-slab.h"
  34 #include "repository.h"
  35 #include "commit-reach.h"
  36 #include "interdiff.h"
  37 #include "range-diff.h"
  38
  39 #define MAIL_DEFAULT_WRAP 72
  40 #define COVER_FROM_AUTO_MAX_SUBJECT_LEN 100
  41
  42 /* Set a default date-time format for git log ("log.date" config variable) */
  43 static const char *default_date_mode = NULL;
  44
  45 static int default_abbrev_commit;
  46 static int default_show_root = 1;
  47 static int default_follow;
  48 static int default_show_signature;
  49 static int decoration_style;
  50 static int decoration_given;
  51 static int use_mailmap_config = 1;
  52 static const char *fmt_patch_subject_prefix = "PATCH";
  53 static const char *fmt_pretty;
  54
  55 static const char * const builtin_log_usage[] = {
  56         N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
  57         N_("git show [<options>] <object>..."),
  58         NULL
  59 };
  60
  61 struct line_opt_callback_data {
  62         struct rev_info *rev;
  63         const char *prefix;
  64         struct string_list args;
  65 };
  66
  67 static int session_is_interactive(void)
  68 {
  69         return isatty(1) || pager_in_use();
  70 }
  71
  72 static int auto_decoration_style(void)
  73 {
  74         return session_is_interactive() ? DECORATE_SHORT_REFS : 0;
  75 }
  76
  77 static int parse_decoration_style(const char *value)
  78 {
  79         switch (git_parse_maybe_bool(value)) {
  80         case 1:
  81                 return DECORATE_SHORT_REFS;
  82         case 0:
  83                 return 0;
  84         default:
  85                 break;
  86         }
  87         if (!strcmp(value, "full"))
  88                 return DECORATE_FULL_REFS;
  89         else if (!strcmp(value, "short"))
  90                 return DECORATE_SHORT_REFS;
  91         else if (!strcmp(value, "auto"))
  92                 return auto_decoration_style();
  93         /*
  94          * Please update _git_log() in git-completion.bash when you
  95          * add new decoration styles.
  96          */
  97         return -1;
  98 }
  99
 100 static int decorate_callback(const struct option *opt, const char *arg, int unset)
 101 {
 102         if (unset)
 103                 decoration_style = 0;
 104         else if (arg)
 105                 decoration_style = parse_decoration_style(arg);
 106         else
 107                 decoration_style = DECORATE_SHORT_REFS;
 108
 109         if (decoration_style < 0)
 110                 die(_("invalid --decorate option: %s"), arg);
 111
 112         decoration_given = 1;
 113
 114         return 0;
 115 }
 116
 117 static int log_line_range_callback(const struct option *option, const char *arg, int unset)
 118 {
 119         struct line_opt_callback_data *data = option->value;
 120
 121         BUG_ON_OPT_NEG(unset);
 122
 123         if (!arg)
 124                 return -1;
 125
 126         data->rev->line_level_traverse = 1;
 127         string_list_append(&data->args, arg);
 128
 129         return 0;
 130 }
 131
 132 static void init_log_defaults(void)
 133 {
 134         init_grep_defaults(the_repository);
 135         init_diff_ui_defaults();
 136
 137         decoration_style = auto_decoration_style();
 138 }
 139
 140 static void cmd_log_init_defaults(struct rev_info *rev)
 141 {
 142         if (fmt_pretty)
 143                 get_commit_format(fmt_pretty, rev);
 144         if (default_follow)
 145                 rev->diffopt.flags.default_follow_renames = 1;
 146         rev->verbose_header = 1;
 147         rev->diffopt.flags.recursive = 1;
 148         rev->diffopt.stat_width = -1; /* use full terminal width */
 149         rev->diffopt.stat_graph_width = -1; /* respect statGraphWidth config */
 150         rev->abbrev_commit = default_abbrev_commit;
 151         rev->show_root_diff = default_show_root;
 152         rev->subject_prefix = fmt_patch_subject_prefix;
 153         rev->show_signature = default_show_signature;
 154         rev->diffopt.flags.allow_textconv = 1;
 155
 156         if (default_date_mode)
 157                 parse_date_format(default_date_mode, &rev->date_mode);
 158 }
 159
 160 static void cmd_log_init_finish(int argc, const char **argv, const char *prefix,
 161                          struct rev_info *rev, struct setup_revision_opt *opt)
 162 {
 163         struct userformat_want w;
 164         int quiet = 0, source = 0, mailmap;
 165         static struct line_opt_callback_data line_cb = {NULL, NULL, STRING_LIST_INIT_DUP};
 166         static struct string_list decorate_refs_exclude = STRING_LIST_INIT_NODUP;
 167         static struct string_list decorate_refs_exclude_config = STRING_LIST_INIT_NODUP;
 168         static struct string_list decorate_refs_include = STRING_LIST_INIT_NODUP;
 169         struct decoration_filter decoration_filter = {&decorate_refs_include,
 170                                                       &decorate_refs_exclude,
 171                                                       &decorate_refs_exclude_config};
 172         static struct revision_sources revision_sources;
 173
 174         const struct option builtin_log_options[] = {
 175                 OPT__QUIET(&quiet, N_("suppress diff output")),
 176                 OPT_BOOL(0, "source", &source, N_("show source")),
 177                 OPT_BOOL(0, "use-mailmap", &mailmap, N_("Use mail map file")),
 178                 OPT_STRING_LIST(0, "decorate-refs", &decorate_refs_include,
 179                                 N_("pattern"), N_("only decorate refs that match <pattern>")),
 180                 OPT_STRING_LIST(0, "decorate-refs-exclude", &decorate_refs_exclude,
 181                                 N_("pattern"), N_("do not decorate refs that match <pattern>")),
 182                 { OPTION_CALLBACK, 0, "decorate", NULL, NULL, N_("decorate options"),
 183                   PARSE_OPT_OPTARG, decorate_callback},
 184                 OPT_CALLBACK('L', NULL, &line_cb, "n,m:file",
 185                              N_("Process line range n,m in file, counting from 1"),
 186                              log_line_range_callback),
 187                 OPT_END()
 188         };
 189
 190         line_cb.rev = rev;
 191         line_cb.prefix = prefix;
 192
 193         mailmap = use_mailmap_config;
 194         argc = parse_options(argc, argv, prefix,
 195                              builtin_log_options, builtin_log_usage,
 196                              PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
 197                              PARSE_OPT_KEEP_DASHDASH);
 198
 199         if (quiet)
 200                 rev->diffopt.output_format |= DIFF_FORMAT_NO_OUTPUT;
 201         argc = setup_revisions(argc, argv, rev, opt);
 202
 203         /* Any arguments at this point are not recognized */
 204         if (argc > 1)
 205                 die(_("unrecognized argument: %s"), argv[1]);
 206
 207         memset(&w, 0, sizeof(w));
 208         userformat_find_requirements(NULL, &w);
 209
 210         if (!rev->show_notes_given && (!rev->pretty_given || w.notes))
 211                 rev->show_notes = 1;
 212         if (rev->show_notes)
 213                 load_display_notes(&rev->notes_opt);
 214
 215         if ((rev->diffopt.pickaxe_opts & DIFF_PICKAXE_KINDS_MASK) ||
 216             rev->diffopt.filter || rev->diffopt.flags.follow_renames)
 217                 rev->always_show_header = 0;
 218
 219         if (source || w.source) {
 220                 init_revision_sources(&revision_sources);
 221                 rev->sources = &revision_sources;
 222         }
 223
 224         if (mailmap) {
 225                 rev->mailmap = xcalloc(1, sizeof(struct string_list));
 226                 read_mailmap(rev->mailmap, NULL);
 227         }
 228
 229         if (rev->pretty_given && rev->commit_format == CMIT_FMT_RAW) {
 230                 /*
 231                  * "log --pretty=raw" is special; ignore UI oriented
 232                  * configuration variables such as decoration.
 233                  */
 234                 if (!decoration_given)
 235                         decoration_style = 0;
 236                 if (!rev->abbrev_commit_given)
 237                         rev->abbrev_commit = 0;
 238         }
 239
 240         if (decoration_style) {
 241                 const struct string_list *config_exclude =
 242                         repo_config_get_value_multi(the_repository,
 243                                                     "log.excludeDecoration");
 244
 245                 if (config_exclude) {
 246                         struct string_list_item *item;
 247                         for_each_string_list_item(item, config_exclude)
 248                                 string_list_append(&decorate_refs_exclude_config,
 249                                                    item->string);
 250                 }
 251
 252                 rev->show_decorations = 1;
 253
 254                 load_ref_decorations(&decoration_filter, decoration_style);
 255         }
 256
 257         if (rev->line_level_traverse)
 258                 line_log_init(rev, line_cb.prefix, &line_cb.args);
 259
 260         setup_pager();
 261 }
 262
 263 static void cmd_log_init(int argc, const char **argv, const char *prefix,
 264                          struct rev_info *rev, struct setup_revision_opt *opt)
 265 {
 266         cmd_log_init_defaults(rev);
 267         cmd_log_init_finish(argc, argv, prefix, rev, opt);
 268 }
 269
 270 /*
 271  * This gives a rough estimate for how many commits we
 272  * will print out in the list.
 273  */
 274 static int estimate_commit_count(struct commit_list *list)
 275 {
 276         int n = 0;
 277
 278         while (list) {
 279                 struct commit *commit = list->item;
 280                 unsigned int flags = commit->object.flags;
 281                 list = list->next;
 282                 if (!(flags & (TREESAME | UNINTERESTING)))
 283                         n++;
 284         }
 285         return n;
 286 }
 287
 288 static void show_early_header(struct rev_info *rev, const char *stage, int nr)
 289 {
 290         if (rev->shown_one) {
 291                 rev->shown_one = 0;
 292                 if (rev->commit_format != CMIT_FMT_ONELINE)
 293                         putchar(rev->diffopt.line_termination);
 294         }
 295         fprintf(rev->diffopt.file, _("Final output: %d %s\n"), nr, stage);
 296 }
 297
 298 static struct itimerval early_output_timer;
 299
 300 static void log_show_early(struct rev_info *revs, struct commit_list *list)
 301 {
 302         int i = revs->early_output, close_file = revs->diffopt.close_file;
 303         int show_header = 1;
 304
 305         revs->diffopt.close_file = 0;
 306         sort_in_topological_order(&list, revs->sort_order);
 307         while (list && i) {
 308                 struct commit *commit = list->item;
 309                 switch (simplify_commit(revs, commit)) {
 310                 case commit_show:
 311                         if (show_header) {
 312                                 int n = estimate_commit_count(list);
 313                                 show_early_header(revs, "incomplete", n);
 314                                 show_header = 0;
 315                         }
 316                         log_tree_commit(revs, commit);
 317                         i--;
 318                         break;
 319                 case commit_ignore:
 320                         break;
 321                 case commit_error:
 322                         if (close_file)
 323                                 fclose(revs->diffopt.file);
 324                         return;
 325                 }
 326                 list = list->next;
 327         }
 328
 329         /* Did we already get enough commits for the early output? */
 330         if (!i) {
 331                 if (close_file)
 332                         fclose(revs->diffopt.file);
 333                 return;
 334         }
 335
 336         /*
 337          * ..if no, then repeat it twice a second until we
 338          * do.
 339          *
 340          * NOTE! We don't use "it_interval", because if the
 341          * reader isn't listening, we want our output to be
 342          * throttled by the writing, and not have the timer
 343          * trigger every second even if we're blocked on a
 344          * reader!
 345          */
 346         early_output_timer.it_value.tv_sec = 0;
 347         early_output_timer.it_value.tv_usec = 500000;
 348         setitimer(ITIMER_REAL, &early_output_timer, NULL);
 349 }
 350
 351 static void early_output(int signal)
 352 {
 353         show_early_output = log_show_early;
 354 }
 355
 356 static void setup_early_output(void)
 357 {
 358         struct sigaction sa;
 359
 360         /*
 361          * Set up the signal handler, minimally intrusively:
 362          * we only set a single volatile integer word (not
 363          * using sigatomic_t - trying to avoid unnecessary
 364          * system dependencies and headers), and using
 365          * SA_RESTART.
 366          */
 367         memset(&sa, 0, sizeof(sa));
 368         sa.sa_handler = early_output;
 369         sigemptyset(&sa.sa_mask);
 370         sa.sa_flags = SA_RESTART;
 371         sigaction(SIGALRM, &sa, NULL);
 372
 373         /*
 374          * If we can get the whole output in less than a
 375          * tenth of a second, don't even bother doing the
 376          * early-output thing..
 377          *
 378          * This is a one-time-only trigger.
 379          */
 380         early_output_timer.it_value.tv_sec = 0;
 381         early_output_timer.it_value.tv_usec = 100000;
 382         setitimer(ITIMER_REAL, &early_output_timer, NULL);
 383 }
 384
 385 static void finish_early_output(struct rev_info *rev)
 386 {
 387         int n = estimate_commit_count(rev->commits);
 388         signal(SIGALRM, SIG_IGN);
 389         show_early_header(rev, "done", n);
 390 }
 391
 392 static int cmd_log_walk(struct rev_info *rev)
 393 {
 394         struct commit *commit;
 395         int saved_nrl = 0;
 396         int saved_dcctc = 0, close_file = rev->diffopt.close_file;
 397
 398         if (rev->early_output)
 399                 setup_early_output();
 400
 401         if (prepare_revision_walk(rev))
 402                 die(_("revision walk setup failed"));
 403
 404         if (rev->early_output)
 405                 finish_early_output(rev);
 406
 407         /*
 408          * For --check and --exit-code, the exit code is based on CHECK_FAILED
 409          * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
 410          * retain that state information if replacing rev->diffopt in this loop
 411          */
 412         rev->diffopt.close_file = 0;
 413         while ((commit = get_revision(rev)) != NULL) {
 414                 if (!log_tree_commit(rev, commit) && rev->max_count >= 0)
 415                         /*
 416                          * We decremented max_count in get_revision,
 417                          * but we didn't actually show the commit.
 418                          */
 419                         rev->max_count++;
 420                 if (!rev->reflog_info) {
 421                         /*
 422                          * We may show a given commit multiple times when
 423                          * walking the reflogs.
 424                          */
 425                         free_commit_buffer(the_repository->parsed_objects,
 426                                            commit);
 427                         free_commit_list(commit->parents);
 428                         commit->parents = NULL;
 429                 }
 430                 if (saved_nrl < rev->diffopt.needed_rename_limit)
 431                         saved_nrl = rev->diffopt.needed_rename_limit;
 432                 if (rev->diffopt.degraded_cc_to_c)
 433                         saved_dcctc = 1;
 434         }
 435         rev->diffopt.degraded_cc_to_c = saved_dcctc;
 436         rev->diffopt.needed_rename_limit = saved_nrl;
 437         if (close_file)
 438                 fclose(rev->diffopt.file);
 439
 440         if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
 441             rev->diffopt.flags.check_failed) {
 442                 return 02;
 443         }
 444         return diff_result_code(&rev->diffopt, 0);
 445 }
 446
 447 static int git_log_config(const char *var, const char *value, void *cb)
 448 {
 449         const char *slot_name;
 450
 451         if (!strcmp(var, "format.pretty"))
 452                 return git_config_string(&fmt_pretty, var, value);
 453         if (!strcmp(var, "format.subjectprefix"))
 454                 return git_config_string(&fmt_patch_subject_prefix, var, value);
 455         if (!strcmp(var, "log.abbrevcommit")) {
 456                 default_abbrev_commit = git_config_bool(var, value);
 457                 return 0;
 458         }
 459         if (!strcmp(var, "log.date"))
 460                 return git_config_string(&default_date_mode, var, value);
 461         if (!strcmp(var, "log.decorate")) {
 462                 decoration_style = parse_decoration_style(value);
 463                 if (decoration_style < 0)
 464                         decoration_style = 0; /* maybe warn? */
 465                 return 0;
 466         }
 467         if (!strcmp(var, "log.showroot")) {
 468                 default_show_root = git_config_bool(var, value);
 469                 return 0;
 470         }
 471         if (!strcmp(var, "log.follow")) {
 472                 default_follow = git_config_bool(var, value);
 473                 return 0;
 474         }
 475         if (skip_prefix(var, "color.decorate.", &slot_name))
 476                 return parse_decorate_color_config(var, slot_name, value);
 477         if (!strcmp(var, "log.mailmap")) {
 478                 use_mailmap_config = git_config_bool(var, value);
 479                 return 0;
 480         }
 481         if (!strcmp(var, "log.showsignature")) {
 482                 default_show_signature = git_config_bool(var, value);
 483                 return 0;
 484         }
 485
 486         if (grep_config(var, value, cb) < 0)
 487                 return -1;
 488         if (git_gpg_config(var, value, cb) < 0)
 489                 return -1;
 490         return git_diff_ui_config(var, value, cb);
 491 }
 492
 493 int cmd_whatchanged(int argc, const char **argv, const char *prefix)
 494 {
 495         struct rev_info rev;
 496         struct setup_revision_opt opt;
 497
 498         init_log_defaults();
 499         git_config(git_log_config, NULL);
 500
 501         repo_init_revisions(the_repository, &rev, prefix);
 502         rev.diff = 1;
 503         rev.simplify_history = 0;
 504         memset(&opt, 0, sizeof(opt));
 505         opt.def = "HEAD";
 506         opt.revarg_opt = REVARG_COMMITTISH;
 507         cmd_log_init(argc, argv, prefix, &rev, &opt);
 508         if (!rev.diffopt.output_format)
 509                 rev.diffopt.output_format = DIFF_FORMAT_RAW;
 510         return cmd_log_walk(&rev);
 511 }
 512
 513 static void show_tagger(const char *buf, struct rev_info *rev)
 514 {
 515         struct strbuf out = STRBUF_INIT;
 516         struct pretty_print_context pp = {0};
 517
 518         pp.fmt = rev->commit_format;
 519         pp.date_mode = rev->date_mode;
 520         pp_user_info(&pp, "Tagger", &out, buf, get_log_output_encoding());
 521         fprintf(rev->diffopt.file, "%s", out.buf);
 522         strbuf_release(&out);
 523 }
 524
 525 static int show_blob_object(const struct object_id *oid, struct rev_info *rev, const char *obj_name)
 526 {
 527         struct object_id oidc;
 528         struct object_context obj_context;
 529         char *buf;
 530         unsigned long size;
 531
 532         fflush(rev->diffopt.file);
 533         if (!rev->diffopt.flags.textconv_set_via_cmdline ||
 534             !rev->diffopt.flags.allow_textconv)
 535                 return stream_blob_to_fd(1, oid, NULL, 0);
 536
 537         if (get_oid_with_context(the_repository, obj_name,
 538                                  GET_OID_RECORD_PATH,
 539                                  &oidc, &obj_context))
 540                 die(_("not a valid object name %s"), obj_name);
 541         if (!obj_context.path ||
 542             !textconv_object(the_repository, obj_context.path,
 543                              obj_context.mode, &oidc, 1, &buf, &size)) {
 544                 free(obj_context.path);
 545                 return stream_blob_to_fd(1, oid, NULL, 0);
 546         }
 547
 548         if (!buf)
 549                 die(_("git show %s: bad file"), obj_name);
 550
 551         write_or_die(1, buf, size);
 552         free(obj_context.path);
 553         return 0;
 554 }
 555
 556 static int show_tag_object(const struct object_id *oid, struct rev_info *rev)
 557 {
 558         unsigned long size;
 559         enum object_type type;
 560         char *buf = read_object_file(oid, &type, &size);
 561         int offset = 0;
 562
 563         if (!buf)
 564                 return error(_("could not read object %s"), oid_to_hex(oid));
 565
 566         assert(type == OBJ_TAG);
 567         while (offset < size && buf[offset] != '\n') {
 568                 int new_offset = offset + 1;
 569                 const char *ident;
 570                 while (new_offset < size && buf[new_offset++] != '\n')
 571                         ; /* do nothing */
 572                 if (skip_prefix(buf + offset, "tagger ", &ident))
 573                         show_tagger(ident, rev);
 574                 offset = new_offset;
 575         }
 576
 577         if (offset < size)
 578                 fwrite(buf + offset, size - offset, 1, rev->diffopt.file);
 579         free(buf);
 580         return 0;
 581 }
 582
 583 static int show_tree_object(const struct object_id *oid,
 584                 struct strbuf *base,
 585                 const char *pathname, unsigned mode, int stage, void *context)
 586 {
 587         FILE *file = context;
 588         fprintf(file, "%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
 589         return 0;
 590 }
 591
 592 static void show_setup_revisions_tweak(struct rev_info *rev,
 593                                        struct setup_revision_opt *opt)
 594 {
 595         if (rev->ignore_merges) {
 596                 /* There was no "-m" on the command line */
 597                 rev->ignore_merges = 0;
 598                 if (!rev->first_parent_only && !rev->combine_merges) {
 599                         /* No "--first-parent", "-c", or "--cc" */
 600                         rev->combine_merges = 1;
 601                         rev->dense_combined_merges = 1;
 602                 }
 603         }
 604         if (!rev->diffopt.output_format)
 605                 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
 606 }
 607
 608 int cmd_show(int argc, const char **argv, const char *prefix)
 609 {
 610         struct rev_info rev;
 611         struct object_array_entry *objects;
 612         struct setup_revision_opt opt;
 613         struct pathspec match_all;
 614         int i, count, ret = 0;
 615
 616         init_log_defaults();
 617         git_config(git_log_config, NULL);
 618
 619         memset(&match_all, 0, sizeof(match_all));
 620         repo_init_revisions(the_repository, &rev, prefix);
 621         rev.diff = 1;
 622         rev.always_show_header = 1;
 623         rev.no_walk = REVISION_WALK_NO_WALK_SORTED;
 624         rev.diffopt.stat_width = -1;    /* Scale to real terminal size */
 625
 626         memset(&opt, 0, sizeof(opt));
 627         opt.def = "HEAD";
 628         opt.tweak = show_setup_revisions_tweak;
 629         cmd_log_init(argc, argv, prefix, &rev, &opt);
 630
 631         if (!rev.no_walk)
 632                 return cmd_log_walk(&rev);
 633
 634         count = rev.pending.nr;
 635         objects = rev.pending.objects;
 636         for (i = 0; i < count && !ret; i++) {
 637                 struct object *o = objects[i].item;
 638                 const char *name = objects[i].name;
 639                 switch (o->type) {
 640                 case OBJ_BLOB:
 641                         ret = show_blob_object(&o->oid, &rev, name);
 642                         break;
 643                 case OBJ_TAG: {
 644                         struct tag *t = (struct tag *)o;
 645                         struct object_id *oid = get_tagged_oid(t);
 646
 647                         if (rev.shown_one)
 648                                 putchar('\n');
 649                         fprintf(rev.diffopt.file, "%stag %s%s\n",
 650                                         diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
 651                                         t->tag,
 652                                         diff_get_color_opt(&rev.diffopt, DIFF_RESET));
 653                         ret = show_tag_object(&o->oid, &rev);
 654                         rev.shown_one = 1;
 655                         if (ret)
 656                                 break;
 657                         o = parse_object(the_repository, oid);
 658                         if (!o)
 659                                 ret = error(_("could not read object %s"),
 660                                             oid_to_hex(oid));
 661                         objects[i].item = o;
 662                         i--;
 663                         break;
 664                 }
 665                 case OBJ_TREE:
 666                         if (rev.shown_one)
 667                                 putchar('\n');
 668                         fprintf(rev.diffopt.file, "%stree %s%s\n\n",
 669                                         diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
 670                                         name,
 671                                         diff_get_color_opt(&rev.diffopt, DIFF_RESET));
 672                         read_tree_recursive(the_repository, (struct tree *)o, "",
 673                                             0, 0, &match_all, show_tree_object,
 674                                             rev.diffopt.file);
 675                         rev.shown_one = 1;
 676                         break;
 677                 case OBJ_COMMIT:
 678                         rev.pending.nr = rev.pending.alloc = 0;
 679                         rev.pending.objects = NULL;
 680                         add_object_array(o, name, &rev.pending);
 681                         ret = cmd_log_walk(&rev);
 682                         break;
 683                 default:
 684                         ret = error(_("unknown type: %d"), o->type);
 685                 }
 686         }
 687         free(objects);
 688         return ret;
 689 }
 690
 691 /*
 692  * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
 693  */
 694 int cmd_log_reflog(int argc, const char **argv, const char *prefix)
 695 {
 696         struct rev_info rev;
 697         struct setup_revision_opt opt;
 698
 699         init_log_defaults();
 700         git_config(git_log_config, NULL);
 701
 702         repo_init_revisions(the_repository, &rev, prefix);
 703         init_reflog_walk(&rev.reflog_info);
 704         rev.verbose_header = 1;
 705         memset(&opt, 0, sizeof(opt));
 706         opt.def = "HEAD";
 707         cmd_log_init_defaults(&rev);
 708         rev.abbrev_commit = 1;
 709         rev.commit_format = CMIT_FMT_ONELINE;
 710         rev.use_terminator = 1;
 711         rev.always_show_header = 1;
 712         cmd_log_init_finish(argc, argv, prefix, &rev, &opt);
 713
 714         return cmd_log_walk(&rev);
 715 }
 716
 717 static void log_setup_revisions_tweak(struct rev_info *rev,
 718                                       struct setup_revision_opt *opt)
 719 {
 720         if (rev->diffopt.flags.default_follow_renames &&
 721             rev->prune_data.nr == 1)
 722                 rev->diffopt.flags.follow_renames = 1;
 723
 724         /* Turn --cc/-c into -p --cc/-c when -p was not given */
 725         if (!rev->diffopt.output_format && rev->combine_merges)
 726                 rev->diffopt.output_format = DIFF_FORMAT_PATCH;
 727
 728         /* Turn -m on when --cc/-c was given */
 729         if (rev->combine_merges)
 730                 rev->ignore_merges = 0;
 731 }
 732
 733 int cmd_log(int argc, const char **argv, const char *prefix)
 734 {
 735         struct rev_info rev;
 736         struct setup_revision_opt opt;
 737
 738         init_log_defaults();
 739         git_config(git_log_config, NULL);
 740
 741         repo_init_revisions(the_repository, &rev, prefix);
 742         rev.always_show_header = 1;
 743         memset(&opt, 0, sizeof(opt));
 744         opt.def = "HEAD";
 745         opt.revarg_opt = REVARG_COMMITTISH;
 746         opt.tweak = log_setup_revisions_tweak;
 747         cmd_log_init(argc, argv, prefix, &rev, &opt);
 748         return cmd_log_walk(&rev);
 749 }
 750
 751 /* format-patch */
 752
 753 static const char *fmt_patch_suffix = ".patch";
 754 static int numbered = 0;
 755 static int auto_number = 1;
 756
 757 static char *default_attach = NULL;
 758
 759 static struct string_list extra_hdr = STRING_LIST_INIT_NODUP;
 760 static struct string_list extra_to = STRING_LIST_INIT_NODUP;
 761 static struct string_list extra_cc = STRING_LIST_INIT_NODUP;
 762
 763 static void add_header(const char *value)
 764 {
 765         struct string_list_item *item;
 766         int len = strlen(value);
 767         while (len && value[len - 1] == '\n')
 768                 len--;
 769
 770         if (!strncasecmp(value, "to: ", 4)) {
 771                 item = string_list_append(&extra_to, value + 4);
 772                 len -= 4;
 773         } else if (!strncasecmp(value, "cc: ", 4)) {
 774                 item = string_list_append(&extra_cc, value + 4);
 775                 len -= 4;
 776         } else {
 777                 item = string_list_append(&extra_hdr, value);
 778         }
 779
 780         item->string[len] = '\0';
 781 }
 782
 783 enum cover_setting {
 784         COVER_UNSET,
 785         COVER_OFF,
 786         COVER_ON,
 787         COVER_AUTO
 788 };
 789
 790 enum thread_level {
 791         THREAD_UNSET,
 792         THREAD_SHALLOW,
 793         THREAD_DEEP
 794 };
 795
 796 enum cover_from_description {
 797         COVER_FROM_NONE,
 798         COVER_FROM_MESSAGE,
 799         COVER_FROM_SUBJECT,
 800         COVER_FROM_AUTO
 801 };
 802
 803 static enum thread_level thread;
 804 static int do_signoff;
 805 static int base_auto;
 806 static char *from;
 807 static const char *signature = git_version_string;
 808 static const char *signature_file;
 809 static enum cover_setting config_cover_letter;
 810 static const char *config_output_directory;
 811 static enum cover_from_description cover_from_description_mode = COVER_FROM_MESSAGE;
 812 static int show_notes;
 813 static struct display_notes_opt notes_opt;
 814
 815 static enum cover_from_description parse_cover_from_description(const char *arg)
 816 {
 817         if (!arg || !strcmp(arg, "default"))
 818                 return COVER_FROM_MESSAGE;
 819         else if (!strcmp(arg, "none"))
 820                 return COVER_FROM_NONE;
 821         else if (!strcmp(arg, "message"))
 822                 return COVER_FROM_MESSAGE;
 823         else if (!strcmp(arg, "subject"))
 824                 return COVER_FROM_SUBJECT;
 825         else if (!strcmp(arg, "auto"))
 826                 return COVER_FROM_AUTO;
 827         else
 828                 die(_("%s: invalid cover from description mode"), arg);
 829 }
 830
 831 static int git_format_config(const char *var, const char *value, void *cb)
 832 {
 833         if (!strcmp(var, "format.headers")) {
 834                 if (!value)
 835                         die(_("format.headers without value"));
 836                 add_header(value);
 837                 return 0;
 838         }
 839         if (!strcmp(var, "format.suffix"))
 840                 return git_config_string(&fmt_patch_suffix, var, value);
 841         if (!strcmp(var, "format.to")) {
 842                 if (!value)
 843                         return config_error_nonbool(var);
 844                 string_list_append(&extra_to, value);
 845                 return 0;
 846         }
 847         if (!strcmp(var, "format.cc")) {
 848                 if (!value)
 849                         return config_error_nonbool(var);
 850                 string_list_append(&extra_cc, value);
 851                 return 0;
 852         }
 853         if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff") ||
 854             !strcmp(var, "color.ui") || !strcmp(var, "diff.submodule")) {
 855                 return 0;
 856         }
 857         if (!strcmp(var, "format.numbered")) {
 858                 if (value && !strcasecmp(value, "auto")) {
 859                         auto_number = 1;
 860                         return 0;
 861                 }
 862                 numbered = git_config_bool(var, value);
 863                 auto_number = auto_number && numbered;
 864                 return 0;
 865         }
 866         if (!strcmp(var, "format.attach")) {
 867                 if (value && *value)
 868                         default_attach = xstrdup(value);
 869                 else
 870                         default_attach = xstrdup(git_version_string);
 871                 return 0;
 872         }
 873         if (!strcmp(var, "format.thread")) {
 874                 if (value && !strcasecmp(value, "deep")) {
 875                         thread = THREAD_DEEP;
 876                         return 0;
 877                 }
 878                 if (value && !strcasecmp(value, "shallow")) {
 879                         thread = THREAD_SHALLOW;
 880                         return 0;
 881                 }
 882                 thread = git_config_bool(var, value) ? THREAD_SHALLOW : THREAD_UNSET;
 883                 return 0;
 884         }
 885         if (!strcmp(var, "format.signoff")) {
 886                 do_signoff = git_config_bool(var, value);
 887                 return 0;
 888         }
 889         if (!strcmp(var, "format.signature"))
 890                 return git_config_string(&signature, var, value);
 891         if (!strcmp(var, "format.signaturefile"))
 892                 return git_config_pathname(&signature_file, var, value);
 893         if (!strcmp(var, "format.coverletter")) {
 894                 if (value && !strcasecmp(value, "auto")) {
 895                         config_cover_letter = COVER_AUTO;
 896                         return 0;
 897                 }
 898                 config_cover_letter = git_config_bool(var, value) ? COVER_ON : COVER_OFF;
 899                 return 0;
 900         }
 901         if (!strcmp(var, "format.outputdirectory"))
 902                 return git_config_string(&config_output_directory, var, value);
 903         if (!strcmp(var, "format.useautobase")) {
 904                 base_auto = git_config_bool(var, value);
 905                 return 0;
 906         }
 907         if (!strcmp(var, "format.from")) {
 908                 int b = git_parse_maybe_bool(value);
 909                 free(from);
 910                 if (b < 0)
 911                         from = xstrdup(value);
 912                 else if (b)
 913                         from = xstrdup(git_committer_info(IDENT_NO_DATE));
 914                 else
 915                         from = NULL;
 916                 return 0;
 917         }
 918         if (!strcmp(var, "format.notes")) {
 919                 int b = git_parse_maybe_bool(value);
 920                 if (b < 0)
 921                         enable_ref_display_notes(&notes_opt, &show_notes, value);
 922                 else if (b)
 923                         enable_default_display_notes(&notes_opt, &show_notes);
 924                 else
 925                         disable_display_notes(&notes_opt, &show_notes);
 926                 return 0;
 927         }
 928         if (!strcmp(var, "format.coverfromdescription")) {
 929                 cover_from_description_mode = parse_cover_from_description(value);
 930                 return 0;
 931         }
 932
 933         return git_log_config(var, value, cb);
 934 }
 935
 936 static const char *output_directory = NULL;
 937 static int outdir_offset;
 938
 939 static int open_next_file(struct commit *commit, const char *subject,
 940                          struct rev_info *rev, int quiet)
 941 {
 942         struct strbuf filename = STRBUF_INIT;
 943         int suffix_len = strlen(rev->patch_suffix) + 1;
 944
 945         if (output_directory) {
 946                 strbuf_addstr(&filename, output_directory);
 947                 if (filename.len >=
 948                     PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len) {
 949                         strbuf_release(&filename);
 950                         return error(_("name of output directory is too long"));
 951                 }
 952                 strbuf_complete(&filename, '/');
 953         }
 954
 955         if (rev->numbered_files)
 956                 strbuf_addf(&filename, "%d", rev->nr);
 957         else if (commit)
 958                 fmt_output_commit(&filename, commit, rev);
 959         else
 960                 fmt_output_subject(&filename, subject, rev);
 961
 962         if (!quiet)
 963                 printf("%s\n", filename.buf + outdir_offset);
 964
 965         if ((rev->diffopt.file = fopen(filename.buf, "w")) == NULL) {
 966                 error_errno(_("cannot open patch file %s"), filename.buf);
 967                 strbuf_release(&filename);
 968                 return -1;
 969         }
 970
 971         strbuf_release(&filename);
 972         return 0;
 973 }
 974
 975 static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids)
 976 {
 977         struct rev_info check_rev;
 978         struct commit *commit, *c1, *c2;
 979         struct object *o1, *o2;
 980         unsigned flags1, flags2;
 981
 982         if (rev->pending.nr != 2)
 983                 die(_("need exactly one range"));
 984
 985         o1 = rev->pending.objects[0].item;
 986         o2 = rev->pending.objects[1].item;
 987         flags1 = o1->flags;
 988         flags2 = o2->flags;
 989         c1 = lookup_commit_reference(the_repository, &o1->oid);
 990         c2 = lookup_commit_reference(the_repository, &o2->oid);
 991
 992         if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
 993                 die(_("not a range"));
 994
 995         init_patch_ids(the_repository, ids);
 996
 997         /* given a range a..b get all patch ids for b..a */
 998         repo_init_revisions(the_repository, &check_rev, rev->prefix);
 999         check_rev.max_parents = 1;
1000         o1->flags ^= UNINTERESTING;
1001         o2->flags ^= UNINTERESTING;
1002         add_pending_object(&check_rev, o1, "o1");
1003         add_pending_object(&check_rev, o2, "o2");
1004         if (prepare_revision_walk(&check_rev))
1005                 die(_("revision walk setup failed"));
1006
1007         while ((commit = get_revision(&check_rev)) != NULL) {
1008                 add_commit_patch_id(commit, ids);
1009         }
1010
1011         /* reset for next revision walk */
1012         clear_commit_marks(c1, SEEN | UNINTERESTING | SHOWN | ADDED);
1013         clear_commit_marks(c2, SEEN | UNINTERESTING | SHOWN | ADDED);
1014         o1->flags = flags1;
1015         o2->flags = flags2;
1016 }
1017
1018 static void gen_message_id(struct rev_info *info, char *base)
1019 {
1020         struct strbuf buf = STRBUF_INIT;
1021         strbuf_addf(&buf, "%s.%"PRItime".git.%s", base,
1022                     (timestamp_t) time(NULL),
1023                     git_committer_info(IDENT_NO_NAME|IDENT_NO_DATE|IDENT_STRICT));
1024         info->message_id = strbuf_detach(&buf, NULL);
1025 }
1026
1027 static void print_signature(FILE *file)
1028 {
1029         if (!signature || !*signature)
1030                 return;
1031
1032         fprintf(file, "-- \n%s", signature);
1033         if (signature[strlen(signature)-1] != '\n')
1034                 putc('\n', file);
1035         putc('\n', file);
1036 }
1037
1038 static char *find_branch_name(struct rev_info *rev)
1039 {
1040         int i, positive = -1;
1041         struct object_id branch_oid;
1042         const struct object_id *tip_oid;
1043         const char *ref, *v;
1044         char *full_ref, *branch = NULL;
1045
1046         for (i = 0; i < rev->cmdline.nr; i++) {
1047                 if (rev->cmdline.rev[i].flags & UNINTERESTING)
1048                         continue;
1049                 if (positive < 0)
1050                         positive = i;
1051                 else
1052                         return NULL;
1053         }
1054         if (positive < 0)
1055                 return NULL;
1056         ref = rev->cmdline.rev[positive].name;
1057         tip_oid = &rev->cmdline.rev[positive].item->oid;
1058         if (dwim_ref(ref, strlen(ref), &branch_oid, &full_ref) &&
1059             skip_prefix(full_ref, "refs/heads/", &v) &&
1060             oideq(tip_oid, &branch_oid))
1061                 branch = xstrdup(v);
1062         free(full_ref);
1063         return branch;
1064 }
1065
1066 static void show_diffstat(struct rev_info *rev,
1067                           struct commit *origin, struct commit *head)
1068 {
1069         struct diff_options opts;
1070
1071         memcpy(&opts, &rev->diffopt, sizeof(opts));
1072         opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1073         diff_setup_done(&opts);
1074
1075         diff_tree_oid(get_commit_tree_oid(origin),
1076                       get_commit_tree_oid(head),
1077                       "", &opts);
1078         diffcore_std(&opts);
1079         diff_flush(&opts);
1080
1081         fprintf(rev->diffopt.file, "\n");
1082 }
1083
1084 static void prepare_cover_text(struct pretty_print_context *pp,
1085                                const char *branch_name,
1086                                struct strbuf *sb,
1087                                const char *encoding,
1088                                int need_8bit_cte)
1089 {
1090         const char *subject = "*** SUBJECT HERE ***";
1091         const char *body = "*** BLURB HERE ***";
1092         struct strbuf description_sb = STRBUF_INIT;
1093         struct strbuf subject_sb = STRBUF_INIT;
1094
1095         if (cover_from_description_mode == COVER_FROM_NONE)
1096                 goto do_pp;
1097
1098         if (branch_name && *branch_name)
1099                 read_branch_desc(&description_sb, branch_name);
1100         if (!description_sb.len)
1101                 goto do_pp;
1102
1103         if (cover_from_description_mode == COVER_FROM_SUBJECT ||
1104                         cover_from_description_mode == COVER_FROM_AUTO)
1105                 body = format_subject(&subject_sb, description_sb.buf, " ");
1106
1107         if (cover_from_description_mode == COVER_FROM_MESSAGE ||
1108                         (cover_from_description_mode == COVER_FROM_AUTO &&
1109                          subject_sb.len > COVER_FROM_AUTO_MAX_SUBJECT_LEN))
1110                 body = description_sb.buf;
1111         else
1112                 subject = subject_sb.buf;
1113
1114 do_pp:
1115         pp_title_line(pp, &subject, sb, encoding, need_8bit_cte);
1116         pp_remainder(pp, &body, sb, 0);
1117
1118         strbuf_release(&description_sb);
1119         strbuf_release(&subject_sb);
1120 }
1121
1122 static int get_notes_refs(struct string_list_item *item, void *arg)
1123 {
1124         argv_array_pushf(arg, "--notes=%s", item->string);
1125         return 0;
1126 }
1127
1128 static void get_notes_args(struct argv_array *arg, struct rev_info *rev)
1129 {
1130         if (!rev->show_notes) {
1131                 argv_array_push(arg, "--no-notes");
1132         } else if (rev->notes_opt.use_default_notes > 0 ||
1133                    (rev->notes_opt.use_default_notes == -1 &&
1134                     !rev->notes_opt.extra_notes_refs.nr)) {
1135                 argv_array_push(arg, "--notes");
1136         } else {
1137                 for_each_string_list(&rev->notes_opt.extra_notes_refs, get_notes_refs, arg);
1138         }
1139 }
1140
1141 static void make_cover_letter(struct rev_info *rev, int use_stdout,
1142                               struct commit *origin,
1143                               int nr, struct commit **list,
1144                               const char *branch_name,
1145                               int quiet)
1146 {
1147         const char *committer;
1148         struct shortlog log;
1149         struct strbuf sb = STRBUF_INIT;
1150         int i;
1151         const char *encoding = "UTF-8";
1152         int need_8bit_cte = 0;
1153         struct pretty_print_context pp = {0};
1154         struct commit *head = list[0];
1155
1156         if (!cmit_fmt_is_mail(rev->commit_format))
1157                 die(_("cover letter needs email format"));
1158
1159         committer = git_committer_info(0);
1160
1161         if (!use_stdout &&
1162             open_next_file(NULL, rev->numbered_files ? NULL : "cover-letter", rev, quiet))
1163                 die(_("failed to create cover-letter file"));
1164
1165         log_write_email_headers(rev, head, &pp.after_subject, &need_8bit_cte, 0);
1166
1167         for (i = 0; !need_8bit_cte && i < nr; i++) {
1168                 const char *buf = get_commit_buffer(list[i], NULL);
1169                 if (has_non_ascii(buf))
1170                         need_8bit_cte = 1;
1171                 unuse_commit_buffer(list[i], buf);
1172         }
1173
1174         if (!branch_name)
1175                 branch_name = find_branch_name(rev);
1176
1177         pp.fmt = CMIT_FMT_EMAIL;
1178         pp.date_mode.type = DATE_RFC2822;
1179         pp.rev = rev;
1180         pp.print_email_subject = 1;
1181         pp_user_info(&pp, NULL, &sb, committer, encoding);
1182         prepare_cover_text(&pp, branch_name, &sb, encoding, need_8bit_cte);
1183         fprintf(rev->diffopt.file, "%s\n", sb.buf);
1184
1185         strbuf_release(&sb);
1186
1187         shortlog_init(&log);
1188         log.wrap_lines = 1;
1189         log.wrap = MAIL_DEFAULT_WRAP;
1190         log.in1 = 2;
1191         log.in2 = 4;
1192         log.file = rev->diffopt.file;
1193         for (i = 0; i < nr; i++)
1194                 shortlog_add_commit(&log, list[i]);
1195
1196         shortlog_output(&log);
1197
1198         /* We can only do diffstat with a unique reference point */
1199         if (origin)
1200                 show_diffstat(rev, origin, head);
1201
1202         if (rev->idiff_oid1) {
1203                 fprintf_ln(rev->diffopt.file, "%s", rev->idiff_title);
1204                 show_interdiff(rev, 0);
1205         }
1206
1207         if (rev->rdiff1) {
1208                 /*
1209                  * Pass minimum required diff-options to range-diff; others
1210                  * can be added later if deemed desirable.
1211                  */
1212                 struct diff_options opts;
1213                 struct argv_array other_arg = ARGV_ARRAY_INIT;
1214                 diff_setup(&opts);
1215                 opts.file = rev->diffopt.file;
1216                 opts.use_color = rev->diffopt.use_color;
1217                 diff_setup_done(&opts);
1218                 fprintf_ln(rev->diffopt.file, "%s", rev->rdiff_title);
1219                 get_notes_args(&other_arg, rev);
1220                 show_range_diff(rev->rdiff1, rev->rdiff2,
1221                                 rev->creation_factor, 1, &opts, &other_arg);
1222                 argv_array_clear(&other_arg);
1223         }
1224 }
1225
1226 static const char *clean_message_id(const char *msg_id)
1227 {
1228         char ch;
1229         const char *a, *z, *m;
1230
1231         m = msg_id;
1232         while ((ch = *m) && (isspace(ch) || (ch == '<')))
1233                 m++;
1234         a = m;
1235         z = NULL;
1236         while ((ch = *m)) {
1237                 if (!isspace(ch) && (ch != '>'))
1238                         z = m;
1239                 m++;
1240         }
1241         if (!z)
1242                 die(_("insane in-reply-to: %s"), msg_id);
1243         if (++z == m)
1244                 return a;
1245         return xmemdupz(a, z - a);
1246 }
1247
1248 static const char *set_outdir(const char *prefix, const char *output_directory)
1249 {
1250         if (output_directory && is_absolute_path(output_directory))
1251                 return output_directory;
1252
1253         if (!prefix || !*prefix) {
1254                 if (output_directory)
1255                         return output_directory;
1256                 /* The user did not explicitly ask for "./" */
1257                 outdir_offset = 2;
1258                 return "./";
1259         }
1260
1261         outdir_offset = strlen(prefix);
1262         if (!output_directory)
1263                 return prefix;
1264
1265         return prefix_filename(prefix, output_directory);
1266 }
1267
1268 static const char * const builtin_format_patch_usage[] = {
1269         N_("git format-patch [<options>] [<since> | <revision-range>]"),
1270         NULL
1271 };
1272
1273 static int keep_subject = 0;
1274
1275 static int keep_callback(const struct option *opt, const char *arg, int unset)
1276 {
1277         BUG_ON_OPT_NEG(unset);
1278         BUG_ON_OPT_ARG(arg);
1279         ((struct rev_info *)opt->value)->total = -1;
1280         keep_subject = 1;
1281         return 0;
1282 }
1283
1284 static int subject_prefix = 0;
1285
1286 static int subject_prefix_callback(const struct option *opt, const char *arg,
1287                             int unset)
1288 {
1289         BUG_ON_OPT_NEG(unset);
1290         subject_prefix = 1;
1291         ((struct rev_info *)opt->value)->subject_prefix = arg;
1292         return 0;
1293 }
1294
1295 static int rfc_callback(const struct option *opt, const char *arg, int unset)
1296 {
1297         BUG_ON_OPT_NEG(unset);
1298         BUG_ON_OPT_ARG(arg);
1299         return subject_prefix_callback(opt, "RFC PATCH", unset);
1300 }
1301
1302 static int numbered_cmdline_opt = 0;
1303
1304 static int numbered_callback(const struct option *opt, const char *arg,
1305                              int unset)
1306 {
1307         BUG_ON_OPT_ARG(arg);
1308         *(int *)opt->value = numbered_cmdline_opt = unset ? 0 : 1;
1309         if (unset)
1310                 auto_number =  0;
1311         return 0;
1312 }
1313
1314 static int no_numbered_callback(const struct option *opt, const char *arg,
1315                                 int unset)
1316 {
1317         BUG_ON_OPT_NEG(unset);
1318         return numbered_callback(opt, arg, 1);
1319 }
1320
1321 static int output_directory_callback(const struct option *opt, const char *arg,
1322                               int unset)
1323 {
1324         const char **dir = (const char **)opt->value;
1325         BUG_ON_OPT_NEG(unset);
1326         if (*dir)
1327                 die(_("two output directories?"));
1328         *dir = arg;
1329         return 0;
1330 }
1331
1332 static int thread_callback(const struct option *opt, const char *arg, int unset)
1333 {
1334         enum thread_level *thread = (enum thread_level *)opt->value;
1335         if (unset)
1336                 *thread = THREAD_UNSET;
1337         else if (!arg || !strcmp(arg, "shallow"))
1338                 *thread = THREAD_SHALLOW;
1339         else if (!strcmp(arg, "deep"))
1340                 *thread = THREAD_DEEP;
1341         /*
1342          * Please update _git_formatpatch() in git-completion.bash
1343          * when you add new options.
1344          */
1345         else
1346                 return 1;
1347         return 0;
1348 }
1349
1350 static int attach_callback(const struct option *opt, const char *arg, int unset)
1351 {
1352         struct rev_info *rev = (struct rev_info *)opt->value;
1353         if (unset)
1354                 rev->mime_boundary = NULL;
1355         else if (arg)
1356                 rev->mime_boundary = arg;
1357         else
1358                 rev->mime_boundary = git_version_string;
1359         rev->no_inline = unset ? 0 : 1;
1360         return 0;
1361 }
1362
1363 static int inline_callback(const struct option *opt, const char *arg, int unset)
1364 {
1365         struct rev_info *rev = (struct rev_info *)opt->value;
1366         if (unset)
1367                 rev->mime_boundary = NULL;
1368         else if (arg)
1369                 rev->mime_boundary = arg;
1370         else
1371                 rev->mime_boundary = git_version_string;
1372         rev->no_inline = 0;
1373         return 0;
1374 }
1375
1376 static int header_callback(const struct option *opt, const char *arg, int unset)
1377 {
1378         if (unset) {
1379                 string_list_clear(&extra_hdr, 0);
1380                 string_list_clear(&extra_to, 0);
1381                 string_list_clear(&extra_cc, 0);
1382         } else {
1383                 add_header(arg);
1384         }
1385         return 0;
1386 }
1387
1388 static int to_callback(const struct option *opt, const char *arg, int unset)
1389 {
1390         if (unset)
1391                 string_list_clear(&extra_to, 0);
1392         else
1393                 string_list_append(&extra_to, arg);
1394         return 0;
1395 }
1396
1397 static int cc_callback(const struct option *opt, const char *arg, int unset)
1398 {
1399         if (unset)
1400                 string_list_clear(&extra_cc, 0);
1401         else
1402                 string_list_append(&extra_cc, arg);
1403         return 0;
1404 }
1405
1406 static int from_callback(const struct option *opt, const char *arg, int unset)
1407 {
1408         char **from = opt->value;
1409
1410         free(*from);
1411
1412         if (unset)
1413                 *from = NULL;
1414         else if (arg)
1415                 *from = xstrdup(arg);
1416         else
1417                 *from = xstrdup(git_committer_info(IDENT_NO_DATE));
1418         return 0;
1419 }
1420
1421 struct base_tree_info {
1422         struct object_id base_commit;
1423         int nr_patch_id, alloc_patch_id;
1424         struct object_id *patch_id;
1425 };
1426
1427 static struct commit *get_base_commit(const char *base_commit,
1428                                       struct commit **list,
1429                                       int total)
1430 {
1431         struct commit *base = NULL;
1432         struct commit **rev;
1433         int i = 0, rev_nr = 0;
1434
1435         if (base_commit && strcmp(base_commit, "auto")) {
1436                 base = lookup_commit_reference_by_name(base_commit);
1437                 if (!base)
1438                         die(_("unknown commit %s"), base_commit);
1439         } else if ((base_commit && !strcmp(base_commit, "auto"))) {
1440                 struct branch *curr_branch = branch_get(NULL);
1441                 const char *upstream = branch_get_upstream(curr_branch, NULL);
1442                 if (upstream) {
1443                         struct commit_list *base_list;
1444                         struct commit *commit;
1445                         struct object_id oid;
1446
1447                         if (get_oid(upstream, &oid))
1448                                 die(_("failed to resolve '%s' as a valid ref"), upstream);
1449                         commit = lookup_commit_or_die(&oid, "upstream base");
1450                         base_list = get_merge_bases_many(commit, total, list);
1451                         /* There should be one and only one merge base. */
1452                         if (!base_list || base_list->next)
1453                                 die(_("could not find exact merge base"));
1454                         base = base_list->item;
1455                         free_commit_list(base_list);
1456                 } else {
1457                         die(_("failed to get upstream, if you want to record base commit automatically,\n"
1458                               "please use git branch --set-upstream-to to track a remote branch.\n"
1459                               "Or you could specify base commit by --base=<base-commit-id> manually"));
1460                 }
1461         }
1462
1463         ALLOC_ARRAY(rev, total);
1464         for (i = 0; i < total; i++)
1465                 rev[i] = list[i];
1466
1467         rev_nr = total;
1468         /*
1469          * Get merge base through pair-wise computations
1470          * and store it in rev[0].
1471          */
1472         while (rev_nr > 1) {
1473                 for (i = 0; i < rev_nr / 2; i++) {
1474                         struct commit_list *merge_base;
1475                         merge_base = get_merge_bases(rev[2 * i], rev[2 * i + 1]);
1476                         if (!merge_base || merge_base->next)
1477                                 die(_("failed to find exact merge base"));
1478
1479                         rev[i] = merge_base->item;
1480                 }
1481
1482                 if (rev_nr % 2)
1483                         rev[i] = rev[2 * i];
1484                 rev_nr = DIV_ROUND_UP(rev_nr, 2);
1485         }
1486
1487         if (!in_merge_bases(base, rev[0]))
1488                 die(_("base commit should be the ancestor of revision list"));
1489
1490         for (i = 0; i < total; i++) {
1491                 if (base == list[i])
1492                         die(_("base commit shouldn't be in revision list"));
1493         }
1494
1495         free(rev);
1496         return base;
1497 }
1498
1499 define_commit_slab(commit_base, int);
1500
1501 static void prepare_bases(struct base_tree_info *bases,
1502                           struct commit *base,
1503                           struct commit **list,
1504                           int total)
1505 {
1506         struct commit *commit;
1507         struct rev_info revs;
1508         struct diff_options diffopt;
1509         struct commit_base commit_base;
1510         int i;
1511
1512         if (!base)
1513                 return;
1514
1515         init_commit_base(&commit_base);
1516         repo_diff_setup(the_repository, &diffopt);
1517         diffopt.flags.recursive = 1;
1518         diff_setup_done(&diffopt);
1519
1520         oidcpy(&bases->base_commit, &base->object.oid);
1521
1522         repo_init_revisions(the_repository, &revs, NULL);
1523         revs.max_parents = 1;
1524         revs.topo_order = 1;
1525         for (i = 0; i < total; i++) {
1526                 list[i]->object.flags &= ~UNINTERESTING;
1527                 add_pending_object(&revs, &list[i]->object, "rev_list");
1528                 *commit_base_at(&commit_base, list[i]) = 1;
1529         }
1530         base->object.flags |= UNINTERESTING;
1531         add_pending_object(&revs, &base->object, "base");
1532
1533         if (prepare_revision_walk(&revs))
1534                 die(_("revision walk setup failed"));
1535         /*
1536          * Traverse the commits list, get prerequisite patch ids
1537          * and stuff them in bases structure.
1538          */
1539         while ((commit = get_revision(&revs)) != NULL) {
1540                 struct object_id oid;
1541                 struct object_id *patch_id;
1542                 if (*commit_base_at(&commit_base, commit))
1543                         continue;
1544                 if (commit_patch_id(commit, &diffopt, &oid, 0, 1))
1545                         die(_("cannot get patch id"));
1546                 ALLOC_GROW(bases->patch_id, bases->nr_patch_id + 1, bases->alloc_patch_id);
1547                 patch_id = bases->patch_id + bases->nr_patch_id;
1548                 oidcpy(patch_id, &oid);
1549                 bases->nr_patch_id++;
1550         }
1551         clear_commit_base(&commit_base);
1552 }
1553
1554 static void print_bases(struct base_tree_info *bases, FILE *file)
1555 {
1556         int i;
1557
1558         /* Only do this once, either for the cover or for the first one */
1559         if (is_null_oid(&bases->base_commit))
1560                 return;
1561
1562         /* Show the base commit */
1563         fprintf(file, "\nbase-commit: %s\n", oid_to_hex(&bases->base_commit));
1564
1565         /* Show the prerequisite patches */
1566         for (i = bases->nr_patch_id - 1; i >= 0; i--)
1567                 fprintf(file, "prerequisite-patch-id: %s\n", oid_to_hex(&bases->patch_id[i]));
1568
1569         free(bases->patch_id);
1570         bases->nr_patch_id = 0;
1571         bases->alloc_patch_id = 0;
1572         oidclr(&bases->base_commit);
1573 }
1574
1575 static const char *diff_title(struct strbuf *sb, int reroll_count,
1576                        const char *generic, const char *rerolled)
1577 {
1578         if (reroll_count <= 0)
1579                 strbuf_addstr(sb, generic);
1580         else /* RFC may be v0, so allow -v1 to diff against v0 */
1581                 strbuf_addf(sb, rerolled, reroll_count - 1);
1582         return sb->buf;
1583 }
1584
1585 static void infer_range_diff_ranges(struct strbuf *r1,
1586                                     struct strbuf *r2,
1587                                     const char *prev,
1588                                     struct commit *origin,
1589                                     struct commit *head)
1590 {
1591         const char *head_oid = oid_to_hex(&head->object.oid);
1592
1593         if (!strstr(prev, "..")) {
1594                 strbuf_addf(r1, "%s..%s", head_oid, prev);
1595                 strbuf_addf(r2, "%s..%s", prev, head_oid);
1596         } else if (!origin) {
1597                 die(_("failed to infer range-diff ranges"));
1598         } else {
1599                 strbuf_addstr(r1, prev);
1600                 strbuf_addf(r2, "%s..%s",
1601                             oid_to_hex(&origin->object.oid), head_oid);
1602         }
1603 }
1604
1605 int cmd_format_patch(int argc, const char **argv, const char *prefix)
1606 {
1607         struct commit *commit;
1608         struct commit **list = NULL;
1609         struct rev_info rev;
1610         struct setup_revision_opt s_r_opt;
1611         int nr = 0, total, i;
1612         int use_stdout = 0;
1613         int start_number = -1;
1614         int just_numbers = 0;
1615         int ignore_if_in_upstream = 0;
1616         int cover_letter = -1;
1617         int boundary_count = 0;
1618         int no_binary_diff = 0;
1619         int zero_commit = 0;
1620         struct commit *origin = NULL;
1621         const char *in_reply_to = NULL;
1622         struct patch_ids ids;
1623         struct strbuf buf = STRBUF_INIT;
1624         int use_patch_format = 0;
1625         int quiet = 0;
1626         int reroll_count = -1;
1627         char *cover_from_description_arg = NULL;
1628         char *branch_name = NULL;
1629         char *base_commit = NULL;
1630         struct base_tree_info bases;
1631         int show_progress = 0;
1632         struct progress *progress = NULL;
1633         struct oid_array idiff_prev = OID_ARRAY_INIT;
1634         struct strbuf idiff_title = STRBUF_INIT;
1635         const char *rdiff_prev = NULL;
1636         struct strbuf rdiff1 = STRBUF_INIT;
1637         struct strbuf rdiff2 = STRBUF_INIT;
1638         struct strbuf rdiff_title = STRBUF_INIT;
1639         int creation_factor = -1;
1640
1641         const struct option builtin_format_patch_options[] = {
1642                 { OPTION_CALLBACK, 'n', "numbered", &numbered, NULL,
1643                             N_("use [PATCH n/m] even with a single patch"),
1644                             PARSE_OPT_NOARG, numbered_callback },
1645                 { OPTION_CALLBACK, 'N', "no-numbered", &numbered, NULL,
1646                             N_("use [PATCH] even with multiple patches"),
1647                             PARSE_OPT_NOARG | PARSE_OPT_NONEG, no_numbered_callback },
1648                 OPT_BOOL('s', "signoff", &do_signoff, N_("add Signed-off-by:")),
1649                 OPT_BOOL(0, "stdout", &use_stdout,
1650                             N_("print patches to standard out")),
1651                 OPT_BOOL(0, "cover-letter", &cover_letter,
1652                             N_("generate a cover letter")),
1653                 OPT_BOOL(0, "numbered-files", &just_numbers,
1654                             N_("use simple number sequence for output file names")),
1655                 OPT_STRING(0, "suffix", &fmt_patch_suffix, N_("sfx"),
1656                             N_("use <sfx> instead of '.patch'")),
1657                 OPT_INTEGER(0, "start-number", &start_number,
1658                             N_("start numbering patches at <n> instead of 1")),
1659                 OPT_INTEGER('v', "reroll-count", &reroll_count,
1660                             N_("mark the series as Nth re-roll")),
1661                 { OPTION_CALLBACK, 0, "rfc", &rev, NULL,
1662                             N_("Use [RFC PATCH] instead of [PATCH]"),
1663                             PARSE_OPT_NOARG | PARSE_OPT_NONEG, rfc_callback },
1664                 OPT_STRING(0, "cover-from-description", &cover_from_description_arg,
1665                             N_("cover-from-description-mode"),
1666                             N_("generate parts of a cover letter based on a branch's description")),
1667                 { OPTION_CALLBACK, 0, "subject-prefix", &rev, N_("prefix"),
1668                             N_("Use [<prefix>] instead of [PATCH]"),
1669                             PARSE_OPT_NONEG, subject_prefix_callback },
1670                 { OPTION_CALLBACK, 'o', "output-directory", &output_directory,
1671                             N_("dir"), N_("store resulting files in <dir>"),
1672                             PARSE_OPT_NONEG, output_directory_callback },
1673                 { OPTION_CALLBACK, 'k', "keep-subject", &rev, NULL,
1674                             N_("don't strip/add [PATCH]"),
1675                             PARSE_OPT_NOARG | PARSE_OPT_NONEG, keep_callback },
1676                 OPT_BOOL(0, "no-binary", &no_binary_diff,
1677                          N_("don't output binary diffs")),
1678                 OPT_BOOL(0, "zero-commit", &zero_commit,
1679                          N_("output all-zero hash in From header")),
1680                 OPT_BOOL(0, "ignore-if-in-upstream", &ignore_if_in_upstream,
1681                          N_("don't include a patch matching a commit upstream")),
1682                 OPT_SET_INT_F('p', "no-stat", &use_patch_format,
1683                               N_("show patch format instead of default (patch + stat)"),
1684                               1, PARSE_OPT_NONEG),
1685                 OPT_GROUP(N_("Messaging")),
1686                 { OPTION_CALLBACK, 0, "add-header", NULL, N_("header"),
1687                             N_("add email header"), 0, header_callback },
1688                 { OPTION_CALLBACK, 0, "to", NULL, N_("email"), N_("add To: header"),
1689                             0, to_callback },
1690                 { OPTION_CALLBACK, 0, "cc", NULL, N_("email"), N_("add Cc: header"),
1691                             0, cc_callback },
1692                 { OPTION_CALLBACK, 0, "from", &from, N_("ident"),
1693                             N_("set From address to <ident> (or committer ident if absent)"),
1694                             PARSE_OPT_OPTARG, from_callback },
1695                 OPT_STRING(0, "in-reply-to", &in_reply_to, N_("message-id"),
1696                             N_("make first mail a reply to <message-id>")),
1697                 { OPTION_CALLBACK, 0, "attach", &rev, N_("boundary"),
1698                             N_("attach the patch"), PARSE_OPT_OPTARG,
1699                             attach_callback },
1700                 { OPTION_CALLBACK, 0, "inline", &rev, N_("boundary"),
1701                             N_("inline the patch"),
1702                             PARSE_OPT_OPTARG | PARSE_OPT_NONEG,
1703                             inline_callback },
1704                 { OPTION_CALLBACK, 0, "thread", &thread, N_("style"),
1705                             N_("enable message threading, styles: shallow, deep"),
1706                             PARSE_OPT_OPTARG, thread_callback },
1707                 OPT_STRING(0, "signature", &signature, N_("signature"),
1708                             N_("add a signature")),
1709                 OPT_STRING(0, "base", &base_commit, N_("base-commit"),
1710                            N_("add prerequisite tree info to the patch series")),
1711                 OPT_FILENAME(0, "signature-file", &signature_file,
1712                                 N_("add a signature from a file")),
1713                 OPT__QUIET(&quiet, N_("don't print the patch filenames")),
1714                 OPT_BOOL(0, "progress", &show_progress,
1715                          N_("show progress while generating patches")),
1716                 OPT_CALLBACK(0, "interdiff", &idiff_prev, N_("rev"),
1717                              N_("show changes against <rev> in cover letter or single patch"),
1718                              parse_opt_object_name),
1719                 OPT_STRING(0, "range-diff", &rdiff_prev, N_("refspec"),
1720                            N_("show changes against <refspec> in cover letter or single patch")),
1721                 OPT_INTEGER(0, "creation-factor", &creation_factor,
1722                             N_("percentage by which creation is weighted")),
1723                 OPT_END()
1724         };
1725
1726         extra_hdr.strdup_strings = 1;
1727         extra_to.strdup_strings = 1;
1728         extra_cc.strdup_strings = 1;
1729         init_log_defaults();
1730         init_display_notes(&notes_opt);
1731         git_config(git_format_config, NULL);
1732         repo_init_revisions(the_repository, &rev, prefix);
1733         rev.show_notes = show_notes;
1734         memcpy(&rev.notes_opt, &notes_opt, sizeof(notes_opt));
1735         rev.commit_format = CMIT_FMT_EMAIL;
1736         rev.expand_tabs_in_log_default = 0;
1737         rev.verbose_header = 1;
1738         rev.diff = 1;
1739         rev.max_parents = 1;
1740         rev.diffopt.flags.recursive = 1;
1741         rev.subject_prefix = fmt_patch_subject_prefix;
1742         memset(&s_r_opt, 0, sizeof(s_r_opt));
1743         s_r_opt.def = "HEAD";
1744         s_r_opt.revarg_opt = REVARG_COMMITTISH;
1745
1746         if (base_auto)
1747                 base_commit = "auto";
1748
1749         if (default_attach) {
1750                 rev.mime_boundary = default_attach;
1751                 rev.no_inline = 1;
1752         }
1753
1754         /*
1755          * Parse the arguments before setup_revisions(), or something
1756          * like "git format-patch -o a123 HEAD^.." may fail; a123 is
1757          * possibly a valid SHA1.
1758          */
1759         argc = parse_options(argc, argv, prefix, builtin_format_patch_options,
1760                              builtin_format_patch_usage,
1761                              PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN |
1762                              PARSE_OPT_KEEP_DASHDASH);
1763
1764         if (cover_from_description_arg)
1765                 cover_from_description_mode = parse_cover_from_description(cover_from_description_arg);
1766
1767         if (0 < reroll_count) {
1768                 struct strbuf sprefix = STRBUF_INIT;
1769                 strbuf_addf(&sprefix, "%s v%d",
1770                             rev.subject_prefix, reroll_count);
1771                 rev.reroll_count = reroll_count;
1772                 rev.subject_prefix = strbuf_detach(&sprefix, NULL);
1773         }
1774
1775         for (i = 0; i < extra_hdr.nr; i++) {
1776                 strbuf_addstr(&buf, extra_hdr.items[i].string);
1777                 strbuf_addch(&buf, '\n');
1778         }
1779
1780         if (extra_to.nr)
1781                 strbuf_addstr(&buf, "To: ");
1782         for (i = 0; i < extra_to.nr; i++) {
1783                 if (i)
1784                         strbuf_addstr(&buf, "    ");
1785                 strbuf_addstr(&buf, extra_to.items[i].string);
1786                 if (i + 1 < extra_to.nr)
1787                         strbuf_addch(&buf, ',');
1788                 strbuf_addch(&buf, '\n');
1789         }
1790
1791         if (extra_cc.nr)
1792                 strbuf_addstr(&buf, "Cc: ");
1793         for (i = 0; i < extra_cc.nr; i++) {
1794                 if (i)
1795                         strbuf_addstr(&buf, "    ");
1796                 strbuf_addstr(&buf, extra_cc.items[i].string);
1797                 if (i + 1 < extra_cc.nr)
1798                         strbuf_addch(&buf, ',');
1799                 strbuf_addch(&buf, '\n');
1800         }
1801
1802         rev.extra_headers = strbuf_detach(&buf, NULL);
1803
1804         if (from) {
1805                 if (split_ident_line(&rev.from_ident, from, strlen(from)))
1806                         die(_("invalid ident line: %s"), from);
1807         }
1808
1809         if (start_number < 0)
1810                 start_number = 1;
1811
1812         /*
1813          * If numbered is set solely due to format.numbered in config,
1814          * and it would conflict with --keep-subject (-k) from the
1815          * command line, reset "numbered".
1816          */
1817         if (numbered && keep_subject && !numbered_cmdline_opt)
1818                 numbered = 0;
1819
1820         if (numbered && keep_subject)
1821                 die(_("-n and -k are mutually exclusive"));
1822         if (keep_subject && subject_prefix)
1823                 die(_("--subject-prefix/--rfc and -k are mutually exclusive"));
1824         rev.preserve_subject = keep_subject;
1825
1826         argc = setup_revisions(argc, argv, &rev, &s_r_opt);
1827         if (argc > 1)
1828                 die(_("unrecognized argument: %s"), argv[1]);
1829
1830         if (rev.diffopt.output_format & DIFF_FORMAT_NAME)
1831                 die(_("--name-only does not make sense"));
1832         if (rev.diffopt.output_format & DIFF_FORMAT_NAME_STATUS)
1833                 die(_("--name-status does not make sense"));
1834         if (rev.diffopt.output_format & DIFF_FORMAT_CHECKDIFF)
1835                 die(_("--check does not make sense"));
1836
1837         if (!use_patch_format &&
1838                 (!rev.diffopt.output_format ||
1839                  rev.diffopt.output_format == DIFF_FORMAT_PATCH))
1840                 rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY;
1841         if (!rev.diffopt.stat_width)
1842                 rev.diffopt.stat_width = MAIL_DEFAULT_WRAP;
1843
1844         /* Always generate a patch */
1845         rev.diffopt.output_format |= DIFF_FORMAT_PATCH;
1846
1847         rev.zero_commit = zero_commit;
1848
1849         if (!rev.diffopt.flags.text && !no_binary_diff)
1850                 rev.diffopt.flags.binary = 1;
1851
1852         if (rev.show_notes)
1853                 load_display_notes(&rev.notes_opt);
1854
1855         if (!output_directory && !use_stdout)
1856                 output_directory = config_output_directory;
1857
1858         if (!use_stdout)
1859                 output_directory = set_outdir(prefix, output_directory);
1860         else
1861                 setup_pager();
1862
1863         if (output_directory) {
1864                 int saved;
1865                 if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
1866                         rev.diffopt.use_color = GIT_COLOR_NEVER;
1867                 if (use_stdout)
1868                         die(_("standard output, or directory, which one?"));
1869                 /*
1870                  * We consider <outdir> as 'outside of gitdir', therefore avoid
1871                  * applying adjust_shared_perm in s-c-l-d.
1872                  */
1873                 saved = get_shared_repository();
1874                 set_shared_repository(0);
1875                 switch (safe_create_leading_directories_const(output_directory)) {
1876                 case SCLD_OK:
1877                 case SCLD_EXISTS:
1878                         break;
1879                 default:
1880                         die(_("could not create leading directories "
1881                               "of '%s'"), output_directory);
1882                 }
1883                 set_shared_repository(saved);
1884                 if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
1885                         die_errno(_("could not create directory '%s'"),
1886                                   output_directory);
1887         }
1888
1889         if (rev.pending.nr == 1) {
1890                 int check_head = 0;
1891
1892                 if (rev.max_count < 0 && !rev.show_root_diff) {
1893                         /*
1894                          * This is traditional behaviour of "git format-patch
1895                          * origin" that prepares what the origin side still
1896                          * does not have.
1897                          */
1898                         rev.pending.objects[0].item->flags |= UNINTERESTING;
1899                         add_head_to_pending(&rev);
1900                         check_head = 1;
1901                 }
1902                 /*
1903                  * Otherwise, it is "format-patch -22 HEAD", and/or
1904                  * "format-patch --root HEAD".  The user wants
1905                  * get_revision() to do the usual traversal.
1906                  */
1907
1908                 if (!strcmp(rev.pending.objects[0].name, "HEAD"))
1909                         check_head = 1;
1910
1911                 if (check_head) {
1912                         const char *ref, *v;
1913                         ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
1914                                                  NULL, NULL);
1915                         if (ref && skip_prefix(ref, "refs/heads/", &v))
1916                                 branch_name = xstrdup(v);
1917                         else
1918                                 branch_name = xstrdup(""); /* no branch */
1919                 }
1920         }
1921
1922         /*
1923          * We cannot move this anywhere earlier because we do want to
1924          * know if --root was given explicitly from the command line.
1925          */
1926         rev.show_root_diff = 1;
1927
1928         if (ignore_if_in_upstream) {
1929                 /* Don't say anything if head and upstream are the same. */
1930                 if (rev.pending.nr == 2) {
1931                         struct object_array_entry *o = rev.pending.objects;
1932                         if (oideq(&o[0].item->oid, &o[1].item->oid))
1933                                 goto done;
1934                 }
1935                 get_patch_ids(&rev, &ids);
1936         }
1937
1938         if (prepare_revision_walk(&rev))
1939                 die(_("revision walk setup failed"));
1940         rev.boundary = 1;
1941         while ((commit = get_revision(&rev)) != NULL) {
1942                 if (commit->object.flags & BOUNDARY) {
1943                         boundary_count++;
1944                         origin = (boundary_count == 1) ? commit : NULL;
1945                         continue;
1946                 }
1947
1948                 if (ignore_if_in_upstream && has_commit_patch_id(commit, &ids))
1949                         continue;
1950
1951                 nr++;
1952                 REALLOC_ARRAY(list, nr);
1953                 list[nr - 1] = commit;
1954         }
1955         if (nr == 0)
1956                 /* nothing to do */
1957                 goto done;
1958         total = nr;
1959         if (cover_letter == -1) {
1960                 if (config_cover_letter == COVER_AUTO)
1961                         cover_letter = (total > 1);
1962                 else
1963                         cover_letter = (config_cover_letter == COVER_ON);
1964         }
1965         if (!keep_subject && auto_number && (total > 1 || cover_letter))
1966                 numbered = 1;
1967         if (numbered)
1968                 rev.total = total + start_number - 1;
1969
1970         if (idiff_prev.nr) {
1971                 if (!cover_letter && total != 1)
1972                         die(_("--interdiff requires --cover-letter or single patch"));
1973                 rev.idiff_oid1 = &idiff_prev.oid[idiff_prev.nr - 1];
1974                 rev.idiff_oid2 = get_commit_tree_oid(list[0]);
1975                 rev.idiff_title = diff_title(&idiff_title, reroll_count,
1976                                              _("Interdiff:"),
1977                                              _("Interdiff against v%d:"));
1978         }
1979
1980         if (creation_factor < 0)
1981                 creation_factor = RANGE_DIFF_CREATION_FACTOR_DEFAULT;
1982         else if (!rdiff_prev)
1983                 die(_("--creation-factor requires --range-diff"));
1984
1985         if (rdiff_prev) {
1986                 if (!cover_letter && total != 1)
1987                         die(_("--range-diff requires --cover-letter or single patch"));
1988
1989                 infer_range_diff_ranges(&rdiff1, &rdiff2, rdiff_prev,
1990                                         origin, list[0]);
1991                 rev.rdiff1 = rdiff1.buf;
1992                 rev.rdiff2 = rdiff2.buf;
1993                 rev.creation_factor = creation_factor;
1994                 rev.rdiff_title = diff_title(&rdiff_title, reroll_count,
1995                                              _("Range-diff:"),
1996                                              _("Range-diff against v%d:"));
1997         }
1998
1999         if (!signature) {
2000                 ; /* --no-signature inhibits all signatures */
2001         } else if (signature && signature != git_version_string) {
2002                 ; /* non-default signature already set */
2003         } else if (signature_file) {
2004                 struct strbuf buf = STRBUF_INIT;
2005
2006                 if (strbuf_read_file(&buf, signature_file, 128) < 0)
2007                         die_errno(_("unable to read signature file '%s'"), signature_file);
2008                 signature = strbuf_detach(&buf, NULL);
2009         }
2010
2011         memset(&bases, 0, sizeof(bases));
2012         if (base_commit) {
2013                 struct commit *base = get_base_commit(base_commit, list, nr);
2014                 reset_revision_walk();
2015                 clear_object_flags(UNINTERESTING);
2016                 prepare_bases(&bases, base, list, nr);
2017         }
2018
2019         if (in_reply_to || thread || cover_letter)
2020                 rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
2021         if (in_reply_to) {
2022                 const char *msgid = clean_message_id(in_reply_to);
2023                 string_list_append(rev.ref_message_ids, msgid);
2024         }
2025         rev.numbered_files = just_numbers;
2026         rev.patch_suffix = fmt_patch_suffix;
2027         if (cover_letter) {
2028                 if (thread)
2029                         gen_message_id(&rev, "cover");
2030                 make_cover_letter(&rev, use_stdout,
2031                                   origin, nr, list, branch_name, quiet);
2032                 print_bases(&bases, rev.diffopt.file);
2033                 print_signature(rev.diffopt.file);
2034                 total++;
2035                 start_number--;
2036                 /* interdiff/range-diff in cover-letter; omit from patches */
2037                 rev.idiff_oid1 = NULL;
2038                 rev.rdiff1 = NULL;
2039         }
2040         rev.add_signoff = do_signoff;
2041
2042         if (show_progress)
2043                 progress = start_delayed_progress(_("Generating patches"), total);
2044         while (0 <= --nr) {
2045                 int shown;
2046                 display_progress(progress, total - nr);
2047                 commit = list[nr];
2048                 rev.nr = total - nr + (start_number - 1);
2049                 /* Make the second and subsequent mails replies to the first */
2050                 if (thread) {
2051                         /* Have we already had a message ID? */
2052                         if (rev.message_id) {
2053                                 /*
2054                                  * For deep threading: make every mail
2055                                  * a reply to the previous one, no
2056                                  * matter what other options are set.
2057                                  *
2058                                  * For shallow threading:
2059                                  *
2060                                  * Without --cover-letter and
2061                                  * --in-reply-to, make every mail a
2062                                  * reply to the one before.
2063                                  *
2064                                  * With --in-reply-to but no
2065                                  * --cover-letter, make every mail a
2066                                  * reply to the <reply-to>.
2067                                  *
2068                                  * With --cover-letter, make every
2069                                  * mail but the cover letter a reply
2070                                  * to the cover letter.  The cover
2071                                  * letter is a reply to the
2072                                  * --in-reply-to, if specified.
2073                                  */
2074                                 if (thread == THREAD_SHALLOW
2075                                     && rev.ref_message_ids->nr > 0
2076                                     && (!cover_letter || rev.nr > 1))
2077                                         free(rev.message_id);
2078                                 else
2079                                         string_list_append(rev.ref_message_ids,
2080                                                            rev.message_id);
2081                         }
2082                         gen_message_id(&rev, oid_to_hex(&commit->object.oid));
2083                 }
2084
2085                 if (!use_stdout &&
2086                     open_next_file(rev.numbered_files ? NULL : commit, NULL, &rev, quiet))
2087                         die(_("failed to create output files"));
2088                 shown = log_tree_commit(&rev, commit);
2089                 free_commit_buffer(the_repository->parsed_objects,
2090                                    commit);
2091
2092                 /* We put one extra blank line between formatted
2093                  * patches and this flag is used by log-tree code
2094                  * to see if it needs to emit a LF before showing
2095                  * the log; when using one file per patch, we do
2096                  * not want the extra blank line.
2097                  */
2098                 if (!use_stdout)
2099                         rev.shown_one = 0;
2100                 if (shown) {
2101                         print_bases(&bases, rev.diffopt.file);
2102                         if (rev.mime_boundary)
2103                                 fprintf(rev.diffopt.file, "\n--%s%s--\n\n\n",
2104                                        mime_boundary_leader,
2105                                        rev.mime_boundary);
2106                         else
2107                                 print_signature(rev.diffopt.file);
2108                 }
2109                 if (!use_stdout)
2110                         fclose(rev.diffopt.file);
2111         }
2112         stop_progress(&progress);
2113         free(list);
2114         free(branch_name);
2115         string_list_clear(&extra_to, 0);
2116         string_list_clear(&extra_cc, 0);
2117         string_list_clear(&extra_hdr, 0);
2118         if (ignore_if_in_upstream)
2119                 free_patch_ids(&ids);
2120
2121 done:
2122         oid_array_clear(&idiff_prev);
2123         strbuf_release(&idiff_title);
2124         strbuf_release(&rdiff1);
2125         strbuf_release(&rdiff2);
2126         strbuf_release(&rdiff_title);
2127         return 0;
2128 }
2129
2130 static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
2131 {
2132         struct object_id oid;
2133         if (get_oid(arg, &oid) == 0) {
2134                 struct commit *commit = lookup_commit_reference(the_repository,
2135                                                                 &oid);
2136                 if (commit) {
2137                         commit->object.flags |= flags;
2138                         add_pending_object(revs, &commit->object, arg);
2139                         return 0;
2140                 }
2141         }
2142         return -1;
2143 }
2144
2145 static const char * const cherry_usage[] = {
2146         N_("git cherry [-v] [<upstream> [<head> [<limit>]]]"),
2147         NULL
2148 };
2149
2150 static void print_commit(char sign, struct commit *commit, int verbose,
2151                          int abbrev, FILE *file)
2152 {
2153         if (!verbose) {
2154                 fprintf(file, "%c %s\n", sign,
2155                        find_unique_abbrev(&commit->object.oid, abbrev));
2156         } else {
2157                 struct strbuf buf = STRBUF_INIT;
2158                 pp_commit_easy(CMIT_FMT_ONELINE, commit, &buf);
2159                 fprintf(file, "%c %s %s\n", sign,
2160                        find_unique_abbrev(&commit->object.oid, abbrev),
2161                        buf.buf);
2162                 strbuf_release(&buf);
2163         }
2164 }
2165
2166 int cmd_cherry(int argc, const char **argv, const char *prefix)
2167 {
2168         struct rev_info revs;
2169         struct patch_ids ids;
2170         struct commit *commit;
2171         struct commit_list *list = NULL;
2172         struct branch *current_branch;
2173         const char *upstream;
2174         const char *head = "HEAD";
2175         const char *limit = NULL;
2176         int verbose = 0, abbrev = 0;
2177
2178         struct option options[] = {
2179                 OPT__ABBREV(&abbrev),
2180                 OPT__VERBOSE(&verbose, N_("be verbose")),
2181                 OPT_END()
2182         };
2183
2184         argc = parse_options(argc, argv, prefix, options, cherry_usage, 0);
2185
2186         switch (argc) {
2187         case 3:
2188                 limit = argv[2];
2189                 /* FALLTHROUGH */
2190         case 2:
2191                 head = argv[1];
2192                 /* FALLTHROUGH */
2193         case 1:
2194                 upstream = argv[0];
2195                 break;
2196         default:
2197                 current_branch = branch_get(NULL);
2198                 upstream = branch_get_upstream(current_branch, NULL);
2199                 if (!upstream) {
2200                         fprintf(stderr, _("Could not find a tracked"
2201                                         " remote branch, please"
2202                                         " specify <upstream> manually.\n"));
2203                         usage_with_options(cherry_usage, options);
2204                 }
2205         }
2206
2207         repo_init_revisions(the_repository, &revs, prefix);
2208         revs.max_parents = 1;
2209
2210         if (add_pending_commit(head, &revs, 0))
2211                 die(_("unknown commit %s"), head);
2212         if (add_pending_commit(upstream, &revs, UNINTERESTING))
2213                 die(_("unknown commit %s"), upstream);
2214
2215         /* Don't say anything if head and upstream are the same. */
2216         if (revs.pending.nr == 2) {
2217                 struct object_array_entry *o = revs.pending.objects;
2218                 if (oideq(&o[0].item->oid, &o[1].item->oid))
2219                         return 0;
2220         }
2221
2222         get_patch_ids(&revs, &ids);
2223
2224         if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
2225                 die(_("unknown commit %s"), limit);
2226
2227         /* reverse the list of commits */
2228         if (prepare_revision_walk(&revs))
2229                 die(_("revision walk setup failed"));
2230         while ((commit = get_revision(&revs)) != NULL) {
2231                 commit_list_insert(commit, &list);
2232         }
2233
2234         while (list) {
2235                 char sign = '+';
2236
2237                 commit = list->item;
2238                 if (has_commit_patch_id(commit, &ids))
2239                         sign = '-';
2240                 print_commit(sign, commit, verbose, abbrev, revs.diffopt.file);
2241                 list = list->next;
2242         }
2243
2244         free_patch_ids(&ids);
2245         return 0;
2246 }