/src/git/builtin/commit.c

Source (jump to first uncovered line)
/*
 * Builtin "git commit"
 *
 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
 */

#include "builtin.h"
#include "advice.h"
#include "config.h"
#include "lockfile.h"
#include "cache-tree.h"
#include "color.h"
#include "dir.h"
#include "editor.h"
#include "environment.h"
#include "diff.h"
#include "commit.h"
#include "gettext.h"
#include "revision.h"
#include "wt-status.h"
#include "run-command.h"
#include "strbuf.h"
#include "object-name.h"
#include "parse-options.h"
#include "path.h"
#include "preload-index.h"
#include "read-cache.h"
#include "string-list.h"
#include "rerere.h"
#include "unpack-trees.h"
#include "column.h"
#include "sequencer.h"
#include "sparse-index.h"
#include "mailmap.h"
#include "help.h"
#include "commit-reach.h"
#include "commit-graph.h"
#include "pretty.h"
#include "trailer.h"

static const char * const builtin_commit_usage[] = {
  N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n"
     "           [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]\n"
     "           [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n"
     "           [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n"
     "           [--date=<date>] [--cleanup=<mode>] [--[no-]status]\n"
     "           [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]\n"
     "           [(--trailer <token>[(=|:)<value>])...] [-S[<keyid>]]\n"
     "           [--] [<pathspec>...]"),
  NULL
};

static const char * const builtin_status_usage[] = {
  N_("git status [<options>] [--] [<pathspec>...]"),
  NULL
};

static const char empty_amend_advice[] =
N_("You asked to amend the most recent commit, but doing so would make\n"
"it empty. You can repeat your command with --allow-empty, or you can\n"
"remove the commit entirely with \"git reset HEAD^\".\n");

static const char empty_cherry_pick_advice[] =
N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
"If you wish to commit it anyway, use:\n"
"\n"
"    git commit --allow-empty\n"
"\n");

static const char empty_rebase_pick_advice[] =
N_("Otherwise, please use 'git rebase --skip'\n");

static const char empty_cherry_pick_advice_single[] =
N_("Otherwise, please use 'git cherry-pick --skip'\n");

static const char empty_cherry_pick_advice_multi[] =
N_("and then use:\n"
"\n"
"    git cherry-pick --continue\n"
"\n"
"to resume cherry-picking the remaining commits.\n"
"If you wish to skip this commit, use:\n"
"\n"
"    git cherry-pick --skip\n"
"\n");

static const char *color_status_slots[] = {
  [WT_STATUS_HEADER]    = "header",
  [WT_STATUS_UPDATED]   = "updated",
  [WT_STATUS_CHANGED]   = "changed",
  [WT_STATUS_UNTRACKED]   = "untracked",
  [WT_STATUS_NOBRANCH]    = "noBranch",
  [WT_STATUS_UNMERGED]    = "unmerged",
  [WT_STATUS_LOCAL_BRANCH]  = "localBranch",
  [WT_STATUS_REMOTE_BRANCH] = "remoteBranch",
  [WT_STATUS_ONBRANCH]    = "branch",
};

static const char *use_message_buffer;
static struct lock_file index_lock; /* real index */
static struct lock_file false_lock; /* used only for partial commits */
static enum {
  COMMIT_AS_IS = 1,
  COMMIT_NORMAL,
  COMMIT_PARTIAL
} commit_style;

static const char *force_author;
static char *logfile;
static char *template_file;
/*
 * The _message variables are commit names from which to take
 * the commit message and/or authorship.
 */
static const char *author_message, *author_message_buffer;
static const char *edit_message, *use_message;
static char *fixup_message, *fixup_commit, *squash_message;
static const char *fixup_prefix;
static int all, also, interactive, patch_interactive, only, amend, signoff;
static int edit_flag = -1; /* unspecified */
static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
static int config_commit_verbose = -1; /* unspecified */
static int no_post_rewrite, allow_empty_message, pathspec_file_nul;
static const char *untracked_files_arg, *force_date, *ignore_submodule_arg, *ignored_arg;
static const char *sign_commit, *pathspec_from_file;
static struct strvec trailer_args = STRVEC_INIT;

/*
 * The default commit message cleanup mode will remove the lines
 * beginning with # (shell comments) and leading and trailing
 * whitespaces (empty lines or containing only whitespaces)
 * if editor is used, and only the whitespaces if the message
 * is specified explicitly.
 */
static enum commit_msg_cleanup_mode cleanup_mode;
static char *cleanup_arg;

static enum commit_whence whence;
static int use_editor = 1, include_status = 1;
static int have_option_m;
static struct strbuf message = STRBUF_INIT;

static enum wt_status_format status_format = STATUS_FORMAT_UNSPECIFIED;

static int opt_parse_porcelain(const struct option *opt, const char *arg, int unset)
{
  enum wt_status_format *value = (enum wt_status_format *)opt->value;
  if (unset)
    *value = STATUS_FORMAT_NONE;
  else if (!arg)
    *value = STATUS_FORMAT_PORCELAIN;
  else if (!strcmp(arg, "v1") || !strcmp(arg, "1"))
    *value = STATUS_FORMAT_PORCELAIN;
  else if (!strcmp(arg, "v2") || !strcmp(arg, "2"))
    *value = STATUS_FORMAT_PORCELAIN_V2;
  else
    die("unsupported porcelain version '%s'", arg);

  return 0;
}

static int opt_parse_m(const struct option *opt, const char *arg, int unset)
{
  struct strbuf *buf = opt->value;
  if (unset) {
    have_option_m = 0;
    strbuf_setlen(buf, 0);
  } else {
    have_option_m = 1;
    if (buf->len)
      strbuf_addch(buf, '\n');
    strbuf_addstr(buf, arg);
    strbuf_complete_line(buf);
  }
  return 0;
}

static int opt_parse_rename_score(const struct option *opt, const char *arg, int unset)
{
  const char **value = opt->value;

  BUG_ON_OPT_NEG(unset);

  if (arg != NULL && *arg == '=')
    arg = arg + 1;

  *value = arg;
  return 0;
}

static void determine_whence(struct wt_status *s)
{
  if (file_exists(git_path_merge_head(the_repository)))
    whence = FROM_MERGE;
  else if (!sequencer_determine_whence(the_repository, &whence))
    whence = FROM_COMMIT;
  if (s)
    s->whence = whence;
}

static void status_init_config(struct wt_status *s, config_fn_t fn)
{
  wt_status_prepare(the_repository, s);
  init_diff_ui_defaults();
  git_config(fn, s);
  determine_whence(s);
  s->hints = advice_enabled(ADVICE_STATUS_HINTS); /* must come after git_config() */
}

static void rollback_index_files(void)
{
  switch (commit_style) {
  case COMMIT_AS_IS:
    break; /* nothing to do */
  case COMMIT_NORMAL:
    rollback_lock_file(&index_lock);
    break;
  case COMMIT_PARTIAL:
    rollback_lock_file(&index_lock);
    rollback_lock_file(&false_lock);
    break;
  }
}

static int commit_index_files(void)
{
  int err = 0;

  switch (commit_style) {
  case COMMIT_AS_IS:
    break; /* nothing to do */
  case COMMIT_NORMAL:
    err = commit_lock_file(&index_lock);
    break;
  case COMMIT_PARTIAL:
    err = commit_lock_file(&index_lock);
    rollback_lock_file(&false_lock);
    break;
  }

  return err;
}

/*
 * Take a union of paths in the index and the named tree (typically, "HEAD"),
 * and return the paths that match the given pattern in list.
 */
