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