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