static int list_paths(struct string_list *list, const char *with_tree,
          const struct pathspec *pattern)
{
  int i, ret;
  char *m;

  if (!pattern->nr)
    return 0;

  m = xcalloc(1, pattern->nr);

  if (with_tree) {
    char *max_prefix = common_prefix(pattern);
    overlay_tree_on_index(the_repository->index, with_tree, max_prefix);
    free(max_prefix);
  }

  /* TODO: audit for interaction with sparse-index. */
  ensure_full_index(the_repository->index);
  for (i = 0; i < the_repository->index->cache_nr; i++) {
    const struct cache_entry *ce = the_repository->index->cache[i];
    struct string_list_item *item;

    if (ce->ce_flags & CE_UPDATE)
      continue;
    if (!ce_path_match(the_repository->index, ce, pattern, m))
      continue;
    item = string_list_insert(list, ce->name);
    if (ce_skip_worktree(ce))
      item->util = item; /* better a valid pointer than a fake one */
  }

  ret = report_path_error(m, pattern);
  free(m);
  return ret;
}

static void add_remove_files(struct string_list *list)
{
  int i;
  for (i = 0; i < list->nr; i++) {
    struct stat st;
    struct string_list_item *p = &(list->items[i]);

    /* p->util is skip-worktree */
    if (p->util)
      continue;

    if (!lstat(p->string, &st)) {
      if (add_to_index(the_repository->index, p->string, &st, 0))
        die(_("updating files failed"));
    } else
      remove_file_from_index(the_repository->index, p->string);
  }
}

static void create_base_index(const struct commit *current_head)
{
  struct tree *tree;
  struct unpack_trees_options opts;
  struct tree_desc t;

  if (!current_head) {
    discard_index(the_repository->index);
    return;
  }

  memset(&opts, 0, sizeof(opts));
  opts.head_idx = 1;
  opts.index_only = 1;
  opts.merge = 1;
  opts.src_index = the_repository->index;
  opts.dst_index = the_repository->index;

  opts.fn = oneway_merge;
  tree = parse_tree_indirect(&current_head->object.oid);
  if (!tree)
    die(_("failed to unpack HEAD tree object"));
  if (parse_tree(tree) < 0)
    exit(128);
  init_tree_desc(&t, &tree->object.oid, tree->buffer, tree->size);
  if (unpack_trees(1, &t, &opts))
    exit(128); /* We've already reported the error, finish dying */
}

static void refresh_cache_or_die(int refresh_flags)
{
  /*
   * refresh_flags contains REFRESH_QUIET, so the only errors
   * are for unmerged entries.
   */
  if (refresh_index(the_repository->index, refresh_flags | REFRESH_IN_PORCELAIN, NULL, NULL, NULL))
    die_resolve_conflict("commit");
}

static const char *prepare_index(const char **argv, const char *prefix,
         const struct commit *current_head, int is_status)
{
  struct string_list partial = STRING_LIST_INIT_DUP;
  struct pathspec pathspec;
  int refresh_flags = REFRESH_QUIET;
  const char *ret;

  if (is_status)
    refresh_flags |= REFRESH_UNMERGED;
  parse_pathspec(&pathspec, 0,
           PATHSPEC_PREFER_FULL,
           prefix, argv);

  if (pathspec_from_file) {
    if (interactive)
      die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--interactive/--patch");

    if (all)
      die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "-a");

    if (pathspec.nr)
      die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");

    parse_pathspec_file(&pathspec, 0,
            PATHSPEC_PREFER_FULL,
            prefix, pathspec_from_file, pathspec_file_nul);
  } else if (pathspec_file_nul) {
    die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
  }

  if (!pathspec.nr && (also || (only && !allow_empty &&
      (!amend || (fixup_message && strcmp(fixup_prefix, "amend"))))))
    die(_("No paths with --include/--only does not make sense."));

  if (repo_read_index_preload(the_repository, &pathspec, 0) < 0)
    die(_("index file corrupt"));

  if (interactive) {
    char *old_index_env = NULL, *old_repo_index_file;
    repo_hold_locked_index(the_repository, &index_lock,
               LOCK_DIE_ON_ERROR);

    refresh_cache_or_die(refresh_flags);

    if (write_locked_index(the_repository->index, &index_lock, 0))
      die(_("unable to create temporary index"));

    old_repo_index_file = the_repository->index_file;
    the_repository->index_file =
      (char *)get_lock_file_path(&index_lock);
    old_index_env = xstrdup_or_null(getenv(INDEX_ENVIRONMENT));
    setenv(INDEX_ENVIRONMENT, the_repository->index_file, 1);

    if (interactive_add(argv, prefix, patch_interactive) != 0)
      die(_("interactive add failed"));

    the_repository->index_file = old_repo_index_file;
    if (old_index_env && *old_index_env)
      setenv(INDEX_ENVIRONMENT, old_index_env, 1);
    else
      unsetenv(INDEX_ENVIRONMENT);
    FREE_AND_NULL(old_index_env);

    discard_index(the_repository->index);
    read_index_from(the_repository->index, get_lock_file_path(&index_lock),
        get_git_dir());
    if (cache_tree_update(the_repository->index, WRITE_TREE_SILENT) == 0) {
      if (reopen_lock_file(&index_lock) < 0)
        die(_("unable to write index file"));
      if (write_locked_index(the_repository->index, &index_lock, 0))
        die(_("unable to update temporary index"));
    } else
      warning(_("Failed to update main cache tree"));

    commit_style = COMMIT_NORMAL;
    ret = get_lock_file_path(&index_lock);
    goto out;
  }

  /*
   * Non partial, non as-is commit.
   *
   * (1) get the real index;
   * (2) update the_index as necessary;
   * (3) write the_index out to the real index (still locked);
   * (4) return the name of the locked index file.
   *
   * The caller should run hooks on the locked real index, and
   * (A) if all goes well, commit the real index;
   * (B) on failure, rollback the real index.
   */
  if (all || (also && pathspec.nr)) {
    char *ps_matched = xcalloc(pathspec.nr, 1);
    repo_hold_locked_index(the_repository, &index_lock,
               LOCK_DIE_ON_ERROR);
    add_files_to_cache(the_repository, also ? prefix : NULL,
           &pathspec, ps_matched, 0, 0);
    if (!all && report_path_error(ps_matched, &pathspec))
      exit(128);

    refresh_cache_or_die(refresh_flags);
    cache_tree_update(the_repository->index, WRITE_TREE_SILENT);
    if (write_locked_index(the_repository->index, &index_lock, 0))
      die(_("unable to write new index file"));
    commit_style = COMMIT_NORMAL;
    ret = get_lock_file_path(&index_lock);
    free(ps_matched);
    goto out;
  }

  /*
   * As-is commit.
   *
   * (1) return the name of the real index file.
   *
   * The caller should run hooks on the real index,
   * and create commit from the_index.
   * We still need to refresh the index here.
   */
  if (!only && !pathspec.nr) {
    repo_hold_locked_index(the_repository, &index_lock,
               LOCK_DIE_ON_ERROR);
    refresh_cache_or_die(refresh_flags);
    if (the_repository->index->cache_changed
        || !cache_tree_fully_valid(the_repository->index->cache_tree))
      cache_tree_update(the_repository->index, WRITE_TREE_SILENT);
    if (write_locked_index(the_repository->index, &index_lock,
               COMMIT_LOCK | SKIP_IF_UNCHANGED))
      die(_("unable to write new index file"));
    commit_style = COMMIT_AS_IS;
    ret = get_index_file();
    goto out;
  }

  /*
   * A partial commit.
   *
   * (0) find the set of affected paths;
   * (1) get lock on the real index file;
   * (2) update the_index with the given paths;
   * (3) write the_index out to the real index (still locked);
   * (4) get lock on the false index file;
   * (5) reset the_index from HEAD;
   * (6) update the_index the same way as (2);
   * (7) write the_index out to the false index file;
   * (8) return the name of the false index file (still locked);
   *
   * The caller should run hooks on the locked false index, and
   * create commit from it.  Then
   * (A) if all goes well, commit the real index;
   * (B) on failure, rollback the real index;
   * In either case, rollback the false index.
   */
  commit_style = COMMIT_PARTIAL;

  if (whence != FROM_COMMIT) {
    if (whence == FROM_MERGE)
      die(_("cannot do a partial commit during a merge."));
    else if (is_from_cherry_pick(whence))
      die(_("cannot do a partial commit during a cherry-pick."));
    else if (is_from_rebase(whence))
      die(_("cannot do a partial commit during a rebase."));
  }

  if (list_paths(&partial, !current_head ? NULL : "HEAD", &pathspec))
    exit(1);

  discard_index(the_repository->index);
  if (repo_read_index(the_repository) < 0)
    die(_("cannot read the index"));

  repo_hold_locked_index(the_repository, &index_lock, LOCK_DIE_ON_ERROR);
  add_remove_files(&partial);
  refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL, NULL);
  cache_tree_update(the_repository->index, WRITE_TREE_SILENT);
  if (write_locked_index(the_repository->index, &index_lock, 0))
    die(_("unable to write new index file"));

  hold_lock_file_for_update(&false_lock,
          git_path("next-index-%"PRIuMAX,
             (uintmax_t) getpid()),
          LOCK_DIE_ON_ERROR);

  create_base_index(current_head);
  add_remove_files(&partial);
  refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL, NULL);

  if (write_locked_index(the_repository->index, &false_lock, 0))
    die(_("unable to write temporary index file"));

  discard_index(the_repository->index);
  ret = get_lock_file_path(&false_lock);
  read_index_from(the_repository->index, ret, get_git_dir());
