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