4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
9 #include "cache-tree.h"
17 #include "wt-status.h"
18 #include "run-command.h"
23 #include "parse-options.h"
24 #include "string-list.h"
26 #include "unpack-trees.h"
28 #include "submodule.h"
29 #include "gpg-interface.h"
31 static const char * const builtin_commit_usage[] = {
32 "git commit [options] [--] <filepattern>...",
36 static const char * const builtin_status_usage[] = {
37 "git status [options] [--] <filepattern>...",
41 static const char implicit_ident_advice[] =
42 N_("Your name and email address were configured automatically based\n"
43 "on your username and hostname. Please check that they are accurate.\n"
44 "You can suppress this message by setting them explicitly:\n"
46 " git config --global user.name \"Your Name\"\n"
47 " git config --global user.email you@example.com\n"
49 "After doing this, you may fix the identity used for this commit with:\n"
51 " git commit --amend --reset-author\n");
53 static const char empty_amend_advice[] =
54 N_("You asked to amend the most recent commit, but doing so would make\n"
55 "it empty. You can repeat your command with --allow-empty, or you can\n"
56 "remove the commit entirely with \"git reset HEAD^\".\n");
58 static const char empty_cherry_pick_advice[] =
59 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
60 "If you wish to commit it anyway, use:\n"
62 " git commit --allow-empty\n"
64 "Otherwise, please use 'git reset'\n");
66 static const char *use_message_buffer;
67 static const char commit_editmsg[] = "COMMIT_EDITMSG";
68 static struct lock_file index_lock; /* real index */
69 static struct lock_file false_lock; /* used only for partial commits */
76 static const char *logfile, *force_author;
77 static const char *template_file;
79 * The _message variables are commit names from which to take
80 * the commit message and/or authorship.
82 static const char *author_message, *author_message_buffer;
83 static char *edit_message, *use_message;
84 static char *fixup_message, *squash_message;
85 static int all, also, interactive, patch_interactive, only, amend, signoff;
86 static int edit_flag = -1; /* unspecified */
87 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
88 static int no_post_rewrite, allow_empty_message;
89 static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
90 static char *sign_commit;
93 * The default commit message cleanup mode will remove the lines
94 * beginning with # (shell comments) and leading and trailing
95 * whitespaces (empty lines or containing only whitespaces)
96 * if editor is used, and only the whitespaces if the message
97 * is specified explicitly.
104 static char *cleanup_arg;
106 static enum commit_whence whence;
107 static int use_editor = 1, include_status = 1;
108 static int show_ignored_in_status;
109 static const char *only_include_assumed;
110 static struct strbuf message = STRBUF_INIT;
112 static int null_termination;
116 STATUS_FORMAT_PORCELAIN
117 } status_format = STATUS_FORMAT_LONG;
118 static int status_show_branch;
120 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
122 struct strbuf *buf = opt->value;
124 strbuf_setlen(buf, 0);
126 strbuf_addstr(buf, arg);
127 strbuf_addstr(buf, "\n\n");
132 static struct option builtin_commit_options[] = {
133 OPT__QUIET(&quiet, "suppress summary after successful commit"),
134 OPT__VERBOSE(&verbose, "show diff in commit message template"),
136 OPT_GROUP("Commit message options"),
137 OPT_FILENAME('F', "file", &logfile, "read message from file"),
138 OPT_STRING(0, "author", &force_author, "author", "override author for commit"),
139 OPT_STRING(0, "date", &force_date, "date", "override date for commit"),
140 OPT_CALLBACK('m', "message", &message, "message", "commit message", opt_parse_m),
141 OPT_STRING('c', "reedit-message", &edit_message, "commit", "reuse and edit message from specified commit"),
142 OPT_STRING('C', "reuse-message", &use_message, "commit", "reuse message from specified commit"),
143 OPT_STRING(0, "fixup", &fixup_message, "commit", "use autosquash formatted message to fixup specified commit"),
144 OPT_STRING(0, "squash", &squash_message, "commit", "use autosquash formatted message to squash specified commit"),
145 OPT_BOOLEAN(0, "reset-author", &renew_authorship, "the commit is authored by me now (used with -C/-c/--amend)"),
146 OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
147 OPT_FILENAME('t', "template", &template_file, "use specified template file"),
148 OPT_BOOL('e', "edit", &edit_flag, "force edit of commit"),
149 OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
150 OPT_BOOLEAN(0, "status", &include_status, "include status in commit message template"),
151 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, "key id",
152 "GPG sign commit", PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
153 /* end commit message options */
155 OPT_GROUP("Commit contents options"),
156 OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
157 OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
158 OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
159 OPT_BOOLEAN('p', "patch", &patch_interactive, "interactively add changes"),
160 OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
161 OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
162 OPT_BOOLEAN(0, "dry-run", &dry_run, "show what would be committed"),
163 OPT_SET_INT(0, "short", &status_format, "show status concisely",
164 STATUS_FORMAT_SHORT),
165 OPT_BOOLEAN(0, "branch", &status_show_branch, "show branch information"),
166 OPT_SET_INT(0, "porcelain", &status_format,
167 "machine-readable output", STATUS_FORMAT_PORCELAIN),
168 OPT_BOOLEAN('z', "null", &null_termination,
169 "terminate entries with NUL"),
170 OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
171 OPT_BOOLEAN(0, "no-post-rewrite", &no_post_rewrite, "bypass post-rewrite hook"),
172 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg, "mode", "show untracked files, optional modes: all, normal, no. (Default: all)", PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
173 /* end commit contents options */
175 { OPTION_BOOLEAN, 0, "allow-empty", &allow_empty, NULL,
176 "ok to record an empty change",
177 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
178 { OPTION_BOOLEAN, 0, "allow-empty-message", &allow_empty_message, NULL,
179 "ok to record a change with an empty message",
180 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
185 static void determine_whence(struct wt_status *s)
187 if (file_exists(git_path("MERGE_HEAD")))
189 else if (file_exists(git_path("CHERRY_PICK_HEAD")))
190 whence = FROM_CHERRY_PICK;
192 whence = FROM_COMMIT;
197 static const char *whence_s(void)
207 case FROM_CHERRY_PICK:
208 s = _("cherry-pick");
215 static void rollback_index_files(void)
217 switch (commit_style) {
219 break; /* nothing to do */
221 rollback_lock_file(&index_lock);
224 rollback_lock_file(&index_lock);
225 rollback_lock_file(&false_lock);
230 static int commit_index_files(void)
234 switch (commit_style) {
236 break; /* nothing to do */
238 err = commit_lock_file(&index_lock);
241 err = commit_lock_file(&index_lock);
242 rollback_lock_file(&false_lock);
250 * Take a union of paths in the index and the named tree (typically, "HEAD"),
251 * and return the paths that match the given pattern in list.
253 static int list_paths(struct string_list *list, const char *with_tree,
254 const char *prefix, const char **pattern)
259 for (i = 0; pattern[i]; i++)
264 char *max_prefix = common_prefix(pattern);
265 overlay_tree_on_cache(with_tree, max_prefix ? max_prefix : prefix);
269 for (i = 0; i < active_nr; i++) {
270 struct cache_entry *ce = active_cache[i];
271 struct string_list_item *item;
273 if (ce->ce_flags & CE_UPDATE)
275 if (!match_pathspec(pattern, ce->name, ce_namelen(ce), 0, m))
277 item = string_list_insert(list, ce->name);
278 if (ce_skip_worktree(ce))
279 item->util = item; /* better a valid pointer than a fake one */
282 return report_path_error(m, pattern, prefix);
285 static void add_remove_files(struct string_list *list)
288 for (i = 0; i < list->nr; i++) {
290 struct string_list_item *p = &(list->items[i]);
292 /* p->util is skip-worktree */
296 if (!lstat(p->string, &st)) {
297 if (add_to_cache(p->string, &st, 0))
298 die(_("updating files failed"));
300 remove_file_from_cache(p->string);
304 static void create_base_index(const struct commit *current_head)
307 struct unpack_trees_options opts;
315 memset(&opts, 0, sizeof(opts));
319 opts.src_index = &the_index;
320 opts.dst_index = &the_index;
322 opts.fn = oneway_merge;
323 tree = parse_tree_indirect(current_head->object.sha1);
325 die(_("failed to unpack HEAD tree object"));
327 init_tree_desc(&t, tree->buffer, tree->size);
328 if (unpack_trees(1, &t, &opts))
329 exit(128); /* We've already reported the error, finish dying */
332 static void refresh_cache_or_die(int refresh_flags)
335 * refresh_flags contains REFRESH_QUIET, so the only errors
336 * are for unmerged entries.
338 if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
339 die_resolve_conflict("commit");
342 static char *prepare_index(int argc, const char **argv, const char *prefix,
343 const struct commit *current_head, int is_status)
346 struct string_list partial;
347 const char **pathspec = NULL;
348 char *old_index_env = NULL;
349 int refresh_flags = REFRESH_QUIET;
352 refresh_flags |= REFRESH_UNMERGED;
355 pathspec = get_pathspec(prefix, argv);
357 if (read_cache_preload(pathspec) < 0)
358 die(_("index file corrupt"));
361 fd = hold_locked_index(&index_lock, 1);
363 refresh_cache_or_die(refresh_flags);
365 if (write_cache(fd, active_cache, active_nr) ||
366 close_lock_file(&index_lock))
367 die(_("unable to create temporary index"));
369 old_index_env = getenv(INDEX_ENVIRONMENT);
370 setenv(INDEX_ENVIRONMENT, index_lock.filename, 1);
372 if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
373 die(_("interactive add failed"));
375 if (old_index_env && *old_index_env)
376 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
378 unsetenv(INDEX_ENVIRONMENT);
381 read_cache_from(index_lock.filename);
383 commit_style = COMMIT_NORMAL;
384 return index_lock.filename;
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 && *pathspec)) {
400 fd = hold_locked_index(&index_lock, 1);
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_cache(fd, active_cache, active_nr) ||
405 close_lock_file(&index_lock))
406 die(_("unable to write new_index file"));
407 commit_style = COMMIT_NORMAL;
408 return index_lock.filename;
414 * (1) return the name of the real index file.
416 * The caller should run hooks on the real index,
417 * and create commit from the_index.
418 * We still need to refresh the index here.
420 if (!pathspec || !*pathspec) {
421 fd = hold_locked_index(&index_lock, 1);
422 refresh_cache_or_die(refresh_flags);
423 if (active_cache_changed) {
424 update_main_cache_tree(WRITE_TREE_SILENT);
425 if (write_cache(fd, active_cache, active_nr) ||
426 commit_locked_index(&index_lock))
427 die(_("unable to write new_index file"));
429 rollback_lock_file(&index_lock);
431 commit_style = COMMIT_AS_IS;
432 return get_index_file();
438 * (0) find the set of affected paths;
439 * (1) get lock on the real index file;
440 * (2) update the_index with the given paths;
441 * (3) write the_index out to the real index (still locked);
442 * (4) get lock on the false index file;
443 * (5) reset the_index from HEAD;
444 * (6) update the_index the same way as (2);
445 * (7) write the_index out to the false index file;
446 * (8) return the name of the false index file (still locked);
448 * The caller should run hooks on the locked false index, and
449 * create commit from it. Then
450 * (A) if all goes well, commit the real index;
451 * (B) on failure, rollback the real index;
452 * In either case, rollback the false index.
454 commit_style = COMMIT_PARTIAL;
456 if (whence != FROM_COMMIT)
457 die(_("cannot do a partial commit during a %s."), whence_s());
459 memset(&partial, 0, sizeof(partial));
460 partial.strdup_strings = 1;
461 if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, pathspec))
465 if (read_cache() < 0)
466 die(_("cannot read the index"));
468 fd = hold_locked_index(&index_lock, 1);
469 add_remove_files(&partial);
470 refresh_cache(REFRESH_QUIET);
471 if (write_cache(fd, active_cache, active_nr) ||
472 close_lock_file(&index_lock))
473 die(_("unable to write new_index file"));
475 fd = hold_lock_file_for_update(&false_lock,
476 git_path("next-index-%"PRIuMAX,
477 (uintmax_t) getpid()),
480 create_base_index(current_head);
481 add_remove_files(&partial);
482 refresh_cache(REFRESH_QUIET);
484 if (write_cache(fd, active_cache, active_nr) ||
485 close_lock_file(&false_lock))
486 die(_("unable to write temporary index file"));
489 read_cache_from(false_lock.filename);
491 return false_lock.filename;
494 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
497 unsigned char sha1[20];
499 if (s->relative_paths)
504 s->reference = "HEAD^1";
506 s->verbose = verbose;
507 s->index_file = index_file;
510 s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
512 wt_status_collect(s);
514 switch (status_format) {
515 case STATUS_FORMAT_SHORT:
516 wt_shortstatus_print(s, null_termination, status_show_branch);
518 case STATUS_FORMAT_PORCELAIN:
519 wt_porcelain_print(s, null_termination);
521 case STATUS_FORMAT_LONG:
526 return s->commitable;
529 static int is_a_merge(const struct commit *current_head)
531 return !!(current_head->parents && current_head->parents->next);
534 static const char sign_off_header[] = "Signed-off-by: ";
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 void determine_author_info(struct strbuf *author_ident)
548 char *name, *email, *date;
549 struct ident_split author;
551 name = getenv("GIT_AUTHOR_NAME");
552 email = getenv("GIT_AUTHOR_EMAIL");
553 date = getenv("GIT_AUTHOR_DATE");
555 if (author_message) {
556 const char *a, *lb, *rb, *eol;
559 a = strstr(author_message_buffer, "\nauthor ");
561 die(_("invalid commit: %s"), author_message);
563 lb = strchrnul(a + strlen("\nauthor "), '<');
564 rb = strchrnul(lb, '>');
565 eol = strchrnul(rb, '\n');
566 if (!*lb || !*rb || !*eol)
567 die(_("invalid commit: %s"), author_message);
569 if (lb == a + strlen("\nauthor "))
570 /* \nauthor <foo@example.com> */
571 name = xcalloc(1, 1);
573 name = xmemdupz(a + strlen("\nauthor "),
575 (a + strlen("\nauthor "))));
576 email = xmemdupz(lb + strlen("<"), rb - (lb + strlen("<")));
577 date = xmemdupz(rb + strlen("> "), eol - (rb + strlen("> ")));
578 len = eol - (rb + strlen("> "));
579 date = xmalloc(len + 2);
581 memcpy(date + 1, rb + strlen("> "), len);
582 date[len + 1] = '\0';
586 const char *lb = strstr(force_author, " <");
587 const char *rb = strchr(force_author, '>');
590 die(_("malformed --author parameter"));
591 name = xstrndup(force_author, lb - force_author);
592 email = xstrndup(lb + 2, rb - (lb + 2));
597 strbuf_addstr(author_ident, fmt_ident(name, email, date,
598 IDENT_ERROR_ON_NO_NAME));
599 if (!split_ident_line(&author, author_ident->buf, author_ident->len)) {
600 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
601 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
602 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
606 static int ends_rfc2822_footer(struct strbuf *sb)
613 const char *buf = sb->buf;
615 for (i = len - 1; i > 0; i--) {
616 if (hit && buf[i] == '\n')
618 hit = (buf[i] == '\n');
621 while (i < len - 1 && buf[i] == '\n')
624 for (; i < len; i = k) {
625 for (k = i; k < len && buf[k] != '\n'; k++)
629 if ((buf[k] == ' ' || buf[k] == '\t') && !first)
634 for (j = 0; i + j < len; j++) {
647 static char *cut_ident_timestamp_part(char *string)
649 char *ket = strrchr(string, '>');
650 if (!ket || ket[1] != ' ')
651 die(_("Malformed ident string: '%s'"), string);
656 static int prepare_to_commit(const char *index_file, const char *prefix,
657 struct commit *current_head,
659 struct strbuf *author_ident)
662 struct strbuf committer_ident = STRBUF_INIT;
663 int commitable, saved_color_setting;
664 struct strbuf sb = STRBUF_INIT;
666 const char *hook_arg1 = NULL;
667 const char *hook_arg2 = NULL;
669 int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
671 /* This checks and barfs if author is badly specified */
672 determine_author_info(author_ident);
674 if (!no_verify && run_hook(index_file, "pre-commit", NULL))
677 if (squash_message) {
679 * Insert the proper subject line before other commit
680 * message options add their content.
682 if (use_message && !strcmp(use_message, squash_message))
683 strbuf_addstr(&sb, "squash! ");
685 struct pretty_print_context ctx = {0};
687 c = lookup_commit_reference_by_name(squash_message);
689 die(_("could not lookup commit %s"), squash_message);
690 ctx.output_encoding = get_commit_output_encoding();
691 format_commit_message(c, "squash! %s\n\n", &sb,
697 strbuf_addbuf(&sb, &message);
698 hook_arg1 = "message";
699 } else if (logfile && !strcmp(logfile, "-")) {
701 fprintf(stderr, _("(reading log message from standard input)\n"));
702 if (strbuf_read(&sb, 0, 0) < 0)
703 die_errno(_("could not read log from standard input"));
704 hook_arg1 = "message";
705 } else if (logfile) {
706 if (strbuf_read_file(&sb, logfile, 0) < 0)
707 die_errno(_("could not read log file '%s'"),
709 hook_arg1 = "message";
710 } else if (use_message) {
711 buffer = strstr(use_message_buffer, "\n\n");
712 if (!buffer || buffer[2] == '\0')
713 die(_("commit has empty message"));
714 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
715 hook_arg1 = "commit";
716 hook_arg2 = use_message;
717 } else if (fixup_message) {
718 struct pretty_print_context ctx = {0};
719 struct commit *commit;
720 commit = lookup_commit_reference_by_name(fixup_message);
722 die(_("could not lookup commit %s"), fixup_message);
723 ctx.output_encoding = get_commit_output_encoding();
724 format_commit_message(commit, "fixup! %s\n\n",
726 hook_arg1 = "message";
727 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
728 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
729 die_errno(_("could not read MERGE_MSG"));
731 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
732 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
733 die_errno(_("could not read SQUASH_MSG"));
734 hook_arg1 = "squash";
735 } else if (template_file) {
736 if (strbuf_read_file(&sb, template_file, 0) < 0)
737 die_errno(_("could not read '%s'"), template_file);
738 hook_arg1 = "template";
739 clean_message_contents = 0;
743 * The remaining cases don't modify the template message, but
744 * just set the argument(s) to the prepare-commit-msg hook.
746 else if (whence == FROM_MERGE)
748 else if (whence == FROM_CHERRY_PICK) {
749 hook_arg1 = "commit";
750 hook_arg2 = "CHERRY_PICK_HEAD";
753 if (squash_message) {
755 * If squash_commit was used for the commit subject,
756 * then we're possibly hijacking other commit log options.
757 * Reset the hook args to tell the real story.
759 hook_arg1 = "message";
763 s->fp = fopen(git_path(commit_editmsg), "w");
765 die_errno(_("could not open '%s'"), git_path(commit_editmsg));
767 if (clean_message_contents)
771 struct strbuf sob = STRBUF_INIT;
774 strbuf_addstr(&sob, sign_off_header);
775 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
776 getenv("GIT_COMMITTER_EMAIL")));
777 strbuf_addch(&sob, '\n');
778 for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
780 if (prefixcmp(sb.buf + i, sob.buf)) {
781 if (!i || !ends_rfc2822_footer(&sb))
782 strbuf_addch(&sb, '\n');
783 strbuf_addbuf(&sb, &sob);
785 strbuf_release(&sob);
788 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
789 die_errno(_("could not write commit template"));
793 /* This checks if committer ident is explicitly given */
794 strbuf_addstr(&committer_ident, git_committer_info(0));
795 if (use_editor && include_status) {
796 char *ai_tmp, *ci_tmp;
797 if (whence != FROM_COMMIT)
798 status_printf_ln(s, GIT_COLOR_NORMAL,
800 "It looks like you may be committing a %s.\n"
801 "If this is not correct, please remove the file\n"
806 git_path(whence == FROM_MERGE
808 : "CHERRY_PICK_HEAD"));
810 fprintf(s->fp, "\n");
811 status_printf(s, GIT_COLOR_NORMAL,
812 _("Please enter the commit message for your changes."));
813 if (cleanup_mode == CLEANUP_ALL)
814 status_printf_more(s, GIT_COLOR_NORMAL,
815 _(" Lines starting\n"
816 "with '#' will be ignored, and an empty"
817 " message aborts the commit.\n"));
818 else /* CLEANUP_SPACE, that is. */
819 status_printf_more(s, GIT_COLOR_NORMAL,
820 _(" Lines starting\n"
821 "with '#' will be kept; you may remove them"
822 " yourself if you want to.\n"
823 "An empty message aborts the commit.\n"));
824 if (only_include_assumed)
825 status_printf_ln(s, GIT_COLOR_NORMAL,
826 "%s", only_include_assumed);
828 ai_tmp = cut_ident_timestamp_part(author_ident->buf);
829 ci_tmp = cut_ident_timestamp_part(committer_ident.buf);
830 if (strcmp(author_ident->buf, committer_ident.buf))
831 status_printf_ln(s, GIT_COLOR_NORMAL,
834 ident_shown++ ? "" : "\n",
837 if (!user_ident_sufficiently_given())
838 status_printf_ln(s, GIT_COLOR_NORMAL,
841 ident_shown++ ? "" : "\n",
842 committer_ident.buf);
845 status_printf_ln(s, GIT_COLOR_NORMAL, "");
847 saved_color_setting = s->use_color;
849 commitable = run_status(s->fp, index_file, prefix, 1, s);
850 s->use_color = saved_color_setting;
855 unsigned char sha1[20];
856 const char *parent = "HEAD";
858 if (!active_nr && read_cache() < 0)
859 die(_("Cannot read index"));
864 if (get_sha1(parent, sha1))
865 commitable = !!active_nr;
867 commitable = index_differs_from(parent, 0);
869 strbuf_release(&committer_ident);
874 * Reject an attempt to record a non-merge empty commit without
875 * explicit --allow-empty. In the cherry-pick case, it may be
876 * empty due to conflict resolution, which the user should okay.
878 if (!commitable && whence != FROM_MERGE && !allow_empty &&
879 !(amend && is_a_merge(current_head))) {
880 run_status(stdout, index_file, prefix, 0, s);
882 fputs(_(empty_amend_advice), stderr);
883 else if (whence == FROM_CHERRY_PICK)
884 fputs(_(empty_cherry_pick_advice), stderr);
889 * Re-read the index as pre-commit hook could have updated it,
890 * and write it out as a tree. We must do this before we invoke
891 * the editor and after we invoke run_status above.
894 read_cache_from(index_file);
895 if (update_main_cache_tree(0)) {
896 error(_("Error building trees"));
900 if (run_hook(index_file, "prepare-commit-msg",
901 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
905 char index[PATH_MAX];
906 const char *env[2] = { NULL };
908 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
909 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
911 _("Please supply the message using either -m or -F option.\n"));
917 run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
924 static int rest_is_empty(struct strbuf *sb, int start)
929 /* Check if the rest is just whitespace and Signed-of-by's. */
930 for (i = start; i < sb->len; i++) {
931 nl = memchr(sb->buf + i, '\n', sb->len - i);
937 if (strlen(sign_off_header) <= eol - i &&
938 !prefixcmp(sb->buf + i, sign_off_header)) {
943 if (!isspace(sb->buf[i++]))
951 * Find out if the message in the strbuf contains only whitespace and
952 * Signed-off-by lines.
954 static int message_is_empty(struct strbuf *sb)
956 if (cleanup_mode == CLEANUP_NONE && sb->len)
958 return rest_is_empty(sb, 0);
962 * See if the user edited the message in the editor or left what
963 * was in the template intact
965 static int template_untouched(struct strbuf *sb)
967 struct strbuf tmpl = STRBUF_INIT;
970 if (cleanup_mode == CLEANUP_NONE && sb->len)
973 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
976 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
977 start = (char *)skip_prefix(sb->buf, tmpl.buf);
980 strbuf_release(&tmpl);
981 return rest_is_empty(sb, start - sb->buf);
984 static const char *find_author_by_nickname(const char *name)
986 struct rev_info revs;
987 struct commit *commit;
988 struct strbuf buf = STRBUF_INIT;
992 init_revisions(&revs, NULL);
993 strbuf_addf(&buf, "--author=%s", name);
998 setup_revisions(ac, av, &revs, NULL);
999 prepare_revision_walk(&revs);
1000 commit = get_revision(&revs);
1002 struct pretty_print_context ctx = {0};
1003 ctx.date_mode = DATE_NORMAL;
1004 strbuf_release(&buf);
1005 format_commit_message(commit, "%an <%ae>", &buf, &ctx);
1006 return strbuf_detach(&buf, NULL);
1008 die(_("No existing author found with '%s'"), name);
1012 static void handle_untracked_files_arg(struct wt_status *s)
1014 if (!untracked_files_arg)
1015 ; /* default already initialized */
1016 else if (!strcmp(untracked_files_arg, "no"))
1017 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1018 else if (!strcmp(untracked_files_arg, "normal"))
1019 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1020 else if (!strcmp(untracked_files_arg, "all"))
1021 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1023 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1026 static const char *read_commit_message(const char *name)
1028 const char *out_enc, *out;
1029 struct commit *commit;
1031 commit = lookup_commit_reference_by_name(name);
1033 die(_("could not lookup commit %s"), name);
1034 out_enc = get_commit_output_encoding();
1035 out = logmsg_reencode(commit, out_enc);
1038 * If we failed to reencode the buffer, just copy it
1039 * byte for byte so the user can try to fix it up.
1040 * This also handles the case where input and output
1041 * encodings are identical.
1044 out = xstrdup(commit->buffer);
1048 static int parse_and_validate_options(int argc, const char *argv[],
1049 const char * const usage[],
1051 struct commit *current_head,
1052 struct wt_status *s)
1056 argc = parse_options(argc, argv, prefix, builtin_commit_options, usage,
1059 if (force_author && !strchr(force_author, '>'))
1060 force_author = find_author_by_nickname(force_author);
1062 if (force_author && renew_authorship)
1063 die(_("Using both --reset-author and --author does not make sense"));
1065 if (logfile || message.len || use_message || fixup_message)
1068 use_editor = edit_flag;
1070 setenv("GIT_EDITOR", ":", 1);
1072 /* Sanity check options */
1073 if (amend && !current_head)
1074 die(_("You have nothing to amend."));
1075 if (amend && whence != FROM_COMMIT)
1076 die(_("You are in the middle of a %s -- cannot amend."), whence_s());
1077 if (fixup_message && squash_message)
1078 die(_("Options --squash and --fixup cannot be used together"));
1088 die(_("Only one of -c/-C/-F/--fixup can be used."));
1089 if (message.len && f > 0)
1090 die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1091 if (f || message.len)
1092 template_file = NULL;
1094 use_message = edit_message;
1095 if (amend && !use_message && !fixup_message)
1096 use_message = "HEAD";
1097 if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1098 die(_("--reset-author can be used only with -C, -c or --amend."));
1100 use_message_buffer = read_commit_message(use_message);
1101 if (!renew_authorship) {
1102 author_message = use_message;
1103 author_message_buffer = use_message_buffer;
1106 if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1107 author_message = "CHERRY_PICK_HEAD";
1108 author_message_buffer = read_commit_message(author_message);
1111 if (patch_interactive)
1114 if (!!also + !!only + !!all + !!interactive > 1)
1115 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1116 if (argc == 0 && (also || (only && !amend)))
1117 die(_("No paths with --include/--only does not make sense."));
1118 if (argc == 0 && only && amend)
1119 only_include_assumed = _("Clever... amending the last one with dirty index.");
1120 if (argc > 0 && !also && !only)
1121 only_include_assumed = _("Explicit paths specified without -i nor -o; assuming --only paths...");
1122 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1123 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
1124 else if (!strcmp(cleanup_arg, "verbatim"))
1125 cleanup_mode = CLEANUP_NONE;
1126 else if (!strcmp(cleanup_arg, "whitespace"))
1127 cleanup_mode = CLEANUP_SPACE;
1128 else if (!strcmp(cleanup_arg, "strip"))
1129 cleanup_mode = CLEANUP_ALL;
1131 die(_("Invalid cleanup mode %s"), cleanup_arg);
1133 handle_untracked_files_arg(s);
1135 if (all && argc > 0)
1136 die(_("Paths with -a does not make sense."));
1138 if (null_termination && status_format == STATUS_FORMAT_LONG)
1139 status_format = STATUS_FORMAT_PORCELAIN;
1140 if (status_format != STATUS_FORMAT_LONG)
1146 static int dry_run_commit(int argc, const char **argv, const char *prefix,
1147 const struct commit *current_head, struct wt_status *s)
1150 const char *index_file;
1152 index_file = prepare_index(argc, argv, prefix, current_head, 1);
1153 commitable = run_status(stdout, index_file, prefix, 0, s);
1154 rollback_index_files();
1156 return commitable ? 0 : 1;
1159 static int parse_status_slot(const char *var, int offset)
1161 if (!strcasecmp(var+offset, "header"))
1162 return WT_STATUS_HEADER;
1163 if (!strcasecmp(var+offset, "branch"))
1164 return WT_STATUS_ONBRANCH;
1165 if (!strcasecmp(var+offset, "updated")
1166 || !strcasecmp(var+offset, "added"))
1167 return WT_STATUS_UPDATED;
1168 if (!strcasecmp(var+offset, "changed"))
1169 return WT_STATUS_CHANGED;
1170 if (!strcasecmp(var+offset, "untracked"))
1171 return WT_STATUS_UNTRACKED;
1172 if (!strcasecmp(var+offset, "nobranch"))
1173 return WT_STATUS_NOBRANCH;
1174 if (!strcasecmp(var+offset, "unmerged"))
1175 return WT_STATUS_UNMERGED;
1179 static int git_status_config(const char *k, const char *v, void *cb)
1181 struct wt_status *s = cb;
1183 if (!strcmp(k, "status.submodulesummary")) {
1185 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1186 if (is_bool && s->submodule_summary)
1187 s->submodule_summary = -1;
1190 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1191 s->use_color = git_config_colorbool(k, v);
1194 if (!prefixcmp(k, "status.color.") || !prefixcmp(k, "color.status.")) {
1195 int slot = parse_status_slot(k, 13);
1199 return config_error_nonbool(k);
1200 color_parse(v, k, s->color_palette[slot]);
1203 if (!strcmp(k, "status.relativepaths")) {
1204 s->relative_paths = git_config_bool(k, v);
1207 if (!strcmp(k, "status.showuntrackedfiles")) {
1209 return config_error_nonbool(k);
1210 else if (!strcmp(v, "no"))
1211 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1212 else if (!strcmp(v, "normal"))
1213 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1214 else if (!strcmp(v, "all"))
1215 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1217 return error(_("Invalid untracked files mode '%s'"), v);
1220 return git_diff_ui_config(k, v, NULL);
1223 int cmd_status(int argc, const char **argv, const char *prefix)
1227 unsigned char sha1[20];
1228 static struct option builtin_status_options[] = {
1229 OPT__VERBOSE(&verbose, "be verbose"),
1230 OPT_SET_INT('s', "short", &status_format,
1231 "show status concisely", STATUS_FORMAT_SHORT),
1232 OPT_BOOLEAN('b', "branch", &status_show_branch,
1233 "show branch information"),
1234 OPT_SET_INT(0, "porcelain", &status_format,
1235 "machine-readable output",
1236 STATUS_FORMAT_PORCELAIN),
1237 OPT_BOOLEAN('z', "null", &null_termination,
1238 "terminate entries with NUL"),
1239 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1241 "show untracked files, optional modes: all, normal, no. (Default: all)",
1242 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1243 OPT_BOOLEAN(0, "ignored", &show_ignored_in_status,
1244 "show ignored files"),
1245 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, "when",
1246 "ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)",
1247 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1251 if (argc == 2 && !strcmp(argv[1], "-h"))
1252 usage_with_options(builtin_status_usage, builtin_status_options);
1254 wt_status_prepare(&s);
1255 gitmodules_config();
1256 git_config(git_status_config, &s);
1257 determine_whence(&s);
1258 argc = parse_options(argc, argv, prefix,
1259 builtin_status_options,
1260 builtin_status_usage, 0);
1262 if (null_termination && status_format == STATUS_FORMAT_LONG)
1263 status_format = STATUS_FORMAT_PORCELAIN;
1265 handle_untracked_files_arg(&s);
1266 if (show_ignored_in_status)
1267 s.show_ignored_files = 1;
1269 s.pathspec = get_pathspec(prefix, argv);
1271 read_cache_preload(s.pathspec);
1272 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, s.pathspec, NULL, NULL);
1274 fd = hold_locked_index(&index_lock, 0);
1276 update_index_if_able(&the_index, &index_lock);
1278 s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1279 s.ignore_submodule_arg = ignore_submodule_arg;
1280 wt_status_collect(&s);
1282 if (s.relative_paths)
1285 switch (status_format) {
1286 case STATUS_FORMAT_SHORT:
1287 wt_shortstatus_print(&s, null_termination, status_show_branch);
1289 case STATUS_FORMAT_PORCELAIN:
1290 wt_porcelain_print(&s, null_termination);
1292 case STATUS_FORMAT_LONG:
1293 s.verbose = verbose;
1294 s.ignore_submodule_arg = ignore_submodule_arg;
1295 wt_status_print(&s);
1301 static void print_summary(const char *prefix, const unsigned char *sha1,
1304 struct rev_info rev;
1305 struct commit *commit;
1306 struct strbuf format = STRBUF_INIT;
1307 unsigned char junk_sha1[20];
1309 struct pretty_print_context pctx = {0};
1310 struct strbuf author_ident = STRBUF_INIT;
1311 struct strbuf committer_ident = STRBUF_INIT;
1313 commit = lookup_commit(sha1);
1315 die(_("couldn't look up newly created commit"));
1316 if (!commit || parse_commit(commit))
1317 die(_("could not parse newly created commit"));
1319 strbuf_addstr(&format, "format:%h] %s");
1321 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1322 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1323 if (strbuf_cmp(&author_ident, &committer_ident)) {
1324 strbuf_addstr(&format, "\n Author: ");
1325 strbuf_addbuf_percentquote(&format, &author_ident);
1327 if (!user_ident_sufficiently_given()) {
1328 strbuf_addstr(&format, "\n Committer: ");
1329 strbuf_addbuf_percentquote(&format, &committer_ident);
1330 if (advice_implicit_identity) {
1331 strbuf_addch(&format, '\n');
1332 strbuf_addstr(&format, _(implicit_ident_advice));
1335 strbuf_release(&author_ident);
1336 strbuf_release(&committer_ident);
1338 init_revisions(&rev, prefix);
1339 setup_revisions(0, NULL, &rev, NULL);
1342 rev.diffopt.output_format =
1343 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1345 rev.verbose_header = 1;
1346 rev.show_root_diff = 1;
1347 get_commit_format(format.buf, &rev);
1348 rev.always_show_header = 0;
1349 rev.diffopt.detect_rename = 1;
1350 rev.diffopt.break_opt = 0;
1351 diff_setup_done(&rev.diffopt);
1353 head = resolve_ref_unsafe("HEAD", junk_sha1, 0, NULL);
1355 !prefixcmp(head, "refs/heads/") ?
1357 !strcmp(head, "HEAD") ?
1358 _("detached HEAD") :
1360 initial_commit ? _(" (root-commit)") : "");
1362 if (!log_tree_commit(&rev, commit)) {
1363 rev.always_show_header = 1;
1364 rev.use_terminator = 1;
1365 log_tree_commit(&rev, commit);
1368 strbuf_release(&format);
1371 static int git_commit_config(const char *k, const char *v, void *cb)
1373 struct wt_status *s = cb;
1376 if (!strcmp(k, "commit.template"))
1377 return git_config_pathname(&template_file, k, v);
1378 if (!strcmp(k, "commit.status")) {
1379 include_status = git_config_bool(k, v);
1383 status = git_gpg_config(k, v, NULL);
1386 return git_status_config(k, v, s);
1389 static const char post_rewrite_hook[] = "hooks/post-rewrite";
1391 static int run_rewrite_hook(const unsigned char *oldsha1,
1392 const unsigned char *newsha1)
1394 /* oldsha1 SP newsha1 LF NUL */
1395 static char buf[2*40 + 3];
1396 struct child_process proc;
1397 const char *argv[3];
1401 if (access(git_path(post_rewrite_hook), X_OK) < 0)
1404 argv[0] = git_path(post_rewrite_hook);
1408 memset(&proc, 0, sizeof(proc));
1411 proc.stdout_to_stderr = 1;
1413 code = start_command(&proc);
1416 n = snprintf(buf, sizeof(buf), "%s %s\n",
1417 sha1_to_hex(oldsha1), sha1_to_hex(newsha1));
1418 write_in_full(proc.in, buf, n);
1420 return finish_command(&proc);
1423 int cmd_commit(int argc, const char **argv, const char *prefix)
1425 struct strbuf sb = STRBUF_INIT;
1426 struct strbuf author_ident = STRBUF_INIT;
1427 const char *index_file, *reflog_msg;
1429 unsigned char sha1[20];
1430 struct ref_lock *ref_lock;
1431 struct commit_list *parents = NULL, **pptr = &parents;
1432 struct stat statbuf;
1433 int allow_fast_forward = 1;
1435 struct commit *current_head = NULL;
1436 struct commit_extra_header *extra = NULL;
1438 if (argc == 2 && !strcmp(argv[1], "-h"))
1439 usage_with_options(builtin_commit_usage, builtin_commit_options);
1441 wt_status_prepare(&s);
1442 git_config(git_commit_config, &s);
1443 determine_whence(&s);
1445 if (get_sha1("HEAD", sha1))
1446 current_head = NULL;
1448 current_head = lookup_commit_or_die(sha1, "HEAD");
1449 if (!current_head || parse_commit(current_head))
1450 die(_("could not parse HEAD commit"));
1452 argc = parse_and_validate_options(argc, argv, builtin_commit_usage,
1453 prefix, current_head, &s);
1455 return dry_run_commit(argc, argv, prefix, current_head, &s);
1456 index_file = prepare_index(argc, argv, prefix, current_head, 0);
1458 /* Set up everything for writing the commit object. This includes
1459 running hooks, writing the trees, and interacting with the user. */
1460 if (!prepare_to_commit(index_file, prefix,
1461 current_head, &s, &author_ident)) {
1462 rollback_index_files();
1466 /* Determine parents */
1467 reflog_msg = getenv("GIT_REFLOG_ACTION");
1468 if (!current_head) {
1470 reflog_msg = "commit (initial)";
1472 struct commit_list *c;
1475 reflog_msg = "commit (amend)";
1476 for (c = current_head->parents; c; c = c->next)
1477 pptr = &commit_list_insert(c->item, pptr)->next;
1478 } else if (whence == FROM_MERGE) {
1479 struct strbuf m = STRBUF_INIT;
1483 reflog_msg = "commit (merge)";
1484 pptr = &commit_list_insert(current_head, pptr)->next;
1485 fp = fopen(git_path("MERGE_HEAD"), "r");
1487 die_errno(_("could not open '%s' for reading"),
1488 git_path("MERGE_HEAD"));
1489 while (strbuf_getline(&m, fp, '\n') != EOF) {
1490 struct commit *parent;
1492 parent = get_merge_parent(m.buf);
1494 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1495 pptr = &commit_list_insert(parent, pptr)->next;
1499 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1500 if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1501 die_errno(_("could not read MERGE_MODE"));
1502 if (!strcmp(sb.buf, "no-ff"))
1503 allow_fast_forward = 0;
1505 if (allow_fast_forward)
1506 parents = reduce_heads(parents);
1509 reflog_msg = (whence == FROM_CHERRY_PICK)
1510 ? "commit (cherry-pick)"
1512 pptr = &commit_list_insert(current_head, pptr)->next;
1515 /* Finally, get the commit message */
1517 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1518 int saved_errno = errno;
1519 rollback_index_files();
1520 die(_("could not read commit message: %s"), strerror(saved_errno));
1523 /* Truncate the message just before the diff, if any. */
1525 p = strstr(sb.buf, "\ndiff --git ");
1527 strbuf_setlen(&sb, p - sb.buf + 1);
1530 if (cleanup_mode != CLEANUP_NONE)
1531 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1532 if (template_untouched(&sb) && !allow_empty_message) {
1533 rollback_index_files();
1534 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1537 if (message_is_empty(&sb) && !allow_empty_message) {
1538 rollback_index_files();
1539 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1544 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1545 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1547 struct commit_extra_header **tail = &extra;
1548 append_merge_tag_headers(parents, &tail);
1551 if (commit_tree_extended(&sb, active_cache_tree->sha1, parents, sha1,
1552 author_ident.buf, sign_commit, extra)) {
1553 rollback_index_files();
1554 die(_("failed to write commit object"));
1556 strbuf_release(&author_ident);
1557 free_commit_extra_headers(extra);
1559 ref_lock = lock_any_ref_for_update("HEAD",
1562 : current_head->object.sha1,
1565 nl = strchr(sb.buf, '\n');
1567 strbuf_setlen(&sb, nl + 1 - sb.buf);
1569 strbuf_addch(&sb, '\n');
1570 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1571 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1574 rollback_index_files();
1575 die(_("cannot lock HEAD ref"));
1577 if (write_ref_sha1(ref_lock, sha1, sb.buf) < 0) {
1578 rollback_index_files();
1579 die(_("cannot update HEAD ref"));
1582 unlink(git_path("CHERRY_PICK_HEAD"));
1583 unlink(git_path("REVERT_HEAD"));
1584 unlink(git_path("MERGE_HEAD"));
1585 unlink(git_path("MERGE_MSG"));
1586 unlink(git_path("MERGE_MODE"));
1587 unlink(git_path("SQUASH_MSG"));
1589 if (commit_index_files())
1590 die (_("Repository has been updated, but unable to write\n"
1591 "new_index file. Check that disk is not full or quota is\n"
1592 "not exceeded, and then \"git reset HEAD\" to recover."));
1595 run_hook(get_index_file(), "post-commit", NULL);
1596 if (amend && !no_post_rewrite) {
1597 struct notes_rewrite_cfg *cfg;
1598 cfg = init_copy_notes_for_rewrite("amend");
1600 /* we are amending, so current_head is not NULL */
1601 copy_note_for_rewrite(cfg, current_head->object.sha1, sha1);
1602 finish_copy_notes_for_rewrite(cfg);
1604 run_rewrite_hook(current_head->object.sha1, sha1);
1607 print_summary(prefix, sha1, !current_head);