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