builtin-commit.c

   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
  28 static const char * const builtin_commit_usage[] = {
  29         "git commit [options] [--] <filepattern>...",
  30         NULL
  31 };
  32
  33 static const char * const builtin_status_usage[] = {
  34         "git status [options] [--] <filepattern>...",
  35         NULL
  36 };
  37
  38 static unsigned char head_sha1[20], merge_head_sha1[20];
  39 static char *use_message_buffer;
  40 static const char commit_editmsg[] = "COMMIT_EDITMSG";
  41 static struct lock_file index_lock; /* real index */
  42 static struct lock_file false_lock; /* used only for partial commits */
  43 static enum {
  44         COMMIT_AS_IS = 1,
  45         COMMIT_NORMAL,
  46         COMMIT_PARTIAL,
  47 } commit_style;
  48
  49 static const char *logfile, *force_author;
  50 static const char *template_file;
  51 static char *edit_message, *use_message;
  52 static char *author_name, *author_email, *author_date;
  53 static int all, edit_flag, also, interactive, only, amend, signoff;
  54 static int quiet, verbose, no_verify, allow_empty;
  55 static 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  */
  63 static enum {
  64         CLEANUP_SPACE,
  65         CLEANUP_NONE,
  66         CLEANUP_ALL,
  67 } cleanup_mode;
  68 static char *cleanup_arg;
  69
  70 static int use_editor = 1, initial_commit, in_merge;
  71 static const char *only_include_assumed;
  72 static struct strbuf message;
  73
  74 static 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
  86 static 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
 114 static 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
 129 static 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  */
 152 static 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
 177 static 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
 192 static 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
 220 static 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()),
 324                                        LOCK_DIE_ON_ERROR);
 325
 326         create_base_index();
 327         add_remove_files(&partial);
 328         refresh_cache(REFRESH_QUIET);
 329
 330         if (write_cache(fd, active_cache, active_nr) ||
 331             close_lock_file(&false_lock))
 332                 die("unable to write temporary index file");
 333
 334         discard_cache();
 335         read_cache_from(false_lock.filename);
 336
 337         return false_lock.filename;
 338 }
 339
 340 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn)
 341 {
 342         struct wt_status s;
 343
 344         wt_status_prepare(&s);
 345         if (wt_status_relative_paths)
 346                 s.prefix = prefix;
 347
 348         if (amend) {
 349                 s.amend = 1;
 350                 s.reference = "HEAD^1";
 351         }
 352         s.verbose = verbose;
 353         s.untracked = (show_untracked_files == SHOW_ALL_UNTRACKED_FILES);
 354         s.index_file = index_file;
 355         s.fp = fp;
 356         s.nowarn = nowarn;
 357
 358         wt_status_print(&s);
 359
 360         return s.commitable;
 361 }
 362
 363 static int run_hook(const char *index_file, const char *name, ...)
 364 {
 365         struct child_process hook;
 366         const char *argv[10], *env[2];
 367         char index[PATH_MAX];
 368         va_list args;
 369         int i;
 370
 371         va_start(args, name);
 372         argv[0] = git_path("hooks/%s", name);
 373         i = 0;
 374         do {
 375                 if (++i >= ARRAY_SIZE(argv))
 376                         die ("run_hook(): too many arguments");
 377                 argv[i] = va_arg(args, const char *);
 378         } while (argv[i]);
 379         va_end(args);
 380
 381         snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
 382         env[0] = index;
 383         env[1] = NULL;
 384
 385         if (access(argv[0], X_OK) < 0)
 386                 return 0;
 387
 388         memset(&hook, 0, sizeof(hook));
 389         hook.argv = argv;
 390         hook.no_stdin = 1;
 391         hook.stdout_to_stderr = 1;
 392         hook.env = env;
 393
 394         return run_command(&hook);
 395 }
 396
 397 static int is_a_merge(const unsigned char *sha1)
 398 {
 399         struct commit *commit = lookup_commit(sha1);
 400         if (!commit || parse_commit(commit))
 401                 die("could not parse HEAD commit");
 402         return !!(commit->parents && commit->parents->next);
 403 }
 404
 405 static const char sign_off_header[] = "Signed-off-by: ";
 406
 407 static void determine_author_info(void)
 408 {
 409         char *name, *email, *date;
 410
 411         name = getenv("GIT_AUTHOR_NAME");
 412         email = getenv("GIT_AUTHOR_EMAIL");
 413         date = getenv("GIT_AUTHOR_DATE");
 414
 415         if (use_message) {
 416                 const char *a, *lb, *rb, *eol;
 417
 418                 a = strstr(use_message_buffer, "\nauthor ");
 419                 if (!a)
 420                         die("invalid commit: %s", use_message);
 421
 422                 lb = strstr(a + 8, " <");
 423                 rb = strstr(a + 8, "> ");
 424                 eol = strchr(a + 8, '\n');
 425                 if (!lb || !rb || !eol)
 426                         die("invalid commit: %s", use_message);
 427
 428                 name = xstrndup(a + 8, lb - (a + 8));
 429                 email = xstrndup(lb + 2, rb - (lb + 2));
 430                 date = xstrndup(rb + 2, eol - (rb + 2));
 431         }
 432
 433         if (force_author) {
 434                 const char *lb = strstr(force_author, " <");
 435                 const char *rb = strchr(force_author, '>');
 436
 437                 if (!lb || !rb)
 438                         die("malformed --author parameter");
 439                 name = xstrndup(force_author, lb - force_author);
 440                 email = xstrndup(lb + 2, rb - (lb + 2));
 441         }
 442
 443         author_name = name;
 444         author_email = email;
 445         author_date = date;
 446 }
 447
 448 static int prepare_to_commit(const char *index_file, const char *prefix)
 449 {
 450         struct stat statbuf;
 451         int commitable, saved_color_setting;
 452         struct strbuf sb;
 453         char *buffer;
 454         FILE *fp;
 455         const char *hook_arg1 = NULL;
 456         const char *hook_arg2 = NULL;
 457         int ident_shown = 0;
 458
 459         if (!no_verify && run_hook(index_file, "pre-commit", NULL))
 460                 return 0;
 461
 462         strbuf_init(&sb, 0);
 463         if (message.len) {
 464                 strbuf_addbuf(&sb, &message);
 465                 hook_arg1 = "message";
 466         } else if (logfile && !strcmp(logfile, "-")) {
 467                 if (isatty(0))
 468                         fprintf(stderr, "(reading log message from standard input)\n");
 469                 if (strbuf_read(&sb, 0, 0) < 0)
 470                         die("could not read log from standard input");
 471                 hook_arg1 = "message";
 472         } else if (logfile) {
 473                 if (strbuf_read_file(&sb, logfile, 0) < 0)
 474                         die("could not read log file '%s': %s",
 475                             logfile, strerror(errno));
 476                 hook_arg1 = "message";
 477         } else if (use_message) {
 478                 buffer = strstr(use_message_buffer, "\n\n");
 479                 if (!buffer || buffer[2] == '\0')
 480                         die("commit has empty message");
 481                 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
 482                 hook_arg1 = "commit";
 483                 hook_arg2 = use_message;
 484         } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
 485                 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
 486                         die("could not read MERGE_MSG: %s", strerror(errno));
 487                 hook_arg1 = "merge";
 488         } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
 489                 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
 490                         die("could not read SQUASH_MSG: %s", strerror(errno));
 491                 hook_arg1 = "squash";
 492         } else if (template_file && !stat(template_file, &statbuf)) {
 493                 if (strbuf_read_file(&sb, template_file, 0) < 0)
 494                         die("could not read %s: %s",
 495                             template_file, strerror(errno));
 496                 hook_arg1 = "template";
 497         }
 498
 499         /*
 500          * This final case does not modify the template message,
 501          * it just sets the argument to the prepare-commit-msg hook.
 502          */
 503         else if (in_merge)
 504                 hook_arg1 = "merge";
 505
 506         fp = fopen(git_path(commit_editmsg), "w");
 507         if (fp == NULL)
 508                 die("could not open %s: %s",
 509                     git_path(commit_editmsg), strerror(errno));
 510
 511         if (cleanup_mode != CLEANUP_NONE)
 512                 stripspace(&sb, 0);
 513
 514         if (signoff) {
 515                 struct strbuf sob;
 516                 int i;
 517
 518                 strbuf_init(&sob, 0);
 519                 strbuf_addstr(&sob, sign_off_header);
 520                 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
 521                                              getenv("GIT_COMMITTER_EMAIL")));
 522                 strbuf_addch(&sob, '\n');
 523                 for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
 524                         ; /* do nothing */
 525                 if (prefixcmp(sb.buf + i, sob.buf)) {
 526                         if (prefixcmp(sb.buf + i, sign_off_header))
 527                                 strbuf_addch(&sb, '\n');
 528                         strbuf_addbuf(&sb, &sob);
 529                 }
 530                 strbuf_release(&sob);
 531         }
 532
 533         if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
 534                 die("could not write commit template: %s", strerror(errno));
 535
 536         strbuf_release(&sb);
 537
 538         determine_author_info();
 539
 540         /* This checks if committer ident is explicitly given */
 541         git_committer_info(0);
 542         if (use_editor) {
 543                 char *author_ident;
 544                 const char *committer_ident;
 545
 546                 if (in_merge)
 547                         fprintf(fp,
 548                                 "#\n"
 549                                 "# It looks like you may be committing a MERGE.\n"
 550                                 "# If this is not correct, please remove the file\n"
 551                                 "#      %s\n"
 552                                 "# and try again.\n"
 553                                 "#\n",
 554                                 git_path("MERGE_HEAD"));
 555
 556                 fprintf(fp,
 557                         "\n"
 558                         "# Please enter the commit message for your changes.");
 559                 if (cleanup_mode == CLEANUP_ALL)
 560                         fprintf(fp,
 561                                 " Lines starting\n"
 562                                 "# with '#' will be ignored, and an empty"
 563                                 " message aborts the commit.\n");
 564                 else /* CLEANUP_SPACE, that is. */
 565                         fprintf(fp,
 566                                 " Lines starting\n"
 567                                 "# with '#' will be kept; you may remove them"
 568                                 " yourself if you want to.\n"
 569                                 "# An empty message aborts the commit.\n");
 570                 if (only_include_assumed)
 571                         fprintf(fp, "# %s\n", only_include_assumed);
 572
 573                 author_ident = xstrdup(fmt_name(author_name, author_email));
 574                 committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
 575                                            getenv("GIT_COMMITTER_EMAIL"));
 576                 if (strcmp(author_ident, committer_ident))
 577                         fprintf(fp,
 578                                 "%s"
 579                                 "# Author:    %s\n",
 580                                 ident_shown++ ? "" : "#\n",
 581                                 author_ident);
 582                 free(author_ident);
 583
 584                 if (!user_ident_explicitly_given)
 585                         fprintf(fp,
 586                                 "%s"
 587                                 "# Committer: %s\n",
 588                                 ident_shown++ ? "" : "#\n",
 589                                 committer_ident);
 590
 591                 if (ident_shown)
 592                         fprintf(fp, "#\n");
 593
 594                 saved_color_setting = wt_status_use_color;
 595                 wt_status_use_color = 0;
 596                 commitable = run_status(fp, index_file, prefix, 1);
 597                 wt_status_use_color = saved_color_setting;
 598         } else {
 599                 struct rev_info rev;
 600                 unsigned char sha1[20];
 601                 const char *parent = "HEAD";
 602
 603                 if (!active_nr && read_cache() < 0)
 604                         die("Cannot read index");
 605
 606                 if (amend)
 607                         parent = "HEAD^1";
 608
 609                 if (get_sha1(parent, sha1))
 610                         commitable = !!active_nr;
 611                 else {
 612                         init_revisions(&rev, "");
 613                         rev.abbrev = 0;
 614                         setup_revisions(0, NULL, &rev, parent);
 615                         DIFF_OPT_SET(&rev.diffopt, QUIET);
 616                         DIFF_OPT_SET(&rev.diffopt, EXIT_WITH_STATUS);
 617                         run_diff_index(&rev, 1 /* cached */);
 618
 619                         commitable = !!DIFF_OPT_TST(&rev.diffopt, HAS_CHANGES);
 620                 }
 621         }
 622
 623         fclose(fp);
 624
 625         if (!commitable && !in_merge && !allow_empty &&
 626             !(amend && is_a_merge(head_sha1))) {
 627                 run_status(stdout, index_file, prefix, 0);
 628                 unlink(commit_editmsg);
 629                 return 0;
 630         }
 631
 632         /*
 633          * Re-read the index as pre-commit hook could have updated it,
 634          * and write it out as a tree.  We must do this before we invoke
 635          * the editor and after we invoke run_status above.
 636          */
 637         discard_cache();
 638         read_cache_from(index_file);
 639         if (!active_cache_tree)
 640                 active_cache_tree = cache_tree();
 641         if (cache_tree_update(active_cache_tree,
 642                               active_cache, active_nr, 0, 0) < 0) {
 643                 error("Error building trees; the index is unmerged?");
 644                 return 0;
 645         }
 646
 647         if (run_hook(index_file, "prepare-commit-msg",
 648                      git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
 649                 return 0;
 650
 651         if (use_editor) {
 652                 char index[PATH_MAX];
 653                 const char *env[2] = { index, NULL };
 654                 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
 655                 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
 656                         fprintf(stderr,
 657                         "Please supply the message using either -m or -F option.\n");
 658                         exit(1);
 659                 }
 660         }
 661
 662         if (!no_verify &&
 663             run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
 664                 return 0;
 665         }
 666
 667         return 1;
 668 }
 669
 670 /*
 671  * Find out if the message starting at position 'start' in the strbuf
 672  * contains only whitespace and Signed-off-by lines.
 673  */
 674 static int message_is_empty(struct strbuf *sb, int start)
 675 {
 676         struct strbuf tmpl;
 677         const char *nl;
 678         int eol, i;
 679
 680         if (cleanup_mode == CLEANUP_NONE && sb->len)
 681                 return 0;
 682
 683         /* See if the template is just a prefix of the message. */
 684         strbuf_init(&tmpl, 0);
 685         if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
 686                 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
 687                 if (start + tmpl.len <= sb->len &&
 688                     memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
 689                         start += tmpl.len;
 690         }
 691         strbuf_release(&tmpl);
 692
 693         /* Check if the rest is just whitespace and Signed-of-by's. */
 694         for (i = start; i < sb->len; i++) {
 695                 nl = memchr(sb->buf + i, '\n', sb->len - i);
 696                 if (nl)
 697                         eol = nl - sb->buf;
 698                 else
 699                         eol = sb->len;
 700
 701                 if (strlen(sign_off_header) <= eol - i &&
 702                     !prefixcmp(sb->buf + i, sign_off_header)) {
 703                         i = eol;
 704                         continue;
 705                 }
 706                 while (i < eol)
 707                         if (!isspace(sb->buf[i++]))
 708                                 return 0;
 709         }
 710
 711         return 1;
 712 }
 713
 714 static int parse_and_validate_options(int argc, const char *argv[],
 715                                       const char * const usage[],
 716                                       const char *prefix)
 717 {
 718         int f = 0;
 719
 720         argc = parse_options(argc, argv, builtin_commit_options, usage, 0);
 721         logfile = parse_options_fix_filename(prefix, logfile);
 722         template_file = parse_options_fix_filename(prefix, template_file);
 723
 724         if (logfile || message.len || use_message)
 725                 use_editor = 0;
 726         if (edit_flag)
 727                 use_editor = 1;
 728         if (!use_editor)
 729                 setenv("GIT_EDITOR", ":", 1);
 730
 731         if (get_sha1("HEAD", head_sha1))
 732                 initial_commit = 1;
 733
 734         if (!get_sha1("MERGE_HEAD", merge_head_sha1))
 735                 in_merge = 1;
 736
 737         /* Sanity check options */
 738         if (amend && initial_commit)
 739                 die("You have nothing to amend.");
 740         if (amend && in_merge)
 741                 die("You are in the middle of a merge -- cannot amend.");
 742
 743         if (use_message)
 744                 f++;
 745         if (edit_message)
 746                 f++;
 747         if (logfile)
 748                 f++;
 749         if (f > 1)
 750                 die("Only one of -c/-C/-F can be used.");
 751         if (message.len && f > 0)
 752                 die("Option -m cannot be combined with -c/-C/-F.");
 753         if (edit_message)
 754                 use_message = edit_message;
 755         if (amend && !use_message)
 756                 use_message = "HEAD";
 757         if (use_message) {
 758                 unsigned char sha1[20];
 759                 static char utf8[] = "UTF-8";
 760                 const char *out_enc;
 761                 char *enc, *end;
 762                 struct commit *commit;
 763
 764                 if (get_sha1(use_message, sha1))
 765                         die("could not lookup commit %s", use_message);
 766                 commit = lookup_commit_reference(sha1);
 767                 if (!commit || parse_commit(commit))
 768                         die("could not parse commit %s", use_message);
 769
 770                 enc = strstr(commit->buffer, "\nencoding");
 771                 if (enc) {
 772                         end = strchr(enc + 10, '\n');
 773                         enc = xstrndup(enc + 10, end - (enc + 10));
 774                 } else {
 775                         enc = utf8;
 776                 }
 777                 out_enc = git_commit_encoding ? git_commit_encoding : utf8;
 778
 779                 if (strcmp(out_enc, enc))
 780                         use_message_buffer =
 781                                 reencode_string(commit->buffer, out_enc, enc);
 782
 783                 /*
 784                  * If we failed to reencode the buffer, just copy it
 785                  * byte for byte so the user can try to fix it up.
 786                  * This also handles the case where input and output
 787                  * encodings are identical.
 788                  */
 789                 if (use_message_buffer == NULL)
 790                         use_message_buffer = xstrdup(commit->buffer);
 791                 if (enc != utf8)
 792                         free(enc);
 793         }
 794
 795         if (!!also + !!only + !!all + !!interactive > 1)
 796                 die("Only one of --include/--only/--all/--interactive can be used.");
 797         if (argc == 0 && (also || (only && !amend)))
 798                 die("No paths with --include/--only does not make sense.");
 799         if (argc == 0 && only && amend)
 800                 only_include_assumed = "Clever... amending the last one with dirty index.";
 801         if (argc > 0 && !also && !only)
 802                 only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
 803         if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
 804                 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
 805         else if (!strcmp(cleanup_arg, "verbatim"))
 806                 cleanup_mode = CLEANUP_NONE;
 807         else if (!strcmp(cleanup_arg, "whitespace"))
 808                 cleanup_mode = CLEANUP_SPACE;
 809         else if (!strcmp(cleanup_arg, "strip"))
 810                 cleanup_mode = CLEANUP_ALL;
 811         else
 812                 die("Invalid cleanup mode %s", cleanup_arg);
 813
 814         if (!untracked_files_arg)
 815                 ; /* default already initialized */
 816         else if (!strcmp(untracked_files_arg, "no"))
 817                 show_untracked_files = SHOW_NO_UNTRACKED_FILES;
 818         else if (!strcmp(untracked_files_arg, "normal"))
 819                 show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
 820         else if (!strcmp(untracked_files_arg, "all"))
 821                 show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
 822         else
 823                 die("Invalid untracked files mode '%s'", untracked_files_arg);
 824
 825         if (all && argc > 0)
 826                 die("Paths with -a does not make sense.");
 827         else if (interactive && argc > 0)
 828                 die("Paths with --interactive does not make sense.");
 829
 830         return argc;
 831 }
 832
 833 int cmd_status(int argc, const char **argv, const char *prefix)
 834 {
 835         const char *index_file;
 836         int commitable;
 837
 838         git_config(git_status_config, NULL);
 839
 840         if (wt_status_use_color == -1)
 841                 wt_status_use_color = git_use_color_default;
 842
 843         argc = parse_and_validate_options(argc, argv, builtin_status_usage, prefix);
 844
 845         index_file = prepare_index(argc, argv, prefix);
 846
 847         commitable = run_status(stdout, index_file, prefix, 0);
 848
 849         rollback_index_files();
 850
 851         return commitable ? 0 : 1;
 852 }
 853
 854 static void print_summary(const char *prefix, const unsigned char *sha1)
 855 {
 856         struct rev_info rev;
 857         struct commit *commit;
 858
 859         commit = lookup_commit(sha1);
 860         if (!commit)
 861                 die("couldn't look up newly created commit");
 862         if (!commit || parse_commit(commit))
 863                 die("could not parse newly created commit");
 864
 865         init_revisions(&rev, prefix);
 866         setup_revisions(0, NULL, &rev, NULL);
 867
 868         rev.abbrev = 0;
 869         rev.diff = 1;
 870         rev.diffopt.output_format =
 871                 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
 872
 873         rev.verbose_header = 1;
 874         rev.show_root_diff = 1;
 875         get_commit_format("format:%h: %s", &rev);
 876         rev.always_show_header = 0;
 877         rev.diffopt.detect_rename = 1;
 878         rev.diffopt.rename_limit = 100;
 879         rev.diffopt.break_opt = 0;
 880         diff_setup_done(&rev.diffopt);
 881
 882         printf("Created %scommit ", initial_commit ? "initial " : "");
 883
 884         if (!log_tree_commit(&rev, commit)) {
 885                 struct strbuf buf = STRBUF_INIT;
 886                 format_commit_message(commit, "%h: %s", &buf, DATE_NORMAL);
 887                 printf("%s\n", buf.buf);
 888                 strbuf_release(&buf);
 889         }
 890 }
 891
 892 static int git_commit_config(const char *k, const char *v, void *cb)
 893 {
 894         if (!strcmp(k, "commit.template"))
 895                 return git_config_string(&template_file, k, v);
 896
 897         return git_status_config(k, v, cb);
 898 }
 899
 900 static const char commit_utf8_warn[] =
 901 "Warning: commit message does not conform to UTF-8.\n"
 902 "You may want to amend it after fixing the message, or set the config\n"
 903 "variable i18n.commitencoding to the encoding your project uses.\n";
 904
 905 static void add_parent(struct strbuf *sb, const unsigned char *sha1)
 906 {
 907         struct object *obj = parse_object(sha1);
 908         const char *parent = sha1_to_hex(sha1);
 909         const char *cp;
 910
 911         if (!obj)
 912                 die("Unable to find commit parent %s", parent);
 913         if (obj->type != OBJ_COMMIT)
 914                 die("Parent %s isn't a proper commit", parent);
 915
 916         for (cp = sb->buf; cp && (cp = strstr(cp, "\nparent ")); cp += 8) {
 917                 if (!memcmp(cp + 8, parent, 40) && cp[48] == '\n') {
 918                         error("duplicate parent %s ignored", parent);
 919                         return;
 920                 }
 921         }
 922         strbuf_addf(sb, "parent %s\n", parent);
 923 }
 924
 925 int cmd_commit(int argc, const char **argv, const char *prefix)
 926 {
 927         int header_len;
 928         struct strbuf sb;
 929         const char *index_file, *reflog_msg;
 930         char *nl, *p;
 931         unsigned char commit_sha1[20];
 932         struct ref_lock *ref_lock;
 933
 934         git_config(git_commit_config, NULL);
 935
 936         argc = parse_and_validate_options(argc, argv, builtin_commit_usage, prefix);
 937
 938         index_file = prepare_index(argc, argv, prefix);
 939
 940         /* Set up everything for writing the commit object.  This includes
 941            running hooks, writing the trees, and interacting with the user.  */
 942         if (!prepare_to_commit(index_file, prefix)) {
 943                 rollback_index_files();
 944                 return 1;
 945         }
 946
 947         /*
 948          * The commit object
 949          */
 950         strbuf_init(&sb, 0);
 951         strbuf_addf(&sb, "tree %s\n",
 952                     sha1_to_hex(active_cache_tree->sha1));
 953
 954         /* Determine parents */
 955         if (initial_commit) {
 956                 reflog_msg = "commit (initial)";
 957         } else if (amend) {
 958                 struct commit_list *c;
 959                 struct commit *commit;
 960
 961                 reflog_msg = "commit (amend)";
 962                 commit = lookup_commit(head_sha1);
 963                 if (!commit || parse_commit(commit))
 964                         die("could not parse HEAD commit");
 965
 966                 for (c = commit->parents; c; c = c->next)
 967                         add_parent(&sb, c->item->object.sha1);
 968         } else if (in_merge) {
 969                 struct strbuf m;
 970                 FILE *fp;
 971
 972                 reflog_msg = "commit (merge)";
 973                 add_parent(&sb, head_sha1);
 974                 strbuf_init(&m, 0);
 975                 fp = fopen(git_path("MERGE_HEAD"), "r");
 976                 if (fp == NULL)
 977                         die("could not open %s for reading: %s",
 978                             git_path("MERGE_HEAD"), strerror(errno));
 979                 while (strbuf_getline(&m, fp, '\n') != EOF) {
 980                         unsigned char sha1[20];
 981                         if (get_sha1_hex(m.buf, sha1) < 0)
 982                                 die("Corrupt MERGE_HEAD file (%s)", m.buf);
 983                         add_parent(&sb, sha1);
 984                 }
 985                 fclose(fp);
 986                 strbuf_release(&m);
 987         } else {
 988                 reflog_msg = "commit";
 989                 strbuf_addf(&sb, "parent %s\n", sha1_to_hex(head_sha1));
 990         }
 991
 992         strbuf_addf(&sb, "author %s\n",
 993                     fmt_ident(author_name, author_email, author_date, IDENT_ERROR_ON_NO_NAME));
 994         strbuf_addf(&sb, "committer %s\n", git_committer_info(IDENT_ERROR_ON_NO_NAME));
 995         if (!is_encoding_utf8(git_commit_encoding))
 996                 strbuf_addf(&sb, "encoding %s\n", git_commit_encoding);
 997         strbuf_addch(&sb, '\n');
 998
 999         /* Finally, get the commit message */
1000         header_len = sb.len;
1001         if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1002                 rollback_index_files();
1003                 die("could not read commit message");
1004         }
1005
1006         /* Truncate the message just before the diff, if any. */
1007         if (verbose) {
1008                 p = strstr(sb.buf, "\ndiff --git ");
1009                 if (p != NULL)
1010                         strbuf_setlen(&sb, p - sb.buf + 1);
1011         }
1012
1013         if (cleanup_mode != CLEANUP_NONE)
1014                 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1015         if (sb.len < header_len || message_is_empty(&sb, header_len)) {
1016                 rollback_index_files();
1017                 fprintf(stderr, "Aborting commit due to empty commit message.\n");
1018                 exit(1);
1019         }
1020         strbuf_addch(&sb, '\0');
1021         if (is_encoding_utf8(git_commit_encoding) && !is_utf8(sb.buf))
1022                 fprintf(stderr, commit_utf8_warn);
1023
1024         if (write_sha1_file(sb.buf, sb.len - 1, commit_type, commit_sha1)) {
1025                 rollback_index_files();
1026                 die("failed to write commit object");
1027         }
1028
1029         ref_lock = lock_any_ref_for_update("HEAD",
1030                                            initial_commit ? NULL : head_sha1,
1031                                            0);
1032
1033         nl = strchr(sb.buf + header_len, '\n');
1034         if (nl)
1035                 strbuf_setlen(&sb, nl + 1 - sb.buf);
1036         else
1037                 strbuf_addch(&sb, '\n');
1038         strbuf_remove(&sb, 0, header_len);
1039         strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1040         strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1041
1042         if (!ref_lock) {
1043                 rollback_index_files();
1044                 die("cannot lock HEAD ref");
1045         }
1046         if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1047                 rollback_index_files();
1048                 die("cannot update HEAD ref");
1049         }
1050
1051         unlink(git_path("MERGE_HEAD"));
1052         unlink(git_path("MERGE_MSG"));
1053         unlink(git_path("SQUASH_MSG"));
1054
1055         if (commit_index_files())
1056                 die ("Repository has been updated, but unable to write\n"
1057                      "new_index file. Check that disk is not full or quota is\n"
1058                      "not exceeded, and then \"git reset HEAD\" to recover.");
1059
1060         rerere();
1061         run_hook(get_index_file(), "post-commit", NULL);
1062         if (!quiet)
1063                 print_summary(prefix, commit_sha1);
1064
1065         return 0;
1066 }