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