out:
  string_list_clear(&partial, 0);
  clear_pathspec(&pathspec);
  return ret;
}

static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
          struct wt_status *s)
{
  struct object_id oid;

  if (s->relative_paths)
    s->prefix = prefix;

  if (amend) {
    s->amend = 1;
    s->reference = "HEAD^1";
  }
  s->verbose = verbose;
  s->index_file = index_file;
  s->fp = fp;
  s->nowarn = nowarn;
  s->is_initial = repo_get_oid(the_repository, s->reference, &oid) ? 1 : 0;
  if (!s->is_initial)
    oidcpy(&s->oid_commit, &oid);
  s->status_format = status_format;
  s->ignore_submodule_arg = ignore_submodule_arg;

  wt_status_collect(s);
  wt_status_print(s);
  wt_status_collect_free_buffers(s);

  return s->committable;
}

static int is_a_merge(const struct commit *current_head)
{
  return !!(current_head->parents && current_head->parents->next);
}

static void assert_split_ident(struct ident_split *id, const struct strbuf *buf)
{
  if (split_ident_line(id, buf->buf, buf->len) || !id->date_begin)
    BUG("unable to parse our own ident: %s", buf->buf);
}

static void export_one(const char *var, const char *s, const char *e, int hack)
{
  struct strbuf buf = STRBUF_INIT;
  if (hack)
    strbuf_addch(&buf, hack);
  strbuf_add(&buf, s, e - s);
  setenv(var, buf.buf, 1);
  strbuf_release(&buf);
}

static int parse_force_date(const char *in, struct strbuf *out)
{
  strbuf_addch(out, '@');

  if (parse_date(in, out) < 0) {
    int errors = 0;
    unsigned long t = approxidate_careful(in, &errors);
    if (errors)
      return -1;
    strbuf_addf(out, "%lu", t);
  }

  return 0;
}

static void set_ident_var(char **buf, char *val)
{
  free(*buf);
  *buf = val;
}

static void determine_author_info(struct strbuf *author_ident)
{
  char *name, *email, *date;
  struct ident_split author;

  name = xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
  email = xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
  date = xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));

  if (author_message) {
    struct ident_split ident;
    size_t len;
    const char *a;

    a = find_commit_header(author_message_buffer, "author", &len);
    if (!a)
      die(_("commit '%s' lacks author header"), author_message);
    if (split_ident_line(&ident, a, len) < 0)
      die(_("commit '%s' has malformed author line"), author_message);

    set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
    set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));

    if (ident.date_begin) {
      struct strbuf date_buf = STRBUF_INIT;
      strbuf_addch(&date_buf, '@');
      strbuf_add(&date_buf, ident.date_begin, ident.date_end - ident.date_begin);
      strbuf_addch(&date_buf, ' ');
      strbuf_add(&date_buf, ident.tz_begin, ident.tz_end - ident.tz_begin);
      set_ident_var(&date, strbuf_detach(&date_buf, NULL));
    }
  }

  if (force_author) {
    struct ident_split ident;

    if (split_ident_line(&ident, force_author, strlen(force_author)) < 0)
      die(_("malformed --author parameter"));
    set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
    set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
  }

  if (force_date) {
    struct strbuf date_buf = STRBUF_INIT;
    if (parse_force_date(force_date, &date_buf))
      die(_("invalid date format: %s"), force_date);
    set_ident_var(&date, strbuf_detach(&date_buf, NULL));
  }

  strbuf_addstr(author_ident, fmt_ident(name, email, WANT_AUTHOR_IDENT, date,
        IDENT_STRICT));
  assert_split_ident(&author, author_ident);
  export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
  export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
  export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
  free(name);
  free(email);
  free(date);
}

static int author_date_is_interesting(void)
{
  return author_message || force_date;
}

static void adjust_comment_line_char(const struct strbuf *sb)
{
  char candidates[] = "#;@!$%^&|:";
  char *candidate;
  const char *p;

  if (!memchr(sb->buf, candidates[0], sb->len)) {
    free(comment_line_str_to_free);
    comment_line_str = comment_line_str_to_free =
      xstrfmt("%c", candidates[0]);
    return;
  }

  p = sb->buf;
  candidate = strchr(candidates, *p);
  if (candidate)
    *candidate = ' ';
  for (p = sb->buf; *p; p++) {
    if ((p[0] == '\n' || p[0] == '\r') && p[1]) {
      candidate = strchr(candidates, p[1]);
      if (candidate)
        *candidate = ' ';
    }
  }

  for (p = candidates; *p == ' '; p++)
    ;
  if (!*p)
    die(_("unable to select a comment character that is not used\n"
          "in the current commit message"));
  free(comment_line_str_to_free);
  comment_line_str = comment_line_str_to_free = xstrfmt("%c", *p);
}

static void prepare_amend_commit(struct commit *commit, struct strbuf *sb,
        struct pretty_print_context *ctx)
{
  const char *buffer, *subject, *fmt;

  buffer = repo_get_commit_buffer(the_repository, commit, NULL);
  find_commit_subject(buffer, &subject);
  /*
   * If we amend the 'amend!' commit then we don't want to
   * duplicate the subject line.
   */
  fmt = starts_with(subject, "amend!") ? "%b" : "%B";
  repo_format_commit_message(the_repository, commit, fmt, sb, ctx);
  repo_unuse_commit_buffer(the_repository, commit, buffer);
}

static int prepare_to_commit(const char *index_file, const char *prefix,
           struct commit *current_head,
           struct wt_status *s,
           struct strbuf *author_ident)
{
  struct stat statbuf;
  struct strbuf committer_ident = STRBUF_INIT;
  int committable;
  struct strbuf sb = STRBUF_INIT;
  const char *hook_arg1 = NULL;
  const char *hook_arg2 = NULL;
  int clean_message_contents = (cleanup_mode != COMMIT_MSG_CLEANUP_NONE);
  int old_display_comment_prefix;
  int invoked_hook;

  /* This checks and barfs if author is badly specified */
  determine_author_info(author_ident);

  if (!no_verify && run_commit_hook(use_editor, index_file, &invoked_hook,
            "pre-commit", NULL))
    return 0;

  if (squash_message) {
    /*
     * Insert the proper subject line before other commit
     * message options add their content.
     */
    if (use_message && !strcmp(use_message, squash_message))
      strbuf_addstr(&sb, "squash! ");
    else {
      struct pretty_print_context ctx = {0};
      struct commit *c;
      c = lookup_commit_reference_by_name(squash_message);
      if (!c)
        die(_("could not lookup commit '%s'"), squash_message);
      ctx.output_encoding = get_commit_output_encoding();
      repo_format_commit_message(the_repository, c,
               "squash! %s\n\n", &sb,
               &ctx);
    }
  }

