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