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