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