builtin-commit.con commit builtin-help: fallback to GIT_MAN_VIEWER before man (5059a42)
   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 "cache-tree.h"
  10#include "color.h"
  11#include "dir.h"
  12#include "builtin.h"
  13#include "diff.h"
  14#include "diffcore.h"
  15#include "commit.h"
  16#include "revision.h"
  17#include "wt-status.h"
  18#include "run-command.h"
  19#include "refs.h"
  20#include "log-tree.h"
  21#include "strbuf.h"
  22#include "utf8.h"
  23#include "parse-options.h"
  24#include "string-list.h"
  25#include "rerere.h"
  26#include "unpack-trees.h"
  27
  28static const char * const builtin_commit_usage[] = {
  29        "git commit [options] [--] <filepattern>...",
  30        NULL
  31};
  32
  33static const char * const builtin_status_usage[] = {
  34        "git status [options] [--] <filepattern>...",
  35        NULL
  36};
  37
  38static unsigned char head_sha1[20], merge_head_sha1[20];
  39static char *use_message_buffer;
  40static const char commit_editmsg[] = "COMMIT_EDITMSG";
  41static struct lock_file index_lock; /* real index */
  42static struct lock_file false_lock; /* used only for partial commits */
  43static enum {
  44        COMMIT_AS_IS = 1,
  45        COMMIT_NORMAL,
  46        COMMIT_PARTIAL,
  47} commit_style;
  48
  49static const char *logfile, *force_author;
  50static const char *template_file;
  51static char *edit_message, *use_message;
  52static char *author_name, *author_email, *author_date;
  53static int all, edit_flag, also, interactive, only, amend, signoff;
  54static int quiet, verbose, no_verify, allow_empty;
  55static char *untracked_files_arg;
  56/*
  57 * The default commit message cleanup mode will remove the lines
  58 * beginning with # (shell comments) and leading and trailing
  59 * whitespaces (empty lines or containing only whitespaces)
  60 * if editor is used, and only the whitespaces if the message
  61 * is specified explicitly.
  62 */
  63static enum {
  64        CLEANUP_SPACE,
  65        CLEANUP_NONE,
  66        CLEANUP_ALL,
  67} cleanup_mode;
  68static char *cleanup_arg;
  69
  70static int use_editor = 1, initial_commit, in_merge;
  71static const char *only_include_assumed;
  72static struct strbuf message;
  73
  74static int opt_parse_m(const struct option *opt, const char *arg, int unset)
  75{
  76        struct strbuf *buf = opt->value;
  77        if (unset)
  78                strbuf_setlen(buf, 0);
  79        else {
  80                strbuf_addstr(buf, arg);
  81                strbuf_addstr(buf, "\n\n");
  82        }
  83        return 0;
  84}
  85
  86static struct option builtin_commit_options[] = {
  87        OPT__QUIET(&quiet),
  88        OPT__VERBOSE(&verbose),
  89        OPT_GROUP("Commit message options"),
  90
  91        OPT_STRING('F', "file", &logfile, "FILE", "read log from file"),
  92        OPT_STRING(0, "author", &force_author, "AUTHOR", "override author for commit"),
  93        OPT_CALLBACK('m', "message", &message, "MESSAGE", "specify commit message", opt_parse_m),
  94        OPT_STRING('c', "reedit-message", &edit_message, "COMMIT", "reuse and edit message from specified commit "),
  95        OPT_STRING('C', "reuse-message", &use_message, "COMMIT", "reuse message from specified commit"),
  96        OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
  97        OPT_STRING('t', "template", &template_file, "FILE", "use specified template file"),
  98        OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
  99
 100        OPT_GROUP("Commit contents options"),
 101        OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
 102        OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
 103        OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
 104        OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
 105        OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
 106        OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
 107        { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg, "mode", "show untracked files, optional modes: all, normal, no. (Default: all)", PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
 108        OPT_BOOLEAN(0, "allow-empty", &allow_empty, "ok to record an empty change"),
 109        OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
 110
 111        OPT_END()
 112};
 113
 114static void rollback_index_files(void)
 115{
 116        switch (commit_style) {
 117        case COMMIT_AS_IS:
 118                break; /* nothing to do */
 119        case COMMIT_NORMAL:
 120                rollback_lock_file(&index_lock);
 121                break;
 122        case COMMIT_PARTIAL:
 123                rollback_lock_file(&index_lock);
 124                rollback_lock_file(&false_lock);
 125                break;
 126        }
 127}
 128
 129static int commit_index_files(void)
 130{
 131        int err = 0;
 132
 133        switch (commit_style) {
 134        case COMMIT_AS_IS:
 135                break; /* nothing to do */
 136        case COMMIT_NORMAL:
 137                err = commit_lock_file(&index_lock);
 138                break;
 139        case COMMIT_PARTIAL:
 140                err = commit_lock_file(&index_lock);
 141                rollback_lock_file(&false_lock);
 142                break;
 143        }
 144
 145        return err;
 146}
 147
 148/*
 149 * Take a union of paths in the index and the named tree (typically, "HEAD"),
 150 * and return the paths that match the given pattern in list.
 151 */
 152static int list_paths(struct string_list *list, const char *with_tree,
 153                      const char *prefix, const char **pattern)
 154{
 155        int i;
 156        char *m;
 157
 158        for (i = 0; pattern[i]; i++)
 159                ;
 160        m = xcalloc(1, i);
 161
 162        if (with_tree)
 163                overlay_tree_on_cache(with_tree, prefix);
 164
 165        for (i = 0; i < active_nr; i++) {
 166                struct cache_entry *ce = active_cache[i];
 167                if (ce->ce_flags & CE_UPDATE)
 168                        continue;
 169                if (!pathspec_match(pattern, m, ce->name, 0))
 170                        continue;
 171                string_list_insert(ce->name, list);
 172        }
 173
 174        return report_path_error(m, pattern, prefix ? strlen(prefix) : 0);
 175}
 176
 177static void add_remove_files(struct string_list *list)
 178{
 179        int i;
 180        for (i = 0; i < list->nr; i++) {
 181                struct stat st;
 182                struct string_list_item *p = &(list->items[i]);
 183
 184                if (!lstat(p->string, &st)) {
 185                        if (add_to_cache(p->string, &st, 0))
 186                                die("updating files failed");
 187                } else
 188                        remove_file_from_cache(p->string);
 189        }
 190}
 191
 192static void create_base_index(void)
 193{
 194        struct tree *tree;
 195        struct unpack_trees_options opts;
 196        struct tree_desc t;
 197
 198        if (initial_commit) {
 199                discard_cache();
 200                return;
 201        }
 202
 203        memset(&opts, 0, sizeof(opts));
 204        opts.head_idx = 1;
 205        opts.index_only = 1;
 206        opts.merge = 1;
 207        opts.src_index = &the_index;
 208        opts.dst_index = &the_index;
 209
 210        opts.fn = oneway_merge;
 211        tree = parse_tree_indirect(head_sha1);
 212        if (!tree)
 213                die("failed to unpack HEAD tree object");
 214        parse_tree(tree);
 215        init_tree_desc(&t, tree->buffer, tree->size);
 216        if (unpack_trees(1, &t, &opts))
 217                exit(128); /* We've already reported the error, finish dying */
 218}
 219
 220static char *prepare_index(int argc, const char **argv, const char *prefix)
 221{
 222        int fd;
 223        struct string_list partial;
 224        const char **pathspec = NULL;
 225
 226        if (interactive) {
 227                interactive_add(argc, argv, prefix);
 228                if (read_cache() < 0)
 229                        die("index file corrupt");
 230                commit_style = COMMIT_AS_IS;
 231                return get_index_file();
 232        }
 233
 234        if (read_cache() < 0)
 235                die("index file corrupt");
 236
 237        if (*argv)
 238                pathspec = get_pathspec(prefix, argv);
 239
 240        /*
 241         * Non partial, non as-is commit.
 242         *
 243         * (1) get the real index;
 244         * (2) update the_index as necessary;
 245         * (3) write the_index out to the real index (still locked);
 246         * (4) return the name of the locked index file.
 247         *
 248         * The caller should run hooks on the locked real index, and
 249         * (A) if all goes well, commit the real index;
 250         * (B) on failure, rollback the real index.
 251         */
 252        if (all || (also && pathspec && *pathspec)) {
 253                int fd = hold_locked_index(&index_lock, 1);
 254                add_files_to_cache(also ? prefix : NULL, pathspec, 0);
 255                refresh_cache(REFRESH_QUIET);
 256                if (write_cache(fd, active_cache, active_nr) ||
 257                    close_lock_file(&index_lock))
 258                        die("unable to write new_index file");
 259                commit_style = COMMIT_NORMAL;
 260                return index_lock.filename;
 261        }
 262
 263        /*
 264         * As-is commit.
 265         *
 266         * (1) return the name of the real index file.
 267         *
 268         * The caller should run hooks on the real index, and run
 269         * hooks on the real index, and create commit from the_index.
 270         * We still need to refresh the index here.
 271         */
 272        if (!pathspec || !*pathspec) {
 273                fd = hold_locked_index(&index_lock, 1);
 274                refresh_cache(REFRESH_QUIET);
 275                if (write_cache(fd, active_cache, active_nr) ||
 276                    commit_locked_index(&index_lock))
 277                        die("unable to write new_index file");
 278                commit_style = COMMIT_AS_IS;
 279                return get_index_file();
 280        }
 281
 282        /*
 283         * A partial commit.
 284         *
 285         * (0) find the set of affected paths;
 286         * (1) get lock on the real index file;
 287         * (2) update the_index with the given paths;
 288         * (3) write the_index out to the real index (still locked);
 289         * (4) get lock on the false index file;
 290         * (5) reset the_index from HEAD;
 291         * (6) update the_index the same way as (2);
 292         * (7) write the_index out to the false index file;
 293         * (8) return the name of the false index file (still locked);
 294         *
 295         * The caller should run hooks on the locked false index, and
 296         * create commit from it.  Then
 297         * (A) if all goes well, commit the real index;
 298         * (B) on failure, rollback the real index;
 299         * In either case, rollback the false index.
 300         */
 301        commit_style = COMMIT_PARTIAL;
 302
 303        if (file_exists(git_path("MERGE_HEAD")))
 304                die("cannot do a partial commit during a merge.");
 305
 306        memset(&partial, 0, sizeof(partial));
 307        partial.strdup_strings = 1;
 308        if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
 309                exit(1);
 310
 311        discard_cache();
 312        if (read_cache() < 0)
 313                die("cannot read the index");
 314
 315        fd = hold_locked_index(&index_lock, 1);
 316        add_remove_files(&partial);
 317        refresh_cache(REFRESH_QUIET);
 318        if (write_cache(fd, active_cache, active_nr) ||
 319            close_lock_file(&index_lock))
 320                die("unable to write new_index file");
 321
 322        fd = hold_lock_file_for_update(&false_lock,
 323                                       git_path("next-index-%d", getpid()), 1);
 324
 325        create_base_index();
 326        add_remove_files(&partial);
 327        refresh_cache(REFRESH_QUIET);
 328
 329        if (write_cache(fd, active_cache, active_nr) ||
 330            close_lock_file(&false_lock))
 331                die("unable to write temporary index file");
 332
 333        discard_cache();
 334        read_cache_from(false_lock.filename);
 335
 336        return false_lock.filename;
 337}
 338
 339static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn)
 340{
 341        struct wt_status s;
 342
 343        wt_status_prepare(&s);
 344        if (wt_status_relative_paths)
 345                s.prefix = prefix;
 346
 347        if (amend) {
 348                s.amend = 1;
 349                s.reference = "HEAD^1";
 350        }
 351        s.verbose = verbose;
 352        s.untracked = (show_untracked_files == SHOW_ALL_UNTRACKED_FILES);
 353        s.index_file = index_file;
 354        s.fp = fp;
 355        s.nowarn = nowarn;
 356
 357        wt_status_print(&s);
 358
 359        return s.commitable;
 360}
 361
 362static int run_hook(const char *index_file, const char *name, ...)
 363{
 364        struct child_process hook;
 365        const char *argv[10], *env[2];
 366        char index[PATH_MAX];
 367        va_list args;
 368        int i;
 369
 370        va_start(args, name);
 371        argv[0] = git_path("hooks/%s", name);
 372        i = 0;
 373        do {
 374                if (++i >= ARRAY_SIZE(argv))
 375                        die ("run_hook(): too many arguments");
 376                argv[i] = va_arg(args, const char *);
 377        } while (argv[i]);
 378        va_end(args);
 379
 380        snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
 381        env[0] = index;
 382        env[1] = NULL;
 383
 384        if (access(argv[0], X_OK) < 0)
 385                return 0;
 386
 387        memset(&hook, 0, sizeof(hook));
 388        hook.argv = argv;
 389        hook.no_stdin = 1;
 390        hook.stdout_to_stderr = 1;
 391        hook.env = env;
 392
 393        return run_command(&hook);
 394}
 395
 396static int is_a_merge(const unsigned char *sha1)
 397{
 398        struct commit *commit = lookup_commit(sha1);
 399        if (!commit || parse_commit(commit))
 400                die("could not parse HEAD commit");
 401        return !!(commit->parents && commit->parents->next);
 402}
 403
 404static const char sign_off_header[] = "Signed-off-by: ";
 405
 406static void determine_author_info(void)
 407{
 408        char *name, *email, *date;
 409
 410        name = getenv("GIT_AUTHOR_NAME");
 411        email = getenv("GIT_AUTHOR_EMAIL");
 412        date = getenv("GIT_AUTHOR_DATE");
 413
 414        if (use_message) {
 415                const char *a, *lb, *rb, *eol;
 416
 417                a = strstr(use_message_buffer, "\nauthor ");
 418                if (!a)
 419                        die("invalid commit: %s", use_message);
 420
 421                lb = strstr(a + 8, " <");
 422                rb = strstr(a + 8, "> ");
 423                eol = strchr(a + 8, '\n');
 424                if (!lb || !rb || !eol)
 425                        die("invalid commit: %s", use_message);
 426
 427                name = xstrndup(a + 8, lb - (a + 8));
 428                email = xstrndup(lb + 2, rb - (lb + 2));
 429                date = xstrndup(rb + 2, eol - (rb + 2));
 430        }
 431
 432        if (force_author) {
 433                const char *lb = strstr(force_author, " <");
 434                const char *rb = strchr(force_author, '>');
 435
 436                if (!lb || !rb)
 437                        die("malformed --author parameter");
 438                name = xstrndup(force_author, lb - force_author);
 439                email = xstrndup(lb + 2, rb - (lb + 2));
 440        }
 441
 442        author_name = name;
 443        author_email = email;
 444        author_date = date;
 445}
 446
 447static int prepare_to_commit(const char *index_file, const char *prefix)
 448{
 449        struct stat statbuf;
 450        int commitable, saved_color_setting;
 451        struct strbuf sb;
 452        char *buffer;
 453        FILE *fp;
 454        const char *hook_arg1 = NULL;
 455        const char *hook_arg2 = NULL;
 456        int ident_shown = 0;
 457
 458        if (!no_verify && run_hook(index_file, "pre-commit", NULL))
 459                return 0;
 460
 461        strbuf_init(&sb, 0);
 462        if (message.len) {
 463                strbuf_addbuf(&sb, &message);
 464                hook_arg1 = "message";
 465        } else if (logfile && !strcmp(logfile, "-")) {
 466                if (isatty(0))
 467                        fprintf(stderr, "(reading log message from standard input)\n");
 468                if (strbuf_read(&sb, 0, 0) < 0)
 469                        die("could not read log from standard input");
 470                hook_arg1 = "message";
 471        } else if (logfile) {
 472                if (strbuf_read_file(&sb, logfile, 0) < 0)
 473                        die("could not read log file '%s': %s",
 474                            logfile, strerror(errno));
 475                hook_arg1 = "message";
 476        } else if (use_message) {
 477                buffer = strstr(use_message_buffer, "\n\n");
 478                if (!buffer || buffer[2] == '\0')
 479                        die("commit has empty message");
 480                strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
 481                hook_arg1 = "commit";
 482                hook_arg2 = use_message;
 483        } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
 484                if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
 485                        die("could not read MERGE_MSG: %s", strerror(errno));
 486                hook_arg1 = "merge";
 487        } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
 488                if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
 489                        die("could not read SQUASH_MSG: %s", strerror(errno));
 490                hook_arg1 = "squash";
 491        } else if (template_file && !stat(template_file, &statbuf)) {
 492                if (strbuf_read_file(&sb, template_file, 0) < 0)
 493                        die("could not read %s: %s",
 494                            template_file, strerror(errno));
 495                hook_arg1 = "template";
 496        }
 497
 498        /*
 499         * This final case does not modify the template message,
 500         * it just sets the argument to the prepare-commit-msg hook.
 501         */
 502        else if (in_merge)
 503                hook_arg1 = "merge";
 504
 505        fp = fopen(git_path(commit_editmsg), "w");
 506        if (fp == NULL)
 507                die("could not open %s: %s",
 508                    git_path(commit_editmsg), strerror(errno));
 509
 510        if (cleanup_mode != CLEANUP_NONE)
 511                stripspace(&sb, 0);
 512
 513        if (signoff) {
 514                struct strbuf sob;
 515                int i;
 516
 517                strbuf_init(&sob, 0);
 518                strbuf_addstr(&sob, sign_off_header);
 519                strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
 520                                             getenv("GIT_COMMITTER_EMAIL")));
 521                strbuf_addch(&sob, '\n');
 522                for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
 523                        ; /* do nothing */
 524                if (prefixcmp(sb.buf + i, sob.buf)) {
 525                        if (prefixcmp(sb.buf + i, sign_off_header))
 526                                strbuf_addch(&sb, '\n');
 527                        strbuf_addbuf(&sb, &sob);
 528                }
 529                strbuf_release(&sob);
 530        }
 531
 532        if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
 533                die("could not write commit template: %s", strerror(errno));
 534
 535        strbuf_release(&sb);
 536
 537        determine_author_info();
 538
 539        /* This checks if committer ident is explicitly given */
 540        git_committer_info(0);
 541        if (use_editor) {
 542                char *author_ident;
 543                const char *committer_ident;
 544
 545                if (in_merge)
 546                        fprintf(fp,
 547                                "#\n"
 548                                "# It looks like you may be committing a MERGE.\n"
 549                                "# If this is not correct, please remove the file\n"
 550                                "#      %s\n"
 551                                "# and try again.\n"
 552                                "#\n",
 553                                git_path("MERGE_HEAD"));
 554
 555                fprintf(fp,
 556                        "\n"
 557                        "# Please enter the commit message for your changes.");
 558                if (cleanup_mode == CLEANUP_ALL)
 559                        fprintf(fp,
 560                                " Lines starting\n"
 561                                "# with '#' will be ignored, and an empty"
 562                                " message aborts the commit.\n");
 563                else /* CLEANUP_SPACE, that is. */
 564                        fprintf(fp,
 565                                " Lines starting\n"
 566                                "# with '#' will be kept; you may remove them"
 567                                " yourself if you want to.\n"
 568                                "# An empty message aborts the commit.\n");
 569                if (only_include_assumed)
 570                        fprintf(fp, "# %s\n", only_include_assumed);
 571
 572                author_ident = xstrdup(fmt_name(author_name, author_email));
 573                committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
 574                                           getenv("GIT_COMMITTER_EMAIL"));
 575                if (strcmp(author_ident, committer_ident))
 576                        fprintf(fp,
 577                                "%s"
 578                                "# Author:    %s\n",
 579                                ident_shown++ ? "" : "#\n",
 580                                author_ident);
 581                free(author_ident);
 582
 583                if (!user_ident_explicitly_given)
 584                        fprintf(fp,
 585                                "%s"
 586                                "# Committer: %s\n",
 587                                ident_shown++ ? "" : "#\n",
 588                                committer_ident);
 589
 590                if (ident_shown)
 591                        fprintf(fp, "#\n");
 592
 593                saved_color_setting = wt_status_use_color;
 594                wt_status_use_color = 0;
 595                commitable = run_status(fp, index_file, prefix, 1);
 596                wt_status_use_color = saved_color_setting;
 597        } else {
 598                struct rev_info rev;
 599                unsigned char sha1[20];
 600                const char *parent = "HEAD";
 601
 602                if (!active_nr && read_cache() < 0)
 603                        die("Cannot read index");
 604
 605                if (amend)
 606                        parent = "HEAD^1";
 607
 608                if (get_sha1(parent, sha1))
 609                        commitable = !!active_nr;
 610                else {
 611                        init_revisions(&rev, "");
 612                        rev.abbrev = 0;
 613                        setup_revisions(0, NULL, &rev, parent);
 614                        DIFF_OPT_SET(&rev.diffopt, QUIET);
 615                        DIFF_OPT_SET(&rev.diffopt, EXIT_WITH_STATUS);
 616                        run_diff_index(&rev, 1 /* cached */);
 617
 618                        commitable = !!DIFF_OPT_TST(&rev.diffopt, HAS_CHANGES);
 619                }
 620        }
 621
 622        fclose(fp);
 623
 624        if (!commitable && !in_merge && !allow_empty &&
 625            !(amend && is_a_merge(head_sha1))) {
 626                run_status(stdout, index_file, prefix, 0);
 627                unlink(commit_editmsg);
 628                return 0;
 629        }
 630
 631        /*
 632         * Re-read the index as pre-commit hook could have updated it,
 633         * and write it out as a tree.  We must do this before we invoke
 634         * the editor and after we invoke run_status above.
 635         */
 636        discard_cache();
 637        read_cache_from(index_file);
 638        if (!active_cache_tree)
 639                active_cache_tree = cache_tree();
 640        if (cache_tree_update(active_cache_tree,
 641                              active_cache, active_nr, 0, 0) < 0) {
 642                error("Error building trees");
 643                return 0;
 644        }
 645
 646        if (run_hook(index_file, "prepare-commit-msg",
 647                     git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
 648                return 0;
 649
 650        if (use_editor) {
 651                char index[PATH_MAX];
 652                const char *env[2] = { index, NULL };
 653                snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
 654                if (launch_editor(git_path(commit_editmsg), NULL, env)) {
 655                        fprintf(stderr,
 656                        "Please supply the message using either -m or -F option.\n");
 657                        exit(1);
 658                }
 659        }
 660
 661        if (!no_verify &&
 662            run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
 663                return 0;
 664        }
 665
 666        return 1;
 667}
 668
 669/*
 670 * Find out if the message starting at position 'start' in the strbuf
 671 * contains only whitespace and Signed-off-by lines.
 672 */
 673static int message_is_empty(struct strbuf *sb, int start)
 674{
 675        struct strbuf tmpl;
 676        const char *nl;
 677        int eol, i;
 678
 679        if (cleanup_mode == CLEANUP_NONE && sb->len)
 680                return 0;
 681
 682        /* See if the template is just a prefix of the message. */
 683        strbuf_init(&tmpl, 0);
 684        if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
 685                stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
 686                if (start + tmpl.len <= sb->len &&
 687                    memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
 688                        start += tmpl.len;
 689        }
 690        strbuf_release(&tmpl);
 691
 692        /* Check if the rest is just whitespace and Signed-of-by's. */
 693        for (i = start; i < sb->len; i++) {
 694                nl = memchr(sb->buf + i, '\n', sb->len - i);
 695                if (nl)
 696                        eol = nl - sb->buf;
 697                else
 698                        eol = sb->len;
 699
 700                if (strlen(sign_off_header) <= eol - i &&
 701                    !prefixcmp(sb->buf + i, sign_off_header)) {
 702                        i = eol;
 703                        continue;
 704                }
 705                while (i < eol)
 706                        if (!isspace(sb->buf[i++]))
 707                                return 0;
 708        }
 709
 710        return 1;
 711}
 712
 713static int parse_and_validate_options(int argc, const char *argv[],
 714                                      const char * const usage[],
 715                                      const char *prefix)
 716{
 717        int f = 0;
 718
 719        argc = parse_options(argc, argv, builtin_commit_options, usage, 0);
 720        logfile = parse_options_fix_filename(prefix, logfile);
 721        template_file = parse_options_fix_filename(prefix, template_file);
 722
 723        if (logfile || message.len || use_message)
 724                use_editor = 0;
 725        if (edit_flag)
 726                use_editor = 1;
 727        if (!use_editor)
 728                setenv("GIT_EDITOR", ":", 1);
 729
 730        if (get_sha1("HEAD", head_sha1))
 731                initial_commit = 1;
 732
 733        if (!get_sha1("MERGE_HEAD", merge_head_sha1))
 734                in_merge = 1;
 735
 736        /* Sanity check options */
 737        if (amend && initial_commit)
 738                die("You have nothing to amend.");
 739        if (amend && in_merge)
 740                die("You are in the middle of a merge -- cannot amend.");
 741
 742        if (use_message)
 743                f++;
 744        if (edit_message)
 745                f++;
 746        if (logfile)
 747                f++;
 748        if (f > 1)
 749                die("Only one of -c/-C/-F can be used.");
 750        if (message.len && f > 0)
 751                die("Option -m cannot be combined with -c/-C/-F.");
 752        if (edit_message)
 753                use_message = edit_message;
 754        if (amend && !use_message)
 755                use_message = "HEAD";
 756        if (use_message) {
 757                unsigned char sha1[20];
 758                static char utf8[] = "UTF-8";
 759                const char *out_enc;
 760                char *enc, *end;
 761                struct commit *commit;
 762
 763                if (get_sha1(use_message, sha1))
 764                        die("could not lookup commit %s", use_message);
 765                commit = lookup_commit_reference(sha1);
 766                if (!commit || parse_commit(commit))
 767                        die("could not parse commit %s", use_message);
 768
 769                enc = strstr(commit->buffer, "\nencoding");
 770                if (enc) {
 771                        end = strchr(enc + 10, '\n');
 772                        enc = xstrndup(enc + 10, end - (enc + 10));
 773                } else {
 774                        enc = utf8;
 775                }
 776                out_enc = git_commit_encoding ? git_commit_encoding : utf8;
 777
 778                if (strcmp(out_enc, enc))
 779                        use_message_buffer =
 780                                reencode_string(commit->buffer, out_enc, enc);
 781
 782                /*
 783                 * If we failed to reencode the buffer, just copy it
 784                 * byte for byte so the user can try to fix it up.
 785                 * This also handles the case where input and output
 786                 * encodings are identical.
 787                 */
 788                if (use_message_buffer == NULL)
 789                        use_message_buffer = xstrdup(commit->buffer);
 790                if (enc != utf8)
 791                        free(enc);
 792        }
 793
 794        if (!!also + !!only + !!all + !!interactive > 1)
 795                die("Only one of --include/--only/--all/--interactive can be used.");
 796        if (argc == 0 && (also || (only && !amend)))
 797                die("No paths with --include/--only does not make sense.");
 798        if (argc == 0 && only && amend)
 799                only_include_assumed = "Clever... amending the last one with dirty index.";
 800        if (argc > 0 && !also && !only)
 801                only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
 802        if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
 803                cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
 804        else if (!strcmp(cleanup_arg, "verbatim"))
 805                cleanup_mode = CLEANUP_NONE;
 806        else if (!strcmp(cleanup_arg, "whitespace"))
 807                cleanup_mode = CLEANUP_SPACE;
 808        else if (!strcmp(cleanup_arg, "strip"))
 809                cleanup_mode = CLEANUP_ALL;
 810        else
 811                die("Invalid cleanup mode %s", cleanup_arg);
 812
 813        if (!untracked_files_arg)
 814                ; /* default already initialized */
 815        else if (!strcmp(untracked_files_arg, "no"))
 816                show_untracked_files = SHOW_NO_UNTRACKED_FILES;
 817        else if (!strcmp(untracked_files_arg, "normal"))
 818                show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
 819        else if (!strcmp(untracked_files_arg, "all"))
 820                show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
 821        else
 822                die("Invalid untracked files mode '%s'", untracked_files_arg);
 823
 824        if (all && argc > 0)
 825                die("Paths with -a does not make sense.");
 826        else if (interactive && argc > 0)
 827                die("Paths with --interactive does not make sense.");
 828
 829        return argc;
 830}
 831
 832int cmd_status(int argc, const char **argv, const char *prefix)
 833{
 834        const char *index_file;
 835        int commitable;
 836
 837        git_config(git_status_config, NULL);
 838
 839        if (wt_status_use_color == -1)
 840                wt_status_use_color = git_use_color_default;
 841
 842        argc = parse_and_validate_options(argc, argv, builtin_status_usage, prefix);
 843
 844        index_file = prepare_index(argc, argv, prefix);
 845
 846        commitable = run_status(stdout, index_file, prefix, 0);
 847
 848        rollback_index_files();
 849
 850        return commitable ? 0 : 1;
 851}
 852
 853static void print_summary(const char *prefix, const unsigned char *sha1)
 854{
 855        struct rev_info rev;
 856        struct commit *commit;
 857
 858        commit = lookup_commit(sha1);
 859        if (!commit)
 860                die("couldn't look up newly created commit");
 861        if (!commit || parse_commit(commit))
 862                die("could not parse newly created commit");
 863
 864        init_revisions(&rev, prefix);
 865        setup_revisions(0, NULL, &rev, NULL);
 866
 867        rev.abbrev = 0;
 868        rev.diff = 1;
 869        rev.diffopt.output_format =
 870                DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
 871
 872        rev.verbose_header = 1;
 873        rev.show_root_diff = 1;
 874        get_commit_format("format:%h: %s", &rev);
 875        rev.always_show_header = 0;
 876        rev.diffopt.detect_rename = 1;
 877        rev.diffopt.rename_limit = 100;
 878        rev.diffopt.break_opt = 0;
 879        diff_setup_done(&rev.diffopt);
 880
 881        printf("Created %scommit ", initial_commit ? "initial " : "");
 882
 883        if (!log_tree_commit(&rev, commit)) {
 884                struct strbuf buf = STRBUF_INIT;
 885                format_commit_message(commit, "%h: %s", &buf, DATE_NORMAL);
 886                printf("%s\n", buf.buf);
 887                strbuf_release(&buf);
 888        }
 889}
 890
 891static int git_commit_config(const char *k, const char *v, void *cb)
 892{
 893        if (!strcmp(k, "commit.template"))
 894                return git_config_string(&template_file, k, v);
 895
 896        return git_status_config(k, v, cb);
 897}
 898
 899static const char commit_utf8_warn[] =
 900"Warning: commit message does not conform to UTF-8.\n"
 901"You may want to amend it after fixing the message, or set the config\n"
 902"variable i18n.commitencoding to the encoding your project uses.\n";
 903
 904static void add_parent(struct strbuf *sb, const unsigned char *sha1)
 905{
 906        struct object *obj = parse_object(sha1);
 907        const char *parent = sha1_to_hex(sha1);
 908        const char *cp;
 909
 910        if (!obj)
 911                die("Unable to find commit parent %s", parent);
 912        if (obj->type != OBJ_COMMIT)
 913                die("Parent %s isn't a proper commit", parent);
 914
 915        for (cp = sb->buf; cp && (cp = strstr(cp, "\nparent ")); cp += 8) {
 916                if (!memcmp(cp + 8, parent, 40) && cp[48] == '\n') {
 917                        error("duplicate parent %s ignored", parent);
 918                        return;
 919                }
 920        }
 921        strbuf_addf(sb, "parent %s\n", parent);
 922}
 923
 924int cmd_commit(int argc, const char **argv, const char *prefix)
 925{
 926        int header_len;
 927        struct strbuf sb;
 928        const char *index_file, *reflog_msg;
 929        char *nl, *p;
 930        unsigned char commit_sha1[20];
 931        struct ref_lock *ref_lock;
 932
 933        git_config(git_commit_config, NULL);
 934
 935        argc = parse_and_validate_options(argc, argv, builtin_commit_usage, prefix);
 936
 937        index_file = prepare_index(argc, argv, prefix);
 938
 939        /* Set up everything for writing the commit object.  This includes
 940           running hooks, writing the trees, and interacting with the user.  */
 941        if (!prepare_to_commit(index_file, prefix)) {
 942                rollback_index_files();
 943                return 1;
 944        }
 945
 946        /*
 947         * The commit object
 948         */
 949        strbuf_init(&sb, 0);
 950        strbuf_addf(&sb, "tree %s\n",
 951                    sha1_to_hex(active_cache_tree->sha1));
 952
 953        /* Determine parents */
 954        if (initial_commit) {
 955                reflog_msg = "commit (initial)";
 956        } else if (amend) {
 957                struct commit_list *c;
 958                struct commit *commit;
 959
 960                reflog_msg = "commit (amend)";
 961                commit = lookup_commit(head_sha1);
 962                if (!commit || parse_commit(commit))
 963                        die("could not parse HEAD commit");
 964
 965                for (c = commit->parents; c; c = c->next)
 966                        add_parent(&sb, c->item->object.sha1);
 967        } else if (in_merge) {
 968                struct strbuf m;
 969                FILE *fp;
 970
 971                reflog_msg = "commit (merge)";
 972                add_parent(&sb, head_sha1);
 973                strbuf_init(&m, 0);
 974                fp = fopen(git_path("MERGE_HEAD"), "r");
 975                if (fp == NULL)
 976                        die("could not open %s for reading: %s",
 977                            git_path("MERGE_HEAD"), strerror(errno));
 978                while (strbuf_getline(&m, fp, '\n') != EOF) {
 979                        unsigned char sha1[20];
 980                        if (get_sha1_hex(m.buf, sha1) < 0)
 981                                die("Corrupt MERGE_HEAD file (%s)", m.buf);
 982                        add_parent(&sb, sha1);
 983                }
 984                fclose(fp);
 985                strbuf_release(&m);
 986        } else {
 987                reflog_msg = "commit";
 988                strbuf_addf(&sb, "parent %s\n", sha1_to_hex(head_sha1));
 989        }
 990
 991        strbuf_addf(&sb, "author %s\n",
 992                    fmt_ident(author_name, author_email, author_date, IDENT_ERROR_ON_NO_NAME));
 993        strbuf_addf(&sb, "committer %s\n", git_committer_info(IDENT_ERROR_ON_NO_NAME));
 994        if (!is_encoding_utf8(git_commit_encoding))
 995                strbuf_addf(&sb, "encoding %s\n", git_commit_encoding);
 996        strbuf_addch(&sb, '\n');
 997
 998        /* Finally, get the commit message */
 999        header_len = sb.len;
1000        if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1001                rollback_index_files();
1002                die("could not read commit message");
1003        }
1004
1005        /* Truncate the message just before the diff, if any. */
1006        p = strstr(sb.buf, "\ndiff --git a/");
1007        if (p != NULL)
1008                strbuf_setlen(&sb, p - sb.buf + 1);
1009
1010        if (cleanup_mode != CLEANUP_NONE)
1011                stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1012        if (sb.len < header_len || message_is_empty(&sb, header_len)) {
1013                rollback_index_files();
1014                fprintf(stderr, "Aborting commit due to empty commit message.\n");
1015                exit(1);
1016        }
1017        strbuf_addch(&sb, '\0');
1018        if (is_encoding_utf8(git_commit_encoding) && !is_utf8(sb.buf))
1019                fprintf(stderr, commit_utf8_warn);
1020
1021        if (write_sha1_file(sb.buf, sb.len - 1, commit_type, commit_sha1)) {
1022                rollback_index_files();
1023                die("failed to write commit object");
1024        }
1025
1026        ref_lock = lock_any_ref_for_update("HEAD",
1027                                           initial_commit ? NULL : head_sha1,
1028                                           0);
1029
1030        nl = strchr(sb.buf + header_len, '\n');
1031        if (nl)
1032                strbuf_setlen(&sb, nl + 1 - sb.buf);
1033        else
1034                strbuf_addch(&sb, '\n');
1035        strbuf_remove(&sb, 0, header_len);
1036        strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1037        strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1038
1039        if (!ref_lock) {
1040                rollback_index_files();
1041                die("cannot lock HEAD ref");
1042        }
1043        if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1044                rollback_index_files();
1045                die("cannot update HEAD ref");
1046        }
1047
1048        unlink(git_path("MERGE_HEAD"));
1049        unlink(git_path("MERGE_MSG"));
1050        unlink(git_path("SQUASH_MSG"));
1051
1052        if (commit_index_files())
1053                die ("Repository has been updated, but unable to write\n"
1054                     "new_index file. Check that disk is not full or quota is\n"
1055                     "not exceeded, and then \"git reset HEAD\" to recover.");
1056
1057        rerere();
1058        run_hook(get_index_file(), "post-commit", NULL);
1059        if (!quiet)
1060                print_summary(prefix, commit_sha1);
1061
1062        return 0;
1063}