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