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