  if (have_option_m && !fixup_message) {
    strbuf_addbuf(&sb, &message);
    hook_arg1 = "message";
  } else if (logfile && !strcmp(logfile, "-")) {
    if (isatty(0))
      fprintf(stderr, _("(reading log message from standard input)\n"));
    if (strbuf_read(&sb, 0, 0) < 0)
      die_errno(_("could not read log from standard input"));
    hook_arg1 = "message";
  } else if (logfile) {
    if (strbuf_read_file(&sb, logfile, 0) < 0)
      die_errno(_("could not read log file '%s'"),
          logfile);
    hook_arg1 = "message";
  } else if (use_message) {
    char *buffer;
    buffer = strstr(use_message_buffer, "\n\n");
    if (buffer)
      strbuf_addstr(&sb, skip_blank_lines(buffer + 2));
    hook_arg1 = "commit";
    hook_arg2 = use_message;
  } else if (fixup_message) {
    struct pretty_print_context ctx = {0};
    struct commit *commit;
    char *fmt;
    commit = lookup_commit_reference_by_name(fixup_commit);
    if (!commit)
      die(_("could not lookup commit '%s'"), fixup_commit);
    ctx.output_encoding = get_commit_output_encoding();
    fmt = xstrfmt("%s! %%s\n\n", fixup_prefix);
    repo_format_commit_message(the_repository, commit, fmt, &sb,
             &ctx);
    free(fmt);
    hook_arg1 = "message";

    /*
     * Only `-m` commit message option is checked here, as
     * it supports `--fixup` to append the commit message.
     *
     * The other commit message options `-c`/`-C`/`-F` are
     * incompatible with all the forms of `--fixup` and
     * have already errored out while parsing the `git commit`
     * options.
     */
    if (have_option_m && !strcmp(fixup_prefix, "fixup"))
      strbuf_addbuf(&sb, &message);

    if (!strcmp(fixup_prefix, "amend")) {
      if (have_option_m)
        die(_("options '%s' and '%s:%s' cannot be used together"), "-m", "--fixup", fixup_message);
      prepare_amend_commit(commit, &sb, &ctx);
    }
  } else if (!stat(git_path_merge_msg(the_repository), &statbuf)) {
    size_t merge_msg_start;

    /*
     * prepend SQUASH_MSG here if it exists and a
     * "merge --squash" was originally performed
     */
    if (!stat(git_path_squash_msg(the_repository), &statbuf)) {
      if (strbuf_read_file(&sb, git_path_squash_msg(the_repository), 0) < 0)
        die_errno(_("could not read SQUASH_MSG"));
      hook_arg1 = "squash";
    } else
      hook_arg1 = "merge";

    merge_msg_start = sb.len;
    if (strbuf_read_file(&sb, git_path_merge_msg(the_repository), 0) < 0)
      die_errno(_("could not read MERGE_MSG"));

    if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS &&
        wt_status_locate_end(sb.buf + merge_msg_start,
           sb.len - merge_msg_start) <
        sb.len - merge_msg_start)
      s->added_cut_line = 1;
  } else if (!stat(git_path_squash_msg(the_repository), &statbuf)) {
    if (strbuf_read_file(&sb, git_path_squash_msg(the_repository), 0) < 0)
      die_errno(_("could not read SQUASH_MSG"));
    hook_arg1 = "squash";
  } else if (template_file) {
    if (strbuf_read_file(&sb, template_file, 0) < 0)
      die_errno(_("could not read '%s'"), template_file);
    hook_arg1 = "template";
    clean_message_contents = 0;
  }

  /*
   * The remaining cases don't modify the template message, but
   * just set the argument(s) to the prepare-commit-msg hook.
   */
  else if (whence == FROM_MERGE)
    hook_arg1 = "merge";
  else if (is_from_cherry_pick(whence) || whence == FROM_REBASE_PICK) {
    hook_arg1 = "commit";
    hook_arg2 = "CHERRY_PICK_HEAD";
  }

  if (squash_message) {
    /*
     * If squash_commit was used for the commit subject,
     * then we're possibly hijacking other commit log options.
     * Reset the hook args to tell the real story.
     */
    hook_arg1 = "message";
    hook_arg2 = "";
  }

  s->fp = fopen_for_writing(git_path_commit_editmsg());
  if (!s->fp)
    die_errno(_("could not open '%s'"), git_path_commit_editmsg());

  /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
  old_display_comment_prefix = s->display_comment_prefix;
  s->display_comment_prefix = 1;

  /*
   * Most hints are counter-productive when the commit has
   * already started.
   */
  s->hints = 0;

  if (clean_message_contents)
    strbuf_stripspace(&sb, NULL);

  if (signoff)
    append_signoff(&sb, ignored_log_message_bytes(sb.buf, sb.len), 0);

  if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
    die_errno(_("could not write commit template"));

  if (auto_comment_line_char)
    adjust_comment_line_char(&sb);
  strbuf_release(&sb);

  /* This checks if committer ident is explicitly given */
  strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
  if (use_editor && include_status) {
    int ident_shown = 0;
    int saved_color_setting;
    struct ident_split ci, ai;
    const char *hint_cleanup_all = allow_empty_message ?
      _("Please enter the commit message for your changes."
        " Lines starting\nwith '%s' will be ignored.\n") :
      _("Please enter the commit message for your changes."
        " Lines starting\nwith '%s' will be ignored, and an empty"
        " message aborts the commit.\n");
    const char *hint_cleanup_space = allow_empty_message ?
      _("Please enter the commit message for your changes."
        " Lines starting\n"
        "with '%s' will be kept; you may remove them"
        " yourself if you want to.\n") :
      _("Please enter the commit message for your changes."
        " Lines starting\n"
        "with '%s' will be kept; you may remove them"
        " yourself if you want to.\n"
        "An empty message aborts the commit.\n");
    if (whence != FROM_COMMIT) {
      if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS)
        wt_status_add_cut_line(s);
      status_printf_ln(
        s, GIT_COLOR_NORMAL,
        whence == FROM_MERGE ?
                _("\n"
            "It looks like you may be committing a merge.\n"
            "If this is not correct, please run\n"
            " git update-ref -d MERGE_HEAD\n"
            "and try again.\n") :
                _("\n"
            "It looks like you may be committing a cherry-pick.\n"
            "If this is not correct, please run\n"
            " git update-ref -d CHERRY_PICK_HEAD\n"
            "and try again.\n"));
    }

    fprintf(s->fp, "\n");
    if (cleanup_mode == COMMIT_MSG_CLEANUP_ALL)
      status_printf(s, GIT_COLOR_NORMAL, hint_cleanup_all, comment_line_str);
    else if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS) {
      if (whence == FROM_COMMIT)
        wt_status_add_cut_line(s);
    } else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
      status_printf(s, GIT_COLOR_NORMAL, hint_cleanup_space, comment_line_str);

    /*
     * These should never fail because they come from our own
     * fmt_ident. They may fail the sane_ident test, but we know
     * that the name and mail pointers will at least be valid,
     * which is enough for our tests and printing here.
     */
    assert_split_ident(&ai, author_ident);
    assert_split_ident(&ci, &committer_ident);

    if (ident_cmp(&ai, &ci))
      status_printf_ln(s, GIT_COLOR_NORMAL,
        _("%s"
        "Author:    %.*s <%.*s>"),
        ident_shown++ ? "" : "\n",
        (int)(ai.name_end - ai.name_begin), ai.name_begin,
        (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);

    if (author_date_is_interesting())
      status_printf_ln(s, GIT_COLOR_NORMAL,
        _("%s"
        "Date:      %s"),
        ident_shown++ ? "" : "\n",
        show_ident_date(&ai, DATE_MODE(NORMAL)));

    if (!committer_ident_sufficiently_given())
      status_printf_ln(s, GIT_COLOR_NORMAL,
        _("%s"
        "Committer: %.*s <%.*s>"),
        ident_shown++ ? "" : "\n",
        (int)(ci.name_end - ci.name_begin), ci.name_begin,
        (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);

    status_printf_ln(s, GIT_COLOR_NORMAL, "%s", ""); /* Add new line for clarity */

    saved_color_setting = s->use_color;
    s->use_color = 0;
    committable = run_status(s->fp, index_file, prefix, 1, s);
    s->use_color = saved_color_setting;
    string_list_clear(&s->change, 1);
  } else {
    struct object_id oid;
    const char *parent = "HEAD";

    if (!the_repository->index->initialized && repo_read_index(the_repository) < 0)
      die(_("Cannot read index"));

    if (amend)
      parent = "HEAD^1";

    if (repo_get_oid(the_repository, parent, &oid)) {
      int i, ita_nr = 0;

      /* TODO: audit for interaction with sparse-index. */
      ensure_full_index(the_repository->index);
      for (i = 0; i < the_repository->index->cache_nr; i++)
        if (ce_intent_to_add(the_repository->index->cache[i]))
          ita_nr++;
      committable = the_repository->index->cache_nr - ita_nr > 0;
    } else {
      /*
       * Unless the user did explicitly request a submodule
       * ignore mode by passing a command line option we do
       * not ignore any changed submodule SHA-1s when
       * comparing index and parent, no matter what is
       * configured. Otherwise we won't commit any
       * submodules which were manually staged, which would
       * be really confusing.
       */
      struct diff_flags flags = DIFF_FLAGS_INIT;
      flags.override_submodule_config = 1;
      if (ignore_submodule_arg &&
          !strcmp(ignore_submodule_arg, "all"))
        flags.ignore_submodules = 1;
      committable = index_differs_from(the_repository,
               parent, &flags, 1);
    }
  }
  strbuf_release(&committer_ident);

  fclose(s->fp);

  if (trailer_args.nr) {
    if (amend_file_with_trailers(git_path_commit_editmsg(), &trailer_args))
      die(_("unable to pass trailers to --trailers"));
    strvec_clear(&trailer_args);
  }

  /*
   * Reject an attempt to record a non-merge empty commit without
   * explicit --allow-empty. In the cherry-pick case, it may be
   * empty due to conflict resolution, which the user should okay.
   */
  if (!committable && whence != FROM_MERGE && !allow_empty &&
      !(amend && is_a_merge(current_head))) {
    s->hints = advice_enabled(ADVICE_STATUS_HINTS);
    s->display_comment_prefix = old_display_comment_prefix;
    run_status(stdout, index_file, prefix, 0, s);
    if (amend)
      fputs(_(empty_amend_advice), stderr);
    else if (is_from_cherry_pick(whence) ||
       whence == FROM_REBASE_PICK) {
      fputs(_(empty_cherry_pick_advice), stderr);
      if (whence == FROM_CHERRY_PICK_SINGLE)
        fputs(_(empty_cherry_pick_advice_single), stderr);
      else if (whence == FROM_CHERRY_PICK_MULTI)
        fputs(_(empty_cherry_pick_advice_multi), stderr);
      else
        fputs(_(empty_rebase_pick_advice), stderr);
    }
    return 0;
  }

  if (!no_verify && invoked_hook) {
    /*
     * Re-read the index as the pre-commit-commit hook was invoked
     * and could have updated it. We must do this before we invoke
     * the editor and after we invoke run_status above.
     */
    discard_index(the_repository->index);
  }
  read_index_from(the_repository->index, index_file, get_git_dir());

  if (cache_tree_update(the_repository->index, 0)) {
    error(_("Error building trees"));
    return 0;
  }

  if (run_commit_hook(use_editor, index_file, NULL, "prepare-commit-msg",
          git_path_commit_editmsg(), hook_arg1, hook_arg2, NULL))
    return 0;

  if (use_editor) {
    struct strvec env = STRVEC_INIT;

    strvec_pushf(&env, "GIT_INDEX_FILE=%s", index_file);
    if (launch_editor(git_path_commit_editmsg(), NULL, env.v)) {
      fprintf(stderr,
      _("Please supply the message using either -m or -F option.\n"));
      exit(1);
    }
    strvec_clear(&env);
  }

  if (!no_verify &&
      run_commit_hook(use_editor, index_file, NULL, "commit-msg",
          git_path_commit_editmsg(), NULL)) {
    return 0;
  }

  return 1;
}

