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