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