static const char *find_author_by_nickname(const char *name)
{
  struct rev_info revs;
  struct commit *commit;
  struct strbuf buf = STRBUF_INIT;
  const char *av[20];
  int ac = 0;

  repo_init_revisions(the_repository, &revs, NULL);
  strbuf_addf(&buf, "--author=%s", name);
  av[++ac] = "--all";
  av[++ac] = "-i";
  av[++ac] = buf.buf;
  av[++ac] = NULL;
  setup_revisions(ac, av, &revs, NULL);
  revs.mailmap = xmalloc(sizeof(struct string_list));
  string_list_init_nodup(revs.mailmap);
  read_mailmap(revs.mailmap);

  if (prepare_revision_walk(&revs))
    die(_("revision walk setup failed"));
  commit = get_revision(&revs);
  if (commit) {
    struct pretty_print_context ctx = {0};
    ctx.date_mode.type = DATE_NORMAL;
    strbuf_release(&buf);
    repo_format_commit_message(the_repository, commit,
             "%aN <%aE>", &buf, &ctx);
    release_revisions(&revs);
    return strbuf_detach(&buf, NULL);
  }
  die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name);
}

static void handle_ignored_arg(struct wt_status *s)
{
  if (!ignored_arg)
    ; /* default already initialized */
  else if (!strcmp(ignored_arg, "traditional"))
    s->show_ignored_mode = SHOW_TRADITIONAL_IGNORED;
  else if (!strcmp(ignored_arg, "no"))
    s->show_ignored_mode = SHOW_NO_IGNORED;
  else if (!strcmp(ignored_arg, "matching"))
    s->show_ignored_mode = SHOW_MATCHING_IGNORED;
  else
    die(_("Invalid ignored mode '%s'"), ignored_arg);
}

static enum untracked_status_type parse_untracked_setting_name(const char *u)
{
  /*
   * Please update $__git_untracked_file_modes in
   * git-completion.bash when you add new options
   */
  switch (git_parse_maybe_bool(u)) {
  case 0:
    u = "no";
    break;
  case 1:
    u = "normal";
    break;
  default:
    break;
  }

  if (!strcmp(u, "no"))
    return SHOW_NO_UNTRACKED_FILES;
  else if (!strcmp(u, "normal"))
    return SHOW_NORMAL_UNTRACKED_FILES;
  else if (!strcmp(u, "all"))
    return SHOW_ALL_UNTRACKED_FILES;
  else
    return SHOW_UNTRACKED_FILES_ERROR;
}

static void handle_untracked_files_arg(struct wt_status *s)
{
  enum untracked_status_type u;

  if (!untracked_files_arg)
    return; /* default already initialized */

  u = parse_untracked_setting_name(untracked_files_arg);
  if (u == SHOW_UNTRACKED_FILES_ERROR)
    die(_("Invalid untracked files mode '%s'"),
        untracked_files_arg);
  s->show_untracked_files = u;
}

static const char *read_commit_message(const char *name)
{
  const char *out_enc;
  struct commit *commit;

  commit = lookup_commit_reference_by_name(name);
  if (!commit)
    die(_("could not lookup commit '%s'"), name);
  out_enc = get_commit_output_encoding();
  return repo_logmsg_reencode(the_repository, commit, NULL, out_enc);
}

/*
 * Enumerate what needs to be propagated when --porcelain
 * is not in effect here.
 */
