4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
11 #include "cache-tree.h"
19 #include "wt-status.h"
20 #include "run-command.h"
25 #include "parse-options.h"
26 #include "string-list.h"
28 #include "unpack-trees.h"
30 #include "submodule.h"
31 #include "gpg-interface.h"
33 #include "sequencer.h"
34 #include "notes-utils.h"
38 static const char * const builtin_commit_usage[] = {
39 N_("git commit [<options>] [--] <pathspec>..."),
43 static const char * const builtin_status_usage[] = {
44 N_("git status [<options>] [--] <pathspec>..."),
48 static const char implicit_ident_advice_noconfig[] =
49 N_("Your name and email address were configured automatically based\n"
50 "on your username and hostname. Please check that they are accurate.\n"
51 "You can suppress this message by setting them explicitly. Run the\n"
52 "following command and follow the instructions in your editor to edit\n"
53 "your configuration file:\n"
55 " git config --global --edit\n"
57 "After doing this, you may fix the identity used for this commit with:\n"
59 " git commit --amend --reset-author\n");
61 static const char implicit_ident_advice_config[] =
62 N_("Your name and email address were configured automatically based\n"
63 "on your username and hostname. Please check that they are accurate.\n"
64 "You can suppress this message by setting them explicitly:\n"
66 " git config --global user.name \"Your Name\"\n"
67 " git config --global user.email you@example.com\n"
69 "After doing this, you may fix the identity used for this commit with:\n"
71 " git commit --amend --reset-author\n");
73 static const char empty_amend_advice[] =
74 N_("You asked to amend the most recent commit, but doing so would make\n"
75 "it empty. You can repeat your command with --allow-empty, or you can\n"
76 "remove the commit entirely with \"git reset HEAD^\".\n");
78 static const char empty_cherry_pick_advice[] =
79 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
80 "If you wish to commit it anyway, use:\n"
82 " git commit --allow-empty\n"
85 static const char empty_cherry_pick_advice_single[] =
86 N_("Otherwise, please use 'git reset'\n");
88 static const char empty_cherry_pick_advice_multi[] =
89 N_("If you wish to skip this commit, use:\n"
93 "Then \"git cherry-pick --continue\" will resume cherry-picking\n"
94 "the remaining commits.\n");
96 static GIT_PATH_FUNC(git_path_commit_editmsg, "COMMIT_EDITMSG")
98 static const char *use_message_buffer;
99 static struct lock_file index_lock; /* real index */
100 static struct lock_file false_lock; /* used only for partial commits */
107 static const char *logfile, *force_author;
108 static const char *template_file;
110 * The _message variables are commit names from which to take
111 * the commit message and/or authorship.
113 static const char *author_message, *author_message_buffer;
114 static char *edit_message, *use_message;
115 static char *fixup_message, *squash_message;
116 static int all, also, interactive, patch_interactive, only, amend, signoff;
117 static int edit_flag = -1; /* unspecified */
118 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
119 static int config_commit_verbose = -1; /* unspecified */
120 static int no_post_rewrite, allow_empty_message;
121 static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
122 static char *sign_commit;
125 * The default commit message cleanup mode will remove the lines
126 * beginning with # (shell comments) and leading and trailing
127 * whitespaces (empty lines or containing only whitespaces)
128 * if editor is used, and only the whitespaces if the message
129 * is specified explicitly.
137 static const char *cleanup_arg;
139 static enum commit_whence whence;
140 static int sequencer_in_use;
141 static int use_editor = 1, include_status = 1;
142 static int show_ignored_in_status, have_option_m;
143 static const char *only_include_assumed;
144 static struct strbuf message = STRBUF_INIT;
146 static enum wt_status_format status_format = STATUS_FORMAT_UNSPECIFIED;
148 static int opt_parse_porcelain(const struct option *opt, const char *arg, int unset)
150 enum wt_status_format *value = (enum wt_status_format *)opt->value;
152 *value = STATUS_FORMAT_NONE;
154 *value = STATUS_FORMAT_PORCELAIN;
155 else if (!strcmp(arg, "v1") || !strcmp(arg, "1"))
156 *value = STATUS_FORMAT_PORCELAIN;
157 else if (!strcmp(arg, "v2") || !strcmp(arg, "2"))
158 *value = STATUS_FORMAT_PORCELAIN_V2;
160 die("unsupported porcelain version '%s'", arg);
165 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
167 struct strbuf *buf = opt->value;
170 strbuf_setlen(buf, 0);
174 strbuf_addch(buf, '\n');
175 strbuf_addstr(buf, arg);
176 strbuf_complete_line(buf);
181 static void determine_whence(struct wt_status *s)
183 if (file_exists(git_path_merge_head()))
185 else if (file_exists(git_path_cherry_pick_head())) {
186 whence = FROM_CHERRY_PICK;
187 if (file_exists(git_path_seq_dir()))
188 sequencer_in_use = 1;
191 whence = FROM_COMMIT;
196 static void status_init_config(struct wt_status *s, config_fn_t fn)
198 wt_status_prepare(s);
202 init_diff_ui_defaults();
203 s->hints = advice_status_hints; /* must come after git_config() */
206 static void rollback_index_files(void)
208 switch (commit_style) {
210 break; /* nothing to do */
212 rollback_lock_file(&index_lock);
215 rollback_lock_file(&index_lock);
216 rollback_lock_file(&false_lock);
221 static int commit_index_files(void)
225 switch (commit_style) {
227 break; /* nothing to do */
229 err = commit_lock_file(&index_lock);
232 err = commit_lock_file(&index_lock);
233 rollback_lock_file(&false_lock);
241 * Take a union of paths in the index and the named tree (typically, "HEAD"),
242 * and return the paths that match the given pattern in list.
244 static int list_paths(struct string_list *list, const char *with_tree,
245 const char *prefix, const struct pathspec *pattern)
253 m = xcalloc(1, pattern->nr);
256 char *max_prefix = common_prefix(pattern);
257 overlay_tree_on_cache(with_tree, max_prefix ? max_prefix : prefix);
261 for (i = 0; i < active_nr; i++) {
262 const struct cache_entry *ce = active_cache[i];
263 struct string_list_item *item;
265 if (ce->ce_flags & CE_UPDATE)
267 if (!ce_path_match(ce, pattern, m))
269 item = string_list_insert(list, ce->name);
270 if (ce_skip_worktree(ce))
271 item->util = item; /* better a valid pointer than a fake one */
274 ret = report_path_error(m, pattern, prefix);
279 static void add_remove_files(struct string_list *list)
282 for (i = 0; i < list->nr; i++) {
284 struct string_list_item *p = &(list->items[i]);
286 /* p->util is skip-worktree */
290 if (!lstat(p->string, &st)) {
291 if (add_to_cache(p->string, &st, 0))
292 die(_("updating files failed"));
294 remove_file_from_cache(p->string);
298 static void create_base_index(const struct commit *current_head)
301 struct unpack_trees_options opts;
309 memset(&opts, 0, sizeof(opts));
313 opts.src_index = &the_index;
314 opts.dst_index = &the_index;
316 opts.fn = oneway_merge;
317 tree = parse_tree_indirect(current_head->object.oid.hash);
319 die(_("failed to unpack HEAD tree object"));
321 init_tree_desc(&t, tree->buffer, tree->size);
322 if (unpack_trees(1, &t, &opts))
323 exit(128); /* We've already reported the error, finish dying */
326 static void refresh_cache_or_die(int refresh_flags)
329 * refresh_flags contains REFRESH_QUIET, so the only errors
330 * are for unmerged entries.
332 if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
333 die_resolve_conflict("commit");
336 static const char *prepare_index(int argc, const char **argv, const char *prefix,
337 const struct commit *current_head, int is_status)
339 struct string_list partial;
340 struct pathspec pathspec;
341 int refresh_flags = REFRESH_QUIET;
345 refresh_flags |= REFRESH_UNMERGED;
346 parse_pathspec(&pathspec, 0,
347 PATHSPEC_PREFER_FULL,
350 if (read_cache_preload(&pathspec) < 0)
351 die(_("index file corrupt"));
354 char *old_index_env = NULL;
355 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
357 refresh_cache_or_die(refresh_flags);
359 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
360 die(_("unable to create temporary index"));
362 old_index_env = getenv(INDEX_ENVIRONMENT);
363 setenv(INDEX_ENVIRONMENT, get_lock_file_path(&index_lock), 1);
365 if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
366 die(_("interactive add failed"));
368 if (old_index_env && *old_index_env)
369 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
371 unsetenv(INDEX_ENVIRONMENT);
374 read_cache_from(get_lock_file_path(&index_lock));
375 if (update_main_cache_tree(WRITE_TREE_SILENT) == 0) {
376 if (reopen_lock_file(&index_lock) < 0)
377 die(_("unable to write index file"));
378 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
379 die(_("unable to update temporary index"));
381 warning(_("Failed to update main cache tree"));
383 commit_style = COMMIT_NORMAL;
384 return get_lock_file_path(&index_lock);
388 * Non partial, non as-is commit.
390 * (1) get the real index;
391 * (2) update the_index as necessary;
392 * (3) write the_index out to the real index (still locked);
393 * (4) return the name of the locked index file.
395 * The caller should run hooks on the locked real index, and
396 * (A) if all goes well, commit the real index;
397 * (B) on failure, rollback the real index.
399 if (all || (also && pathspec.nr)) {
400 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
401 add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
402 refresh_cache_or_die(refresh_flags);
403 update_main_cache_tree(WRITE_TREE_SILENT);
404 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
405 die(_("unable to write new_index file"));
406 commit_style = COMMIT_NORMAL;
407 return get_lock_file_path(&index_lock);
413 * (1) return the name of the real index file.
415 * The caller should run hooks on the real index,
416 * and create commit from the_index.
417 * We still need to refresh the index here.
419 if (!only && !pathspec.nr) {
420 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
421 refresh_cache_or_die(refresh_flags);
422 if (active_cache_changed
423 || !cache_tree_fully_valid(active_cache_tree))
424 update_main_cache_tree(WRITE_TREE_SILENT);
425 if (active_cache_changed) {
426 if (write_locked_index(&the_index, &index_lock,
428 die(_("unable to write new_index file"));
430 rollback_lock_file(&index_lock);
432 commit_style = COMMIT_AS_IS;
433 return get_index_file();
439 * (0) find the set of affected paths;
440 * (1) get lock on the real index file;
441 * (2) update the_index with the given paths;
442 * (3) write the_index out to the real index (still locked);
443 * (4) get lock on the false index file;
444 * (5) reset the_index from HEAD;
445 * (6) update the_index the same way as (2);
446 * (7) write the_index out to the false index file;
447 * (8) return the name of the false index file (still locked);
449 * The caller should run hooks on the locked false index, and
450 * create commit from it. Then
451 * (A) if all goes well, commit the real index;
452 * (B) on failure, rollback the real index;
453 * In either case, rollback the false index.
455 commit_style = COMMIT_PARTIAL;
457 if (whence != FROM_COMMIT) {
458 if (whence == FROM_MERGE)
459 die(_("cannot do a partial commit during a merge."));
460 else if (whence == FROM_CHERRY_PICK)
461 die(_("cannot do a partial commit during a cherry-pick."));
464 string_list_init(&partial, 1);
465 if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, &pathspec))
469 if (read_cache() < 0)
470 die(_("cannot read the index"));
472 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
473 add_remove_files(&partial);
474 refresh_cache(REFRESH_QUIET);
475 update_main_cache_tree(WRITE_TREE_SILENT);
476 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
477 die(_("unable to write new_index file"));
479 hold_lock_file_for_update(&false_lock,
480 git_path("next-index-%"PRIuMAX,
481 (uintmax_t) getpid()),
484 create_base_index(current_head);
485 add_remove_files(&partial);
486 refresh_cache(REFRESH_QUIET);
488 if (write_locked_index(&the_index, &false_lock, CLOSE_LOCK))
489 die(_("unable to write temporary index file"));
492 ret = get_lock_file_path(&false_lock);
493 read_cache_from(ret);
497 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
500 struct object_id oid;
502 if (s->relative_paths)
507 s->reference = "HEAD^1";
509 s->verbose = verbose;
510 s->index_file = index_file;
513 s->is_initial = get_sha1(s->reference, oid.hash) ? 1 : 0;
515 hashcpy(s->sha1_commit, oid.hash);
516 s->status_format = status_format;
517 s->ignore_submodule_arg = ignore_submodule_arg;
519 wt_status_collect(s);
522 return s->commitable;
525 static int is_a_merge(const struct commit *current_head)
527 return !!(current_head->parents && current_head->parents->next);
530 static void assert_split_ident(struct ident_split *id, const struct strbuf *buf)
532 if (split_ident_line(id, buf->buf, buf->len) || !id->date_begin)
533 die("BUG: unable to parse our own ident: %s", buf->buf);
536 static void export_one(const char *var, const char *s, const char *e, int hack)
538 struct strbuf buf = STRBUF_INIT;
540 strbuf_addch(&buf, hack);
541 strbuf_addf(&buf, "%.*s", (int)(e - s), s);
542 setenv(var, buf.buf, 1);
543 strbuf_release(&buf);
546 static int parse_force_date(const char *in, struct strbuf *out)
548 strbuf_addch(out, '@');
550 if (parse_date(in, out) < 0) {
552 unsigned long t = approxidate_careful(in, &errors);
555 strbuf_addf(out, "%lu", t);
561 static void set_ident_var(char **buf, char *val)
567 static void determine_author_info(struct strbuf *author_ident)
569 char *name, *email, *date;
570 struct ident_split author;
572 name = xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
573 email = xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
574 date = xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
576 if (author_message) {
577 struct ident_split ident;
581 a = find_commit_header(author_message_buffer, "author", &len);
583 die(_("commit '%s' lacks author header"), author_message);
584 if (split_ident_line(&ident, a, len) < 0)
585 die(_("commit '%s' has malformed author line"), author_message);
587 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
588 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
590 if (ident.date_begin) {
591 struct strbuf date_buf = STRBUF_INIT;
592 strbuf_addch(&date_buf, '@');
593 strbuf_add(&date_buf, ident.date_begin, ident.date_end - ident.date_begin);
594 strbuf_addch(&date_buf, ' ');
595 strbuf_add(&date_buf, ident.tz_begin, ident.tz_end - ident.tz_begin);
596 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
601 struct ident_split ident;
603 if (split_ident_line(&ident, force_author, strlen(force_author)) < 0)
604 die(_("malformed --author parameter"));
605 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
606 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
610 struct strbuf date_buf = STRBUF_INIT;
611 if (parse_force_date(force_date, &date_buf))
612 die(_("invalid date format: %s"), force_date);
613 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
616 strbuf_addstr(author_ident, fmt_ident(name, email, date, IDENT_STRICT));
617 assert_split_ident(&author, author_ident);
618 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
619 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
620 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
626 static int author_date_is_interesting(void)
628 return author_message || force_date;
631 static void adjust_comment_line_char(const struct strbuf *sb)
633 char candidates[] = "#;@!$%^&|:";
637 comment_line_char = candidates[0];
638 if (!memchr(sb->buf, comment_line_char, sb->len))
642 candidate = strchr(candidates, *p);
645 for (p = sb->buf; *p; p++) {
646 if ((p[0] == '\n' || p[0] == '\r') && p[1]) {
647 candidate = strchr(candidates, p[1]);
653 for (p = candidates; *p == ' '; p++)
656 die(_("unable to select a comment character that is not used\n"
657 "in the current commit message"));
658 comment_line_char = *p;
661 static int prepare_to_commit(const char *index_file, const char *prefix,
662 struct commit *current_head,
664 struct strbuf *author_ident)
667 struct strbuf committer_ident = STRBUF_INIT;
669 struct strbuf sb = STRBUF_INIT;
670 const char *hook_arg1 = NULL;
671 const char *hook_arg2 = NULL;
672 int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
673 int old_display_comment_prefix;
675 /* This checks and barfs if author is badly specified */
676 determine_author_info(author_ident);
678 if (!no_verify && run_commit_hook(use_editor, index_file, "pre-commit", NULL))
681 if (squash_message) {
683 * Insert the proper subject line before other commit
684 * message options add their content.
686 if (use_message && !strcmp(use_message, squash_message))
687 strbuf_addstr(&sb, "squash! ");
689 struct pretty_print_context ctx = {0};
691 c = lookup_commit_reference_by_name(squash_message);
693 die(_("could not lookup commit %s"), squash_message);
694 ctx.output_encoding = get_commit_output_encoding();
695 format_commit_message(c, "squash! %s\n\n", &sb,
701 strbuf_addbuf(&sb, &message);
702 hook_arg1 = "message";
703 } else if (logfile && !strcmp(logfile, "-")) {
705 fprintf(stderr, _("(reading log message from standard input)\n"));
706 if (strbuf_read(&sb, 0, 0) < 0)
707 die_errno(_("could not read log from standard input"));
708 hook_arg1 = "message";
709 } else if (logfile) {
710 if (strbuf_read_file(&sb, logfile, 0) < 0)
711 die_errno(_("could not read log file '%s'"),
713 hook_arg1 = "message";
714 } else if (use_message) {
716 buffer = strstr(use_message_buffer, "\n\n");
718 strbuf_addstr(&sb, skip_blank_lines(buffer + 2));
719 hook_arg1 = "commit";
720 hook_arg2 = use_message;
721 } else if (fixup_message) {
722 struct pretty_print_context ctx = {0};
723 struct commit *commit;
724 commit = lookup_commit_reference_by_name(fixup_message);
726 die(_("could not lookup commit %s"), fixup_message);
727 ctx.output_encoding = get_commit_output_encoding();
728 format_commit_message(commit, "fixup! %s\n\n",
730 hook_arg1 = "message";
731 } else if (!stat(git_path_merge_msg(), &statbuf)) {
733 * prepend SQUASH_MSG here if it exists and a
734 * "merge --squash" was originally performed
736 if (!stat(git_path_squash_msg(), &statbuf)) {
737 if (strbuf_read_file(&sb, git_path_squash_msg(), 0) < 0)
738 die_errno(_("could not read SQUASH_MSG"));
739 hook_arg1 = "squash";
742 if (strbuf_read_file(&sb, git_path_merge_msg(), 0) < 0)
743 die_errno(_("could not read MERGE_MSG"));
744 } else if (!stat(git_path_squash_msg(), &statbuf)) {
745 if (strbuf_read_file(&sb, git_path_squash_msg(), 0) < 0)
746 die_errno(_("could not read SQUASH_MSG"));
747 hook_arg1 = "squash";
748 } else if (template_file) {
749 if (strbuf_read_file(&sb, template_file, 0) < 0)
750 die_errno(_("could not read '%s'"), template_file);
751 hook_arg1 = "template";
752 clean_message_contents = 0;
756 * The remaining cases don't modify the template message, but
757 * just set the argument(s) to the prepare-commit-msg hook.
759 else if (whence == FROM_MERGE)
761 else if (whence == FROM_CHERRY_PICK) {
762 hook_arg1 = "commit";
763 hook_arg2 = "CHERRY_PICK_HEAD";
766 if (squash_message) {
768 * If squash_commit was used for the commit subject,
769 * then we're possibly hijacking other commit log options.
770 * Reset the hook args to tell the real story.
772 hook_arg1 = "message";
776 s->fp = fopen_for_writing(git_path_commit_editmsg());
778 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
780 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
781 old_display_comment_prefix = s->display_comment_prefix;
782 s->display_comment_prefix = 1;
785 * Most hints are counter-productive when the commit has
790 if (clean_message_contents)
791 strbuf_stripspace(&sb, 0);
794 append_signoff(&sb, ignore_non_trailer(sb.buf, sb.len), 0);
796 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
797 die_errno(_("could not write commit template"));
799 if (auto_comment_line_char)
800 adjust_comment_line_char(&sb);
803 /* This checks if committer ident is explicitly given */
804 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
805 if (use_editor && include_status) {
807 int saved_color_setting;
808 struct ident_split ci, ai;
810 if (whence != FROM_COMMIT) {
811 if (cleanup_mode == CLEANUP_SCISSORS)
812 wt_status_add_cut_line(s->fp);
813 status_printf_ln(s, GIT_COLOR_NORMAL,
816 "It looks like you may be committing a merge.\n"
817 "If this is not correct, please remove the file\n"
821 "It looks like you may be committing a cherry-pick.\n"
822 "If this is not correct, please remove the file\n"
825 whence == FROM_MERGE ?
826 git_path_merge_head() :
827 git_path_cherry_pick_head());
830 fprintf(s->fp, "\n");
831 if (cleanup_mode == CLEANUP_ALL)
832 status_printf(s, GIT_COLOR_NORMAL,
833 _("Please enter the commit message for your changes."
834 " Lines starting\nwith '%c' will be ignored, and an empty"
835 " message aborts the commit.\n"), comment_line_char);
836 else if (cleanup_mode == CLEANUP_SCISSORS && whence == FROM_COMMIT)
837 wt_status_add_cut_line(s->fp);
838 else /* CLEANUP_SPACE, that is. */
839 status_printf(s, GIT_COLOR_NORMAL,
840 _("Please enter the commit message for your changes."
842 "with '%c' will be kept; you may remove them"
843 " yourself if you want to.\n"
844 "An empty message aborts the commit.\n"), comment_line_char);
845 if (only_include_assumed)
846 status_printf_ln(s, GIT_COLOR_NORMAL,
847 "%s", only_include_assumed);
850 * These should never fail because they come from our own
851 * fmt_ident. They may fail the sane_ident test, but we know
852 * that the name and mail pointers will at least be valid,
853 * which is enough for our tests and printing here.
855 assert_split_ident(&ai, author_ident);
856 assert_split_ident(&ci, &committer_ident);
858 if (ident_cmp(&ai, &ci))
859 status_printf_ln(s, GIT_COLOR_NORMAL,
861 "Author: %.*s <%.*s>"),
862 ident_shown++ ? "" : "\n",
863 (int)(ai.name_end - ai.name_begin), ai.name_begin,
864 (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);
866 if (author_date_is_interesting())
867 status_printf_ln(s, GIT_COLOR_NORMAL,
870 ident_shown++ ? "" : "\n",
871 show_ident_date(&ai, DATE_MODE(NORMAL)));
873 if (!committer_ident_sufficiently_given())
874 status_printf_ln(s, GIT_COLOR_NORMAL,
876 "Committer: %.*s <%.*s>"),
877 ident_shown++ ? "" : "\n",
878 (int)(ci.name_end - ci.name_begin), ci.name_begin,
879 (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
882 status_printf_ln(s, GIT_COLOR_NORMAL, "%s", "");
884 saved_color_setting = s->use_color;
886 commitable = run_status(s->fp, index_file, prefix, 1, s);
887 s->use_color = saved_color_setting;
889 struct object_id oid;
890 const char *parent = "HEAD";
892 if (!active_nr && read_cache() < 0)
893 die(_("Cannot read index"));
898 if (get_sha1(parent, oid.hash)) {
901 for (i = 0; i < active_nr; i++)
902 if (ce_intent_to_add(active_cache[i]))
904 commitable = active_nr - ita_nr > 0;
907 * Unless the user did explicitly request a submodule
908 * ignore mode by passing a command line option we do
909 * not ignore any changed submodule SHA-1s when
910 * comparing index and parent, no matter what is
911 * configured. Otherwise we won't commit any
912 * submodules which were manually staged, which would
913 * be really confusing.
915 int diff_flags = DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG;
916 if (ignore_submodule_arg &&
917 !strcmp(ignore_submodule_arg, "all"))
918 diff_flags |= DIFF_OPT_IGNORE_SUBMODULES;
919 commitable = index_differs_from(parent, diff_flags, 1);
922 strbuf_release(&committer_ident);
927 * Reject an attempt to record a non-merge empty commit without
928 * explicit --allow-empty. In the cherry-pick case, it may be
929 * empty due to conflict resolution, which the user should okay.
931 if (!commitable && whence != FROM_MERGE && !allow_empty &&
932 !(amend && is_a_merge(current_head))) {
933 s->display_comment_prefix = old_display_comment_prefix;
934 run_status(stdout, index_file, prefix, 0, s);
936 fputs(_(empty_amend_advice), stderr);
937 else if (whence == FROM_CHERRY_PICK) {
938 fputs(_(empty_cherry_pick_advice), stderr);
939 if (!sequencer_in_use)
940 fputs(_(empty_cherry_pick_advice_single), stderr);
942 fputs(_(empty_cherry_pick_advice_multi), stderr);
948 * Re-read the index as pre-commit hook could have updated it,
949 * and write it out as a tree. We must do this before we invoke
950 * the editor and after we invoke run_status above.
953 read_cache_from(index_file);
954 if (update_main_cache_tree(0)) {
955 error(_("Error building trees"));
959 if (run_commit_hook(use_editor, index_file, "prepare-commit-msg",
960 git_path_commit_editmsg(), hook_arg1, hook_arg2, NULL))
964 struct argv_array env = ARGV_ARRAY_INIT;
966 argv_array_pushf(&env, "GIT_INDEX_FILE=%s", index_file);
967 if (launch_editor(git_path_commit_editmsg(), NULL, env.argv)) {
969 _("Please supply the message using either -m or -F option.\n"));
972 argv_array_clear(&env);
976 run_commit_hook(use_editor, index_file, "commit-msg", git_path_commit_editmsg(), NULL)) {
983 static int rest_is_empty(struct strbuf *sb, int start)
988 /* Check if the rest is just whitespace and Signed-of-by's. */
989 for (i = start; i < sb->len; i++) {
990 nl = memchr(sb->buf + i, '\n', sb->len - i);
996 if (strlen(sign_off_header) <= eol - i &&
997 starts_with(sb->buf + i, sign_off_header)) {
1002 if (!isspace(sb->buf[i++]))
1010 * Find out if the message in the strbuf contains only whitespace and
1011 * Signed-off-by lines.
1013 static int message_is_empty(struct strbuf *sb)
1015 if (cleanup_mode == CLEANUP_NONE && sb->len)
1017 return rest_is_empty(sb, 0);
1021 * See if the user edited the message in the editor or left what
1022 * was in the template intact
1024 static int template_untouched(struct strbuf *sb)
1026 struct strbuf tmpl = STRBUF_INIT;
1029 if (cleanup_mode == CLEANUP_NONE && sb->len)
1032 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
1035 strbuf_stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
1036 if (!skip_prefix(sb->buf, tmpl.buf, &start))
1038 strbuf_release(&tmpl);
1039 return rest_is_empty(sb, start - sb->buf);
1042 static const char *find_author_by_nickname(const char *name)
1044 struct rev_info revs;
1045 struct commit *commit;
1046 struct strbuf buf = STRBUF_INIT;
1047 struct string_list mailmap = STRING_LIST_INIT_NODUP;
1051 init_revisions(&revs, NULL);
1052 strbuf_addf(&buf, "--author=%s", name);
1057 setup_revisions(ac, av, &revs, NULL);
1058 revs.mailmap = &mailmap;
1059 read_mailmap(revs.mailmap, NULL);
1061 if (prepare_revision_walk(&revs))
1062 die(_("revision walk setup failed"));
1063 commit = get_revision(&revs);
1065 struct pretty_print_context ctx = {0};
1066 ctx.date_mode.type = DATE_NORMAL;
1067 strbuf_release(&buf);
1068 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
1069 clear_mailmap(&mailmap);
1070 return strbuf_detach(&buf, NULL);
1072 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name);
1076 static void handle_untracked_files_arg(struct wt_status *s)
1078 if (!untracked_files_arg)
1079 ; /* default already initialized */
1080 else if (!strcmp(untracked_files_arg, "no"))
1081 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1082 else if (!strcmp(untracked_files_arg, "normal"))
1083 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1084 else if (!strcmp(untracked_files_arg, "all"))
1085 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1087 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1090 static const char *read_commit_message(const char *name)
1092 const char *out_enc;
1093 struct commit *commit;
1095 commit = lookup_commit_reference_by_name(name);
1097 die(_("could not lookup commit %s"), name);
1098 out_enc = get_commit_output_encoding();
1099 return logmsg_reencode(commit, NULL, out_enc);
1103 * Enumerate what needs to be propagated when --porcelain
1104 * is not in effect here.
1106 static struct status_deferred_config {
1107 enum wt_status_format status_format;
1109 } status_deferred_config = {
1110 STATUS_FORMAT_UNSPECIFIED,
1111 -1 /* unspecified */
1114 static void finalize_deferred_config(struct wt_status *s)
1116 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1117 status_format != STATUS_FORMAT_PORCELAIN_V2 &&
1118 !s->null_termination);
1120 if (s->null_termination) {
1121 if (status_format == STATUS_FORMAT_NONE ||
1122 status_format == STATUS_FORMAT_UNSPECIFIED)
1123 status_format = STATUS_FORMAT_PORCELAIN;
1124 else if (status_format == STATUS_FORMAT_LONG)
1125 die(_("--long and -z are incompatible"));
1128 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1129 status_format = status_deferred_config.status_format;
1130 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1131 status_format = STATUS_FORMAT_NONE;
1133 if (use_deferred_config && s->show_branch < 0)
1134 s->show_branch = status_deferred_config.show_branch;
1135 if (s->show_branch < 0)
1139 static int parse_and_validate_options(int argc, const char *argv[],
1140 const struct option *options,
1141 const char * const usage[],
1143 struct commit *current_head,
1144 struct wt_status *s)
1148 argc = parse_options(argc, argv, prefix, options, usage, 0);
1149 finalize_deferred_config(s);
1151 if (force_author && !strchr(force_author, '>'))
1152 force_author = find_author_by_nickname(force_author);
1154 if (force_author && renew_authorship)
1155 die(_("Using both --reset-author and --author does not make sense"));
1157 if (logfile || have_option_m || use_message || fixup_message)
1160 use_editor = edit_flag;
1162 /* Sanity check options */
1163 if (amend && !current_head)
1164 die(_("You have nothing to amend."));
1165 if (amend && whence != FROM_COMMIT) {
1166 if (whence == FROM_MERGE)
1167 die(_("You are in the middle of a merge -- cannot amend."));
1168 else if (whence == FROM_CHERRY_PICK)
1169 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1171 if (fixup_message && squash_message)
1172 die(_("Options --squash and --fixup cannot be used together"));
1182 die(_("Only one of -c/-C/-F/--fixup can be used."));
1183 if (have_option_m && f > 0)
1184 die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1185 if (f || have_option_m)
1186 template_file = NULL;
1188 use_message = edit_message;
1189 if (amend && !use_message && !fixup_message)
1190 use_message = "HEAD";
1191 if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1192 die(_("--reset-author can be used only with -C, -c or --amend."));
1194 use_message_buffer = read_commit_message(use_message);
1195 if (!renew_authorship) {
1196 author_message = use_message;
1197 author_message_buffer = use_message_buffer;
1200 if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1201 author_message = "CHERRY_PICK_HEAD";
1202 author_message_buffer = read_commit_message(author_message);
1205 if (patch_interactive)
1208 if (also + only + all + interactive > 1)
1209 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1210 if (argc == 0 && (also || (only && !amend && !allow_empty)))
1211 die(_("No paths with --include/--only does not make sense."));
1212 if (argc > 0 && !also && !only)
1213 only_include_assumed = _("Explicit paths specified without -i or -o; assuming --only paths...");
1214 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1215 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
1216 else if (!strcmp(cleanup_arg, "verbatim"))
1217 cleanup_mode = CLEANUP_NONE;
1218 else if (!strcmp(cleanup_arg, "whitespace"))
1219 cleanup_mode = CLEANUP_SPACE;
1220 else if (!strcmp(cleanup_arg, "strip"))
1221 cleanup_mode = CLEANUP_ALL;
1222 else if (!strcmp(cleanup_arg, "scissors"))
1223 cleanup_mode = use_editor ? CLEANUP_SCISSORS : CLEANUP_SPACE;
1225 die(_("Invalid cleanup mode %s"), cleanup_arg);
1227 handle_untracked_files_arg(s);
1229 if (all && argc > 0)
1230 die(_("Paths with -a does not make sense."));
1232 if (status_format != STATUS_FORMAT_NONE)
1238 static int dry_run_commit(int argc, const char **argv, const char *prefix,
1239 const struct commit *current_head, struct wt_status *s)
1242 const char *index_file;
1244 index_file = prepare_index(argc, argv, prefix, current_head, 1);
1245 commitable = run_status(stdout, index_file, prefix, 0, s);
1246 rollback_index_files();
1248 return commitable ? 0 : 1;
1251 static int parse_status_slot(const char *slot)
1253 if (!strcasecmp(slot, "header"))
1254 return WT_STATUS_HEADER;
1255 if (!strcasecmp(slot, "branch"))
1256 return WT_STATUS_ONBRANCH;
1257 if (!strcasecmp(slot, "updated") || !strcasecmp(slot, "added"))
1258 return WT_STATUS_UPDATED;
1259 if (!strcasecmp(slot, "changed"))
1260 return WT_STATUS_CHANGED;
1261 if (!strcasecmp(slot, "untracked"))
1262 return WT_STATUS_UNTRACKED;
1263 if (!strcasecmp(slot, "nobranch"))
1264 return WT_STATUS_NOBRANCH;
1265 if (!strcasecmp(slot, "unmerged"))
1266 return WT_STATUS_UNMERGED;
1270 static int git_status_config(const char *k, const char *v, void *cb)
1272 struct wt_status *s = cb;
1273 const char *slot_name;
1275 if (starts_with(k, "column."))
1276 return git_column_config(k, v, "status", &s->colopts);
1277 if (!strcmp(k, "status.submodulesummary")) {
1279 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1280 if (is_bool && s->submodule_summary)
1281 s->submodule_summary = -1;
1284 if (!strcmp(k, "status.short")) {
1285 if (git_config_bool(k, v))
1286 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1288 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1291 if (!strcmp(k, "status.branch")) {
1292 status_deferred_config.show_branch = git_config_bool(k, v);
1295 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1296 s->use_color = git_config_colorbool(k, v);
1299 if (!strcmp(k, "status.displaycommentprefix")) {
1300 s->display_comment_prefix = git_config_bool(k, v);
1303 if (skip_prefix(k, "status.color.", &slot_name) ||
1304 skip_prefix(k, "color.status.", &slot_name)) {
1305 int slot = parse_status_slot(slot_name);
1309 return config_error_nonbool(k);
1310 return color_parse(v, s->color_palette[slot]);
1312 if (!strcmp(k, "status.relativepaths")) {
1313 s->relative_paths = git_config_bool(k, v);
1316 if (!strcmp(k, "status.showuntrackedfiles")) {
1318 return config_error_nonbool(k);
1319 else if (!strcmp(v, "no"))
1320 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1321 else if (!strcmp(v, "normal"))
1322 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1323 else if (!strcmp(v, "all"))
1324 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1326 return error(_("Invalid untracked files mode '%s'"), v);
1329 return git_diff_ui_config(k, v, NULL);
1332 int cmd_status(int argc, const char **argv, const char *prefix)
1334 static struct wt_status s;
1336 struct object_id oid;
1337 static struct option builtin_status_options[] = {
1338 OPT__VERBOSE(&verbose, N_("be verbose")),
1339 OPT_SET_INT('s', "short", &status_format,
1340 N_("show status concisely"), STATUS_FORMAT_SHORT),
1341 OPT_BOOL('b', "branch", &s.show_branch,
1342 N_("show branch information")),
1343 { OPTION_CALLBACK, 0, "porcelain", &status_format,
1344 N_("version"), N_("machine-readable output"),
1345 PARSE_OPT_OPTARG, opt_parse_porcelain },
1346 OPT_SET_INT(0, "long", &status_format,
1347 N_("show status in long format (default)"),
1348 STATUS_FORMAT_LONG),
1349 OPT_BOOL('z', "null", &s.null_termination,
1350 N_("terminate entries with NUL")),
1351 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1353 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1354 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1355 OPT_BOOL(0, "ignored", &show_ignored_in_status,
1356 N_("show ignored files")),
1357 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1358 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1359 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1360 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1364 if (argc == 2 && !strcmp(argv[1], "-h"))
1365 usage_with_options(builtin_status_usage, builtin_status_options);
1367 status_init_config(&s, git_status_config);
1368 argc = parse_options(argc, argv, prefix,
1369 builtin_status_options,
1370 builtin_status_usage, 0);
1371 finalize_colopts(&s.colopts, -1);
1372 finalize_deferred_config(&s);
1374 handle_untracked_files_arg(&s);
1375 if (show_ignored_in_status)
1376 s.show_ignored_files = 1;
1377 parse_pathspec(&s.pathspec, 0,
1378 PATHSPEC_PREFER_FULL,
1381 read_cache_preload(&s.pathspec);
1382 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &s.pathspec, NULL, NULL);
1384 fd = hold_locked_index(&index_lock, 0);
1386 s.is_initial = get_sha1(s.reference, oid.hash) ? 1 : 0;
1388 hashcpy(s.sha1_commit, oid.hash);
1390 s.ignore_submodule_arg = ignore_submodule_arg;
1391 s.status_format = status_format;
1392 s.verbose = verbose;
1394 wt_status_collect(&s);
1397 update_index_if_able(&the_index, &index_lock);
1399 if (s.relative_paths)
1402 wt_status_print(&s);
1406 static const char *implicit_ident_advice(void)
1408 char *user_config = expand_user_path("~/.gitconfig", 0);
1409 char *xdg_config = xdg_config_home("config");
1410 int config_exists = file_exists(user_config) || file_exists(xdg_config);
1416 return _(implicit_ident_advice_config);
1418 return _(implicit_ident_advice_noconfig);
1422 static void print_summary(const char *prefix, const struct object_id *oid,
1425 struct rev_info rev;
1426 struct commit *commit;
1427 struct strbuf format = STRBUF_INIT;
1428 struct object_id junk_oid;
1430 struct pretty_print_context pctx = {0};
1431 struct strbuf author_ident = STRBUF_INIT;
1432 struct strbuf committer_ident = STRBUF_INIT;
1434 commit = lookup_commit(oid->hash);
1436 die(_("couldn't look up newly created commit"));
1437 if (parse_commit(commit))
1438 die(_("could not parse newly created commit"));
1440 strbuf_addstr(&format, "format:%h] %s");
1442 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1443 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1444 if (strbuf_cmp(&author_ident, &committer_ident)) {
1445 strbuf_addstr(&format, "\n Author: ");
1446 strbuf_addbuf_percentquote(&format, &author_ident);
1448 if (author_date_is_interesting()) {
1449 struct strbuf date = STRBUF_INIT;
1450 format_commit_message(commit, "%ad", &date, &pctx);
1451 strbuf_addstr(&format, "\n Date: ");
1452 strbuf_addbuf_percentquote(&format, &date);
1453 strbuf_release(&date);
1455 if (!committer_ident_sufficiently_given()) {
1456 strbuf_addstr(&format, "\n Committer: ");
1457 strbuf_addbuf_percentquote(&format, &committer_ident);
1458 if (advice_implicit_identity) {
1459 strbuf_addch(&format, '\n');
1460 strbuf_addstr(&format, implicit_ident_advice());
1463 strbuf_release(&author_ident);
1464 strbuf_release(&committer_ident);
1466 init_revisions(&rev, prefix);
1467 setup_revisions(0, NULL, &rev, NULL);
1470 rev.diffopt.output_format =
1471 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1473 rev.verbose_header = 1;
1474 rev.show_root_diff = 1;
1475 get_commit_format(format.buf, &rev);
1476 rev.always_show_header = 0;
1477 rev.diffopt.detect_rename = 1;
1478 rev.diffopt.break_opt = 0;
1479 diff_setup_done(&rev.diffopt);
1481 head = resolve_ref_unsafe("HEAD", 0, junk_oid.hash, NULL);
1482 if (!strcmp(head, "HEAD"))
1483 head = _("detached HEAD");
1485 skip_prefix(head, "refs/heads/", &head);
1486 printf("[%s%s ", head, initial_commit ? _(" (root-commit)") : "");
1488 if (!log_tree_commit(&rev, commit)) {
1489 rev.always_show_header = 1;
1490 rev.use_terminator = 1;
1491 log_tree_commit(&rev, commit);
1494 strbuf_release(&format);
1497 static int git_commit_config(const char *k, const char *v, void *cb)
1499 struct wt_status *s = cb;
1502 if (!strcmp(k, "commit.template"))
1503 return git_config_pathname(&template_file, k, v);
1504 if (!strcmp(k, "commit.status")) {
1505 include_status = git_config_bool(k, v);
1508 if (!strcmp(k, "commit.cleanup"))
1509 return git_config_string(&cleanup_arg, k, v);
1510 if (!strcmp(k, "commit.gpgsign")) {
1511 sign_commit = git_config_bool(k, v) ? "" : NULL;
1514 if (!strcmp(k, "commit.verbose")) {
1516 config_commit_verbose = git_config_bool_or_int(k, v, &is_bool);
1520 status = git_gpg_config(k, v, NULL);
1523 return git_status_config(k, v, s);
1526 static int run_rewrite_hook(const struct object_id *oldoid,
1527 const struct object_id *newoid)
1529 struct child_process proc = CHILD_PROCESS_INIT;
1530 const char *argv[3];
1532 struct strbuf sb = STRBUF_INIT;
1534 argv[0] = find_hook("post-rewrite");
1543 proc.stdout_to_stderr = 1;
1545 code = start_command(&proc);
1548 strbuf_addf(&sb, "%s %s\n", oid_to_hex(oldoid), oid_to_hex(newoid));
1549 sigchain_push(SIGPIPE, SIG_IGN);
1550 write_in_full(proc.in, sb.buf, sb.len);
1552 strbuf_release(&sb);
1553 sigchain_pop(SIGPIPE);
1554 return finish_command(&proc);
1557 int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...)
1559 struct argv_array hook_env = ARGV_ARRAY_INIT;
1563 argv_array_pushf(&hook_env, "GIT_INDEX_FILE=%s", index_file);
1566 * Let the hook know that no editor will be launched.
1568 if (!editor_is_used)
1569 argv_array_push(&hook_env, "GIT_EDITOR=:");
1571 va_start(args, name);
1572 ret = run_hook_ve(hook_env.argv,name, args);
1574 argv_array_clear(&hook_env);
1579 int cmd_commit(int argc, const char **argv, const char *prefix)
1581 static struct wt_status s;
1582 static struct option builtin_commit_options[] = {
1583 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1584 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1586 OPT_GROUP(N_("Commit message options")),
1587 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1588 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1589 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1590 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1591 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1592 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1593 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1594 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1595 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1596 OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1597 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1598 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1599 OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
1600 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1601 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
1602 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1603 /* end commit message options */
1605 OPT_GROUP(N_("Commit contents options")),
1606 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1607 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1608 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1609 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1610 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1611 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit and commit-msg hooks")),
1612 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1613 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1614 STATUS_FORMAT_SHORT),
1615 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1616 OPT_SET_INT(0, "porcelain", &status_format,
1617 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1618 OPT_SET_INT(0, "long", &status_format,
1619 N_("show status in long format (default)"),
1620 STATUS_FORMAT_LONG),
1621 OPT_BOOL('z', "null", &s.null_termination,
1622 N_("terminate entries with NUL")),
1623 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1624 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1625 { 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" },
1626 /* end commit contents options */
1628 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1629 N_("ok to record an empty change")),
1630 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1631 N_("ok to record a change with an empty message")),
1636 struct strbuf sb = STRBUF_INIT;
1637 struct strbuf author_ident = STRBUF_INIT;
1638 const char *index_file, *reflog_msg;
1640 struct object_id oid;
1641 struct commit_list *parents = NULL;
1642 struct stat statbuf;
1643 struct commit *current_head = NULL;
1644 struct commit_extra_header *extra = NULL;
1645 struct ref_transaction *transaction;
1646 struct strbuf err = STRBUF_INIT;
1648 if (argc == 2 && !strcmp(argv[1], "-h"))
1649 usage_with_options(builtin_commit_usage, builtin_commit_options);
1651 status_init_config(&s, git_commit_config);
1652 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1655 if (get_sha1("HEAD", oid.hash))
1656 current_head = NULL;
1658 current_head = lookup_commit_or_die(oid.hash, "HEAD");
1659 if (parse_commit(current_head))
1660 die(_("could not parse HEAD commit"));
1662 verbose = -1; /* unspecified */
1663 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1664 builtin_commit_usage,
1665 prefix, current_head, &s);
1667 verbose = (config_commit_verbose < 0) ? 0 : config_commit_verbose;
1670 return dry_run_commit(argc, argv, prefix, current_head, &s);
1671 index_file = prepare_index(argc, argv, prefix, current_head, 0);
1673 /* Set up everything for writing the commit object. This includes
1674 running hooks, writing the trees, and interacting with the user. */
1675 if (!prepare_to_commit(index_file, prefix,
1676 current_head, &s, &author_ident)) {
1677 rollback_index_files();
1681 /* Determine parents */
1682 reflog_msg = getenv("GIT_REFLOG_ACTION");
1683 if (!current_head) {
1685 reflog_msg = "commit (initial)";
1688 reflog_msg = "commit (amend)";
1689 parents = copy_commit_list(current_head->parents);
1690 } else if (whence == FROM_MERGE) {
1691 struct strbuf m = STRBUF_INIT;
1693 int allow_fast_forward = 1;
1694 struct commit_list **pptr = &parents;
1697 reflog_msg = "commit (merge)";
1698 pptr = commit_list_append(current_head, pptr);
1699 fp = fopen(git_path_merge_head(), "r");
1701 die_errno(_("could not open '%s' for reading"),
1702 git_path_merge_head());
1703 while (strbuf_getline_lf(&m, fp) != EOF) {
1704 struct commit *parent;
1706 parent = get_merge_parent(m.buf);
1708 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1709 pptr = commit_list_append(parent, pptr);
1713 if (!stat(git_path_merge_mode(), &statbuf)) {
1714 if (strbuf_read_file(&sb, git_path_merge_mode(), 0) < 0)
1715 die_errno(_("could not read MERGE_MODE"));
1716 if (!strcmp(sb.buf, "no-ff"))
1717 allow_fast_forward = 0;
1719 if (allow_fast_forward)
1720 parents = reduce_heads(parents);
1723 reflog_msg = (whence == FROM_CHERRY_PICK)
1724 ? "commit (cherry-pick)"
1726 commit_list_insert(current_head, &parents);
1729 /* Finally, get the commit message */
1731 if (strbuf_read_file(&sb, git_path_commit_editmsg(), 0) < 0) {
1732 int saved_errno = errno;
1733 rollback_index_files();
1734 die(_("could not read commit message: %s"), strerror(saved_errno));
1737 if (verbose || /* Truncate the message just before the diff, if any. */
1738 cleanup_mode == CLEANUP_SCISSORS)
1739 wt_status_truncate_message_at_cut_line(&sb);
1741 if (cleanup_mode != CLEANUP_NONE)
1742 strbuf_stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1743 if (template_untouched(&sb) && !allow_empty_message) {
1744 rollback_index_files();
1745 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1748 if (message_is_empty(&sb) && !allow_empty_message) {
1749 rollback_index_files();
1750 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1755 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1756 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1758 struct commit_extra_header **tail = &extra;
1759 append_merge_tag_headers(parents, &tail);
1762 if (commit_tree_extended(sb.buf, sb.len, active_cache_tree->sha1,
1763 parents, oid.hash, author_ident.buf, sign_commit, extra)) {
1764 rollback_index_files();
1765 die(_("failed to write commit object"));
1767 strbuf_release(&author_ident);
1768 free_commit_extra_headers(extra);
1770 nl = strchr(sb.buf, '\n');
1772 strbuf_setlen(&sb, nl + 1 - sb.buf);
1774 strbuf_addch(&sb, '\n');
1775 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1776 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1778 transaction = ref_transaction_begin(&err);
1780 ref_transaction_update(transaction, "HEAD", oid.hash,
1782 ? current_head->object.oid.hash : null_sha1,
1784 ref_transaction_commit(transaction, &err)) {
1785 rollback_index_files();
1788 ref_transaction_free(transaction);
1790 unlink(git_path_cherry_pick_head());
1791 unlink(git_path_revert_head());
1792 unlink(git_path_merge_head());
1793 unlink(git_path_merge_msg());
1794 unlink(git_path_merge_mode());
1795 unlink(git_path_squash_msg());
1797 if (commit_index_files())
1798 die (_("Repository has been updated, but unable to write\n"
1799 "new_index file. Check that disk is not full and quota is\n"
1800 "not exceeded, and then \"git reset HEAD\" to recover."));
1803 run_commit_hook(use_editor, get_index_file(), "post-commit", NULL);
1804 if (amend && !no_post_rewrite) {
1805 struct notes_rewrite_cfg *cfg;
1806 cfg = init_copy_notes_for_rewrite("amend");
1808 /* we are amending, so current_head is not NULL */
1809 copy_note_for_rewrite(cfg, current_head->object.oid.hash, oid.hash);
1810 finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1812 run_rewrite_hook(¤t_head->object.oid, &oid);
1815 print_summary(prefix, &oid, !current_head);
1817 strbuf_release(&err);