builtin / commit.con commit help: add --config to list all available config (3ac68a9)
   1/*
   2 * Builtin "git commit"
   3 *
   4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
   5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
   6 */
   7
   8#include "cache.h"
   9#include "config.h"
  10#include "lockfile.h"
  11#include "cache-tree.h"
  12#include "color.h"
  13#include "dir.h"
  14#include "builtin.h"
  15#include "diff.h"
  16#include "diffcore.h"
  17#include "commit.h"
  18#include "revision.h"
  19#include "wt-status.h"
  20#include "run-command.h"
  21#include "refs.h"
  22#include "log-tree.h"
  23#include "strbuf.h"
  24#include "utf8.h"
  25#include "parse-options.h"
  26#include "string-list.h"
  27#include "rerere.h"
  28#include "unpack-trees.h"
  29#include "quote.h"
  30#include "submodule.h"
  31#include "gpg-interface.h"
  32#include "column.h"
  33#include "sequencer.h"
  34#include "mailmap.h"
  35#include "help.h"
  36
  37static const char * const builtin_commit_usage[] = {
  38        N_("git commit [<options>] [--] <pathspec>..."),
  39        NULL
  40};
  41
  42static const char * const builtin_status_usage[] = {
  43        N_("git status [<options>] [--] <pathspec>..."),
  44        NULL
  45};
  46
  47static const char empty_amend_advice[] =
  48N_("You asked to amend the most recent commit, but doing so would make\n"
  49"it empty. You can repeat your command with --allow-empty, or you can\n"
  50"remove the commit entirely with \"git reset HEAD^\".\n");
  51
  52static const char empty_cherry_pick_advice[] =
  53N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
  54"If you wish to commit it anyway, use:\n"
  55"\n"
  56"    git commit --allow-empty\n"
  57"\n");
  58
  59static const char empty_cherry_pick_advice_single[] =
  60N_("Otherwise, please use 'git reset'\n");
  61
  62static const char empty_cherry_pick_advice_multi[] =
  63N_("If you wish to skip this commit, use:\n"
  64"\n"
  65"    git reset\n"
  66"\n"
  67"Then \"git cherry-pick --continue\" will resume cherry-picking\n"
  68"the remaining commits.\n");
  69
  70static const char *color_status_slots[] = {
  71        [WT_STATUS_HEADER]        = "header",
  72        [WT_STATUS_UPDATED]       = "updated",
  73        [WT_STATUS_CHANGED]       = "changed",
  74        [WT_STATUS_UNTRACKED]     = "untracked",
  75        [WT_STATUS_NOBRANCH]      = "noBranch",
  76        [WT_STATUS_UNMERGED]      = "unmerged",
  77        [WT_STATUS_LOCAL_BRANCH]  = "localBranch",
  78        [WT_STATUS_REMOTE_BRANCH] = "remoteBranch",
  79        [WT_STATUS_ONBRANCH]      = "branch",
  80};
  81
  82static const char *use_message_buffer;
  83static struct lock_file index_lock; /* real index */
  84static struct lock_file false_lock; /* used only for partial commits */
  85static enum {
  86        COMMIT_AS_IS = 1,
  87        COMMIT_NORMAL,
  88        COMMIT_PARTIAL
  89} commit_style;
  90
  91static const char *logfile, *force_author;
  92static const char *template_file;
  93/*
  94 * The _message variables are commit names from which to take
  95 * the commit message and/or authorship.
  96 */
  97static const char *author_message, *author_message_buffer;
  98static char *edit_message, *use_message;
  99static char *fixup_message, *squash_message;
 100static int all, also, interactive, patch_interactive, only, amend, signoff;
 101static int edit_flag = -1; /* unspecified */
 102static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
 103static int config_commit_verbose = -1; /* unspecified */
 104static int no_post_rewrite, allow_empty_message;
 105static char *untracked_files_arg, *force_date, *ignore_submodule_arg, *ignored_arg;
 106static char *sign_commit;
 107
 108/*
 109 * The default commit message cleanup mode will remove the lines
 110 * beginning with # (shell comments) and leading and trailing
 111 * whitespaces (empty lines or containing only whitespaces)
 112 * if editor is used, and only the whitespaces if the message
 113 * is specified explicitly.
 114 */
 115static enum commit_msg_cleanup_mode cleanup_mode;
 116static const char *cleanup_arg;
 117
 118static enum commit_whence whence;
 119static int sequencer_in_use;
 120static int use_editor = 1, include_status = 1;
 121static int have_option_m;
 122static struct strbuf message = STRBUF_INIT;
 123
 124static enum wt_status_format status_format = STATUS_FORMAT_UNSPECIFIED;
 125
 126static int opt_parse_porcelain(const struct option *opt, const char *arg, int unset)
 127{
 128        enum wt_status_format *value = (enum wt_status_format *)opt->value;
 129        if (unset)
 130                *value = STATUS_FORMAT_NONE;
 131        else if (!arg)
 132                *value = STATUS_FORMAT_PORCELAIN;
 133        else if (!strcmp(arg, "v1") || !strcmp(arg, "1"))
 134                *value = STATUS_FORMAT_PORCELAIN;
 135        else if (!strcmp(arg, "v2") || !strcmp(arg, "2"))
 136                *value = STATUS_FORMAT_PORCELAIN_V2;
 137        else
 138                die("unsupported porcelain version '%s'", arg);
 139
 140        return 0;
 141}
 142
 143static int opt_parse_m(const struct option *opt, const char *arg, int unset)
 144{
 145        struct strbuf *buf = opt->value;
 146        if (unset) {
 147                have_option_m = 0;
 148                strbuf_setlen(buf, 0);
 149        } else {
 150                have_option_m = 1;
 151                if (buf->len)
 152                        strbuf_addch(buf, '\n');
 153                strbuf_addstr(buf, arg);
 154                strbuf_complete_line(buf);
 155        }
 156        return 0;
 157}
 158
 159static void determine_whence(struct wt_status *s)
 160{
 161        if (file_exists(git_path_merge_head()))
 162                whence = FROM_MERGE;
 163        else if (file_exists(git_path_cherry_pick_head())) {
 164                whence = FROM_CHERRY_PICK;
 165                if (file_exists(git_path_seq_dir()))
 166                        sequencer_in_use = 1;
 167        }
 168        else
 169                whence = FROM_COMMIT;
 170        if (s)
 171                s->whence = whence;
 172}
 173
 174static void status_init_config(struct wt_status *s, config_fn_t fn)
 175{
 176        wt_status_prepare(s);
 177        init_diff_ui_defaults();
 178        git_config(fn, s);
 179        determine_whence(s);
 180        s->hints = advice_status_hints; /* must come after git_config() */
 181}
 182
 183static void rollback_index_files(void)
 184{
 185        switch (commit_style) {
 186        case COMMIT_AS_IS:
 187                break; /* nothing to do */
 188        case COMMIT_NORMAL:
 189                rollback_lock_file(&index_lock);
 190                break;
 191        case COMMIT_PARTIAL:
 192                rollback_lock_file(&index_lock);
 193                rollback_lock_file(&false_lock);
 194                break;
 195        }
 196}
 197
 198static int commit_index_files(void)
 199{
 200        int err = 0;
 201
 202        switch (commit_style) {
 203        case COMMIT_AS_IS:
 204                break; /* nothing to do */
 205        case COMMIT_NORMAL:
 206                err = commit_lock_file(&index_lock);
 207                break;
 208        case COMMIT_PARTIAL:
 209                err = commit_lock_file(&index_lock);
 210                rollback_lock_file(&false_lock);
 211                break;
 212        }
 213
 214        return err;
 215}
 216
 217/*
 218 * Take a union of paths in the index and the named tree (typically, "HEAD"),
 219 * and return the paths that match the given pattern in list.
 220 */
 221static int list_paths(struct string_list *list, const char *with_tree,
 222                      const char *prefix, const struct pathspec *pattern)
 223{
 224        int i, ret;
 225        char *m;
 226
 227        if (!pattern->nr)
 228                return 0;
 229
 230        m = xcalloc(1, pattern->nr);
 231
 232        if (with_tree) {
 233                char *max_prefix = common_prefix(pattern);
 234                overlay_tree_on_index(&the_index, with_tree, max_prefix);
 235                free(max_prefix);
 236        }
 237
 238        for (i = 0; i < active_nr; i++) {
 239                const struct cache_entry *ce = active_cache[i];
 240                struct string_list_item *item;
 241
 242                if (ce->ce_flags & CE_UPDATE)
 243                        continue;
 244                if (!ce_path_match(ce, pattern, m))
 245                        continue;
 246                item = string_list_insert(list, ce->name);
 247                if (ce_skip_worktree(ce))
 248                        item->util = item; /* better a valid pointer than a fake one */
 249        }
 250
 251        ret = report_path_error(m, pattern, prefix);
 252        free(m);
 253        return ret;
 254}
 255
 256static void add_remove_files(struct string_list *list)
 257{
 258        int i;
 259        for (i = 0; i < list->nr; i++) {
 260                struct stat st;
 261                struct string_list_item *p = &(list->items[i]);
 262
 263                /* p->util is skip-worktree */
 264                if (p->util)
 265                        continue;
 266
 267                if (!lstat(p->string, &st)) {
 268                        if (add_to_cache(p->string, &st, 0))
 269                                die(_("updating files failed"));
 270                } else
 271                        remove_file_from_cache(p->string);
 272        }
 273}
 274
 275static void create_base_index(const struct commit *current_head)
 276{
 277        struct tree *tree;
 278        struct unpack_trees_options opts;
 279        struct tree_desc t;
 280
 281        if (!current_head) {
 282                discard_cache();
 283                return;
 284        }
 285
 286        memset(&opts, 0, sizeof(opts));
 287        opts.head_idx = 1;
 288        opts.index_only = 1;
 289        opts.merge = 1;
 290        opts.src_index = &the_index;
 291        opts.dst_index = &the_index;
 292
 293        opts.fn = oneway_merge;
 294        tree = parse_tree_indirect(&current_head->object.oid);
 295        if (!tree)
 296                die(_("failed to unpack HEAD tree object"));
 297        parse_tree(tree);
 298        init_tree_desc(&t, tree->buffer, tree->size);
 299        if (unpack_trees(1, &t, &opts))
 300                exit(128); /* We've already reported the error, finish dying */
 301}
 302
 303static void refresh_cache_or_die(int refresh_flags)
 304{
 305        /*
 306         * refresh_flags contains REFRESH_QUIET, so the only errors
 307         * are for unmerged entries.
 308         */
 309        if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
 310                die_resolve_conflict("commit");
 311}
 312
 313static const char *prepare_index(int argc, const char **argv, const char *prefix,
 314                                 const struct commit *current_head, int is_status)
 315{
 316        struct string_list partial = STRING_LIST_INIT_DUP;
 317        struct pathspec pathspec;
 318        int refresh_flags = REFRESH_QUIET;
 319        const char *ret;
 320
 321        if (is_status)
 322                refresh_flags |= REFRESH_UNMERGED;
 323        parse_pathspec(&pathspec, 0,
 324                       PATHSPEC_PREFER_FULL,
 325                       prefix, argv);
 326
 327        if (read_cache_preload(&pathspec) < 0)
 328                die(_("index file corrupt"));
 329
 330        if (interactive) {
 331                char *old_index_env = NULL;
 332                hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
 333
 334                refresh_cache_or_die(refresh_flags);
 335
 336                if (write_locked_index(&the_index, &index_lock, 0))
 337                        die(_("unable to create temporary index"));
 338
 339                old_index_env = getenv(INDEX_ENVIRONMENT);
 340                setenv(INDEX_ENVIRONMENT, get_lock_file_path(&index_lock), 1);
 341
 342                if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
 343                        die(_("interactive add failed"));
 344
 345                if (old_index_env && *old_index_env)
 346                        setenv(INDEX_ENVIRONMENT, old_index_env, 1);
 347                else
 348                        unsetenv(INDEX_ENVIRONMENT);
 349
 350                discard_cache();
 351                read_cache_from(get_lock_file_path(&index_lock));
 352                if (update_main_cache_tree(WRITE_TREE_SILENT) == 0) {
 353                        if (reopen_lock_file(&index_lock) < 0)
 354                                die(_("unable to write index file"));
 355                        if (write_locked_index(&the_index, &index_lock, 0))
 356                                die(_("unable to update temporary index"));
 357                } else
 358                        warning(_("Failed to update main cache tree"));
 359
 360                commit_style = COMMIT_NORMAL;
 361                ret = get_lock_file_path(&index_lock);
 362                goto out;
 363        }
 364
 365        /*
 366         * Non partial, non as-is commit.
 367         *
 368         * (1) get the real index;
 369         * (2) update the_index as necessary;
 370         * (3) write the_index out to the real index (still locked);
 371         * (4) return the name of the locked index file.
 372         *
 373         * The caller should run hooks on the locked real index, and
 374         * (A) if all goes well, commit the real index;
 375         * (B) on failure, rollback the real index.
 376         */
 377        if (all || (also && pathspec.nr)) {
 378                hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
 379                add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
 380                refresh_cache_or_die(refresh_flags);
 381                update_main_cache_tree(WRITE_TREE_SILENT);
 382                if (write_locked_index(&the_index, &index_lock, 0))
 383                        die(_("unable to write new_index file"));
 384                commit_style = COMMIT_NORMAL;
 385                ret = get_lock_file_path(&index_lock);
 386                goto out;
 387        }
 388
 389        /*
 390         * As-is commit.
 391         *
 392         * (1) return the name of the real index file.
 393         *
 394         * The caller should run hooks on the real index,
 395         * and create commit from the_index.
 396         * We still need to refresh the index here.
 397         */
 398        if (!only && !pathspec.nr) {
 399                hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
 400                refresh_cache_or_die(refresh_flags);
 401                if (active_cache_changed
 402                    || !cache_tree_fully_valid(active_cache_tree))
 403                        update_main_cache_tree(WRITE_TREE_SILENT);
 404                if (write_locked_index(&the_index, &index_lock,
 405                                       COMMIT_LOCK | SKIP_IF_UNCHANGED))
 406                        die(_("unable to write new_index file"));
 407                commit_style = COMMIT_AS_IS;
 408                ret = get_index_file();
 409                goto out;
 410        }
 411
 412        /*
 413         * A partial commit.
 414         *
 415         * (0) find the set of affected paths;
 416         * (1) get lock on the real index file;
 417         * (2) update the_index with the given paths;
 418         * (3) write the_index out to the real index (still locked);
 419         * (4) get lock on the false index file;
 420         * (5) reset the_index from HEAD;
 421         * (6) update the_index the same way as (2);
 422         * (7) write the_index out to the false index file;
 423         * (8) return the name of the false index file (still locked);
 424         *
 425         * The caller should run hooks on the locked false index, and
 426         * create commit from it.  Then
 427         * (A) if all goes well, commit the real index;
 428         * (B) on failure, rollback the real index;
 429         * In either case, rollback the false index.
 430         */
 431        commit_style = COMMIT_PARTIAL;
 432
 433        if (whence != FROM_COMMIT) {
 434                if (whence == FROM_MERGE)
 435                        die(_("cannot do a partial commit during a merge."));
 436                else if (whence == FROM_CHERRY_PICK)
 437                        die(_("cannot do a partial commit during a cherry-pick."));
 438        }
 439
 440        if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, &pathspec))
 441                exit(1);
 442
 443        discard_cache();
 444        if (read_cache() < 0)
 445                die(_("cannot read the index"));
 446
 447        hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
 448        add_remove_files(&partial);
 449        refresh_cache(REFRESH_QUIET);
 450        update_main_cache_tree(WRITE_TREE_SILENT);
 451        if (write_locked_index(&the_index, &index_lock, 0))
 452                die(_("unable to write new_index file"));
 453
 454        hold_lock_file_for_update(&false_lock,
 455                                  git_path("next-index-%"PRIuMAX,
 456                                           (uintmax_t) getpid()),
 457                                  LOCK_DIE_ON_ERROR);
 458
 459        create_base_index(current_head);
 460        add_remove_files(&partial);
 461        refresh_cache(REFRESH_QUIET);
 462
 463        if (write_locked_index(&the_index, &false_lock, 0))
 464                die(_("unable to write temporary index file"));
 465
 466        discard_cache();
 467        ret = get_lock_file_path(&false_lock);
 468        read_cache_from(ret);
 469out:
 470        string_list_clear(&partial, 0);
 471        clear_pathspec(&pathspec);
 472        return ret;
 473}
 474
 475static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
 476                      struct wt_status *s)
 477{
 478        struct object_id oid;
 479
 480        if (s->relative_paths)
 481                s->prefix = prefix;
 482
 483        if (amend) {
 484                s->amend = 1;
 485                s->reference = "HEAD^1";
 486        }
 487        s->verbose = verbose;
 488        s->index_file = index_file;
 489        s->fp = fp;
 490        s->nowarn = nowarn;
 491        s->is_initial = get_oid(s->reference, &oid) ? 1 : 0;
 492        if (!s->is_initial)
 493                hashcpy(s->sha1_commit, oid.hash);
 494        s->status_format = status_format;
 495        s->ignore_submodule_arg = ignore_submodule_arg;
 496
 497        wt_status_collect(s);
 498        wt_status_print(s);
 499
 500        return s->commitable;
 501}
 502
 503static int is_a_merge(const struct commit *current_head)
 504{
 505        return !!(current_head->parents && current_head->parents->next);
 506}
 507
 508static void assert_split_ident(struct ident_split *id, const struct strbuf *buf)
 509{
 510        if (split_ident_line(id, buf->buf, buf->len) || !id->date_begin)
 511                die("BUG: unable to parse our own ident: %s", buf->buf);
 512}
 513
 514static void export_one(const char *var, const char *s, const char *e, int hack)
 515{
 516        struct strbuf buf = STRBUF_INIT;
 517        if (hack)
 518                strbuf_addch(&buf, hack);
 519        strbuf_addf(&buf, "%.*s", (int)(e - s), s);
 520        setenv(var, buf.buf, 1);
 521        strbuf_release(&buf);
 522}
 523
 524static int parse_force_date(const char *in, struct strbuf *out)
 525{
 526        strbuf_addch(out, '@');
 527
 528        if (parse_date(in, out) < 0) {
 529                int errors = 0;
 530                unsigned long t = approxidate_careful(in, &errors);
 531                if (errors)
 532                        return -1;
 533                strbuf_addf(out, "%lu", t);
 534        }
 535
 536        return 0;
 537}
 538
 539static void set_ident_var(char **buf, char *val)
 540{
 541        free(*buf);
 542        *buf = val;
 543}
 544
 545static void determine_author_info(struct strbuf *author_ident)
 546{
 547        char *name, *email, *date;
 548        struct ident_split author;
 549
 550        name = xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
 551        email = xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
 552        date = xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
 553
 554        if (author_message) {
 555                struct ident_split ident;
 556                size_t len;
 557                const char *a;
 558
 559                a = find_commit_header(author_message_buffer, "author", &len);
 560                if (!a)
 561                        die(_("commit '%s' lacks author header"), author_message);
 562                if (split_ident_line(&ident, a, len) < 0)
 563                        die(_("commit '%s' has malformed author line"), author_message);
 564
 565                set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
 566                set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
 567
 568                if (ident.date_begin) {
 569                        struct strbuf date_buf = STRBUF_INIT;
 570                        strbuf_addch(&date_buf, '@');
 571                        strbuf_add(&date_buf, ident.date_begin, ident.date_end - ident.date_begin);
 572                        strbuf_addch(&date_buf, ' ');
 573                        strbuf_add(&date_buf, ident.tz_begin, ident.tz_end - ident.tz_begin);
 574                        set_ident_var(&date, strbuf_detach(&date_buf, NULL));
 575                }
 576        }
 577
 578        if (force_author) {
 579                struct ident_split ident;
 580
 581                if (split_ident_line(&ident, force_author, strlen(force_author)) < 0)
 582                        die(_("malformed --author parameter"));
 583                set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
 584                set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
 585        }
 586
 587        if (force_date) {
 588                struct strbuf date_buf = STRBUF_INIT;
 589                if (parse_force_date(force_date, &date_buf))
 590                        die(_("invalid date format: %s"), force_date);
 591                set_ident_var(&date, strbuf_detach(&date_buf, NULL));
 592        }
 593
 594        strbuf_addstr(author_ident, fmt_ident(name, email, date, IDENT_STRICT));
 595        assert_split_ident(&author, author_ident);
 596        export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
 597        export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
 598        export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
 599        free(name);
 600        free(email);
 601        free(date);
 602}
 603
 604static int author_date_is_interesting(void)
 605{
 606        return author_message || force_date;
 607}
 608
 609static void adjust_comment_line_char(const struct strbuf *sb)
 610{
 611        char candidates[] = "#;@!$%^&|:";
 612        char *candidate;
 613        const char *p;
 614
 615        comment_line_char = candidates[0];
 616        if (!memchr(sb->buf, comment_line_char, sb->len))
 617                return;
 618
 619        p = sb->buf;
 620        candidate = strchr(candidates, *p);
 621        if (candidate)
 622                *candidate = ' ';
 623        for (p = sb->buf; *p; p++) {
 624                if ((p[0] == '\n' || p[0] == '\r') && p[1]) {
 625                        candidate = strchr(candidates, p[1]);
 626                        if (candidate)
 627                                *candidate = ' ';
 628                }
 629        }
 630
 631        for (p = candidates; *p == ' '; p++)
 632                ;
 633        if (!*p)
 634                die(_("unable to select a comment character that is not used\n"
 635                      "in the current commit message"));
 636        comment_line_char = *p;
 637}
 638
 639static int prepare_to_commit(const char *index_file, const char *prefix,
 640                             struct commit *current_head,
 641                             struct wt_status *s,
 642                             struct strbuf *author_ident)
 643{
 644        struct stat statbuf;
 645        struct strbuf committer_ident = STRBUF_INIT;
 646        int commitable;
 647        struct strbuf sb = STRBUF_INIT;
 648        const char *hook_arg1 = NULL;
 649        const char *hook_arg2 = NULL;
 650        int clean_message_contents = (cleanup_mode != COMMIT_MSG_CLEANUP_NONE);
 651        int old_display_comment_prefix;
 652
 653        /* This checks and barfs if author is badly specified */
 654        determine_author_info(author_ident);
 655
 656        if (!no_verify && run_commit_hook(use_editor, index_file, "pre-commit", NULL))
 657                return 0;
 658
 659        if (squash_message) {
 660                /*
 661                 * Insert the proper subject line before other commit
 662                 * message options add their content.
 663                 */
 664                if (use_message && !strcmp(use_message, squash_message))
 665                        strbuf_addstr(&sb, "squash! ");
 666                else {
 667                        struct pretty_print_context ctx = {0};
 668                        struct commit *c;
 669                        c = lookup_commit_reference_by_name(squash_message);
 670                        if (!c)
 671                                die(_("could not lookup commit %s"), squash_message);
 672                        ctx.output_encoding = get_commit_output_encoding();
 673                        format_commit_message(c, "squash! %s\n\n", &sb,
 674                                              &ctx);
 675                }
 676        }
 677
 678        if (have_option_m && !fixup_message) {
 679                strbuf_addbuf(&sb, &message);
 680                hook_arg1 = "message";
 681        } else if (logfile && !strcmp(logfile, "-")) {
 682                if (isatty(0))
 683                        fprintf(stderr, _("(reading log message from standard input)\n"));
 684                if (strbuf_read(&sb, 0, 0) < 0)
 685                        die_errno(_("could not read log from standard input"));
 686                hook_arg1 = "message";
 687        } else if (logfile) {
 688                if (strbuf_read_file(&sb, logfile, 0) < 0)
 689                        die_errno(_("could not read log file '%s'"),
 690                                  logfile);
 691                hook_arg1 = "message";
 692        } else if (use_message) {
 693                char *buffer;
 694                buffer = strstr(use_message_buffer, "\n\n");
 695                if (buffer)
 696                        strbuf_addstr(&sb, skip_blank_lines(buffer + 2));
 697                hook_arg1 = "commit";
 698                hook_arg2 = use_message;
 699        } else if (fixup_message) {
 700                struct pretty_print_context ctx = {0};
 701                struct commit *commit;
 702                commit = lookup_commit_reference_by_name(fixup_message);
 703                if (!commit)
 704                        die(_("could not lookup commit %s"), fixup_message);
 705                ctx.output_encoding = get_commit_output_encoding();
 706                format_commit_message(commit, "fixup! %s\n\n",
 707                                      &sb, &ctx);
 708                if (have_option_m)
 709                        strbuf_addbuf(&sb, &message);
 710                hook_arg1 = "message";
 711        } else if (!stat(git_path_merge_msg(), &statbuf)) {
 712                /*
 713                 * prepend SQUASH_MSG here if it exists and a
 714                 * "merge --squash" was originally performed
 715                 */
 716                if (!stat(git_path_squash_msg(), &statbuf)) {
 717                        if (strbuf_read_file(&sb, git_path_squash_msg(), 0) < 0)
 718                                die_errno(_("could not read SQUASH_MSG"));
 719                        hook_arg1 = "squash";
 720                } else
 721                        hook_arg1 = "merge";
 722                if (strbuf_read_file(&sb, git_path_merge_msg(), 0) < 0)
 723                        die_errno(_("could not read MERGE_MSG"));
 724        } else if (!stat(git_path_squash_msg(), &statbuf)) {
 725                if (strbuf_read_file(&sb, git_path_squash_msg(), 0) < 0)
 726                        die_errno(_("could not read SQUASH_MSG"));
 727                hook_arg1 = "squash";
 728        } else if (template_file) {
 729                if (strbuf_read_file(&sb, template_file, 0) < 0)
 730                        die_errno(_("could not read '%s'"), template_file);
 731                hook_arg1 = "template";
 732                clean_message_contents = 0;
 733        }
 734
 735        /*
 736         * The remaining cases don't modify the template message, but
 737         * just set the argument(s) to the prepare-commit-msg hook.
 738         */
 739        else if (whence == FROM_MERGE)
 740                hook_arg1 = "merge";
 741        else if (whence == FROM_CHERRY_PICK) {
 742                hook_arg1 = "commit";
 743                hook_arg2 = "CHERRY_PICK_HEAD";
 744        }
 745
 746        if (squash_message) {
 747                /*
 748                 * If squash_commit was used for the commit subject,
 749                 * then we're possibly hijacking other commit log options.
 750                 * Reset the hook args to tell the real story.
 751                 */
 752                hook_arg1 = "message";
 753                hook_arg2 = "";
 754        }
 755
 756        s->fp = fopen_for_writing(git_path_commit_editmsg());
 757        if (s->fp == NULL)
 758                die_errno(_("could not open '%s'"), git_path_commit_editmsg());
 759
 760        /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
 761        old_display_comment_prefix = s->display_comment_prefix;
 762        s->display_comment_prefix = 1;
 763
 764        /*
 765         * Most hints are counter-productive when the commit has
 766         * already started.
 767         */
 768        s->hints = 0;
 769
 770        if (clean_message_contents)
 771                strbuf_stripspace(&sb, 0);
 772
 773        if (signoff)
 774                append_signoff(&sb, ignore_non_trailer(sb.buf, sb.len), 0);
 775
 776        if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
 777                die_errno(_("could not write commit template"));
 778
 779        if (auto_comment_line_char)
 780                adjust_comment_line_char(&sb);
 781        strbuf_release(&sb);
 782
 783        /* This checks if committer ident is explicitly given */
 784        strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
 785        if (use_editor && include_status) {
 786                int ident_shown = 0;
 787                int saved_color_setting;
 788                struct ident_split ci, ai;
 789
 790                if (whence != FROM_COMMIT) {
 791                        if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS)
 792                                wt_status_add_cut_line(s->fp);
 793                        status_printf_ln(s, GIT_COLOR_NORMAL,
 794                            whence == FROM_MERGE
 795                                ? _("\n"
 796                                        "It looks like you may be committing a merge.\n"
 797                                        "If this is not correct, please remove the file\n"
 798                                        "       %s\n"
 799                                        "and try again.\n")
 800                                : _("\n"
 801                                        "It looks like you may be committing a cherry-pick.\n"
 802                                        "If this is not correct, please remove the file\n"
 803                                        "       %s\n"
 804                                        "and try again.\n"),
 805                                whence == FROM_MERGE ?
 806                                        git_path_merge_head() :
 807                                        git_path_cherry_pick_head());
 808                }
 809
 810                fprintf(s->fp, "\n");
 811                if (cleanup_mode == COMMIT_MSG_CLEANUP_ALL)
 812                        status_printf(s, GIT_COLOR_NORMAL,
 813                                _("Please enter the commit message for your changes."
 814                                  " Lines starting\nwith '%c' will be ignored, and an empty"
 815                                  " message aborts the commit.\n"), comment_line_char);
 816                else if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS &&
 817                         whence == FROM_COMMIT)
 818                        wt_status_add_cut_line(s->fp);
 819                else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
 820                        status_printf(s, GIT_COLOR_NORMAL,
 821                                _("Please enter the commit message for your changes."
 822                                  " Lines starting\n"
 823                                  "with '%c' will be kept; you may remove them"
 824                                  " yourself if you want to.\n"
 825                                  "An empty message aborts the commit.\n"), comment_line_char);
 826
 827                /*
 828                 * These should never fail because they come from our own
 829                 * fmt_ident. They may fail the sane_ident test, but we know
 830                 * that the name and mail pointers will at least be valid,
 831                 * which is enough for our tests and printing here.
 832                 */
 833                assert_split_ident(&ai, author_ident);
 834                assert_split_ident(&ci, &committer_ident);
 835
 836                if (ident_cmp(&ai, &ci))
 837                        status_printf_ln(s, GIT_COLOR_NORMAL,
 838                                _("%s"
 839                                "Author:    %.*s <%.*s>"),
 840                                ident_shown++ ? "" : "\n",
 841                                (int)(ai.name_end - ai.name_begin), ai.name_begin,
 842                                (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);
 843
 844                if (author_date_is_interesting())
 845                        status_printf_ln(s, GIT_COLOR_NORMAL,
 846                                _("%s"
 847                                "Date:      %s"),
 848                                ident_shown++ ? "" : "\n",
 849                                show_ident_date(&ai, DATE_MODE(NORMAL)));
 850
 851                if (!committer_ident_sufficiently_given())
 852                        status_printf_ln(s, GIT_COLOR_NORMAL,
 853                                _("%s"
 854                                "Committer: %.*s <%.*s>"),
 855                                ident_shown++ ? "" : "\n",
 856                                (int)(ci.name_end - ci.name_begin), ci.name_begin,
 857                                (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
 858
 859                status_printf_ln(s, GIT_COLOR_NORMAL, "%s", ""); /* Add new line for clarity */
 860
 861                saved_color_setting = s->use_color;
 862                s->use_color = 0;
 863                commitable = run_status(s->fp, index_file, prefix, 1, s);
 864                s->use_color = saved_color_setting;
 865        } else {
 866                struct object_id oid;
 867                const char *parent = "HEAD";
 868
 869                if (!active_nr && read_cache() < 0)
 870                        die(_("Cannot read index"));
 871
 872                if (amend)
 873                        parent = "HEAD^1";
 874
 875                if (get_oid(parent, &oid)) {
 876                        int i, ita_nr = 0;
 877
 878                        for (i = 0; i < active_nr; i++)
 879                                if (ce_intent_to_add(active_cache[i]))
 880                                        ita_nr++;
 881                        commitable = active_nr - ita_nr > 0;
 882                } else {
 883                        /*
 884                         * Unless the user did explicitly request a submodule
 885                         * ignore mode by passing a command line option we do
 886                         * not ignore any changed submodule SHA-1s when
 887                         * comparing index and parent, no matter what is
 888                         * configured. Otherwise we won't commit any
 889                         * submodules which were manually staged, which would
 890                         * be really confusing.
 891                         */
 892                        struct diff_flags flags = DIFF_FLAGS_INIT;
 893                        flags.override_submodule_config = 1;
 894                        if (ignore_submodule_arg &&
 895                            !strcmp(ignore_submodule_arg, "all"))
 896                                flags.ignore_submodules = 1;
 897                        commitable = index_differs_from(parent, &flags, 1);
 898                }
 899        }
 900        strbuf_release(&committer_ident);
 901
 902        fclose(s->fp);
 903
 904        /*
 905         * Reject an attempt to record a non-merge empty commit without
 906         * explicit --allow-empty. In the cherry-pick case, it may be
 907         * empty due to conflict resolution, which the user should okay.
 908         */
 909        if (!commitable && whence != FROM_MERGE && !allow_empty &&
 910            !(amend && is_a_merge(current_head))) {
 911                s->display_comment_prefix = old_display_comment_prefix;
 912                run_status(stdout, index_file, prefix, 0, s);
 913                if (amend)
 914                        fputs(_(empty_amend_advice), stderr);
 915                else if (whence == FROM_CHERRY_PICK) {
 916                        fputs(_(empty_cherry_pick_advice), stderr);
 917                        if (!sequencer_in_use)
 918                                fputs(_(empty_cherry_pick_advice_single), stderr);
 919                        else
 920                                fputs(_(empty_cherry_pick_advice_multi), stderr);
 921                }
 922                return 0;
 923        }
 924
 925        if (!no_verify && find_hook("pre-commit")) {
 926                /*
 927                 * Re-read the index as pre-commit hook could have updated it,
 928                 * and write it out as a tree.  We must do this before we invoke
 929                 * the editor and after we invoke run_status above.
 930                 */
 931                discard_cache();
 932        }
 933        read_cache_from(index_file);
 934
 935        if (update_main_cache_tree(0)) {
 936                error(_("Error building trees"));
 937                return 0;
 938        }
 939
 940        if (run_commit_hook(use_editor, index_file, "prepare-commit-msg",
 941                            git_path_commit_editmsg(), hook_arg1, hook_arg2, NULL))
 942                return 0;
 943
 944        if (use_editor) {
 945                struct argv_array env = ARGV_ARRAY_INIT;
 946
 947                argv_array_pushf(&env, "GIT_INDEX_FILE=%s", index_file);
 948                if (launch_editor(git_path_commit_editmsg(), NULL, env.argv)) {
 949                        fprintf(stderr,
 950                        _("Please supply the message using either -m or -F option.\n"));
 951                        exit(1);
 952                }
 953                argv_array_clear(&env);
 954        }
 955
 956        if (!no_verify &&
 957            run_commit_hook(use_editor, index_file, "commit-msg", git_path_commit_editmsg(), NULL)) {
 958                return 0;
 959        }
 960
 961        return 1;
 962}
 963
 964static const char *find_author_by_nickname(const char *name)
 965{
 966        struct rev_info revs;
 967        struct commit *commit;
 968        struct strbuf buf = STRBUF_INIT;
 969        struct string_list mailmap = STRING_LIST_INIT_NODUP;
 970        const char *av[20];
 971        int ac = 0;
 972
 973        init_revisions(&revs, NULL);
 974        strbuf_addf(&buf, "--author=%s", name);
 975        av[++ac] = "--all";
 976        av[++ac] = "-i";
 977        av[++ac] = buf.buf;
 978        av[++ac] = NULL;
 979        setup_revisions(ac, av, &revs, NULL);
 980        revs.mailmap = &mailmap;
 981        read_mailmap(revs.mailmap, NULL);
 982
 983        if (prepare_revision_walk(&revs))
 984                die(_("revision walk setup failed"));
 985        commit = get_revision(&revs);
 986        if (commit) {
 987                struct pretty_print_context ctx = {0};
 988                ctx.date_mode.type = DATE_NORMAL;
 989                strbuf_release(&buf);
 990                format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
 991                clear_mailmap(&mailmap);
 992                return strbuf_detach(&buf, NULL);
 993        }
 994        die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name);
 995}
 996
 997static void handle_ignored_arg(struct wt_status *s)
 998{
 999        if (!ignored_arg)
1000                ; /* default already initialized */
1001        else if (!strcmp(ignored_arg, "traditional"))
1002                s->show_ignored_mode = SHOW_TRADITIONAL_IGNORED;
1003        else if (!strcmp(ignored_arg, "no"))
1004                s->show_ignored_mode = SHOW_NO_IGNORED;
1005        else if (!strcmp(ignored_arg, "matching"))
1006                s->show_ignored_mode = SHOW_MATCHING_IGNORED;
1007        else
1008                die(_("Invalid ignored mode '%s'"), ignored_arg);
1009}
1010
1011static void handle_untracked_files_arg(struct wt_status *s)
1012{
1013        if (!untracked_files_arg)
1014                ; /* default already initialized */
1015        else if (!strcmp(untracked_files_arg, "no"))
1016                s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1017        else if (!strcmp(untracked_files_arg, "normal"))
1018                s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1019        else if (!strcmp(untracked_files_arg, "all"))
1020                s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1021        else
1022                die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1023}
1024
1025static const char *read_commit_message(const char *name)
1026{
1027        const char *out_enc;
1028        struct commit *commit;
1029
1030        commit = lookup_commit_reference_by_name(name);
1031        if (!commit)
1032                die(_("could not lookup commit %s"), name);
1033        out_enc = get_commit_output_encoding();
1034        return logmsg_reencode(commit, NULL, out_enc);
1035}
1036
1037/*
1038 * Enumerate what needs to be propagated when --porcelain
1039 * is not in effect here.
1040 */
1041static struct status_deferred_config {
1042        enum wt_status_format status_format;
1043        int show_branch;
1044} status_deferred_config = {
1045        STATUS_FORMAT_UNSPECIFIED,
1046        -1 /* unspecified */
1047};
1048
1049static void finalize_deferred_config(struct wt_status *s)
1050{
1051        int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1052                                   status_format != STATUS_FORMAT_PORCELAIN_V2 &&
1053                                   !s->null_termination);
1054
1055        if (s->null_termination) {
1056                if (status_format == STATUS_FORMAT_NONE ||
1057                    status_format == STATUS_FORMAT_UNSPECIFIED)
1058                        status_format = STATUS_FORMAT_PORCELAIN;
1059                else if (status_format == STATUS_FORMAT_LONG)
1060                        die(_("--long and -z are incompatible"));
1061        }
1062
1063        if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1064                status_format = status_deferred_config.status_format;
1065        if (status_format == STATUS_FORMAT_UNSPECIFIED)
1066                status_format = STATUS_FORMAT_NONE;
1067
1068        if (use_deferred_config && s->show_branch < 0)
1069                s->show_branch = status_deferred_config.show_branch;
1070        if (s->show_branch < 0)
1071                s->show_branch = 0;
1072
1073        if (s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
1074                s->ahead_behind_flags = AHEAD_BEHIND_FULL;
1075}
1076
1077static int parse_and_validate_options(int argc, const char *argv[],
1078                                      const struct option *options,
1079                                      const char * const usage[],
1080                                      const char *prefix,
1081                                      struct commit *current_head,
1082                                      struct wt_status *s)
1083{
1084        int f = 0;
1085
1086        argc = parse_options(argc, argv, prefix, options, usage, 0);
1087        finalize_deferred_config(s);
1088
1089        if (force_author && !strchr(force_author, '>'))
1090                force_author = find_author_by_nickname(force_author);
1091
1092        if (force_author && renew_authorship)
1093                die(_("Using both --reset-author and --author does not make sense"));
1094
1095        if (logfile || have_option_m || use_message || fixup_message)
1096                use_editor = 0;
1097        if (0 <= edit_flag)
1098                use_editor = edit_flag;
1099
1100        /* Sanity check options */
1101        if (amend && !current_head)
1102                die(_("You have nothing to amend."));
1103        if (amend && whence != FROM_COMMIT) {
1104                if (whence == FROM_MERGE)
1105                        die(_("You are in the middle of a merge -- cannot amend."));
1106                else if (whence == FROM_CHERRY_PICK)
1107                        die(_("You are in the middle of a cherry-pick -- cannot amend."));
1108        }
1109        if (fixup_message && squash_message)
1110                die(_("Options --squash and --fixup cannot be used together"));
1111        if (use_message)
1112                f++;
1113        if (edit_message)
1114                f++;
1115        if (fixup_message)
1116                f++;
1117        if (logfile)
1118                f++;
1119        if (f > 1)
1120                die(_("Only one of -c/-C/-F/--fixup can be used."));
1121        if (have_option_m && (edit_message || use_message || logfile))
1122                die((_("Option -m cannot be combined with -c/-C/-F.")));
1123        if (f || have_option_m)
1124                template_file = NULL;
1125        if (edit_message)
1126                use_message = edit_message;
1127        if (amend && !use_message && !fixup_message)
1128                use_message = "HEAD";
1129        if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1130                die(_("--reset-author can be used only with -C, -c or --amend."));
1131        if (use_message) {
1132                use_message_buffer = read_commit_message(use_message);
1133                if (!renew_authorship) {
1134                        author_message = use_message;
1135                        author_message_buffer = use_message_buffer;
1136                }
1137        }
1138        if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1139                author_message = "CHERRY_PICK_HEAD";
1140                author_message_buffer = read_commit_message(author_message);
1141        }
1142
1143        if (patch_interactive)
1144                interactive = 1;
1145
1146        if (also + only + all + interactive > 1)
1147                die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1148        if (argc == 0 && (also || (only && !amend && !allow_empty)))
1149                die(_("No paths with --include/--only does not make sense."));
1150        if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1151                cleanup_mode = use_editor ? COMMIT_MSG_CLEANUP_ALL :
1152                                            COMMIT_MSG_CLEANUP_SPACE;
1153        else if (!strcmp(cleanup_arg, "verbatim"))
1154                cleanup_mode = COMMIT_MSG_CLEANUP_NONE;
1155        else if (!strcmp(cleanup_arg, "whitespace"))
1156                cleanup_mode = COMMIT_MSG_CLEANUP_SPACE;
1157        else if (!strcmp(cleanup_arg, "strip"))
1158                cleanup_mode = COMMIT_MSG_CLEANUP_ALL;
1159        else if (!strcmp(cleanup_arg, "scissors"))
1160                cleanup_mode = use_editor ? COMMIT_MSG_CLEANUP_SCISSORS :
1161                                            COMMIT_MSG_CLEANUP_SPACE;
1162        else
1163                die(_("Invalid cleanup mode %s"), cleanup_arg);
1164
1165        handle_untracked_files_arg(s);
1166
1167        if (all && argc > 0)
1168                die(_("Paths with -a does not make sense."));
1169
1170        if (status_format != STATUS_FORMAT_NONE)
1171                dry_run = 1;
1172
1173        return argc;
1174}
1175
1176static int dry_run_commit(int argc, const char **argv, const char *prefix,
1177                          const struct commit *current_head, struct wt_status *s)
1178{
1179        int commitable;
1180        const char *index_file;
1181
1182        index_file = prepare_index(argc, argv, prefix, current_head, 1);
1183        commitable = run_status(stdout, index_file, prefix, 0, s);
1184        rollback_index_files();
1185
1186        return commitable ? 0 : 1;
1187}
1188
1189define_list_config_array_extra(color_status_slots, {"added"});
1190
1191static int parse_status_slot(const char *slot)
1192{
1193        if (!strcasecmp(slot, "added"))
1194                return WT_STATUS_UPDATED;
1195
1196        return LOOKUP_CONFIG(color_status_slots, slot);
1197}
1198
1199static int git_status_config(const char *k, const char *v, void *cb)
1200{
1201        struct wt_status *s = cb;
1202        const char *slot_name;
1203
1204        if (starts_with(k, "column."))
1205                return git_column_config(k, v, "status", &s->colopts);
1206        if (!strcmp(k, "status.submodulesummary")) {
1207                int is_bool;
1208                s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1209                if (is_bool && s->submodule_summary)
1210                        s->submodule_summary = -1;
1211                return 0;
1212        }
1213        if (!strcmp(k, "status.short")) {
1214                if (git_config_bool(k, v))
1215                        status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1216                else
1217                        status_deferred_config.status_format = STATUS_FORMAT_NONE;
1218                return 0;
1219        }
1220        if (!strcmp(k, "status.branch")) {
1221                status_deferred_config.show_branch = git_config_bool(k, v);
1222                return 0;
1223        }
1224        if (!strcmp(k, "status.showstash")) {
1225                s->show_stash = git_config_bool(k, v);
1226                return 0;
1227        }
1228        if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1229                s->use_color = git_config_colorbool(k, v);
1230                return 0;
1231        }
1232        if (!strcmp(k, "status.displaycommentprefix")) {
1233                s->display_comment_prefix = git_config_bool(k, v);
1234                return 0;
1235        }
1236        if (skip_prefix(k, "status.color.", &slot_name) ||
1237            skip_prefix(k, "color.status.", &slot_name)) {
1238                int slot = parse_status_slot(slot_name);
1239                if (slot < 0)
1240                        return 0;
1241                if (!v)
1242                        return config_error_nonbool(k);
1243                return color_parse(v, s->color_palette[slot]);
1244        }
1245        if (!strcmp(k, "status.relativepaths")) {
1246                s->relative_paths = git_config_bool(k, v);
1247                return 0;
1248        }
1249        if (!strcmp(k, "status.showuntrackedfiles")) {
1250                if (!v)
1251                        return config_error_nonbool(k);
1252                else if (!strcmp(v, "no"))
1253                        s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1254                else if (!strcmp(v, "normal"))
1255                        s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1256                else if (!strcmp(v, "all"))
1257                        s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1258                else
1259                        return error(_("Invalid untracked files mode '%s'"), v);
1260                return 0;
1261        }
1262        return git_diff_ui_config(k, v, NULL);
1263}
1264
1265int cmd_status(int argc, const char **argv, const char *prefix)
1266{
1267        static struct wt_status s;
1268        int fd;
1269        struct object_id oid;
1270        static struct option builtin_status_options[] = {
1271                OPT__VERBOSE(&verbose, N_("be verbose")),
1272                OPT_SET_INT('s', "short", &status_format,
1273                            N_("show status concisely"), STATUS_FORMAT_SHORT),
1274                OPT_BOOL('b', "branch", &s.show_branch,
1275                         N_("show branch information")),
1276                OPT_BOOL(0, "show-stash", &s.show_stash,
1277                         N_("show stash information")),
1278                OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
1279                         N_("compute full ahead/behind values")),
1280                { OPTION_CALLBACK, 0, "porcelain", &status_format,
1281                  N_("version"), N_("machine-readable output"),
1282                  PARSE_OPT_OPTARG, opt_parse_porcelain },
1283                OPT_SET_INT(0, "long", &status_format,
1284                            N_("show status in long format (default)"),
1285                            STATUS_FORMAT_LONG),
1286                OPT_BOOL('z', "null", &s.null_termination,
1287                         N_("terminate entries with NUL")),
1288                { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1289                  N_("mode"),
1290                  N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1291                  PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1292                { OPTION_STRING, 0, "ignored", &ignored_arg,
1293                  N_("mode"),
1294                  N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1295                  PARSE_OPT_OPTARG, NULL, (intptr_t)"traditional" },
1296                { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1297                  N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1298                  PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1299                OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1300                OPT_END(),
1301        };
1302
1303        if (argc == 2 && !strcmp(argv[1], "-h"))
1304                usage_with_options(builtin_status_usage, builtin_status_options);
1305
1306        status_init_config(&s, git_status_config);
1307        argc = parse_options(argc, argv, prefix,
1308                             builtin_status_options,
1309                             builtin_status_usage, 0);
1310        finalize_colopts(&s.colopts, -1);
1311        finalize_deferred_config(&s);
1312
1313        handle_untracked_files_arg(&s);
1314        handle_ignored_arg(&s);
1315
1316        if (s.show_ignored_mode == SHOW_MATCHING_IGNORED &&
1317            s.show_untracked_files == SHOW_NO_UNTRACKED_FILES)
1318                die(_("Unsupported combination of ignored and untracked-files arguments"));
1319
1320        parse_pathspec(&s.pathspec, 0,
1321                       PATHSPEC_PREFER_FULL,
1322                       prefix, argv);
1323
1324        read_cache_preload(&s.pathspec);
1325        refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &s.pathspec, NULL, NULL);
1326
1327        if (use_optional_locks())
1328                fd = hold_locked_index(&index_lock, 0);
1329        else
1330                fd = -1;
1331
1332        s.is_initial = get_oid(s.reference, &oid) ? 1 : 0;
1333        if (!s.is_initial)
1334                hashcpy(s.sha1_commit, oid.hash);
1335
1336        s.ignore_submodule_arg = ignore_submodule_arg;
1337        s.status_format = status_format;
1338        s.verbose = verbose;
1339
1340        wt_status_collect(&s);
1341
1342        if (0 <= fd)
1343                update_index_if_able(&the_index, &index_lock);
1344
1345        if (s.relative_paths)
1346                s.prefix = prefix;
1347
1348        wt_status_print(&s);
1349        return 0;
1350}
1351
1352static int git_commit_config(const char *k, const char *v, void *cb)
1353{
1354        struct wt_status *s = cb;
1355        int status;
1356
1357        if (!strcmp(k, "commit.template"))
1358                return git_config_pathname(&template_file, k, v);
1359        if (!strcmp(k, "commit.status")) {
1360                include_status = git_config_bool(k, v);
1361                return 0;
1362        }
1363        if (!strcmp(k, "commit.cleanup"))
1364                return git_config_string(&cleanup_arg, k, v);
1365        if (!strcmp(k, "commit.gpgsign")) {
1366                sign_commit = git_config_bool(k, v) ? "" : NULL;
1367                return 0;
1368        }
1369        if (!strcmp(k, "commit.verbose")) {
1370                int is_bool;
1371                config_commit_verbose = git_config_bool_or_int(k, v, &is_bool);
1372                return 0;
1373        }
1374
1375        status = git_gpg_config(k, v, NULL);
1376        if (status)
1377                return status;
1378        return git_status_config(k, v, s);
1379}
1380
1381int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...)
1382{
1383        struct argv_array hook_env = ARGV_ARRAY_INIT;
1384        va_list args;
1385        int ret;
1386
1387        argv_array_pushf(&hook_env, "GIT_INDEX_FILE=%s", index_file);
1388
1389        /*
1390         * Let the hook know that no editor will be launched.
1391         */
1392        if (!editor_is_used)
1393                argv_array_push(&hook_env, "GIT_EDITOR=:");
1394
1395        va_start(args, name);
1396        ret = run_hook_ve(hook_env.argv,name, args);
1397        va_end(args);
1398        argv_array_clear(&hook_env);
1399
1400        return ret;
1401}
1402
1403int cmd_commit(int argc, const char **argv, const char *prefix)
1404{
1405        const char *argv_gc_auto[] = {"gc", "--auto", NULL};
1406        static struct wt_status s;
1407        static struct option builtin_commit_options[] = {
1408                OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1409                OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1410
1411                OPT_GROUP(N_("Commit message options")),
1412                OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1413                OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1414                OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1415                OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1416                OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1417                OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1418                OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1419                OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1420                OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1421                OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1422                OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1423                OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1424                OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
1425                OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1426                { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
1427                  N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1428                /* end commit message options */
1429
1430                OPT_GROUP(N_("Commit contents options")),
1431                OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1432                OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1433                OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1434                OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1435                OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1436                OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit and commit-msg hooks")),
1437                OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1438                OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1439                            STATUS_FORMAT_SHORT),
1440                OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1441                OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
1442                         N_("compute full ahead/behind values")),
1443                OPT_SET_INT(0, "porcelain", &status_format,
1444                            N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1445                OPT_SET_INT(0, "long", &status_format,
1446                            N_("show status in long format (default)"),
1447                            STATUS_FORMAT_LONG),
1448                OPT_BOOL('z', "null", &s.null_termination,
1449                         N_("terminate entries with NUL")),
1450                OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1451                OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1452                { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg, N_("mode"), N_("show untracked files, optional modes: all, normal, no. (Default: all)"), PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1453                /* end commit contents options */
1454
1455                OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1456                                N_("ok to record an empty change")),
1457                OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1458                                N_("ok to record a change with an empty message")),
1459
1460                OPT_END()
1461        };
1462
1463        struct strbuf sb = STRBUF_INIT;
1464        struct strbuf author_ident = STRBUF_INIT;
1465        const char *index_file, *reflog_msg;
1466        struct object_id oid;
1467        struct commit_list *parents = NULL;
1468        struct stat statbuf;
1469        struct commit *current_head = NULL;
1470        struct commit_extra_header *extra = NULL;
1471        struct strbuf err = STRBUF_INIT;
1472
1473        if (argc == 2 && !strcmp(argv[1], "-h"))
1474                usage_with_options(builtin_commit_usage, builtin_commit_options);
1475
1476        status_init_config(&s, git_commit_config);
1477        s.commit_template = 1;
1478        status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1479        s.colopts = 0;
1480
1481        if (get_oid("HEAD", &oid))
1482                current_head = NULL;
1483        else {
1484                current_head = lookup_commit_or_die(&oid, "HEAD");
1485                if (parse_commit(current_head))
1486                        die(_("could not parse HEAD commit"));
1487        }
1488        verbose = -1; /* unspecified */
1489        argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1490                                          builtin_commit_usage,
1491                                          prefix, current_head, &s);
1492        if (verbose == -1)
1493                verbose = (config_commit_verbose < 0) ? 0 : config_commit_verbose;
1494
1495        if (dry_run)
1496                return dry_run_commit(argc, argv, prefix, current_head, &s);
1497        index_file = prepare_index(argc, argv, prefix, current_head, 0);
1498
1499        /* Set up everything for writing the commit object.  This includes
1500           running hooks, writing the trees, and interacting with the user.  */
1501        if (!prepare_to_commit(index_file, prefix,
1502                               current_head, &s, &author_ident)) {
1503                rollback_index_files();
1504                return 1;
1505        }
1506
1507        /* Determine parents */
1508        reflog_msg = getenv("GIT_REFLOG_ACTION");
1509        if (!current_head) {
1510                if (!reflog_msg)
1511                        reflog_msg = "commit (initial)";
1512        } else if (amend) {
1513                if (!reflog_msg)
1514                        reflog_msg = "commit (amend)";
1515                parents = copy_commit_list(current_head->parents);
1516        } else if (whence == FROM_MERGE) {
1517                struct strbuf m = STRBUF_INIT;
1518                FILE *fp;
1519                int allow_fast_forward = 1;
1520                struct commit_list **pptr = &parents;
1521
1522                if (!reflog_msg)
1523                        reflog_msg = "commit (merge)";
1524                pptr = commit_list_append(current_head, pptr);
1525                fp = xfopen(git_path_merge_head(), "r");
1526                while (strbuf_getline_lf(&m, fp) != EOF) {
1527                        struct commit *parent;
1528
1529                        parent = get_merge_parent(m.buf);
1530                        if (!parent)
1531                                die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1532                        pptr = commit_list_append(parent, pptr);
1533                }
1534                fclose(fp);
1535                strbuf_release(&m);
1536                if (!stat(git_path_merge_mode(), &statbuf)) {
1537                        if (strbuf_read_file(&sb, git_path_merge_mode(), 0) < 0)
1538                                die_errno(_("could not read MERGE_MODE"));
1539                        if (!strcmp(sb.buf, "no-ff"))
1540                                allow_fast_forward = 0;
1541                }
1542                if (allow_fast_forward)
1543                        reduce_heads_replace(&parents);
1544        } else {
1545                if (!reflog_msg)
1546                        reflog_msg = (whence == FROM_CHERRY_PICK)
1547                                        ? "commit (cherry-pick)"
1548                                        : "commit";
1549                commit_list_insert(current_head, &parents);
1550        }
1551
1552        /* Finally, get the commit message */
1553        strbuf_reset(&sb);
1554        if (strbuf_read_file(&sb, git_path_commit_editmsg(), 0) < 0) {
1555                int saved_errno = errno;
1556                rollback_index_files();
1557                die(_("could not read commit message: %s"), strerror(saved_errno));
1558        }
1559
1560        if (verbose || /* Truncate the message just before the diff, if any. */
1561            cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS)
1562                strbuf_setlen(&sb, wt_status_locate_end(sb.buf, sb.len));
1563        if (cleanup_mode != COMMIT_MSG_CLEANUP_NONE)
1564                strbuf_stripspace(&sb, cleanup_mode == COMMIT_MSG_CLEANUP_ALL);
1565
1566        if (message_is_empty(&sb, cleanup_mode) && !allow_empty_message) {
1567                rollback_index_files();
1568                fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1569                exit(1);
1570        }
1571        if (template_untouched(&sb, template_file, cleanup_mode) && !allow_empty_message) {
1572                rollback_index_files();
1573                fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1574                exit(1);
1575        }
1576
1577        if (amend) {
1578                const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1579                extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1580        } else {
1581                struct commit_extra_header **tail = &extra;
1582                append_merge_tag_headers(parents, &tail);
1583        }
1584
1585        if (commit_tree_extended(sb.buf, sb.len, &active_cache_tree->oid,
1586                                 parents, &oid, author_ident.buf, sign_commit,
1587                                 extra)) {
1588                rollback_index_files();
1589                die(_("failed to write commit object"));
1590        }
1591        strbuf_release(&author_ident);
1592        free_commit_extra_headers(extra);
1593
1594        if (update_head_with_reflog(current_head, &oid, reflog_msg, &sb,
1595                                    &err)) {
1596                rollback_index_files();
1597                die("%s", err.buf);
1598        }
1599
1600        unlink(git_path_cherry_pick_head());
1601        unlink(git_path_revert_head());
1602        unlink(git_path_merge_head());
1603        unlink(git_path_merge_msg());
1604        unlink(git_path_merge_mode());
1605        unlink(git_path_squash_msg());
1606
1607        if (commit_index_files())
1608                die (_("Repository has been updated, but unable to write\n"
1609                     "new_index file. Check that disk is not full and quota is\n"
1610                     "not exceeded, and then \"git reset HEAD\" to recover."));
1611
1612        rerere(0);
1613        run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
1614        run_commit_hook(use_editor, get_index_file(), "post-commit", NULL);
1615        if (amend && !no_post_rewrite) {
1616                commit_post_rewrite(current_head, &oid);
1617        }
1618        if (!quiet) {
1619                unsigned int flags = 0;
1620
1621                if (!current_head)
1622                        flags |= SUMMARY_INITIAL_COMMIT;
1623                if (author_date_is_interesting())
1624                        flags |= SUMMARY_SHOW_AUTHOR_DATE;
1625                print_commit_summary(prefix, &oid, flags);
1626        }
1627
1628        UNLEAK(err);
1629        UNLEAK(sb);
1630        return 0;
1631}