static struct status_deferred_config {
  enum wt_status_format status_format;
  int show_branch;
  enum ahead_behind_flags ahead_behind;
} status_deferred_config = {
  STATUS_FORMAT_UNSPECIFIED,
  -1, /* unspecified */
  AHEAD_BEHIND_UNSPECIFIED,
};

static void finalize_deferred_config(struct wt_status *s)
{
  int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
           status_format != STATUS_FORMAT_PORCELAIN_V2 &&
           !s->null_termination);

  if (s->null_termination) {
    if (status_format == STATUS_FORMAT_NONE ||
        status_format == STATUS_FORMAT_UNSPECIFIED)
      status_format = STATUS_FORMAT_PORCELAIN;
    else if (status_format == STATUS_FORMAT_LONG)
      die(_("options '%s' and '%s' cannot be used together"), "--long", "-z");
  }

  if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
    status_format = status_deferred_config.status_format;
  if (status_format == STATUS_FORMAT_UNSPECIFIED)
    status_format = STATUS_FORMAT_NONE;

  if (use_deferred_config && s->show_branch < 0)
    s->show_branch = status_deferred_config.show_branch;
  if (s->show_branch < 0)
    s->show_branch = 0;

  /*
   * If the user did not give a "--[no]-ahead-behind" command
   * line argument *AND* we will print in a human-readable format
   * (short, long etc.) then we inherit from the status.aheadbehind
   * config setting.  In all other cases (and porcelain V[12] formats
   * in particular), we inherit _FULL for backwards compatibility.
   */
  if (use_deferred_config &&
      s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
    s->ahead_behind_flags = status_deferred_config.ahead_behind;

  if (s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
    s->ahead_behind_flags = AHEAD_BEHIND_FULL;
}

static void check_fixup_reword_options(int argc, const char *argv[]) {
  if (whence != FROM_COMMIT) {
    if (whence == FROM_MERGE)
      die(_("You are in the middle of a merge -- cannot reword."));
    else if (is_from_cherry_pick(whence))
      die(_("You are in the middle of a cherry-pick -- cannot reword."));
  }
  if (argc)
    die(_("reword option of '%s' and path '%s' cannot be used together"), "--fixup", *argv);
  if (patch_interactive || interactive || all || also || only)
    die(_("reword option of '%s' and '%s' cannot be used together"),
      "--fixup", "--patch/--interactive/--all/--include/--only");
}

static int parse_and_validate_options(int argc, const char *argv[],
              const struct option *options,
              const char * const usage[],
              const char *prefix,
              struct commit *current_head,
              struct wt_status *s)
{
  argc = parse_options(argc, argv, prefix, options, usage, 0);
  finalize_deferred_config(s);

  if (force_author && !strchr(force_author, '>'))
    force_author = find_author_by_nickname(force_author);

  if (force_author && renew_authorship)
    die(_("options '%s' and '%s' cannot be used together"), "--reset-author", "--author");

  if (logfile || have_option_m || use_message)
    use_editor = 0;

  /* Sanity check options */
  if (amend && !current_head)
    die(_("You have nothing to amend."));
  if (amend && whence != FROM_COMMIT) {
    if (whence == FROM_MERGE)
      die(_("You are in the middle of a merge -- cannot amend."));
    else if (is_from_cherry_pick(whence))
      die(_("You are in the middle of a cherry-pick -- cannot amend."));
    else if (whence == FROM_REBASE_PICK)
      die(_("You are in the middle of a rebase -- cannot amend."));
  }
  if (fixup_message && squash_message)
    die(_("options '%s' and '%s' cannot be used together"), "--squash", "--fixup");
  die_for_incompatible_opt4(!!use_message, "-C",
          !!edit_message, "-c",
          !!logfile, "-F",
          !!fixup_message, "--fixup");
  die_for_incompatible_opt4(have_option_m, "-m",
          !!edit_message, "-c",
          !!use_message, "-C",
          !!logfile, "-F");
  if (use_message || edit_message || logfile ||fixup_message || have_option_m)
    FREE_AND_NULL(template_file);
  if (edit_message)
    use_message = edit_message;
  if (amend && !use_message && !fixup_message)
    use_message = "HEAD";
  if (!use_message && !is_from_cherry_pick(whence) &&
      !is_from_rebase(whence) && renew_authorship)
    die(_("--reset-author can be used only with -C, -c or --amend."));
  if (use_message) {
    use_message_buffer = read_commit_message(use_message);
    if (!renew_authorship) {
      author_message = use_message;
      author_message_buffer = use_message_buffer;
    }
  }
  if ((is_from_cherry_pick(whence) || whence == FROM_REBASE_PICK) &&
      !renew_authorship) {
    author_message = "CHERRY_PICK_HEAD";
    author_message_buffer = read_commit_message(author_message);
  }

  if (patch_interactive)
    interactive = 1;

  die_for_incompatible_opt4(also, "-i/--include",
          only, "-o/--only",
          all, "-a/--all",
          interactive, "--interactive/-p/--patch");
  if (fixup_message) {
    /*
     * We limit --fixup's suboptions to only alpha characters.
     * If the first character after a run of alpha is colon,
     * then the part before the colon may be a known suboption
     * name like `amend` or `reword`, or a misspelt suboption
     * name. In either case, we treat it as
     * --fixup=<suboption>:<arg>.
     *
     * Otherwise, we are dealing with --fixup=<commit>.
     */
    char *p = fixup_message;
    while (isalpha(*p))
      p++;
    if (p > fixup_message && *p == ':') {
      *p = '\0';
      fixup_commit = p + 1;
      if (!strcmp("amend", fixup_message) ||
          !strcmp("reword", fixup_message)) {
        fixup_prefix = "amend";
        allow_empty = 1;
        if (*fixup_message == 'r') {
          check_fixup_reword_options(argc, argv);
          only = 1;
        }
      } else {
        die(_("unknown option: --fixup=%s:%s"), fixup_message, fixup_commit);
      }
    } else {
      fixup_commit = fixup_message;
      fixup_prefix = "fixup";
      use_editor = 0;
    }
  }

  if (0 <= edit_flag)
    use_editor = edit_flag;

  cleanup_mode = get_cleanup_mode(cleanup_arg, use_editor);

  handle_untracked_files_arg(s);

  if (all && argc > 0)
    die(_("paths '%s ...' with -a does not make sense"),
        argv[0]);

  if (status_format != STATUS_FORMAT_NONE)
    dry_run = 1;

  return argc;
}

static int dry_run_commit(const char **argv, const char *prefix,
        const struct commit *current_head, struct wt_status *s)
{
  int committable;
  const char *index_file;

  index_file = prepare_index(argv, prefix, current_head, 1);
  committable = run_status(stdout, index_file, prefix, 0, s);
  rollback_index_files();

  return committable ? 0 : 1;
}

define_list_config_array_extra(color_status_slots, {"added"});

static int parse_status_slot(const char *slot)
{
  if (!strcasecmp(slot, "added"))
    return WT_STATUS_UPDATED;

  return LOOKUP_CONFIG(color_status_slots, slot);
}

static int git_status_config(const char *k, const char *v,
           const struct config_context *ctx, void *cb)
{
  struct wt_status *s = cb;
  const char *slot_name;

  if (starts_with(k, "column."))
    return git_column_config(k, v, "status", &s->colopts);
  if (!strcmp(k, "status.submodulesummary")) {
    int is_bool;
    s->submodule_summary = git_config_bool_or_int(k, v, ctx->kvi,
                    &is_bool);
    if (is_bool && s->submodule_summary)
      s->submodule_summary = -1;
    return 0;
  }
  if (!strcmp(k, "status.short")) {
    if (git_config_bool(k, v))
      status_deferred_config.status_format = STATUS_FORMAT_SHORT;
    else
      status_deferred_config.status_format = STATUS_FORMAT_NONE;
    return 0;
  }
  if (!strcmp(k, "status.branch")) {
    status_deferred_config.show_branch = git_config_bool(k, v);
    return 0;
  }
  if (!strcmp(k, "status.aheadbehind")) {
    status_deferred_config.ahead_behind = git_config_bool(k, v);
    return 0;
  }
  if (!strcmp(k, "status.showstash")) {
    s->show_stash = git_config_bool(k, v);
    return 0;
  }
  if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
    s->use_color = git_config_colorbool(k, v);
    return 0;
  }
  if (!strcmp(k, "status.displaycommentprefix")) {
    s->display_comment_prefix = git_config_bool(k, v);
    return 0;
  }
  if (skip_prefix(k, "status.color.", &slot_name) ||
      skip_prefix(k, "color.status.", &slot_name)) {
    int slot = parse_status_slot(slot_name);
    if (slot < 0)
      return 0;
    if (!v)
      return config_error_nonbool(k);
    return color_parse(v, s->color_palette[slot]);
  }
  if (!strcmp(k, "status.relativepaths")) {
    s->relative_paths = git_config_bool(k, v);
    return 0;
  }
  if (!strcmp(k, "status.showuntrackedfiles")) {
    enum untracked_status_type u;

    u = parse_untracked_setting_name(v);
    if (u == SHOW_UNTRACKED_FILES_ERROR)
      return error(_("Invalid untracked files mode '%s'"), v);
    s->show_untracked_files = u;
    return 0;
  }
  if (!strcmp(k, "diff.renamelimit")) {
    if (s->rename_limit == -1)
      s->rename_limit = git_config_int(k, v, ctx->kvi);
    return 0;
  }
  if (!strcmp(k, "status.renamelimit")) {
    s->rename_limit = git_config_int(k, v, ctx->kvi);
    return 0;
  }
  if (!strcmp(k, "diff.renames")) {
    if (s->detect_rename == -1)
      s->detect_rename = git_config_rename(k, v);
    return 0;
  }
  if (!strcmp(k, "status.renames")) {
    s->detect_rename = git_config_rename(k, v);
    return 0;
  }
  return git_diff_ui_config(k, v, ctx, NULL);
}

