4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
10 #include "cache-tree.h"
18 #include "wt-status.h"
19 #include "run-command.h"
24 #include "parse-options.h"
25 #include "string-list.h"
27 #include "unpack-trees.h"
29 #include "submodule.h"
30 #include "gpg-interface.h"
32 #include "sequencer.h"
33 #include "notes-utils.h"
37 static const char * const builtin_commit_usage[] = {
38 N_("git commit [<options>] [--] <pathspec>..."),
42 static const char * const builtin_status_usage[] = {
43 N_("git status [<options>] [--] <pathspec>..."),
47 static const char implicit_ident_advice_noconfig[] =
48 N_("Your name and email address were configured automatically based\n"
49 "on your username and hostname. Please check that they are accurate.\n"
50 "You can suppress this message by setting them explicitly. Run the\n"
51 "following command and follow the instructions in your editor to edit\n"
52 "your configuration file:\n"
54 " git config --global --edit\n"
56 "After doing this, you may fix the identity used for this commit with:\n"
58 " git commit --amend --reset-author\n");
60 static const char implicit_ident_advice_config[] =
61 N_("Your name and email address were configured automatically based\n"
62 "on your username and hostname. Please check that they are accurate.\n"
63 "You can suppress this message by setting them explicitly:\n"
65 " git config --global user.name \"Your Name\"\n"
66 " git config --global user.email you@example.com\n"
68 "After doing this, you may fix the identity used for this commit with:\n"
70 " git commit --amend --reset-author\n");
72 static const char empty_amend_advice[] =
73 N_("You asked to amend the most recent commit, but doing so would make\n"
74 "it empty. You can repeat your command with --allow-empty, or you can\n"
75 "remove the commit entirely with \"git reset HEAD^\".\n");
77 static const char empty_cherry_pick_advice[] =
78 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
79 "If you wish to commit it anyway, use:\n"
81 " git commit --allow-empty\n"
84 static const char empty_cherry_pick_advice_single[] =
85 N_("Otherwise, please use 'git reset'\n");
87 static const char empty_cherry_pick_advice_multi[] =
88 N_("If you wish to skip this commit, use:\n"
92 "Then \"git cherry-pick --continue\" will resume cherry-picking\n"
93 "the remaining commits.\n");
95 static const char *use_message_buffer;
96 static const char commit_editmsg[] = "COMMIT_EDITMSG";
97 static struct lock_file index_lock; /* real index */
98 static struct lock_file false_lock; /* used only for partial commits */
105 static const char *logfile, *force_author;
106 static const char *template_file;
108 * The _message variables are commit names from which to take
109 * the commit message and/or authorship.
111 static const char *author_message, *author_message_buffer;
112 static char *edit_message, *use_message;
113 static char *fixup_message, *squash_message;
114 static int all, also, interactive, patch_interactive, only, amend, signoff;
115 static int edit_flag = -1; /* unspecified */
116 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
117 static int no_post_rewrite, allow_empty_message;
118 static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
119 static char *sign_commit;
122 * The default commit message cleanup mode will remove the lines
123 * beginning with # (shell comments) and leading and trailing
124 * whitespaces (empty lines or containing only whitespaces)
125 * if editor is used, and only the whitespaces if the message
126 * is specified explicitly.
134 static const char *cleanup_arg;
136 static enum commit_whence whence;
137 static int sequencer_in_use;
138 static int use_editor = 1, include_status = 1;
139 static int show_ignored_in_status, have_option_m;
140 static const char *only_include_assumed;
141 static struct strbuf message = STRBUF_INIT;
143 static enum status_format {
144 STATUS_FORMAT_NONE = 0,
147 STATUS_FORMAT_PORCELAIN,
149 STATUS_FORMAT_UNSPECIFIED
150 } status_format = STATUS_FORMAT_UNSPECIFIED;
152 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
154 struct strbuf *buf = opt->value;
157 strbuf_setlen(buf, 0);
161 strbuf_addch(buf, '\n');
162 strbuf_addstr(buf, arg);
163 strbuf_complete_line(buf);
168 static void determine_whence(struct wt_status *s)
170 if (file_exists(git_path("MERGE_HEAD")))
172 else if (file_exists(git_path("CHERRY_PICK_HEAD"))) {
173 whence = FROM_CHERRY_PICK;
174 if (file_exists(git_path(SEQ_DIR)))
175 sequencer_in_use = 1;
178 whence = FROM_COMMIT;
183 static void status_init_config(struct wt_status *s, config_fn_t fn)
185 wt_status_prepare(s);
189 s->hints = advice_status_hints; /* must come after git_config() */
192 static void rollback_index_files(void)
194 switch (commit_style) {
196 break; /* nothing to do */
198 rollback_lock_file(&index_lock);
201 rollback_lock_file(&index_lock);
202 rollback_lock_file(&false_lock);
207 static int commit_index_files(void)
211 switch (commit_style) {
213 break; /* nothing to do */
215 err = commit_lock_file(&index_lock);
218 err = commit_lock_file(&index_lock);
219 rollback_lock_file(&false_lock);
227 * Take a union of paths in the index and the named tree (typically, "HEAD"),
228 * and return the paths that match the given pattern in list.
230 static int list_paths(struct string_list *list, const char *with_tree,
231 const char *prefix, const struct pathspec *pattern)
239 m = xcalloc(1, pattern->nr);
242 char *max_prefix = common_prefix(pattern);
243 overlay_tree_on_cache(with_tree, max_prefix ? max_prefix : prefix);
247 for (i = 0; i < active_nr; i++) {
248 const struct cache_entry *ce = active_cache[i];
249 struct string_list_item *item;
251 if (ce->ce_flags & CE_UPDATE)
253 if (!ce_path_match(ce, pattern, m))
255 item = string_list_insert(list, ce->name);
256 if (ce_skip_worktree(ce))
257 item->util = item; /* better a valid pointer than a fake one */
260 ret = report_path_error(m, pattern, prefix);
265 static void add_remove_files(struct string_list *list)
268 for (i = 0; i < list->nr; i++) {
270 struct string_list_item *p = &(list->items[i]);
272 /* p->util is skip-worktree */
276 if (!lstat(p->string, &st)) {
277 if (add_to_cache(p->string, &st, 0))
278 die(_("updating files failed"));
280 remove_file_from_cache(p->string);
284 static void create_base_index(const struct commit *current_head)
287 struct unpack_trees_options opts;
295 memset(&opts, 0, sizeof(opts));
299 opts.src_index = &the_index;
300 opts.dst_index = &the_index;
302 opts.fn = oneway_merge;
303 tree = parse_tree_indirect(current_head->object.sha1);
305 die(_("failed to unpack HEAD tree object"));
307 init_tree_desc(&t, tree->buffer, tree->size);
308 if (unpack_trees(1, &t, &opts))
309 exit(128); /* We've already reported the error, finish dying */
312 static void refresh_cache_or_die(int refresh_flags)
315 * refresh_flags contains REFRESH_QUIET, so the only errors
316 * are for unmerged entries.
318 if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
319 die_resolve_conflict("commit");
322 static const char *prepare_index(int argc, const char **argv, const char *prefix,
323 const struct commit *current_head, int is_status)
325 struct string_list partial;
326 struct pathspec pathspec;
327 int refresh_flags = REFRESH_QUIET;
330 refresh_flags |= REFRESH_UNMERGED;
331 parse_pathspec(&pathspec, 0,
332 PATHSPEC_PREFER_FULL,
335 if (read_cache_preload(&pathspec) < 0)
336 die(_("index file corrupt"));
339 char *old_index_env = NULL;
340 hold_locked_index(&index_lock, 1);
342 refresh_cache_or_die(refresh_flags);
344 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
345 die(_("unable to create temporary index"));
347 old_index_env = getenv(INDEX_ENVIRONMENT);
348 setenv(INDEX_ENVIRONMENT, index_lock.filename.buf, 1);
350 if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
351 die(_("interactive add failed"));
353 if (old_index_env && *old_index_env)
354 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
356 unsetenv(INDEX_ENVIRONMENT);
359 read_cache_from(index_lock.filename.buf);
360 if (update_main_cache_tree(WRITE_TREE_SILENT) == 0) {
361 if (reopen_lock_file(&index_lock) < 0)
362 die(_("unable to write index file"));
363 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
364 die(_("unable to update temporary index"));
366 warning(_("Failed to update main cache tree"));
368 commit_style = COMMIT_NORMAL;
369 return index_lock.filename.buf;
373 * Non partial, non as-is commit.
375 * (1) get the real index;
376 * (2) update the_index as necessary;
377 * (3) write the_index out to the real index (still locked);
378 * (4) return the name of the locked index file.
380 * The caller should run hooks on the locked real index, and
381 * (A) if all goes well, commit the real index;
382 * (B) on failure, rollback the real index.
384 if (all || (also && pathspec.nr)) {
385 hold_locked_index(&index_lock, 1);
386 add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
387 refresh_cache_or_die(refresh_flags);
388 update_main_cache_tree(WRITE_TREE_SILENT);
389 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
390 die(_("unable to write new_index file"));
391 commit_style = COMMIT_NORMAL;
392 return index_lock.filename.buf;
398 * (1) return the name of the real index file.
400 * The caller should run hooks on the real index,
401 * and create commit from the_index.
402 * We still need to refresh the index here.
404 if (!only && !pathspec.nr) {
405 hold_locked_index(&index_lock, 1);
406 refresh_cache_or_die(refresh_flags);
407 if (active_cache_changed
408 || !cache_tree_fully_valid(active_cache_tree)) {
409 update_main_cache_tree(WRITE_TREE_SILENT);
410 active_cache_changed = 1;
412 if (active_cache_changed) {
413 if (write_locked_index(&the_index, &index_lock,
415 die(_("unable to write new_index file"));
417 rollback_lock_file(&index_lock);
419 commit_style = COMMIT_AS_IS;
420 return get_index_file();
426 * (0) find the set of affected paths;
427 * (1) get lock on the real index file;
428 * (2) update the_index with the given paths;
429 * (3) write the_index out to the real index (still locked);
430 * (4) get lock on the false index file;
431 * (5) reset the_index from HEAD;
432 * (6) update the_index the same way as (2);
433 * (7) write the_index out to the false index file;
434 * (8) return the name of the false index file (still locked);
436 * The caller should run hooks on the locked false index, and
437 * create commit from it. Then
438 * (A) if all goes well, commit the real index;
439 * (B) on failure, rollback the real index;
440 * In either case, rollback the false index.
442 commit_style = COMMIT_PARTIAL;
444 if (whence != FROM_COMMIT) {
445 if (whence == FROM_MERGE)
446 die(_("cannot do a partial commit during a merge."));
447 else if (whence == FROM_CHERRY_PICK)
448 die(_("cannot do a partial commit during a cherry-pick."));
451 string_list_init(&partial, 1);
452 if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, &pathspec))
456 if (read_cache() < 0)
457 die(_("cannot read the index"));
459 hold_locked_index(&index_lock, 1);
460 add_remove_files(&partial);
461 refresh_cache(REFRESH_QUIET);
462 update_main_cache_tree(WRITE_TREE_SILENT);
463 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
464 die(_("unable to write new_index file"));
466 hold_lock_file_for_update(&false_lock,
467 git_path("next-index-%"PRIuMAX,
468 (uintmax_t) getpid()),
471 create_base_index(current_head);
472 add_remove_files(&partial);
473 refresh_cache(REFRESH_QUIET);
475 if (write_locked_index(&the_index, &false_lock, CLOSE_LOCK))
476 die(_("unable to write temporary index file"));
479 read_cache_from(false_lock.filename.buf);
481 return false_lock.filename.buf;
484 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
487 unsigned char sha1[20];
489 if (s->relative_paths)
494 s->reference = "HEAD^1";
496 s->verbose = verbose;
497 s->index_file = index_file;
500 s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
502 wt_status_collect(s);
504 switch (status_format) {
505 case STATUS_FORMAT_SHORT:
506 wt_shortstatus_print(s);
508 case STATUS_FORMAT_PORCELAIN:
509 wt_porcelain_print(s);
511 case STATUS_FORMAT_UNSPECIFIED:
512 die("BUG: finalize_deferred_config() should have been called");
514 case STATUS_FORMAT_NONE:
515 case STATUS_FORMAT_LONG:
520 return s->commitable;
523 static int is_a_merge(const struct commit *current_head)
525 return !!(current_head->parents && current_head->parents->next);
528 static void assert_split_ident(struct ident_split *id, const struct strbuf *buf)
530 if (split_ident_line(id, buf->buf, buf->len) || !id->date_begin)
531 die("BUG: unable to parse our own ident: %s", buf->buf);
534 static void export_one(const char *var, const char *s, const char *e, int hack)
536 struct strbuf buf = STRBUF_INIT;
538 strbuf_addch(&buf, hack);
539 strbuf_addf(&buf, "%.*s", (int)(e - s), s);
540 setenv(var, buf.buf, 1);
541 strbuf_release(&buf);
544 static int parse_force_date(const char *in, struct strbuf *out)
546 strbuf_addch(out, '@');
548 if (parse_date(in, out) < 0) {
550 unsigned long t = approxidate_careful(in, &errors);
553 strbuf_addf(out, "%lu", t);
559 static void set_ident_var(char **buf, char *val)
565 static void determine_author_info(struct strbuf *author_ident)
567 char *name, *email, *date;
568 struct ident_split author;
570 name = xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
571 email = xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
572 date = xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
574 if (author_message) {
575 struct ident_split ident;
579 a = find_commit_header(author_message_buffer, "author", &len);
581 die(_("commit '%s' lacks author header"), author_message);
582 if (split_ident_line(&ident, a, len) < 0)
583 die(_("commit '%s' has malformed author line"), author_message);
585 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
586 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
588 if (ident.date_begin) {
589 struct strbuf date_buf = STRBUF_INIT;
590 strbuf_addch(&date_buf, '@');
591 strbuf_add(&date_buf, ident.date_begin, ident.date_end - ident.date_begin);
592 strbuf_addch(&date_buf, ' ');
593 strbuf_add(&date_buf, ident.tz_begin, ident.tz_end - ident.tz_begin);
594 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
599 struct ident_split ident;
601 if (split_ident_line(&ident, force_author, strlen(force_author)) < 0)
602 die(_("malformed --author parameter"));
603 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
604 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
608 struct strbuf date_buf = STRBUF_INIT;
609 if (parse_force_date(force_date, &date_buf))
610 die(_("invalid date format: %s"), force_date);
611 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
614 strbuf_addstr(author_ident, fmt_ident(name, email, date, IDENT_STRICT));
615 assert_split_ident(&author, author_ident);
616 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
617 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
618 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
624 static int author_date_is_interesting(void)
626 return author_message || force_date;
629 static void adjust_comment_line_char(const struct strbuf *sb)
631 char candidates[] = "#;@!$%^&|:";
635 comment_line_char = candidates[0];
636 if (!memchr(sb->buf, comment_line_char, sb->len))
640 candidate = strchr(candidates, *p);
643 for (p = sb->buf; *p; p++) {
644 if ((p[0] == '\n' || p[0] == '\r') && p[1]) {
645 candidate = strchr(candidates, p[1]);
651 for (p = candidates; *p == ' '; p++)
654 die(_("unable to select a comment character that is not used\n"
655 "in the current commit message"));
656 comment_line_char = *p;
659 static int prepare_to_commit(const char *index_file, const char *prefix,
660 struct commit *current_head,
662 struct strbuf *author_ident)
665 struct strbuf committer_ident = STRBUF_INIT;
667 struct strbuf sb = STRBUF_INIT;
668 const char *hook_arg1 = NULL;
669 const char *hook_arg2 = NULL;
670 int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
671 int old_display_comment_prefix;
673 /* This checks and barfs if author is badly specified */
674 determine_author_info(author_ident);
676 if (!no_verify && run_commit_hook(use_editor, index_file, "pre-commit", NULL))
679 if (squash_message) {
681 * Insert the proper subject line before other commit
682 * message options add their content.
684 if (use_message && !strcmp(use_message, squash_message))
685 strbuf_addstr(&sb, "squash! ");
687 struct pretty_print_context ctx = {0};
689 c = lookup_commit_reference_by_name(squash_message);
691 die(_("could not lookup commit %s"), squash_message);
692 ctx.output_encoding = get_commit_output_encoding();
693 format_commit_message(c, "squash! %s\n\n", &sb,
699 strbuf_addbuf(&sb, &message);
700 hook_arg1 = "message";
701 } else if (logfile && !strcmp(logfile, "-")) {
703 fprintf(stderr, _("(reading log message from standard input)\n"));
704 if (strbuf_read(&sb, 0, 0) < 0)
705 die_errno(_("could not read log from standard input"));
706 hook_arg1 = "message";
707 } else if (logfile) {
708 if (strbuf_read_file(&sb, logfile, 0) < 0)
709 die_errno(_("could not read log file '%s'"),
711 hook_arg1 = "message";
712 } else if (use_message) {
714 buffer = strstr(use_message_buffer, "\n\n");
716 strbuf_addstr(&sb, buffer + 2);
717 hook_arg1 = "commit";
718 hook_arg2 = use_message;
719 } else if (fixup_message) {
720 struct pretty_print_context ctx = {0};
721 struct commit *commit;
722 commit = lookup_commit_reference_by_name(fixup_message);
724 die(_("could not lookup commit %s"), fixup_message);
725 ctx.output_encoding = get_commit_output_encoding();
726 format_commit_message(commit, "fixup! %s\n\n",
728 hook_arg1 = "message";
729 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
730 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
731 die_errno(_("could not read MERGE_MSG"));
733 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
734 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
735 die_errno(_("could not read SQUASH_MSG"));
736 hook_arg1 = "squash";
737 } else if (template_file) {
738 if (strbuf_read_file(&sb, template_file, 0) < 0)
739 die_errno(_("could not read '%s'"), template_file);
740 hook_arg1 = "template";
741 clean_message_contents = 0;
745 * The remaining cases don't modify the template message, but
746 * just set the argument(s) to the prepare-commit-msg hook.
748 else if (whence == FROM_MERGE)
750 else if (whence == FROM_CHERRY_PICK) {
751 hook_arg1 = "commit";
752 hook_arg2 = "CHERRY_PICK_HEAD";
755 if (squash_message) {
757 * If squash_commit was used for the commit subject,
758 * then we're possibly hijacking other commit log options.
759 * Reset the hook args to tell the real story.
761 hook_arg1 = "message";
765 s->fp = fopen(git_path(commit_editmsg), "w");
767 die_errno(_("could not open '%s'"), git_path(commit_editmsg));
769 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
770 old_display_comment_prefix = s->display_comment_prefix;
771 s->display_comment_prefix = 1;
774 * Most hints are counter-productive when the commit has
779 if (clean_message_contents)
783 append_signoff(&sb, ignore_non_trailer(&sb), 0);
785 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
786 die_errno(_("could not write commit template"));
788 if (auto_comment_line_char)
789 adjust_comment_line_char(&sb);
792 /* This checks if committer ident is explicitly given */
793 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
794 if (use_editor && include_status) {
796 int saved_color_setting;
797 struct ident_split ci, ai;
799 if (whence != FROM_COMMIT) {
800 if (cleanup_mode == CLEANUP_SCISSORS)
801 wt_status_add_cut_line(s->fp);
802 status_printf_ln(s, GIT_COLOR_NORMAL,
805 "It looks like you may be committing a merge.\n"
806 "If this is not correct, please remove the file\n"
810 "It looks like you may be committing a cherry-pick.\n"
811 "If this is not correct, please remove the file\n"
814 git_path(whence == FROM_MERGE
816 : "CHERRY_PICK_HEAD"));
819 fprintf(s->fp, "\n");
820 if (cleanup_mode == CLEANUP_ALL)
821 status_printf(s, GIT_COLOR_NORMAL,
822 _("Please enter the commit message for your changes."
823 " Lines starting\nwith '%c' will be ignored, and an empty"
824 " message aborts the commit.\n"), comment_line_char);
825 else if (cleanup_mode == CLEANUP_SCISSORS && whence == FROM_COMMIT)
826 wt_status_add_cut_line(s->fp);
827 else /* CLEANUP_SPACE, that is. */
828 status_printf(s, GIT_COLOR_NORMAL,
829 _("Please enter the commit message for your changes."
831 "with '%c' will be kept; you may remove them"
832 " yourself if you want to.\n"
833 "An empty message aborts the commit.\n"), comment_line_char);
834 if (only_include_assumed)
835 status_printf_ln(s, GIT_COLOR_NORMAL,
836 "%s", only_include_assumed);
839 * These should never fail because they come from our own
840 * fmt_ident. They may fail the sane_ident test, but we know
841 * that the name and mail pointers will at least be valid,
842 * which is enough for our tests and printing here.
844 assert_split_ident(&ai, author_ident);
845 assert_split_ident(&ci, &committer_ident);
847 if (ident_cmp(&ai, &ci))
848 status_printf_ln(s, GIT_COLOR_NORMAL,
850 "Author: %.*s <%.*s>"),
851 ident_shown++ ? "" : "\n",
852 (int)(ai.name_end - ai.name_begin), ai.name_begin,
853 (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);
855 if (author_date_is_interesting())
856 status_printf_ln(s, GIT_COLOR_NORMAL,
859 ident_shown++ ? "" : "\n",
860 show_ident_date(&ai, DATE_NORMAL));
862 if (!committer_ident_sufficiently_given())
863 status_printf_ln(s, GIT_COLOR_NORMAL,
865 "Committer: %.*s <%.*s>"),
866 ident_shown++ ? "" : "\n",
867 (int)(ci.name_end - ci.name_begin), ci.name_begin,
868 (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
871 status_printf_ln(s, GIT_COLOR_NORMAL, "%s", "");
873 saved_color_setting = s->use_color;
875 commitable = run_status(s->fp, index_file, prefix, 1, s);
876 s->use_color = saved_color_setting;
878 unsigned char sha1[20];
879 const char *parent = "HEAD";
881 if (!active_nr && read_cache() < 0)
882 die(_("Cannot read index"));
887 if (get_sha1(parent, sha1))
888 commitable = !!active_nr;
891 * Unless the user did explicitly request a submodule
892 * ignore mode by passing a command line option we do
893 * not ignore any changed submodule SHA-1s when
894 * comparing index and parent, no matter what is
895 * configured. Otherwise we won't commit any
896 * submodules which were manually staged, which would
897 * be really confusing.
899 int diff_flags = DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG;
900 if (ignore_submodule_arg &&
901 !strcmp(ignore_submodule_arg, "all"))
902 diff_flags |= DIFF_OPT_IGNORE_SUBMODULES;
903 commitable = index_differs_from(parent, diff_flags);
906 strbuf_release(&committer_ident);
911 * Reject an attempt to record a non-merge empty commit without
912 * explicit --allow-empty. In the cherry-pick case, it may be
913 * empty due to conflict resolution, which the user should okay.
915 if (!commitable && whence != FROM_MERGE && !allow_empty &&
916 !(amend && is_a_merge(current_head))) {
917 s->display_comment_prefix = old_display_comment_prefix;
918 run_status(stdout, index_file, prefix, 0, s);
920 fputs(_(empty_amend_advice), stderr);
921 else if (whence == FROM_CHERRY_PICK) {
922 fputs(_(empty_cherry_pick_advice), stderr);
923 if (!sequencer_in_use)
924 fputs(_(empty_cherry_pick_advice_single), stderr);
926 fputs(_(empty_cherry_pick_advice_multi), stderr);
932 * Re-read the index as pre-commit hook could have updated it,
933 * and write it out as a tree. We must do this before we invoke
934 * the editor and after we invoke run_status above.
937 read_cache_from(index_file);
938 if (update_main_cache_tree(0)) {
939 error(_("Error building trees"));
943 if (run_commit_hook(use_editor, index_file, "prepare-commit-msg",
944 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
948 char index[PATH_MAX];
949 const char *env[2] = { NULL };
951 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
952 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
954 _("Please supply the message using either -m or -F option.\n"));
960 run_commit_hook(use_editor, index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
967 static int rest_is_empty(struct strbuf *sb, int start)
972 /* Check if the rest is just whitespace and Signed-of-by's. */
973 for (i = start; i < sb->len; i++) {
974 nl = memchr(sb->buf + i, '\n', sb->len - i);
980 if (strlen(sign_off_header) <= eol - i &&
981 starts_with(sb->buf + i, sign_off_header)) {
986 if (!isspace(sb->buf[i++]))
994 * Find out if the message in the strbuf contains only whitespace and
995 * Signed-off-by lines.
997 static int message_is_empty(struct strbuf *sb)
999 if (cleanup_mode == CLEANUP_NONE && sb->len)
1001 return rest_is_empty(sb, 0);
1005 * See if the user edited the message in the editor or left what
1006 * was in the template intact
1008 static int template_untouched(struct strbuf *sb)
1010 struct strbuf tmpl = STRBUF_INIT;
1013 if (cleanup_mode == CLEANUP_NONE && sb->len)
1016 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
1019 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
1020 if (!skip_prefix(sb->buf, tmpl.buf, &start))
1022 strbuf_release(&tmpl);
1023 return rest_is_empty(sb, start - sb->buf);
1026 static const char *find_author_by_nickname(const char *name)
1028 struct rev_info revs;
1029 struct commit *commit;
1030 struct strbuf buf = STRBUF_INIT;
1031 struct string_list mailmap = STRING_LIST_INIT_NODUP;
1035 init_revisions(&revs, NULL);
1036 strbuf_addf(&buf, "--author=%s", name);
1041 setup_revisions(ac, av, &revs, NULL);
1042 revs.mailmap = &mailmap;
1043 read_mailmap(revs.mailmap, NULL);
1045 if (prepare_revision_walk(&revs))
1046 die(_("revision walk setup failed"));
1047 commit = get_revision(&revs);
1049 struct pretty_print_context ctx = {0};
1050 ctx.date_mode = DATE_NORMAL;
1051 strbuf_release(&buf);
1052 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
1053 clear_mailmap(&mailmap);
1054 return strbuf_detach(&buf, NULL);
1056 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name);
1060 static void handle_untracked_files_arg(struct wt_status *s)
1062 if (!untracked_files_arg)
1063 ; /* default already initialized */
1064 else if (!strcmp(untracked_files_arg, "no"))
1065 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1066 else if (!strcmp(untracked_files_arg, "normal"))
1067 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1068 else if (!strcmp(untracked_files_arg, "all"))
1069 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1071 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1074 static const char *read_commit_message(const char *name)
1076 const char *out_enc;
1077 struct commit *commit;
1079 commit = lookup_commit_reference_by_name(name);
1081 die(_("could not lookup commit %s"), name);
1082 out_enc = get_commit_output_encoding();
1083 return logmsg_reencode(commit, NULL, out_enc);
1087 * Enumerate what needs to be propagated when --porcelain
1088 * is not in effect here.
1090 static struct status_deferred_config {
1091 enum status_format status_format;
1093 } status_deferred_config = {
1094 STATUS_FORMAT_UNSPECIFIED,
1095 -1 /* unspecified */
1098 static void finalize_deferred_config(struct wt_status *s)
1100 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1101 !s->null_termination);
1103 if (s->null_termination) {
1104 if (status_format == STATUS_FORMAT_NONE ||
1105 status_format == STATUS_FORMAT_UNSPECIFIED)
1106 status_format = STATUS_FORMAT_PORCELAIN;
1107 else if (status_format == STATUS_FORMAT_LONG)
1108 die(_("--long and -z are incompatible"));
1111 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1112 status_format = status_deferred_config.status_format;
1113 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1114 status_format = STATUS_FORMAT_NONE;
1116 if (use_deferred_config && s->show_branch < 0)
1117 s->show_branch = status_deferred_config.show_branch;
1118 if (s->show_branch < 0)
1122 static int parse_and_validate_options(int argc, const char *argv[],
1123 const struct option *options,
1124 const char * const usage[],
1126 struct commit *current_head,
1127 struct wt_status *s)
1131 argc = parse_options(argc, argv, prefix, options, usage, 0);
1132 finalize_deferred_config(s);
1134 if (force_author && !strchr(force_author, '>'))
1135 force_author = find_author_by_nickname(force_author);
1137 if (force_author && renew_authorship)
1138 die(_("Using both --reset-author and --author does not make sense"));
1140 if (logfile || have_option_m || use_message || fixup_message)
1143 use_editor = edit_flag;
1145 /* Sanity check options */
1146 if (amend && !current_head)
1147 die(_("You have nothing to amend."));
1148 if (amend && whence != FROM_COMMIT) {
1149 if (whence == FROM_MERGE)
1150 die(_("You are in the middle of a merge -- cannot amend."));
1151 else if (whence == FROM_CHERRY_PICK)
1152 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1154 if (fixup_message && squash_message)
1155 die(_("Options --squash and --fixup cannot be used together"));
1165 die(_("Only one of -c/-C/-F/--fixup can be used."));
1166 if (message.len && f > 0)
1167 die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1168 if (f || message.len)
1169 template_file = NULL;
1171 use_message = edit_message;
1172 if (amend && !use_message && !fixup_message)
1173 use_message = "HEAD";
1174 if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1175 die(_("--reset-author can be used only with -C, -c or --amend."));
1177 use_message_buffer = read_commit_message(use_message);
1178 if (!renew_authorship) {
1179 author_message = use_message;
1180 author_message_buffer = use_message_buffer;
1183 if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1184 author_message = "CHERRY_PICK_HEAD";
1185 author_message_buffer = read_commit_message(author_message);
1188 if (patch_interactive)
1191 if (also + only + all + interactive > 1)
1192 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1193 if (argc == 0 && (also || (only && !amend)))
1194 die(_("No paths with --include/--only does not make sense."));
1195 if (argc == 0 && only && amend)
1196 only_include_assumed = _("Clever... amending the last one with dirty index.");
1197 if (argc > 0 && !also && !only)
1198 only_include_assumed = _("Explicit paths specified without -i or -o; assuming --only paths...");
1199 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1200 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
1201 else if (!strcmp(cleanup_arg, "verbatim"))
1202 cleanup_mode = CLEANUP_NONE;
1203 else if (!strcmp(cleanup_arg, "whitespace"))
1204 cleanup_mode = CLEANUP_SPACE;
1205 else if (!strcmp(cleanup_arg, "strip"))
1206 cleanup_mode = CLEANUP_ALL;
1207 else if (!strcmp(cleanup_arg, "scissors"))
1208 cleanup_mode = use_editor ? CLEANUP_SCISSORS : CLEANUP_SPACE;
1210 die(_("Invalid cleanup mode %s"), cleanup_arg);
1212 handle_untracked_files_arg(s);
1214 if (all && argc > 0)
1215 die(_("Paths with -a does not make sense."));
1217 if (status_format != STATUS_FORMAT_NONE)
1223 static int dry_run_commit(int argc, const char **argv, const char *prefix,
1224 const struct commit *current_head, struct wt_status *s)
1227 const char *index_file;
1229 index_file = prepare_index(argc, argv, prefix, current_head, 1);
1230 commitable = run_status(stdout, index_file, prefix, 0, s);
1231 rollback_index_files();
1233 return commitable ? 0 : 1;
1236 static int parse_status_slot(const char *slot)
1238 if (!strcasecmp(slot, "header"))
1239 return WT_STATUS_HEADER;
1240 if (!strcasecmp(slot, "branch"))
1241 return WT_STATUS_ONBRANCH;
1242 if (!strcasecmp(slot, "updated") || !strcasecmp(slot, "added"))
1243 return WT_STATUS_UPDATED;
1244 if (!strcasecmp(slot, "changed"))
1245 return WT_STATUS_CHANGED;
1246 if (!strcasecmp(slot, "untracked"))
1247 return WT_STATUS_UNTRACKED;
1248 if (!strcasecmp(slot, "nobranch"))
1249 return WT_STATUS_NOBRANCH;
1250 if (!strcasecmp(slot, "unmerged"))
1251 return WT_STATUS_UNMERGED;
1255 static int git_status_config(const char *k, const char *v, void *cb)
1257 struct wt_status *s = cb;
1258 const char *slot_name;
1260 if (starts_with(k, "column."))
1261 return git_column_config(k, v, "status", &s->colopts);
1262 if (!strcmp(k, "status.submodulesummary")) {
1264 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1265 if (is_bool && s->submodule_summary)
1266 s->submodule_summary = -1;
1269 if (!strcmp(k, "status.short")) {
1270 if (git_config_bool(k, v))
1271 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1273 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1276 if (!strcmp(k, "status.branch")) {
1277 status_deferred_config.show_branch = git_config_bool(k, v);
1280 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1281 s->use_color = git_config_colorbool(k, v);
1284 if (!strcmp(k, "status.displaycommentprefix")) {
1285 s->display_comment_prefix = git_config_bool(k, v);
1288 if (skip_prefix(k, "status.color.", &slot_name) ||
1289 skip_prefix(k, "color.status.", &slot_name)) {
1290 int slot = parse_status_slot(slot_name);
1294 return config_error_nonbool(k);
1295 return color_parse(v, s->color_palette[slot]);
1297 if (!strcmp(k, "status.relativepaths")) {
1298 s->relative_paths = git_config_bool(k, v);
1301 if (!strcmp(k, "status.showuntrackedfiles")) {
1303 return config_error_nonbool(k);
1304 else if (!strcmp(v, "no"))
1305 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1306 else if (!strcmp(v, "normal"))
1307 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1308 else if (!strcmp(v, "all"))
1309 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1311 return error(_("Invalid untracked files mode '%s'"), v);
1314 return git_diff_ui_config(k, v, NULL);
1317 int cmd_status(int argc, const char **argv, const char *prefix)
1319 static struct wt_status s;
1321 unsigned char sha1[20];
1322 static struct option builtin_status_options[] = {
1323 OPT__VERBOSE(&verbose, N_("be verbose")),
1324 OPT_SET_INT('s', "short", &status_format,
1325 N_("show status concisely"), STATUS_FORMAT_SHORT),
1326 OPT_BOOL('b', "branch", &s.show_branch,
1327 N_("show branch information")),
1328 OPT_SET_INT(0, "porcelain", &status_format,
1329 N_("machine-readable output"),
1330 STATUS_FORMAT_PORCELAIN),
1331 OPT_SET_INT(0, "long", &status_format,
1332 N_("show status in long format (default)"),
1333 STATUS_FORMAT_LONG),
1334 OPT_BOOL('z', "null", &s.null_termination,
1335 N_("terminate entries with NUL")),
1336 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1338 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1339 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1340 OPT_BOOL(0, "ignored", &show_ignored_in_status,
1341 N_("show ignored files")),
1342 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1343 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1344 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1345 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1349 if (argc == 2 && !strcmp(argv[1], "-h"))
1350 usage_with_options(builtin_status_usage, builtin_status_options);
1352 status_init_config(&s, git_status_config);
1353 argc = parse_options(argc, argv, prefix,
1354 builtin_status_options,
1355 builtin_status_usage, 0);
1356 finalize_colopts(&s.colopts, -1);
1357 finalize_deferred_config(&s);
1359 handle_untracked_files_arg(&s);
1360 if (show_ignored_in_status)
1361 s.show_ignored_files = 1;
1362 parse_pathspec(&s.pathspec, 0,
1363 PATHSPEC_PREFER_FULL,
1366 read_cache_preload(&s.pathspec);
1367 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &s.pathspec, NULL, NULL);
1369 fd = hold_locked_index(&index_lock, 0);
1371 s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1372 s.ignore_submodule_arg = ignore_submodule_arg;
1373 wt_status_collect(&s);
1376 update_index_if_able(&the_index, &index_lock);
1378 if (s.relative_paths)
1381 switch (status_format) {
1382 case STATUS_FORMAT_SHORT:
1383 wt_shortstatus_print(&s);
1385 case STATUS_FORMAT_PORCELAIN:
1386 wt_porcelain_print(&s);
1388 case STATUS_FORMAT_UNSPECIFIED:
1389 die("BUG: finalize_deferred_config() should have been called");
1391 case STATUS_FORMAT_NONE:
1392 case STATUS_FORMAT_LONG:
1393 s.verbose = verbose;
1394 s.ignore_submodule_arg = ignore_submodule_arg;
1395 wt_status_print(&s);
1401 static const char *implicit_ident_advice(void)
1403 char *user_config = expand_user_path("~/.gitconfig");
1404 char *xdg_config = xdg_config_home("config");
1405 int config_exists = file_exists(user_config) || file_exists(xdg_config);
1411 return _(implicit_ident_advice_config);
1413 return _(implicit_ident_advice_noconfig);
1417 static void print_summary(const char *prefix, const unsigned char *sha1,
1420 struct rev_info rev;
1421 struct commit *commit;
1422 struct strbuf format = STRBUF_INIT;
1423 unsigned char junk_sha1[20];
1425 struct pretty_print_context pctx = {0};
1426 struct strbuf author_ident = STRBUF_INIT;
1427 struct strbuf committer_ident = STRBUF_INIT;
1429 commit = lookup_commit(sha1);
1431 die(_("couldn't look up newly created commit"));
1432 if (parse_commit(commit))
1433 die(_("could not parse newly created commit"));
1435 strbuf_addstr(&format, "format:%h] %s");
1437 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1438 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1439 if (strbuf_cmp(&author_ident, &committer_ident)) {
1440 strbuf_addstr(&format, "\n Author: ");
1441 strbuf_addbuf_percentquote(&format, &author_ident);
1443 if (author_date_is_interesting()) {
1444 struct strbuf date = STRBUF_INIT;
1445 format_commit_message(commit, "%ad", &date, &pctx);
1446 strbuf_addstr(&format, "\n Date: ");
1447 strbuf_addbuf_percentquote(&format, &date);
1448 strbuf_release(&date);
1450 if (!committer_ident_sufficiently_given()) {
1451 strbuf_addstr(&format, "\n Committer: ");
1452 strbuf_addbuf_percentquote(&format, &committer_ident);
1453 if (advice_implicit_identity) {
1454 strbuf_addch(&format, '\n');
1455 strbuf_addstr(&format, implicit_ident_advice());
1458 strbuf_release(&author_ident);
1459 strbuf_release(&committer_ident);
1461 init_revisions(&rev, prefix);
1462 setup_revisions(0, NULL, &rev, NULL);
1465 rev.diffopt.output_format =
1466 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1468 rev.verbose_header = 1;
1469 rev.show_root_diff = 1;
1470 get_commit_format(format.buf, &rev);
1471 rev.always_show_header = 0;
1472 rev.diffopt.detect_rename = 1;
1473 rev.diffopt.break_opt = 0;
1474 diff_setup_done(&rev.diffopt);
1476 head = resolve_ref_unsafe("HEAD", 0, junk_sha1, NULL);
1477 if (!strcmp(head, "HEAD"))
1478 head = _("detached HEAD");
1480 skip_prefix(head, "refs/heads/", &head);
1481 printf("[%s%s ", head, initial_commit ? _(" (root-commit)") : "");
1483 if (!log_tree_commit(&rev, commit)) {
1484 rev.always_show_header = 1;
1485 rev.use_terminator = 1;
1486 log_tree_commit(&rev, commit);
1489 strbuf_release(&format);
1492 static int git_commit_config(const char *k, const char *v, void *cb)
1494 struct wt_status *s = cb;
1497 if (!strcmp(k, "commit.template"))
1498 return git_config_pathname(&template_file, k, v);
1499 if (!strcmp(k, "commit.status")) {
1500 include_status = git_config_bool(k, v);
1503 if (!strcmp(k, "commit.cleanup"))
1504 return git_config_string(&cleanup_arg, k, v);
1505 if (!strcmp(k, "commit.gpgsign")) {
1506 sign_commit = git_config_bool(k, v) ? "" : NULL;
1510 status = git_gpg_config(k, v, NULL);
1513 return git_status_config(k, v, s);
1516 int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...)
1518 const char *hook_env[3] = { NULL };
1519 char index[PATH_MAX];
1523 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
1524 hook_env[0] = index;
1527 * Let the hook know that no editor will be launched.
1529 if (!editor_is_used)
1530 hook_env[1] = "GIT_EDITOR=:";
1532 va_start(args, name);
1533 ret = run_hook_ve(hook_env, name, args);
1539 int cmd_commit(int argc, const char **argv, const char *prefix)
1541 static struct wt_status s;
1542 static struct option builtin_commit_options[] = {
1543 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1544 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1546 OPT_GROUP(N_("Commit message options")),
1547 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1548 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1549 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1550 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1551 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1552 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1553 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1554 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1555 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1556 OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1557 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1558 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1559 OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
1560 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1561 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
1562 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1563 /* end commit message options */
1565 OPT_GROUP(N_("Commit contents options")),
1566 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1567 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1568 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1569 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1570 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1571 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit hook")),
1572 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1573 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1574 STATUS_FORMAT_SHORT),
1575 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1576 OPT_SET_INT(0, "porcelain", &status_format,
1577 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1578 OPT_SET_INT(0, "long", &status_format,
1579 N_("show status in long format (default)"),
1580 STATUS_FORMAT_LONG),
1581 OPT_BOOL('z', "null", &s.null_termination,
1582 N_("terminate entries with NUL")),
1583 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1584 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1585 { 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" },
1586 /* end commit contents options */
1588 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1589 N_("ok to record an empty change")),
1590 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1591 N_("ok to record a change with an empty message")),
1596 struct strbuf sb = STRBUF_INIT;
1597 struct strbuf author_ident = STRBUF_INIT;
1598 const char *index_file, *reflog_msg;
1600 unsigned char sha1[20];
1601 struct commit_list *parents = NULL, **pptr = &parents;
1602 struct stat statbuf;
1603 struct commit *current_head = NULL;
1604 struct commit_extra_header *extra = NULL;
1605 struct ref_transaction *transaction;
1606 struct strbuf err = STRBUF_INIT;
1608 if (argc == 2 && !strcmp(argv[1], "-h"))
1609 usage_with_options(builtin_commit_usage, builtin_commit_options);
1611 status_init_config(&s, git_commit_config);
1612 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1615 if (get_sha1("HEAD", sha1))
1616 current_head = NULL;
1618 current_head = lookup_commit_or_die(sha1, "HEAD");
1619 if (parse_commit(current_head))
1620 die(_("could not parse HEAD commit"));
1622 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1623 builtin_commit_usage,
1624 prefix, current_head, &s);
1626 return dry_run_commit(argc, argv, prefix, current_head, &s);
1627 index_file = prepare_index(argc, argv, prefix, current_head, 0);
1629 /* Set up everything for writing the commit object. This includes
1630 running hooks, writing the trees, and interacting with the user. */
1631 if (!prepare_to_commit(index_file, prefix,
1632 current_head, &s, &author_ident)) {
1633 rollback_index_files();
1637 /* Determine parents */
1638 reflog_msg = getenv("GIT_REFLOG_ACTION");
1639 if (!current_head) {
1641 reflog_msg = "commit (initial)";
1643 struct commit_list *c;
1646 reflog_msg = "commit (amend)";
1647 for (c = current_head->parents; c; c = c->next)
1648 pptr = &commit_list_insert(c->item, pptr)->next;
1649 } else if (whence == FROM_MERGE) {
1650 struct strbuf m = STRBUF_INIT;
1652 int allow_fast_forward = 1;
1655 reflog_msg = "commit (merge)";
1656 pptr = &commit_list_insert(current_head, pptr)->next;
1657 fp = fopen(git_path("MERGE_HEAD"), "r");
1659 die_errno(_("could not open '%s' for reading"),
1660 git_path("MERGE_HEAD"));
1661 while (strbuf_getline(&m, fp, '\n') != EOF) {
1662 struct commit *parent;
1664 parent = get_merge_parent(m.buf);
1666 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1667 pptr = &commit_list_insert(parent, pptr)->next;
1671 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1672 if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1673 die_errno(_("could not read MERGE_MODE"));
1674 if (!strcmp(sb.buf, "no-ff"))
1675 allow_fast_forward = 0;
1677 if (allow_fast_forward)
1678 parents = reduce_heads(parents);
1681 reflog_msg = (whence == FROM_CHERRY_PICK)
1682 ? "commit (cherry-pick)"
1684 pptr = &commit_list_insert(current_head, pptr)->next;
1687 /* Finally, get the commit message */
1689 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1690 int saved_errno = errno;
1691 rollback_index_files();
1692 die(_("could not read commit message: %s"), strerror(saved_errno));
1695 if (verbose || /* Truncate the message just before the diff, if any. */
1696 cleanup_mode == CLEANUP_SCISSORS)
1697 wt_status_truncate_message_at_cut_line(&sb);
1699 if (cleanup_mode != CLEANUP_NONE)
1700 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1701 if (template_untouched(&sb) && !allow_empty_message) {
1702 rollback_index_files();
1703 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1706 if (message_is_empty(&sb) && !allow_empty_message) {
1707 rollback_index_files();
1708 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1713 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1714 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1716 struct commit_extra_header **tail = &extra;
1717 append_merge_tag_headers(parents, &tail);
1720 if (commit_tree_extended(sb.buf, sb.len, active_cache_tree->sha1,
1721 parents, sha1, author_ident.buf, sign_commit, extra)) {
1722 rollback_index_files();
1723 die(_("failed to write commit object"));
1725 strbuf_release(&author_ident);
1726 free_commit_extra_headers(extra);
1728 nl = strchr(sb.buf, '\n');
1730 strbuf_setlen(&sb, nl + 1 - sb.buf);
1732 strbuf_addch(&sb, '\n');
1733 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1734 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1736 transaction = ref_transaction_begin(&err);
1738 ref_transaction_update(transaction, "HEAD", sha1,
1740 ? current_head->object.sha1 : null_sha1,
1742 ref_transaction_commit(transaction, &err)) {
1743 rollback_index_files();
1746 ref_transaction_free(transaction);
1748 unlink(git_path("CHERRY_PICK_HEAD"));
1749 unlink(git_path("REVERT_HEAD"));
1750 unlink(git_path("MERGE_HEAD"));
1751 unlink(git_path("MERGE_MSG"));
1752 unlink(git_path("MERGE_MODE"));
1753 unlink(git_path("SQUASH_MSG"));
1755 if (commit_index_files())
1756 die (_("Repository has been updated, but unable to write\n"
1757 "new_index file. Check that disk is not full and quota is\n"
1758 "not exceeded, and then \"git reset HEAD\" to recover."));
1761 run_commit_hook(use_editor, get_index_file(), "post-commit", NULL);
1762 if (amend && !no_post_rewrite) {
1763 struct rewritten rewrite;
1764 memset(&rewrite, 0, sizeof(rewrite));
1765 add_rewritten(&rewrite, current_head->object.sha1, sha1);
1766 copy_rewrite_notes(&rewrite, "amend", "Notes added by 'git commit --amend'");
1767 run_rewrite_hook(&rewrite, "amend");
1770 print_summary(prefix, sha1, !current_head);
1772 strbuf_release(&err);