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 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 = STRBUF_INIT;
  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()), 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
 339 static 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
 362 static 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
 396 static 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
 404 static const char sign_off_header[] = "Signed-off-by: ";
 405
 406 static 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
 447 static 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.\n"
 558                         "# (Comment lines starting with '#' will ");
 559                 if (cleanup_mode == CLEANUP_ALL)
 560                         fprintf(fp, "not be included)\n");
 561                 else /* CLEANUP_SPACE, that is. */
 562                         fprintf(fp, "be kept.\n"
 563                                 "# You can remove them yourself if you want to)\n");
 564                 if (only_include_assumed)
 565                         fprintf(fp, "# %s\n", only_include_assumed);
 566
 567                 author_ident = xstrdup(fmt_name(author_name, author_email));
 568                 committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
 569                                            getenv("GIT_COMMITTER_EMAIL"));
 570                 if (strcmp(author_ident, committer_ident))
 571                         fprintf(fp,
 572                                 "%s"
 573                                 "# Author:    %s\n",
 574                                 ident_shown++ ? "" : "#\n",
 575                                 author_ident);
 576                 free(author_ident);
 577
 578                 if (!user_ident_explicitly_given)
 579                         fprintf(fp,
 580                                 "%s"
 581                                 "# Committer: %s\n",
 582                                 ident_shown++ ? "" : "#\n",
 583                                 committer_ident);
 584
 585                 if (ident_shown)
 586                         fprintf(fp, "#\n");
 587
 588                 saved_color_setting = wt_status_use_color;
 589                 wt_status_use_color = 0;
 590                 commitable = run_status(fp, index_file, prefix, 1);
 591                 wt_status_use_color = saved_color_setting;
 592         } else {
 593                 struct rev_info rev;
 594                 unsigned char sha1[20];
 595                 const char *parent = "HEAD";
 596
 597                 if (!active_nr && read_cache() < 0)
 598                         die("Cannot read index");
 599
 600                 if (amend)
 601                         parent = "HEAD^1";
 602
 603                 if (get_sha1(parent, sha1))
 604                         commitable = !!active_nr;
 605                 else {
 606                         init_revisions(&rev, "");
 607                         rev.abbrev = 0;
 608                         setup_revisions(0, NULL, &rev, parent);
 609                         DIFF_OPT_SET(&rev.diffopt, QUIET);
 610                         DIFF_OPT_SET(&rev.diffopt, EXIT_WITH_STATUS);
 611                         run_diff_index(&rev, 1 /* cached */);
 612
 613                         commitable = !!DIFF_OPT_TST(&rev.diffopt, HAS_CHANGES);
 614                 }
 615         }
 616
 617         fclose(fp);
 618
 619         if (!commitable && !in_merge && !allow_empty &&
 620             !(amend && is_a_merge(head_sha1))) {
 621                 run_status(stdout, index_file, prefix, 0);
 622                 unlink(commit_editmsg);
 623                 return 0;
 624         }
 625
 626         /*
 627          * Re-read the index as pre-commit hook could have updated it,
 628          * and write it out as a tree.  We must do this before we invoke
 629          * the editor and after we invoke run_status above.
 630          */
 631         discard_cache();
 632         read_cache_from(index_file);
 633         if (!active_cache_tree)
 634                 active_cache_tree = cache_tree();
 635         if (cache_tree_update(active_cache_tree,
 636                               active_cache, active_nr, 0, 0) < 0) {
 637                 error("Error building trees");
 638                 return 0;
 639         }
 640
 641         if (run_hook(index_file, "prepare-commit-msg",
 642                      git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
 643                 return 0;
 644
 645         if (use_editor) {
 646                 char index[PATH_MAX];
 647                 const char *env[2] = { index, NULL };
 648                 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
 649                 launch_editor(git_path(commit_editmsg), NULL, env);
 650         }
 651
 652         if (!no_verify &&
 653             run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
 654                 return 0;
 655         }
 656
 657         return 1;
 658 }
 659
 660 /*
 661  * Find out if the message starting at position 'start' in the strbuf
 662  * contains only whitespace and Signed-off-by lines.
 663  */
 664 static int message_is_empty(struct strbuf *sb, int start)
 665 {
 666         struct strbuf tmpl;
 667         const char *nl;
 668         int eol, i;
 669
 670         if (cleanup_mode == CLEANUP_NONE && sb->len)
 671                 return 0;
 672
 673         /* See if the template is just a prefix of the message. */
 674         strbuf_init(&tmpl, 0);
 675         if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
 676                 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
 677                 if (start + tmpl.len <= sb->len &&
 678                     memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
 679                         start += tmpl.len;
 680         }
 681         strbuf_release(&tmpl);
 682
 683         /* Check if the rest is just whitespace and Signed-of-by's. */
 684         for (i = start; i < sb->len; i++) {
 685                 nl = memchr(sb->buf + i, '\n', sb->len - i);
 686                 if (nl)
 687                         eol = nl - sb->buf;
 688                 else
 689                         eol = sb->len;
 690
 691                 if (strlen(sign_off_header) <= eol - i &&
 692                     !prefixcmp(sb->buf + i, sign_off_header)) {
 693                         i = eol;
 694                         continue;
 695                 }
 696                 while (i < eol)
 697                         if (!isspace(sb->buf[i++]))
 698                                 return 0;
 699         }
 700
 701         return 1;
 702 }
 703
 704 static int parse_and_validate_options(int argc, const char *argv[],
 705                                       const char * const usage[])
 706 {
 707         int f = 0;
 708
 709         argc = parse_options(argc, argv, builtin_commit_options, usage, 0);
 710
 711         if (logfile || message.len || use_message)
 712                 use_editor = 0;
 713         if (edit_flag)
 714                 use_editor = 1;
 715         if (!use_editor)
 716                 setenv("GIT_EDITOR", ":", 1);
 717
 718         if (get_sha1("HEAD", head_sha1))
 719                 initial_commit = 1;
 720
 721         if (!get_sha1("MERGE_HEAD", merge_head_sha1))
 722                 in_merge = 1;
 723
 724         /* Sanity check options */
 725         if (amend && initial_commit)
 726                 die("You have nothing to amend.");
 727         if (amend && in_merge)
 728                 die("You are in the middle of a merge -- cannot amend.");
 729
 730         if (use_message)
 731                 f++;
 732         if (edit_message)
 733                 f++;
 734         if (logfile)
 735                 f++;
 736         if (f > 1)
 737                 die("Only one of -c/-C/-F can be used.");
 738         if (message.len && f > 0)
 739                 die("Option -m cannot be combined with -c/-C/-F.");
 740         if (edit_message)
 741                 use_message = edit_message;
 742         if (amend && !use_message)
 743                 use_message = "HEAD";
 744         if (use_message) {
 745                 unsigned char sha1[20];
 746                 static char utf8[] = "UTF-8";
 747                 const char *out_enc;
 748                 char *enc, *end;
 749                 struct commit *commit;
 750
 751                 if (get_sha1(use_message, sha1))
 752                         die("could not lookup commit %s", use_message);
 753                 commit = lookup_commit_reference(sha1);
 754                 if (!commit || parse_commit(commit))
 755                         die("could not parse commit %s", use_message);
 756
 757                 enc = strstr(commit->buffer, "\nencoding");
 758                 if (enc) {
 759                         end = strchr(enc + 10, '\n');
 760                         enc = xstrndup(enc + 10, end - (enc + 10));
 761                 } else {
 762                         enc = utf8;
 763                 }
 764                 out_enc = git_commit_encoding ? git_commit_encoding : utf8;
 765
 766                 if (strcmp(out_enc, enc))
 767                         use_message_buffer =
 768                                 reencode_string(commit->buffer, out_enc, enc);
 769
 770                 /*
 771                  * If we failed to reencode the buffer, just copy it
 772                  * byte for byte so the user can try to fix it up.
 773                  * This also handles the case where input and output
 774                  * encodings are identical.
 775                  */
 776                 if (use_message_buffer == NULL)
 777                         use_message_buffer = xstrdup(commit->buffer);
 778                 if (enc != utf8)
 779                         free(enc);
 780         }
 781
 782         if (!!also + !!only + !!all + !!interactive > 1)
 783                 die("Only one of --include/--only/--all/--interactive can be used.");
 784         if (argc == 0 && (also || (only && !amend)))
 785                 die("No paths with --include/--only does not make sense.");
 786         if (argc == 0 && only && amend)
 787                 only_include_assumed = "Clever... amending the last one with dirty index.";
 788         if (argc > 0 && !also && !only)
 789                 only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
 790         if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
 791                 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
 792         else if (!strcmp(cleanup_arg, "verbatim"))
 793                 cleanup_mode = CLEANUP_NONE;
 794         else if (!strcmp(cleanup_arg, "whitespace"))
 795                 cleanup_mode = CLEANUP_SPACE;
 796         else if (!strcmp(cleanup_arg, "strip"))
 797                 cleanup_mode = CLEANUP_ALL;
 798         else
 799                 die("Invalid cleanup mode %s", cleanup_arg);
 800
 801         if (!untracked_files_arg)
 802                 ; /* default already initialized */
 803         else if (!strcmp(untracked_files_arg, "no"))
 804                 show_untracked_files = SHOW_NO_UNTRACKED_FILES;
 805         else if (!strcmp(untracked_files_arg, "normal"))
 806                 show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
 807         else if (!strcmp(untracked_files_arg, "all"))
 808                 show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
 809         else
 810                 die("Invalid untracked files mode '%s'", untracked_files_arg);
 811
 812         if (all && argc > 0)
 813                 die("Paths with -a does not make sense.");
 814         else if (interactive && argc > 0)
 815                 die("Paths with --interactive does not make sense.");
 816
 817         return argc;
 818 }
 819
 820 int cmd_status(int argc, const char **argv, const char *prefix)
 821 {
 822         const char *index_file;
 823         int commitable;
 824
 825         git_config(git_status_config, NULL);
 826
 827         if (wt_status_use_color == -1)
 828                 wt_status_use_color = git_use_color_default;
 829
 830         argc = parse_and_validate_options(argc, argv, builtin_status_usage);
 831
 832         index_file = prepare_index(argc, argv, prefix);
 833
 834         commitable = run_status(stdout, index_file, prefix, 0);
 835
 836         rollback_index_files();
 837
 838         return commitable ? 0 : 1;
 839 }
 840
 841 static void print_summary(const char *prefix, const unsigned char *sha1)
 842 {
 843         struct rev_info rev;
 844         struct commit *commit;
 845
 846         commit = lookup_commit(sha1);
 847         if (!commit)
 848                 die("couldn't look up newly created commit");
 849         if (!commit || parse_commit(commit))
 850                 die("could not parse newly created commit");
 851
 852         init_revisions(&rev, prefix);
 853         setup_revisions(0, NULL, &rev, NULL);
 854
 855         rev.abbrev = 0;
 856         rev.diff = 1;
 857         rev.diffopt.output_format =
 858                 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
 859
 860         rev.verbose_header = 1;
 861         rev.show_root_diff = 1;
 862         get_commit_format("format:%h: %s", &rev);
 863         rev.always_show_header = 0;
 864         rev.diffopt.detect_rename = 1;
 865         rev.diffopt.rename_limit = 100;
 866         rev.diffopt.break_opt = 0;
 867         diff_setup_done(&rev.diffopt);
 868
 869         printf("Created %scommit ", initial_commit ? "initial " : "");
 870
 871         if (!log_tree_commit(&rev, commit)) {
 872                 struct strbuf buf = STRBUF_INIT;
 873                 format_commit_message(commit, "%h: %s", &buf);
 874                 printf("%s\n", buf.buf);
 875                 strbuf_release(&buf);
 876         }
 877 }
 878
 879 int git_commit_config(const char *k, const char *v, void *cb)
 880 {
 881         if (!strcmp(k, "commit.template"))
 882                 return git_config_string(&template_file, k, v);
 883
 884         return git_status_config(k, v, cb);
 885 }
 886
 887 static const char commit_utf8_warn[] =
 888 "Warning: commit message does not conform to UTF-8.\n"
 889 "You may want to amend it after fixing the message, or set the config\n"
 890 "variable i18n.commitencoding to the encoding your project uses.\n";
 891
 892 static void add_parent(struct strbuf *sb, const unsigned char *sha1)
 893 {
 894         struct object *obj = parse_object(sha1);
 895         const char *parent = sha1_to_hex(sha1);
 896         const char *cp;
 897
 898         if (!obj)
 899                 die("Unable to find commit parent %s", parent);
 900         if (obj->type != OBJ_COMMIT)
 901                 die("Parent %s isn't a proper commit", parent);
 902
 903         for (cp = sb->buf; cp && (cp = strstr(cp, "\nparent ")); cp += 8) {
 904                 if (!memcmp(cp + 8, parent, 40) && cp[48] == '\n') {
 905                         error("duplicate parent %s ignored", parent);
 906                         return;
 907                 }
 908         }
 909         strbuf_addf(sb, "parent %s\n", parent);
 910 }
 911
 912 int cmd_commit(int argc, const char **argv, const char *prefix)
 913 {
 914         int header_len;
 915         struct strbuf sb;
 916         const char *index_file, *reflog_msg;
 917         char *nl, *p;
 918         unsigned char commit_sha1[20];
 919         struct ref_lock *ref_lock;
 920
 921         git_config(git_commit_config, NULL);
 922
 923         argc = parse_and_validate_options(argc, argv, builtin_commit_usage);
 924
 925         index_file = prepare_index(argc, argv, prefix);
 926
 927         /* Set up everything for writing the commit object.  This includes
 928            running hooks, writing the trees, and interacting with the user.  */
 929         if (!prepare_to_commit(index_file, prefix)) {
 930                 rollback_index_files();
 931                 return 1;
 932         }
 933
 934         /*
 935          * The commit object
 936          */
 937         strbuf_init(&sb, 0);
 938         strbuf_addf(&sb, "tree %s\n",
 939                     sha1_to_hex(active_cache_tree->sha1));
 940
 941         /* Determine parents */
 942         if (initial_commit) {
 943                 reflog_msg = "commit (initial)";
 944         } else if (amend) {
 945                 struct commit_list *c;
 946                 struct commit *commit;
 947
 948                 reflog_msg = "commit (amend)";
 949                 commit = lookup_commit(head_sha1);
 950                 if (!commit || parse_commit(commit))
 951                         die("could not parse HEAD commit");
 952
 953                 for (c = commit->parents; c; c = c->next)
 954                         add_parent(&sb, c->item->object.sha1);
 955         } else if (in_merge) {
 956                 struct strbuf m;
 957                 FILE *fp;
 958
 959                 reflog_msg = "commit (merge)";
 960                 add_parent(&sb, head_sha1);
 961                 strbuf_init(&m, 0);
 962                 fp = fopen(git_path("MERGE_HEAD"), "r");
 963                 if (fp == NULL)
 964                         die("could not open %s for reading: %s",
 965                             git_path("MERGE_HEAD"), strerror(errno));
 966                 while (strbuf_getline(&m, fp, '\n') != EOF) {
 967                         unsigned char sha1[20];
 968                         if (get_sha1_hex(m.buf, sha1) < 0)
 969                                 die("Corrupt MERGE_HEAD file (%s)", m.buf);
 970                         add_parent(&sb, sha1);
 971                 }
 972                 fclose(fp);
 973                 strbuf_release(&m);
 974         } else {
 975                 reflog_msg = "commit";
 976                 strbuf_addf(&sb, "parent %s\n", sha1_to_hex(head_sha1));
 977         }
 978
 979         strbuf_addf(&sb, "author %s\n",
 980                     fmt_ident(author_name, author_email, author_date, IDENT_ERROR_ON_NO_NAME));
 981         strbuf_addf(&sb, "committer %s\n", git_committer_info(IDENT_ERROR_ON_NO_NAME));
 982         if (!is_encoding_utf8(git_commit_encoding))
 983                 strbuf_addf(&sb, "encoding %s\n", git_commit_encoding);
 984         strbuf_addch(&sb, '\n');
 985
 986         /* Finally, get the commit message */
 987         header_len = sb.len;
 988         if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
 989                 rollback_index_files();
 990                 die("could not read commit message");
 991         }
 992
 993         /* Truncate the message just before the diff, if any. */
 994         p = strstr(sb.buf, "\ndiff --git a/");
 995         if (p != NULL)
 996                 strbuf_setlen(&sb, p - sb.buf + 1);
 997
 998         if (cleanup_mode != CLEANUP_NONE)
 999                 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1000         if (sb.len < header_len || message_is_empty(&sb, header_len)) {
1001                 rollback_index_files();
1002                 die("no commit message?  aborting commit.");
1003         }
1004         strbuf_addch(&sb, '\0');
1005         if (is_encoding_utf8(git_commit_encoding) && !is_utf8(sb.buf))
1006                 fprintf(stderr, commit_utf8_warn);
1007
1008         if (write_sha1_file(sb.buf, sb.len - 1, commit_type, commit_sha1)) {
1009                 rollback_index_files();
1010                 die("failed to write commit object");
1011         }
1012
1013         ref_lock = lock_any_ref_for_update("HEAD",
1014                                            initial_commit ? NULL : head_sha1,
1015                                            0);
1016
1017         nl = strchr(sb.buf + header_len, '\n');
1018         if (nl)
1019                 strbuf_setlen(&sb, nl + 1 - sb.buf);
1020         else
1021                 strbuf_addch(&sb, '\n');
1022         strbuf_remove(&sb, 0, header_len);
1023         strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1024         strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1025
1026         if (!ref_lock) {
1027                 rollback_index_files();
1028                 die("cannot lock HEAD ref");
1029         }
1030         if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1031                 rollback_index_files();
1032                 die("cannot update HEAD ref");
1033         }
1034
1035         unlink(git_path("MERGE_HEAD"));
1036         unlink(git_path("MERGE_MSG"));
1037         unlink(git_path("SQUASH_MSG"));
1038
1039         if (commit_index_files())
1040                 die ("Repository has been updated, but unable to write\n"
1041                      "new_index file. Check that disk is not full or quota is\n"
1042                      "not exceeded, and then \"git reset HEAD\" to recover.");
1043
1044         rerere();
1045         run_hook(get_index_file(), "post-commit", NULL);
1046         if (!quiet)
1047                 print_summary(prefix, commit_sha1);
1048
1049         return 0;
1050 }