int cmd_status(int argc, const char **argv, const char *prefix)
{
  static int no_renames = -1;
  static const char *rename_score_arg = (const char *)-1;
  static struct wt_status s;
  unsigned int progress_flag = 0;
  int fd;
  struct object_id oid;
  static struct option builtin_status_options[] = {
    OPT__VERBOSE(&verbose, N_("be verbose")),
    OPT_SET_INT('s', "short", &status_format,
          N_("show status concisely"), STATUS_FORMAT_SHORT),
    OPT_BOOL('b', "branch", &s.show_branch,
       N_("show branch information")),
    OPT_BOOL(0, "show-stash", &s.show_stash,
       N_("show stash information")),
    OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
       N_("compute full ahead/behind values")),
    OPT_CALLBACK_F(0, "porcelain", &status_format,
      N_("version"), N_("machine-readable output"),
      PARSE_OPT_OPTARG, opt_parse_porcelain),
    OPT_SET_INT(0, "long", &status_format,
          N_("show status in long format (default)"),
          STATUS_FORMAT_LONG),
    OPT_BOOL('z', "null", &s.null_termination,
       N_("terminate entries with NUL")),
    { 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" },
    { OPTION_STRING, 0, "ignored", &ignored_arg,
      N_("mode"),
      N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
      PARSE_OPT_OPTARG, NULL, (intptr_t)"traditional" },
    { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
      N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
      PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
    OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
    OPT_BOOL(0, "no-renames", &no_renames, N_("do not detect renames")),
    OPT_CALLBACK_F('M', "find-renames", &rename_score_arg,
      N_("n"), N_("detect renames, optionally set similarity index"),
      PARSE_OPT_OPTARG | PARSE_OPT_NONEG, opt_parse_rename_score),
    OPT_END(),
  };

  if (argc == 2 && !strcmp(argv[1], "-h"))
    usage_with_options(builtin_status_usage, builtin_status_options);

  prepare_repo_settings(the_repository);
  the_repository->settings.command_requires_full_index = 0;

  status_init_config(&s, git_status_config);
  argc = parse_options(argc, argv, prefix,
           builtin_status_options,
           builtin_status_usage, 0);
  finalize_colopts(&s.colopts, -1);
  finalize_deferred_config(&s);

  handle_untracked_files_arg(&s);
  handle_ignored_arg(&s);

  if (s.show_ignored_mode == SHOW_MATCHING_IGNORED &&
      s.show_untracked_files == SHOW_NO_UNTRACKED_FILES)
    die(_("Unsupported combination of ignored and untracked-files arguments"));

  parse_pathspec(&s.pathspec, 0,
           PATHSPEC_PREFER_FULL,
           prefix, argv);

  if (status_format != STATUS_FORMAT_PORCELAIN &&
      status_format != STATUS_FORMAT_PORCELAIN_V2)
    progress_flag = REFRESH_PROGRESS;
  repo_read_index(the_repository);
  refresh_index(the_repository->index,
          REFRESH_QUIET|REFRESH_UNMERGED|progress_flag,
          &s.pathspec, NULL, NULL);

  if (use_optional_locks())
    fd = repo_hold_locked_index(the_repository, &index_lock, 0);
  else
    fd = -1;

  s.is_initial = repo_get_oid(the_repository, s.reference, &oid) ? 1 : 0;
  if (!s.is_initial)
    oidcpy(&s.oid_commit, &oid);

  s.ignore_submodule_arg = ignore_submodule_arg;
  s.status_format = status_format;
  s.verbose = verbose;
  if (no_renames != -1)
    s.detect_rename = !no_renames;
  if ((intptr_t)rename_score_arg != -1) {
    if (s.detect_rename < DIFF_DETECT_RENAME)
      s.detect_rename = DIFF_DETECT_RENAME;
    if (rename_score_arg)
      s.rename_score = parse_rename_score(&rename_score_arg);
  }

  wt_status_collect(&s);

  if (0 <= fd)
    repo_update_index_if_able(the_repository, &index_lock);

  if (s.relative_paths)
    s.prefix = prefix;

  wt_status_print(&s);
  wt_status_collect_free_buffers(&s);

  return 0;
}

static int git_commit_config(const char *k, const char *v,
           const struct config_context *ctx, void *cb)
{
  struct wt_status *s = cb;

  if (!strcmp(k, "commit.template"))
    return git_config_pathname(&template_file, k, v);
  if (!strcmp(k, "commit.status")) {
    include_status = git_config_bool(k, v);
    return 0;
  }
  if (!strcmp(k, "commit.cleanup"))
    return git_config_string(&cleanup_arg, k, v);
  if (!strcmp(k, "commit.gpgsign")) {
    sign_commit = git_config_bool(k, v) ? "" : NULL;
    return 0;
  }
  if (!strcmp(k, "commit.verbose")) {
    int is_bool;
    config_commit_verbose = git_config_bool_or_int(k, v, ctx->kvi,
                     &is_bool);
    return 0;
  }

  return git_status_config(k, v, ctx, s);
}

int cmd_commit(int argc, const char **argv, const char *prefix)
{
  static struct wt_status s;
  static struct option builtin_commit_options[] = {
    OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
    OPT__VERBOSE(&verbose, N_("show diff in commit message template")),

    OPT_GROUP(N_("Commit message options")),
    OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
    OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
    OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
    OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
    OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
    OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
    /*
     * TRANSLATORS: Leave "[(amend|reword):]" as-is,
     * and only translate <commit>.
     */
    OPT_STRING(0, "fixup", &fixup_message, N_("[(amend|reword):]commit"), N_("use autosquash formatted message to fixup or amend/reword specified commit")),
    OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
    OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
    OPT_PASSTHRU_ARGV(0, "trailer", &trailer_args, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG),
    OPT_BOOL('s', "signoff", &signoff, N_("add a Signed-off-by trailer")),
    OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
    OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
    OPT_CLEANUP(&cleanup_arg),
    OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
    { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
      N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
    /* end commit message options */

    OPT_GROUP(N_("Commit contents options")),
    OPT_BOOL('a', "all", &all, N_("commit all changed files")),
    OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
    OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
    OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
    OPT_BOOL('o', "only", &only, N_("commit only specified files")),
    OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit and commit-msg hooks")),
    OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
    OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
          STATUS_FORMAT_SHORT),
    OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
    OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
       N_("compute full ahead/behind values")),
    OPT_SET_INT(0, "porcelain", &status_format,
          N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
    OPT_SET_INT(0, "long", &status_format,
          N_("show status in long format (default)"),
          STATUS_FORMAT_LONG),
    OPT_BOOL('z', "null", &s.null_termination,
       N_("terminate entries with NUL")),
    OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
    OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
    { 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" },
    OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
    OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
    /* end commit contents options */

    OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
        N_("ok to record an empty change")),
    OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
        N_("ok to record a change with an empty message")),

    OPT_END()
  };

  struct strbuf sb = STRBUF_INIT;
  struct strbuf author_ident = STRBUF_INIT;
  const char *index_file, *reflog_msg;
  struct object_id oid;
  struct commit_list *parents = NULL;
  struct stat statbuf;
  struct commit *current_head = NULL;
  struct commit_extra_header *extra = NULL;
  struct strbuf err = STRBUF_INIT;
  int ret = 0;

  if (argc == 2 && !strcmp(argv[1], "-h"))
    usage_with_options(builtin_commit_usage, builtin_commit_options);

  prepare_repo_settings(the_repository);
  the_repository->settings.command_requires_full_index = 0;

  status_init_config(&s, git_commit_config);
  s.commit_template = 1;
  status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
  s.colopts = 0;

  if (repo_get_oid(the_repository, "HEAD", &oid))
    current_head = NULL;
  else {
    current_head = lookup_commit_or_die(&oid, "HEAD");
    if (repo_parse_commit(the_repository, current_head))
      die(_("could not parse HEAD commit"));
  }
  verbose = -1; /* unspecified */
  argc = parse_and_validate_options(argc, argv, builtin_commit_options,
            builtin_commit_usage,
            prefix, current_head, &s);
  if (verbose == -1)
    verbose = (config_commit_verbose < 0) ? 0 : config_commit_verbose;

  if (dry_run)
    return dry_run_commit(argv, prefix, current_head, &s);
  index_file = prepare_index(argv, prefix, current_head, 0);

  /* Set up everything for writing the commit object.  This includes
     running hooks, writing the trees, and interacting with the user.  */
  if (!prepare_to_commit(index_file, prefix,
             current_head, &s, &author_ident)) {
    ret = 1;
    rollback_index_files();
    goto cleanup;
  }

  /* Determine parents */
  reflog_msg = getenv("GIT_REFLOG_ACTION");
  if (!current_head) {
    if (!reflog_msg)
      reflog_msg = "commit (initial)";
  } else if (amend) {
    if (!reflog_msg)
      reflog_msg = "commit (amend)";
    parents = copy_commit_list(current_head->parents);
  } else if (whence == FROM_MERGE) {
    struct strbuf m = STRBUF_INIT;
    FILE *fp;
    int allow_fast_forward = 1;
    struct commit_list **pptr = &parents;

    if (!reflog_msg)
      reflog_msg = "commit (merge)";
    pptr = commit_list_append(current_head, pptr);
    fp = xfopen(git_path_merge_head(the_repository), "r");
    while (strbuf_getline_lf(&m, fp) != EOF) {
      struct commit *parent;

      parent = get_merge_parent(m.buf);
      if (!parent)
        die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
      pptr = commit_list_append(parent, pptr);
    }
    fclose(fp);
    strbuf_release(&m);
    if (!stat(git_path_merge_mode(the_repository), &statbuf)) {
      if (strbuf_read_file(&sb, git_path_merge_mode(the_repository), 0) < 0)
        die_errno(_("could not read MERGE_MODE"));
      if (!strcmp(sb.buf, "no-ff"))
        allow_fast_forward = 0;
    }
    if (allow_fast_forward)
      reduce_heads_replace(&parents);
  } else {
    if (!reflog_msg)
      reflog_msg = is_from_cherry_pick(whence)
          ? "commit (cherry-pick)"
          : is_from_rebase(whence)
          ? "commit (rebase)"
          : "commit";
    commit_list_insert(current_head, &parents);
  }

  /* Finally, get the commit message */
  strbuf_reset(&sb);
  if (strbuf_read_file(&sb, git_path_commit_editmsg(), 0) < 0) {
    int saved_errno = errno;
    rollback_index_files();
    die(_("could not read commit message: %s"), strerror(saved_errno));
  }

  cleanup_message(&sb, cleanup_mode, verbose);

  if (message_is_empty(&sb, cleanup_mode) && !allow_empty_message) {
    rollback_index_files();
    fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
    exit(1);
  }
  if (template_untouched(&sb, template_file, cleanup_mode) && !allow_empty_message) {
    rollback_index_files();
    fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
    exit(1);
  }

  if (fixup_message && starts_with(sb.buf, "amend! ") &&
      !allow_empty_message) {
    struct strbuf body = STRBUF_INIT;
    size_t len = commit_subject_length(sb.buf);
    strbuf_addstr(&body, sb.buf + len);
    if (message_is_empty(&body, cleanup_mode)) {
      rollback_index_files();
      fprintf(stderr, _("Aborting commit due to empty commit message body.\n"));
      exit(1);
    }
    strbuf_release(&body);
  }

  if (amend) {
    const char *exclude_gpgsig[3] = { "gpgsig", "gpgsig-sha256", NULL };
    extra = read_commit_extra_headers(current_head, exclude_gpgsig);
  } else {
    struct commit_extra_header **tail = &extra;
    append_merge_tag_headers(parents, &tail);
  }

  if (commit_tree_extended(sb.buf, sb.len, &the_repository->index->cache_tree->oid,
         parents, &oid, author_ident.buf, NULL,
         sign_commit, extra)) {
    rollback_index_files();
    die(_("failed to write commit object"));
  }

  if (update_head_with_reflog(current_head, &oid, reflog_msg, &sb,
            &err)) {
    rollback_index_files();
    die("%s", err.buf);
  }

  sequencer_post_commit_cleanup(the_repository, 0);
  unlink(git_path_merge_head(the_repository));
  unlink(git_path_merge_msg(the_repository));
  unlink(git_path_merge_mode(the_repository));
  unlink(git_path_squash_msg(the_repository));

  if (commit_index_files())
    die(_("repository has been updated, but unable to write\n"
          "new index file. Check that disk is not full and quota is\n"
          "not exceeded, and then \"git restore --staged :/\" to recover."));

  git_test_write_commit_graph_or_die();

  repo_rerere(the_repository, 0);
  run_auto_maintenance(quiet);
  run_commit_hook(use_editor, get_index_file(), NULL, "post-commit",
      NULL);
  if (amend && !no_post_rewrite) {
    commit_post_rewrite(the_repository, current_head, &oid);
  }
  if (!quiet) {
    unsigned int flags = 0;

    if (!current_head)
      flags |= SUMMARY_INITIAL_COMMIT;
    if (author_date_is_interesting())
      flags |= SUMMARY_SHOW_AUTHOR_DATE;
    print_commit_summary(the_repository, prefix,
             &oid, flags);
  }

  apply_autostash_ref(the_repository, "MERGE_AUTOSTASH");

cleanup:
  free_commit_extra_headers(extra);
  free_commit_list(parents);
  strbuf_release(&author_ident);
  strbuf_release(&err);
  strbuf_release(&sb);
  free(logfile);
  free(template_file);
  return ret;
}

Coverage Report

Created: 2024-09-08 06:23