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