reset: add t7112 for submodule updates
[git/debian.git] / builtin / commit.c
blob5e2221c8e8c842314cb177d55223e87328b3da26
1 /*
2 * Builtin "git commit"
4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
6 */
8 #include "cache.h"
9 #include "cache-tree.h"
10 #include "color.h"
11 #include "dir.h"
12 #include "builtin.h"
13 #include "diff.h"
14 #include "diffcore.h"
15 #include "commit.h"
16 #include "revision.h"
17 #include "wt-status.h"
18 #include "run-command.h"
19 #include "refs.h"
20 #include "log-tree.h"
21 #include "strbuf.h"
22 #include "utf8.h"
23 #include "parse-options.h"
24 #include "string-list.h"
25 #include "rerere.h"
26 #include "unpack-trees.h"
27 #include "quote.h"
28 #include "submodule.h"
29 #include "gpg-interface.h"
30 #include "column.h"
31 #include "sequencer.h"
32 #include "notes-utils.h"
33 #include "mailmap.h"
35 static const char * const builtin_commit_usage[] = {
36 N_("git commit [options] [--] <pathspec>..."),
37 NULL
40 static const char * const builtin_status_usage[] = {
41 N_("git status [options] [--] <pathspec>..."),
42 NULL
45 static const char implicit_ident_advice[] =
46 N_("Your name and email address were configured automatically based\n"
47 "on your username and hostname. Please check that they are accurate.\n"
48 "You can suppress this message by setting them explicitly:\n"
49 "\n"
50 " git config --global user.name \"Your Name\"\n"
51 " git config --global user.email you@example.com\n"
52 "\n"
53 "After doing this, you may fix the identity used for this commit with:\n"
54 "\n"
55 " git commit --amend --reset-author\n");
57 static const char empty_amend_advice[] =
58 N_("You asked to amend the most recent commit, but doing so would make\n"
59 "it empty. You can repeat your command with --allow-empty, or you can\n"
60 "remove the commit entirely with \"git reset HEAD^\".\n");
62 static const char empty_cherry_pick_advice[] =
63 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
64 "If you wish to commit it anyway, use:\n"
65 "\n"
66 " git commit --allow-empty\n"
67 "\n");
69 static const char empty_cherry_pick_advice_single[] =
70 N_("Otherwise, please use 'git reset'\n");
72 static const char empty_cherry_pick_advice_multi[] =
73 N_("If you wish to skip this commit, use:\n"
74 "\n"
75 " git reset\n"
76 "\n"
77 "Then \"git cherry-pick --continue\" will resume cherry-picking\n"
78 "the remaining commits.\n");
80 static const char *use_message_buffer;
81 static const char commit_editmsg[] = "COMMIT_EDITMSG";
82 static struct lock_file index_lock; /* real index */
83 static struct lock_file false_lock; /* used only for partial commits */
84 static enum {
85 COMMIT_AS_IS = 1,
86 COMMIT_NORMAL,
87 COMMIT_PARTIAL
88 } commit_style;
90 static const char *logfile, *force_author;
91 static const char *template_file;
93 * The _message variables are commit names from which to take
94 * the commit message and/or authorship.
96 static const char *author_message, *author_message_buffer;
97 static char *edit_message, *use_message;
98 static char *fixup_message, *squash_message;
99 static int all, also, interactive, patch_interactive, only, amend, signoff;
100 static int edit_flag = -1; /* unspecified */
101 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
102 static int no_post_rewrite, allow_empty_message;
103 static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
104 static char *sign_commit;
107 * The default commit message cleanup mode will remove the lines
108 * beginning with # (shell comments) and leading and trailing
109 * whitespaces (empty lines or containing only whitespaces)
110 * if editor is used, and only the whitespaces if the message
111 * is specified explicitly.
113 static enum {
114 CLEANUP_SPACE,
115 CLEANUP_NONE,
116 CLEANUP_SCISSORS,
117 CLEANUP_ALL
118 } cleanup_mode;
119 static const char *cleanup_arg;
121 static enum commit_whence whence;
122 static int sequencer_in_use;
123 static int use_editor = 1, include_status = 1;
124 static int show_ignored_in_status, have_option_m;
125 static const char *only_include_assumed;
126 static struct strbuf message = STRBUF_INIT;
128 static enum status_format {
129 STATUS_FORMAT_NONE = 0,
130 STATUS_FORMAT_LONG,
131 STATUS_FORMAT_SHORT,
132 STATUS_FORMAT_PORCELAIN,
134 STATUS_FORMAT_UNSPECIFIED
135 } status_format = STATUS_FORMAT_UNSPECIFIED;
137 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
139 struct strbuf *buf = opt->value;
140 if (unset) {
141 have_option_m = 0;
142 strbuf_setlen(buf, 0);
143 } else {
144 have_option_m = 1;
145 if (buf->len)
146 strbuf_addch(buf, '\n');
147 strbuf_addstr(buf, arg);
148 strbuf_complete_line(buf);
150 return 0;
153 static void determine_whence(struct wt_status *s)
155 if (file_exists(git_path("MERGE_HEAD")))
156 whence = FROM_MERGE;
157 else if (file_exists(git_path("CHERRY_PICK_HEAD"))) {
158 whence = FROM_CHERRY_PICK;
159 if (file_exists(git_path("sequencer")))
160 sequencer_in_use = 1;
162 else
163 whence = FROM_COMMIT;
164 if (s)
165 s->whence = whence;
168 static void status_init_config(struct wt_status *s, config_fn_t fn)
170 wt_status_prepare(s);
171 gitmodules_config();
172 git_config(fn, s);
173 determine_whence(s);
174 s->hints = advice_status_hints; /* must come after git_config() */
177 static void rollback_index_files(void)
179 switch (commit_style) {
180 case COMMIT_AS_IS:
181 break; /* nothing to do */
182 case COMMIT_NORMAL:
183 rollback_lock_file(&index_lock);
184 break;
185 case COMMIT_PARTIAL:
186 rollback_lock_file(&index_lock);
187 rollback_lock_file(&false_lock);
188 break;
192 static int commit_index_files(void)
194 int err = 0;
196 switch (commit_style) {
197 case COMMIT_AS_IS:
198 break; /* nothing to do */
199 case COMMIT_NORMAL:
200 err = commit_lock_file(&index_lock);
201 break;
202 case COMMIT_PARTIAL:
203 err = commit_lock_file(&index_lock);
204 rollback_lock_file(&false_lock);
205 break;
208 return err;
212 * Take a union of paths in the index and the named tree (typically, "HEAD"),
213 * and return the paths that match the given pattern in list.
215 static int list_paths(struct string_list *list, const char *with_tree,
216 const char *prefix, const struct pathspec *pattern)
218 int i;
219 char *m;
221 if (!pattern->nr)
222 return 0;
224 m = xcalloc(1, pattern->nr);
226 if (with_tree) {
227 char *max_prefix = common_prefix(pattern);
228 overlay_tree_on_cache(with_tree, max_prefix ? max_prefix : prefix);
229 free(max_prefix);
232 for (i = 0; i < active_nr; i++) {
233 const struct cache_entry *ce = active_cache[i];
234 struct string_list_item *item;
236 if (ce->ce_flags & CE_UPDATE)
237 continue;
238 if (!ce_path_match(ce, pattern, m))
239 continue;
240 item = string_list_insert(list, ce->name);
241 if (ce_skip_worktree(ce))
242 item->util = item; /* better a valid pointer than a fake one */
245 return report_path_error(m, pattern, prefix);
248 static void add_remove_files(struct string_list *list)
250 int i;
251 for (i = 0; i < list->nr; i++) {
252 struct stat st;
253 struct string_list_item *p = &(list->items[i]);
255 /* p->util is skip-worktree */
256 if (p->util)
257 continue;
259 if (!lstat(p->string, &st)) {
260 if (add_to_cache(p->string, &st, 0))
261 die(_("updating files failed"));
262 } else
263 remove_file_from_cache(p->string);
267 static void create_base_index(const struct commit *current_head)
269 struct tree *tree;
270 struct unpack_trees_options opts;
271 struct tree_desc t;
273 if (!current_head) {
274 discard_cache();
275 return;
278 memset(&opts, 0, sizeof(opts));
279 opts.head_idx = 1;
280 opts.index_only = 1;
281 opts.merge = 1;
282 opts.src_index = &the_index;
283 opts.dst_index = &the_index;
285 opts.fn = oneway_merge;
286 tree = parse_tree_indirect(current_head->object.sha1);
287 if (!tree)
288 die(_("failed to unpack HEAD tree object"));
289 parse_tree(tree);
290 init_tree_desc(&t, tree->buffer, tree->size);
291 if (unpack_trees(1, &t, &opts))
292 exit(128); /* We've already reported the error, finish dying */
295 static void refresh_cache_or_die(int refresh_flags)
298 * refresh_flags contains REFRESH_QUIET, so the only errors
299 * are for unmerged entries.
301 if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
302 die_resolve_conflict("commit");
305 static char *prepare_index(int argc, const char **argv, const char *prefix,
306 const struct commit *current_head, int is_status)
308 int fd;
309 struct string_list partial;
310 struct pathspec pathspec;
311 int refresh_flags = REFRESH_QUIET;
313 if (is_status)
314 refresh_flags |= REFRESH_UNMERGED;
315 parse_pathspec(&pathspec, 0,
316 PATHSPEC_PREFER_FULL,
317 prefix, argv);
319 if (read_cache_preload(&pathspec) < 0)
320 die(_("index file corrupt"));
322 if (interactive) {
323 char *old_index_env = NULL;
324 fd = hold_locked_index(&index_lock, 1);
326 refresh_cache_or_die(refresh_flags);
328 if (write_cache(fd, active_cache, active_nr) ||
329 close_lock_file(&index_lock))
330 die(_("unable to create temporary index"));
332 old_index_env = getenv(INDEX_ENVIRONMENT);
333 setenv(INDEX_ENVIRONMENT, index_lock.filename, 1);
335 if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
336 die(_("interactive add failed"));
338 if (old_index_env && *old_index_env)
339 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
340 else
341 unsetenv(INDEX_ENVIRONMENT);
343 discard_cache();
344 read_cache_from(index_lock.filename);
346 commit_style = COMMIT_NORMAL;
347 return index_lock.filename;
351 * Non partial, non as-is commit.
353 * (1) get the real index;
354 * (2) update the_index as necessary;
355 * (3) write the_index out to the real index (still locked);
356 * (4) return the name of the locked index file.
358 * The caller should run hooks on the locked real index, and
359 * (A) if all goes well, commit the real index;
360 * (B) on failure, rollback the real index.
362 if (all || (also && pathspec.nr)) {
363 fd = hold_locked_index(&index_lock, 1);
364 add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
365 refresh_cache_or_die(refresh_flags);
366 update_main_cache_tree(WRITE_TREE_SILENT);
367 if (write_cache(fd, active_cache, active_nr) ||
368 close_lock_file(&index_lock))
369 die(_("unable to write new_index file"));
370 commit_style = COMMIT_NORMAL;
371 return index_lock.filename;
375 * As-is commit.
377 * (1) return the name of the real index file.
379 * The caller should run hooks on the real index,
380 * and create commit from the_index.
381 * We still need to refresh the index here.
383 if (!only && !pathspec.nr) {
384 fd = hold_locked_index(&index_lock, 1);
385 refresh_cache_or_die(refresh_flags);
386 if (active_cache_changed) {
387 update_main_cache_tree(WRITE_TREE_SILENT);
388 if (write_cache(fd, active_cache, active_nr) ||
389 commit_locked_index(&index_lock))
390 die(_("unable to write new_index file"));
391 } else {
392 rollback_lock_file(&index_lock);
394 commit_style = COMMIT_AS_IS;
395 return get_index_file();
399 * A partial commit.
401 * (0) find the set of affected paths;
402 * (1) get lock on the real index file;
403 * (2) update the_index with the given paths;
404 * (3) write the_index out to the real index (still locked);
405 * (4) get lock on the false index file;
406 * (5) reset the_index from HEAD;
407 * (6) update the_index the same way as (2);
408 * (7) write the_index out to the false index file;
409 * (8) return the name of the false index file (still locked);
411 * The caller should run hooks on the locked false index, and
412 * create commit from it. Then
413 * (A) if all goes well, commit the real index;
414 * (B) on failure, rollback the real index;
415 * In either case, rollback the false index.
417 commit_style = COMMIT_PARTIAL;
419 if (whence != FROM_COMMIT) {
420 if (whence == FROM_MERGE)
421 die(_("cannot do a partial commit during a merge."));
422 else if (whence == FROM_CHERRY_PICK)
423 die(_("cannot do a partial commit during a cherry-pick."));
426 memset(&partial, 0, sizeof(partial));
427 partial.strdup_strings = 1;
428 if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, &pathspec))
429 exit(1);
431 discard_cache();
432 if (read_cache() < 0)
433 die(_("cannot read the index"));
435 fd = hold_locked_index(&index_lock, 1);
436 add_remove_files(&partial);
437 refresh_cache(REFRESH_QUIET);
438 if (write_cache(fd, active_cache, active_nr) ||
439 close_lock_file(&index_lock))
440 die(_("unable to write new_index file"));
442 fd = hold_lock_file_for_update(&false_lock,
443 git_path("next-index-%"PRIuMAX,
444 (uintmax_t) getpid()),
445 LOCK_DIE_ON_ERROR);
447 create_base_index(current_head);
448 add_remove_files(&partial);
449 refresh_cache(REFRESH_QUIET);
451 if (write_cache(fd, active_cache, active_nr) ||
452 close_lock_file(&false_lock))
453 die(_("unable to write temporary index file"));
455 discard_cache();
456 read_cache_from(false_lock.filename);
458 return false_lock.filename;
461 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
462 struct wt_status *s)
464 unsigned char sha1[20];
466 if (s->relative_paths)
467 s->prefix = prefix;
469 if (amend) {
470 s->amend = 1;
471 s->reference = "HEAD^1";
473 s->verbose = verbose;
474 s->index_file = index_file;
475 s->fp = fp;
476 s->nowarn = nowarn;
477 s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
479 wt_status_collect(s);
481 switch (status_format) {
482 case STATUS_FORMAT_SHORT:
483 wt_shortstatus_print(s);
484 break;
485 case STATUS_FORMAT_PORCELAIN:
486 wt_porcelain_print(s);
487 break;
488 case STATUS_FORMAT_UNSPECIFIED:
489 die("BUG: finalize_deferred_config() should have been called");
490 break;
491 case STATUS_FORMAT_NONE:
492 case STATUS_FORMAT_LONG:
493 wt_status_print(s);
494 break;
497 return s->commitable;
500 static int is_a_merge(const struct commit *current_head)
502 return !!(current_head->parents && current_head->parents->next);
505 static void export_one(const char *var, const char *s, const char *e, int hack)
507 struct strbuf buf = STRBUF_INIT;
508 if (hack)
509 strbuf_addch(&buf, hack);
510 strbuf_addf(&buf, "%.*s", (int)(e - s), s);
511 setenv(var, buf.buf, 1);
512 strbuf_release(&buf);
515 static int sane_ident_split(struct ident_split *person)
517 if (!person->name_begin || !person->name_end ||
518 person->name_begin == person->name_end)
519 return 0; /* no human readable name */
520 if (!person->mail_begin || !person->mail_end ||
521 person->mail_begin == person->mail_end)
522 return 0; /* no usable mail */
523 if (!person->date_begin || !person->date_end ||
524 !person->tz_begin || !person->tz_end)
525 return 0;
526 return 1;
529 static int parse_force_date(const char *in, char *out, int len)
531 if (len < 1)
532 return -1;
533 *out++ = '@';
534 len--;
536 if (parse_date(in, out, len) < 0) {
537 int errors = 0;
538 unsigned long t = approxidate_careful(in, &errors);
539 if (errors)
540 return -1;
541 snprintf(out, len, "%lu", t);
544 return 0;
547 static void determine_author_info(struct strbuf *author_ident)
549 char *name, *email, *date;
550 struct ident_split author;
551 char date_buf[64];
553 name = getenv("GIT_AUTHOR_NAME");
554 email = getenv("GIT_AUTHOR_EMAIL");
555 date = getenv("GIT_AUTHOR_DATE");
557 if (author_message) {
558 const char *a, *lb, *rb, *eol;
559 size_t len;
561 a = strstr(author_message_buffer, "\nauthor ");
562 if (!a)
563 die(_("invalid commit: %s"), author_message);
565 lb = strchrnul(a + strlen("\nauthor "), '<');
566 rb = strchrnul(lb, '>');
567 eol = strchrnul(rb, '\n');
568 if (!*lb || !*rb || !*eol)
569 die(_("invalid commit: %s"), author_message);
571 if (lb == a + strlen("\nauthor "))
572 /* \nauthor <foo@example.com> */
573 name = xcalloc(1, 1);
574 else
575 name = xmemdupz(a + strlen("\nauthor "),
576 (lb - strlen(" ") -
577 (a + strlen("\nauthor "))));
578 email = xmemdupz(lb + strlen("<"), rb - (lb + strlen("<")));
579 len = eol - (rb + strlen("> "));
580 date = xmalloc(len + 2);
581 *date = '@';
582 memcpy(date + 1, rb + strlen("> "), len);
583 date[len + 1] = '\0';
586 if (force_author) {
587 const char *lb = strstr(force_author, " <");
588 const char *rb = strchr(force_author, '>');
590 if (!lb || !rb)
591 die(_("malformed --author parameter"));
592 name = xstrndup(force_author, lb - force_author);
593 email = xstrndup(lb + 2, rb - (lb + 2));
596 if (force_date) {
597 if (parse_force_date(force_date, date_buf, sizeof(date_buf)))
598 die(_("invalid date format: %s"), force_date);
599 date = date_buf;
602 strbuf_addstr(author_ident, fmt_ident(name, email, date, IDENT_STRICT));
603 if (!split_ident_line(&author, author_ident->buf, author_ident->len) &&
604 sane_ident_split(&author)) {
605 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
606 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
607 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
611 static void split_ident_or_die(struct ident_split *id, const struct strbuf *buf)
613 if (split_ident_line(id, buf->buf, buf->len) ||
614 !sane_ident_split(id))
615 die(_("Malformed ident string: '%s'"), buf->buf);
618 static int author_date_is_interesting(void)
620 return author_message || force_date;
623 static void adjust_comment_line_char(const struct strbuf *sb)
625 char candidates[] = "#;@!$%^&|:";
626 char *candidate;
627 const char *p;
629 comment_line_char = candidates[0];
630 if (!memchr(sb->buf, comment_line_char, sb->len))
631 return;
633 p = sb->buf;
634 candidate = strchr(candidates, *p);
635 if (candidate)
636 *candidate = ' ';
637 for (p = sb->buf; *p; p++) {
638 if ((p[0] == '\n' || p[0] == '\r') && p[1]) {
639 candidate = strchr(candidates, p[1]);
640 if (candidate)
641 *candidate = ' ';
645 for (p = candidates; *p == ' '; p++)
647 if (!*p)
648 die(_("unable to select a comment character that is not used\n"
649 "in the current commit message"));
650 comment_line_char = *p;
653 static int prepare_to_commit(const char *index_file, const char *prefix,
654 struct commit *current_head,
655 struct wt_status *s,
656 struct strbuf *author_ident)
658 struct stat statbuf;
659 struct strbuf committer_ident = STRBUF_INIT;
660 int commitable;
661 struct strbuf sb = STRBUF_INIT;
662 const char *hook_arg1 = NULL;
663 const char *hook_arg2 = NULL;
664 int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
665 int old_display_comment_prefix;
667 /* This checks and barfs if author is badly specified */
668 determine_author_info(author_ident);
670 if (!no_verify && run_commit_hook(use_editor, index_file, "pre-commit", NULL))
671 return 0;
673 if (squash_message) {
675 * Insert the proper subject line before other commit
676 * message options add their content.
678 if (use_message && !strcmp(use_message, squash_message))
679 strbuf_addstr(&sb, "squash! ");
680 else {
681 struct pretty_print_context ctx = {0};
682 struct commit *c;
683 c = lookup_commit_reference_by_name(squash_message);
684 if (!c)
685 die(_("could not lookup commit %s"), squash_message);
686 ctx.output_encoding = get_commit_output_encoding();
687 format_commit_message(c, "squash! %s\n\n", &sb,
688 &ctx);
692 if (message.len) {
693 strbuf_addbuf(&sb, &message);
694 hook_arg1 = "message";
695 } else if (logfile && !strcmp(logfile, "-")) {
696 if (isatty(0))
697 fprintf(stderr, _("(reading log message from standard input)\n"));
698 if (strbuf_read(&sb, 0, 0) < 0)
699 die_errno(_("could not read log from standard input"));
700 hook_arg1 = "message";
701 } else if (logfile) {
702 if (strbuf_read_file(&sb, logfile, 0) < 0)
703 die_errno(_("could not read log file '%s'"),
704 logfile);
705 hook_arg1 = "message";
706 } else if (use_message) {
707 char *buffer;
708 buffer = strstr(use_message_buffer, "\n\n");
709 if (buffer)
710 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
711 hook_arg1 = "commit";
712 hook_arg2 = use_message;
713 } else if (fixup_message) {
714 struct pretty_print_context ctx = {0};
715 struct commit *commit;
716 commit = lookup_commit_reference_by_name(fixup_message);
717 if (!commit)
718 die(_("could not lookup commit %s"), fixup_message);
719 ctx.output_encoding = get_commit_output_encoding();
720 format_commit_message(commit, "fixup! %s\n\n",
721 &sb, &ctx);
722 hook_arg1 = "message";
723 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
724 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
725 die_errno(_("could not read MERGE_MSG"));
726 hook_arg1 = "merge";
727 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
728 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
729 die_errno(_("could not read SQUASH_MSG"));
730 hook_arg1 = "squash";
731 } else if (template_file) {
732 if (strbuf_read_file(&sb, template_file, 0) < 0)
733 die_errno(_("could not read '%s'"), template_file);
734 hook_arg1 = "template";
735 clean_message_contents = 0;
739 * The remaining cases don't modify the template message, but
740 * just set the argument(s) to the prepare-commit-msg hook.
742 else if (whence == FROM_MERGE)
743 hook_arg1 = "merge";
744 else if (whence == FROM_CHERRY_PICK) {
745 hook_arg1 = "commit";
746 hook_arg2 = "CHERRY_PICK_HEAD";
749 if (squash_message) {
751 * If squash_commit was used for the commit subject,
752 * then we're possibly hijacking other commit log options.
753 * Reset the hook args to tell the real story.
755 hook_arg1 = "message";
756 hook_arg2 = "";
759 s->fp = fopen(git_path(commit_editmsg), "w");
760 if (s->fp == NULL)
761 die_errno(_("could not open '%s'"), git_path(commit_editmsg));
763 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
764 old_display_comment_prefix = s->display_comment_prefix;
765 s->display_comment_prefix = 1;
768 * Most hints are counter-productive when the commit has
769 * already started.
771 s->hints = 0;
773 if (clean_message_contents)
774 stripspace(&sb, 0);
776 if (signoff) {
778 * See if we have a Conflicts: block at the end. If yes, count
779 * its size, so we can ignore it.
781 int ignore_footer = 0;
782 int i, eol, previous = 0;
783 const char *nl;
785 for (i = 0; i < sb.len; i++) {
786 nl = memchr(sb.buf + i, '\n', sb.len - i);
787 if (nl)
788 eol = nl - sb.buf;
789 else
790 eol = sb.len;
791 if (starts_with(sb.buf + previous, "\nConflicts:\n")) {
792 ignore_footer = sb.len - previous;
793 break;
795 while (i < eol)
796 i++;
797 previous = eol;
800 append_signoff(&sb, ignore_footer, 0);
803 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
804 die_errno(_("could not write commit template"));
806 if (auto_comment_line_char)
807 adjust_comment_line_char(&sb);
808 strbuf_release(&sb);
810 /* This checks if committer ident is explicitly given */
811 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
812 if (use_editor && include_status) {
813 int ident_shown = 0;
814 int saved_color_setting;
815 struct ident_split ci, ai;
817 if (whence != FROM_COMMIT) {
818 if (cleanup_mode == CLEANUP_SCISSORS)
819 wt_status_add_cut_line(s->fp);
820 status_printf_ln(s, GIT_COLOR_NORMAL,
821 whence == FROM_MERGE
822 ? _("\n"
823 "It looks like you may be committing a merge.\n"
824 "If this is not correct, please remove the file\n"
825 " %s\n"
826 "and try again.\n")
827 : _("\n"
828 "It looks like you may be committing a cherry-pick.\n"
829 "If this is not correct, please remove the file\n"
830 " %s\n"
831 "and try again.\n"),
832 git_path(whence == FROM_MERGE
833 ? "MERGE_HEAD"
834 : "CHERRY_PICK_HEAD"));
837 fprintf(s->fp, "\n");
838 if (cleanup_mode == CLEANUP_ALL)
839 status_printf(s, GIT_COLOR_NORMAL,
840 _("Please enter the commit message for your changes."
841 " Lines starting\nwith '%c' will be ignored, and an empty"
842 " message aborts the commit.\n"), comment_line_char);
843 else if (cleanup_mode == CLEANUP_SCISSORS && whence == FROM_COMMIT)
844 wt_status_add_cut_line(s->fp);
845 else /* CLEANUP_SPACE, that is. */
846 status_printf(s, GIT_COLOR_NORMAL,
847 _("Please enter the commit message for your changes."
848 " Lines starting\n"
849 "with '%c' will be kept; you may remove them"
850 " yourself if you want to.\n"
851 "An empty message aborts the commit.\n"), comment_line_char);
852 if (only_include_assumed)
853 status_printf_ln(s, GIT_COLOR_NORMAL,
854 "%s", only_include_assumed);
856 split_ident_or_die(&ai, author_ident);
857 split_ident_or_die(&ci, &committer_ident);
859 if (ident_cmp(&ai, &ci))
860 status_printf_ln(s, GIT_COLOR_NORMAL,
861 _("%s"
862 "Author: %.*s <%.*s>"),
863 ident_shown++ ? "" : "\n",
864 (int)(ai.name_end - ai.name_begin), ai.name_begin,
865 (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);
867 if (author_date_is_interesting())
868 status_printf_ln(s, GIT_COLOR_NORMAL,
869 _("%s"
870 "Date: %s"),
871 ident_shown++ ? "" : "\n",
872 show_ident_date(&ai, DATE_NORMAL));
874 if (!committer_ident_sufficiently_given())
875 status_printf_ln(s, GIT_COLOR_NORMAL,
876 _("%s"
877 "Committer: %.*s <%.*s>"),
878 ident_shown++ ? "" : "\n",
879 (int)(ci.name_end - ci.name_begin), ci.name_begin,
880 (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
882 if (ident_shown)
883 status_printf_ln(s, GIT_COLOR_NORMAL, "%s", "");
885 saved_color_setting = s->use_color;
886 s->use_color = 0;
887 commitable = run_status(s->fp, index_file, prefix, 1, s);
888 s->use_color = saved_color_setting;
889 } else {
890 unsigned char sha1[20];
891 const char *parent = "HEAD";
893 if (!active_nr && read_cache() < 0)
894 die(_("Cannot read index"));
896 if (amend)
897 parent = "HEAD^1";
899 if (get_sha1(parent, sha1))
900 commitable = !!active_nr;
901 else {
903 * Unless the user did explicitly request a submodule
904 * ignore mode by passing a command line option we do
905 * not ignore any changed submodule SHA-1s when
906 * comparing index and parent, no matter what is
907 * configured. Otherwise we won't commit any
908 * submodules which were manually staged, which would
909 * be really confusing.
911 int diff_flags = DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG;
912 if (ignore_submodule_arg &&
913 !strcmp(ignore_submodule_arg, "all"))
914 diff_flags |= DIFF_OPT_IGNORE_SUBMODULES;
915 commitable = index_differs_from(parent, diff_flags);
918 strbuf_release(&committer_ident);
920 fclose(s->fp);
923 * Reject an attempt to record a non-merge empty commit without
924 * explicit --allow-empty. In the cherry-pick case, it may be
925 * empty due to conflict resolution, which the user should okay.
927 if (!commitable && whence != FROM_MERGE && !allow_empty &&
928 !(amend && is_a_merge(current_head))) {
929 s->display_comment_prefix = old_display_comment_prefix;
930 run_status(stdout, index_file, prefix, 0, s);
931 if (amend)
932 fputs(_(empty_amend_advice), stderr);
933 else if (whence == FROM_CHERRY_PICK) {
934 fputs(_(empty_cherry_pick_advice), stderr);
935 if (!sequencer_in_use)
936 fputs(_(empty_cherry_pick_advice_single), stderr);
937 else
938 fputs(_(empty_cherry_pick_advice_multi), stderr);
940 return 0;
944 * Re-read the index as pre-commit hook could have updated it,
945 * and write it out as a tree. We must do this before we invoke
946 * the editor and after we invoke run_status above.
948 discard_cache();
949 read_cache_from(index_file);
950 if (update_main_cache_tree(0)) {
951 error(_("Error building trees"));
952 return 0;
955 if (run_commit_hook(use_editor, index_file, "prepare-commit-msg",
956 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
957 return 0;
959 if (use_editor) {
960 char index[PATH_MAX];
961 const char *env[2] = { NULL };
962 env[0] = index;
963 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
964 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
965 fprintf(stderr,
966 _("Please supply the message using either -m or -F option.\n"));
967 exit(1);
971 if (!no_verify &&
972 run_commit_hook(use_editor, index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
973 return 0;
976 return 1;
979 static int rest_is_empty(struct strbuf *sb, int start)
981 int i, eol;
982 const char *nl;
984 /* Check if the rest is just whitespace and Signed-of-by's. */
985 for (i = start; i < sb->len; i++) {
986 nl = memchr(sb->buf + i, '\n', sb->len - i);
987 if (nl)
988 eol = nl - sb->buf;
989 else
990 eol = sb->len;
992 if (strlen(sign_off_header) <= eol - i &&
993 starts_with(sb->buf + i, sign_off_header)) {
994 i = eol;
995 continue;
997 while (i < eol)
998 if (!isspace(sb->buf[i++]))
999 return 0;
1002 return 1;
1006 * Find out if the message in the strbuf contains only whitespace and
1007 * Signed-off-by lines.
1009 static int message_is_empty(struct strbuf *sb)
1011 if (cleanup_mode == CLEANUP_NONE && sb->len)
1012 return 0;
1013 return rest_is_empty(sb, 0);
1017 * See if the user edited the message in the editor or left what
1018 * was in the template intact
1020 static int template_untouched(struct strbuf *sb)
1022 struct strbuf tmpl = STRBUF_INIT;
1023 char *start;
1025 if (cleanup_mode == CLEANUP_NONE && sb->len)
1026 return 0;
1028 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
1029 return 0;
1031 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
1032 start = (char *)skip_prefix(sb->buf, tmpl.buf);
1033 if (!start)
1034 start = sb->buf;
1035 strbuf_release(&tmpl);
1036 return rest_is_empty(sb, start - sb->buf);
1039 static const char *find_author_by_nickname(const char *name)
1041 struct rev_info revs;
1042 struct commit *commit;
1043 struct strbuf buf = STRBUF_INIT;
1044 struct string_list mailmap = STRING_LIST_INIT_NODUP;
1045 const char *av[20];
1046 int ac = 0;
1048 init_revisions(&revs, NULL);
1049 strbuf_addf(&buf, "--author=%s", name);
1050 av[++ac] = "--all";
1051 av[++ac] = "-i";
1052 av[++ac] = buf.buf;
1053 av[++ac] = NULL;
1054 setup_revisions(ac, av, &revs, NULL);
1055 revs.mailmap = &mailmap;
1056 read_mailmap(revs.mailmap, NULL);
1058 prepare_revision_walk(&revs);
1059 commit = get_revision(&revs);
1060 if (commit) {
1061 struct pretty_print_context ctx = {0};
1062 ctx.date_mode = DATE_NORMAL;
1063 strbuf_release(&buf);
1064 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
1065 clear_mailmap(&mailmap);
1066 return strbuf_detach(&buf, NULL);
1068 die(_("No existing author found with '%s'"), name);
1072 static void handle_untracked_files_arg(struct wt_status *s)
1074 if (!untracked_files_arg)
1075 ; /* default already initialized */
1076 else if (!strcmp(untracked_files_arg, "no"))
1077 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1078 else if (!strcmp(untracked_files_arg, "normal"))
1079 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1080 else if (!strcmp(untracked_files_arg, "all"))
1081 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1082 else
1083 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1086 static const char *read_commit_message(const char *name)
1088 const char *out_enc;
1089 struct commit *commit;
1091 commit = lookup_commit_reference_by_name(name);
1092 if (!commit)
1093 die(_("could not lookup commit %s"), name);
1094 out_enc = get_commit_output_encoding();
1095 return logmsg_reencode(commit, NULL, out_enc);
1099 * Enumerate what needs to be propagated when --porcelain
1100 * is not in effect here.
1102 static struct status_deferred_config {
1103 enum status_format status_format;
1104 int show_branch;
1105 } status_deferred_config = {
1106 STATUS_FORMAT_UNSPECIFIED,
1107 -1 /* unspecified */
1110 static void finalize_deferred_config(struct wt_status *s)
1112 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1113 !s->null_termination);
1115 if (s->null_termination) {
1116 if (status_format == STATUS_FORMAT_NONE ||
1117 status_format == STATUS_FORMAT_UNSPECIFIED)
1118 status_format = STATUS_FORMAT_PORCELAIN;
1119 else if (status_format == STATUS_FORMAT_LONG)
1120 die(_("--long and -z are incompatible"));
1123 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1124 status_format = status_deferred_config.status_format;
1125 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1126 status_format = STATUS_FORMAT_NONE;
1128 if (use_deferred_config && s->show_branch < 0)
1129 s->show_branch = status_deferred_config.show_branch;
1130 if (s->show_branch < 0)
1131 s->show_branch = 0;
1134 static int parse_and_validate_options(int argc, const char *argv[],
1135 const struct option *options,
1136 const char * const usage[],
1137 const char *prefix,
1138 struct commit *current_head,
1139 struct wt_status *s)
1141 int f = 0;
1143 argc = parse_options(argc, argv, prefix, options, usage, 0);
1144 finalize_deferred_config(s);
1146 if (force_author && !strchr(force_author, '>'))
1147 force_author = find_author_by_nickname(force_author);
1149 if (force_author && renew_authorship)
1150 die(_("Using both --reset-author and --author does not make sense"));
1152 if (logfile || have_option_m || use_message || fixup_message)
1153 use_editor = 0;
1154 if (0 <= edit_flag)
1155 use_editor = edit_flag;
1157 /* Sanity check options */
1158 if (amend && !current_head)
1159 die(_("You have nothing to amend."));
1160 if (amend && whence != FROM_COMMIT) {
1161 if (whence == FROM_MERGE)
1162 die(_("You are in the middle of a merge -- cannot amend."));
1163 else if (whence == FROM_CHERRY_PICK)
1164 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1166 if (fixup_message && squash_message)
1167 die(_("Options --squash and --fixup cannot be used together"));
1168 if (use_message)
1169 f++;
1170 if (edit_message)
1171 f++;
1172 if (fixup_message)
1173 f++;
1174 if (logfile)
1175 f++;
1176 if (f > 1)
1177 die(_("Only one of -c/-C/-F/--fixup can be used."));
1178 if (message.len && f > 0)
1179 die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1180 if (f || message.len)
1181 template_file = NULL;
1182 if (edit_message)
1183 use_message = edit_message;
1184 if (amend && !use_message && !fixup_message)
1185 use_message = "HEAD";
1186 if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1187 die(_("--reset-author can be used only with -C, -c or --amend."));
1188 if (use_message) {
1189 use_message_buffer = read_commit_message(use_message);
1190 if (!renew_authorship) {
1191 author_message = use_message;
1192 author_message_buffer = use_message_buffer;
1195 if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1196 author_message = "CHERRY_PICK_HEAD";
1197 author_message_buffer = read_commit_message(author_message);
1200 if (patch_interactive)
1201 interactive = 1;
1203 if (also + only + all + interactive > 1)
1204 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1205 if (argc == 0 && (also || (only && !amend)))
1206 die(_("No paths with --include/--only does not make sense."));
1207 if (argc == 0 && only && amend)
1208 only_include_assumed = _("Clever... amending the last one with dirty index.");
1209 if (argc > 0 && !also && !only)
1210 only_include_assumed = _("Explicit paths specified without -i or -o; assuming --only paths...");
1211 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1212 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
1213 else if (!strcmp(cleanup_arg, "verbatim"))
1214 cleanup_mode = CLEANUP_NONE;
1215 else if (!strcmp(cleanup_arg, "whitespace"))
1216 cleanup_mode = CLEANUP_SPACE;
1217 else if (!strcmp(cleanup_arg, "strip"))
1218 cleanup_mode = CLEANUP_ALL;
1219 else if (!strcmp(cleanup_arg, "scissors"))
1220 cleanup_mode = use_editor ? CLEANUP_SCISSORS : CLEANUP_SPACE;
1221 else
1222 die(_("Invalid cleanup mode %s"), cleanup_arg);
1224 handle_untracked_files_arg(s);
1226 if (all && argc > 0)
1227 die(_("Paths with -a does not make sense."));
1229 if (status_format != STATUS_FORMAT_NONE)
1230 dry_run = 1;
1232 return argc;
1235 static int dry_run_commit(int argc, const char **argv, const char *prefix,
1236 const struct commit *current_head, struct wt_status *s)
1238 int commitable;
1239 const char *index_file;
1241 index_file = prepare_index(argc, argv, prefix, current_head, 1);
1242 commitable = run_status(stdout, index_file, prefix, 0, s);
1243 rollback_index_files();
1245 return commitable ? 0 : 1;
1248 static int parse_status_slot(const char *var, int offset)
1250 if (!strcasecmp(var+offset, "header"))
1251 return WT_STATUS_HEADER;
1252 if (!strcasecmp(var+offset, "branch"))
1253 return WT_STATUS_ONBRANCH;
1254 if (!strcasecmp(var+offset, "updated")
1255 || !strcasecmp(var+offset, "added"))
1256 return WT_STATUS_UPDATED;
1257 if (!strcasecmp(var+offset, "changed"))
1258 return WT_STATUS_CHANGED;
1259 if (!strcasecmp(var+offset, "untracked"))
1260 return WT_STATUS_UNTRACKED;
1261 if (!strcasecmp(var+offset, "nobranch"))
1262 return WT_STATUS_NOBRANCH;
1263 if (!strcasecmp(var+offset, "unmerged"))
1264 return WT_STATUS_UNMERGED;
1265 return -1;
1268 static int git_status_config(const char *k, const char *v, void *cb)
1270 struct wt_status *s = cb;
1272 if (starts_with(k, "column."))
1273 return git_column_config(k, v, "status", &s->colopts);
1274 if (!strcmp(k, "status.submodulesummary")) {
1275 int is_bool;
1276 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1277 if (is_bool && s->submodule_summary)
1278 s->submodule_summary = -1;
1279 return 0;
1281 if (!strcmp(k, "status.short")) {
1282 if (git_config_bool(k, v))
1283 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1284 else
1285 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1286 return 0;
1288 if (!strcmp(k, "status.branch")) {
1289 status_deferred_config.show_branch = git_config_bool(k, v);
1290 return 0;
1292 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1293 s->use_color = git_config_colorbool(k, v);
1294 return 0;
1296 if (!strcmp(k, "status.displaycommentprefix")) {
1297 s->display_comment_prefix = git_config_bool(k, v);
1298 return 0;
1300 if (starts_with(k, "status.color.") || starts_with(k, "color.status.")) {
1301 int slot = parse_status_slot(k, 13);
1302 if (slot < 0)
1303 return 0;
1304 if (!v)
1305 return config_error_nonbool(k);
1306 color_parse(v, k, s->color_palette[slot]);
1307 return 0;
1309 if (!strcmp(k, "status.relativepaths")) {
1310 s->relative_paths = git_config_bool(k, v);
1311 return 0;
1313 if (!strcmp(k, "status.showuntrackedfiles")) {
1314 if (!v)
1315 return config_error_nonbool(k);
1316 else if (!strcmp(v, "no"))
1317 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1318 else if (!strcmp(v, "normal"))
1319 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1320 else if (!strcmp(v, "all"))
1321 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1322 else
1323 return error(_("Invalid untracked files mode '%s'"), v);
1324 return 0;
1326 return git_diff_ui_config(k, v, NULL);
1329 int cmd_status(int argc, const char **argv, const char *prefix)
1331 static struct wt_status s;
1332 int fd;
1333 unsigned char sha1[20];
1334 static struct option builtin_status_options[] = {
1335 OPT__VERBOSE(&verbose, N_("be verbose")),
1336 OPT_SET_INT('s', "short", &status_format,
1337 N_("show status concisely"), STATUS_FORMAT_SHORT),
1338 OPT_BOOL('b', "branch", &s.show_branch,
1339 N_("show branch information")),
1340 OPT_SET_INT(0, "porcelain", &status_format,
1341 N_("machine-readable output"),
1342 STATUS_FORMAT_PORCELAIN),
1343 OPT_SET_INT(0, "long", &status_format,
1344 N_("show status in long format (default)"),
1345 STATUS_FORMAT_LONG),
1346 OPT_BOOL('z', "null", &s.null_termination,
1347 N_("terminate entries with NUL")),
1348 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1349 N_("mode"),
1350 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1351 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1352 OPT_BOOL(0, "ignored", &show_ignored_in_status,
1353 N_("show ignored files")),
1354 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1355 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1356 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1357 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1358 OPT_END(),
1361 if (argc == 2 && !strcmp(argv[1], "-h"))
1362 usage_with_options(builtin_status_usage, builtin_status_options);
1364 status_init_config(&s, git_status_config);
1365 argc = parse_options(argc, argv, prefix,
1366 builtin_status_options,
1367 builtin_status_usage, 0);
1368 finalize_colopts(&s.colopts, -1);
1369 finalize_deferred_config(&s);
1371 handle_untracked_files_arg(&s);
1372 if (show_ignored_in_status)
1373 s.show_ignored_files = 1;
1374 parse_pathspec(&s.pathspec, 0,
1375 PATHSPEC_PREFER_FULL,
1376 prefix, argv);
1378 read_cache_preload(&s.pathspec);
1379 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &s.pathspec, NULL, NULL);
1381 fd = hold_locked_index(&index_lock, 0);
1382 if (0 <= fd)
1383 update_index_if_able(&the_index, &index_lock);
1385 s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1386 s.ignore_submodule_arg = ignore_submodule_arg;
1387 wt_status_collect(&s);
1389 if (s.relative_paths)
1390 s.prefix = prefix;
1392 switch (status_format) {
1393 case STATUS_FORMAT_SHORT:
1394 wt_shortstatus_print(&s);
1395 break;
1396 case STATUS_FORMAT_PORCELAIN:
1397 wt_porcelain_print(&s);
1398 break;
1399 case STATUS_FORMAT_UNSPECIFIED:
1400 die("BUG: finalize_deferred_config() should have been called");
1401 break;
1402 case STATUS_FORMAT_NONE:
1403 case STATUS_FORMAT_LONG:
1404 s.verbose = verbose;
1405 s.ignore_submodule_arg = ignore_submodule_arg;
1406 wt_status_print(&s);
1407 break;
1409 return 0;
1412 static void print_summary(const char *prefix, const unsigned char *sha1,
1413 int initial_commit)
1415 struct rev_info rev;
1416 struct commit *commit;
1417 struct strbuf format = STRBUF_INIT;
1418 unsigned char junk_sha1[20];
1419 const char *head;
1420 struct pretty_print_context pctx = {0};
1421 struct strbuf author_ident = STRBUF_INIT;
1422 struct strbuf committer_ident = STRBUF_INIT;
1424 commit = lookup_commit(sha1);
1425 if (!commit)
1426 die(_("couldn't look up newly created commit"));
1427 if (parse_commit(commit))
1428 die(_("could not parse newly created commit"));
1430 strbuf_addstr(&format, "format:%h] %s");
1432 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1433 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1434 if (strbuf_cmp(&author_ident, &committer_ident)) {
1435 strbuf_addstr(&format, "\n Author: ");
1436 strbuf_addbuf_percentquote(&format, &author_ident);
1438 if (author_date_is_interesting()) {
1439 struct strbuf date = STRBUF_INIT;
1440 format_commit_message(commit, "%ad", &date, &pctx);
1441 strbuf_addstr(&format, "\n Date: ");
1442 strbuf_addbuf_percentquote(&format, &date);
1443 strbuf_release(&date);
1445 if (!committer_ident_sufficiently_given()) {
1446 strbuf_addstr(&format, "\n Committer: ");
1447 strbuf_addbuf_percentquote(&format, &committer_ident);
1448 if (advice_implicit_identity) {
1449 strbuf_addch(&format, '\n');
1450 strbuf_addstr(&format, _(implicit_ident_advice));
1453 strbuf_release(&author_ident);
1454 strbuf_release(&committer_ident);
1456 init_revisions(&rev, prefix);
1457 setup_revisions(0, NULL, &rev, NULL);
1459 rev.diff = 1;
1460 rev.diffopt.output_format =
1461 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1463 rev.verbose_header = 1;
1464 rev.show_root_diff = 1;
1465 get_commit_format(format.buf, &rev);
1466 rev.always_show_header = 0;
1467 rev.diffopt.detect_rename = 1;
1468 rev.diffopt.break_opt = 0;
1469 diff_setup_done(&rev.diffopt);
1471 head = resolve_ref_unsafe("HEAD", junk_sha1, 0, NULL);
1472 printf("[%s%s ",
1473 starts_with(head, "refs/heads/") ?
1474 head + 11 :
1475 !strcmp(head, "HEAD") ?
1476 _("detached HEAD") :
1477 head,
1478 initial_commit ? _(" (root-commit)") : "");
1480 if (!log_tree_commit(&rev, commit)) {
1481 rev.always_show_header = 1;
1482 rev.use_terminator = 1;
1483 log_tree_commit(&rev, commit);
1486 strbuf_release(&format);
1489 static int git_commit_config(const char *k, const char *v, void *cb)
1491 struct wt_status *s = cb;
1492 int status;
1494 if (!strcmp(k, "commit.template"))
1495 return git_config_pathname(&template_file, k, v);
1496 if (!strcmp(k, "commit.status")) {
1497 include_status = git_config_bool(k, v);
1498 return 0;
1500 if (!strcmp(k, "commit.cleanup"))
1501 return git_config_string(&cleanup_arg, k, v);
1502 if (!strcmp(k, "commit.gpgsign")) {
1503 sign_commit = git_config_bool(k, v) ? "" : NULL;
1504 return 0;
1507 status = git_gpg_config(k, v, NULL);
1508 if (status)
1509 return status;
1510 return git_status_config(k, v, s);
1513 static int run_rewrite_hook(const unsigned char *oldsha1,
1514 const unsigned char *newsha1)
1516 /* oldsha1 SP newsha1 LF NUL */
1517 static char buf[2*40 + 3];
1518 struct child_process proc;
1519 const char *argv[3];
1520 int code;
1521 size_t n;
1523 argv[0] = find_hook("post-rewrite");
1524 if (!argv[0])
1525 return 0;
1527 argv[1] = "amend";
1528 argv[2] = NULL;
1530 memset(&proc, 0, sizeof(proc));
1531 proc.argv = argv;
1532 proc.in = -1;
1533 proc.stdout_to_stderr = 1;
1535 code = start_command(&proc);
1536 if (code)
1537 return code;
1538 n = snprintf(buf, sizeof(buf), "%s %s\n",
1539 sha1_to_hex(oldsha1), sha1_to_hex(newsha1));
1540 write_in_full(proc.in, buf, n);
1541 close(proc.in);
1542 return finish_command(&proc);
1545 int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...)
1547 const char *hook_env[3] = { NULL };
1548 char index[PATH_MAX];
1549 va_list args;
1550 int ret;
1552 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
1553 hook_env[0] = index;
1556 * Let the hook know that no editor will be launched.
1558 if (!editor_is_used)
1559 hook_env[1] = "GIT_EDITOR=:";
1561 va_start(args, name);
1562 ret = run_hook_ve(hook_env, name, args);
1563 va_end(args);
1565 return ret;
1568 int cmd_commit(int argc, const char **argv, const char *prefix)
1570 static struct wt_status s;
1571 static struct option builtin_commit_options[] = {
1572 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1573 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1575 OPT_GROUP(N_("Commit message options")),
1576 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1577 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1578 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1579 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1580 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1581 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1582 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1583 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1584 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1585 OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1586 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1587 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1588 OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
1589 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1590 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
1591 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1592 /* end commit message options */
1594 OPT_GROUP(N_("Commit contents options")),
1595 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1596 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1597 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1598 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1599 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1600 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit hook")),
1601 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1602 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1603 STATUS_FORMAT_SHORT),
1604 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1605 OPT_SET_INT(0, "porcelain", &status_format,
1606 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1607 OPT_SET_INT(0, "long", &status_format,
1608 N_("show status in long format (default)"),
1609 STATUS_FORMAT_LONG),
1610 OPT_BOOL('z', "null", &s.null_termination,
1611 N_("terminate entries with NUL")),
1612 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1613 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1614 { 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" },
1615 /* end commit contents options */
1617 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1618 N_("ok to record an empty change")),
1619 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1620 N_("ok to record a change with an empty message")),
1622 OPT_END()
1625 struct strbuf sb = STRBUF_INIT;
1626 struct strbuf author_ident = STRBUF_INIT;
1627 const char *index_file, *reflog_msg;
1628 char *nl;
1629 unsigned char sha1[20];
1630 struct ref_lock *ref_lock;
1631 struct commit_list *parents = NULL, **pptr = &parents;
1632 struct stat statbuf;
1633 struct commit *current_head = NULL;
1634 struct commit_extra_header *extra = NULL;
1636 if (argc == 2 && !strcmp(argv[1], "-h"))
1637 usage_with_options(builtin_commit_usage, builtin_commit_options);
1639 status_init_config(&s, git_commit_config);
1640 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1641 s.colopts = 0;
1643 if (get_sha1("HEAD", sha1))
1644 current_head = NULL;
1645 else {
1646 current_head = lookup_commit_or_die(sha1, "HEAD");
1647 if (parse_commit(current_head))
1648 die(_("could not parse HEAD commit"));
1650 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1651 builtin_commit_usage,
1652 prefix, current_head, &s);
1653 if (dry_run)
1654 return dry_run_commit(argc, argv, prefix, current_head, &s);
1655 index_file = prepare_index(argc, argv, prefix, current_head, 0);
1657 /* Set up everything for writing the commit object. This includes
1658 running hooks, writing the trees, and interacting with the user. */
1659 if (!prepare_to_commit(index_file, prefix,
1660 current_head, &s, &author_ident)) {
1661 rollback_index_files();
1662 return 1;
1665 /* Determine parents */
1666 reflog_msg = getenv("GIT_REFLOG_ACTION");
1667 if (!current_head) {
1668 if (!reflog_msg)
1669 reflog_msg = "commit (initial)";
1670 } else if (amend) {
1671 struct commit_list *c;
1673 if (!reflog_msg)
1674 reflog_msg = "commit (amend)";
1675 for (c = current_head->parents; c; c = c->next)
1676 pptr = &commit_list_insert(c->item, pptr)->next;
1677 } else if (whence == FROM_MERGE) {
1678 struct strbuf m = STRBUF_INIT;
1679 FILE *fp;
1680 int allow_fast_forward = 1;
1682 if (!reflog_msg)
1683 reflog_msg = "commit (merge)";
1684 pptr = &commit_list_insert(current_head, pptr)->next;
1685 fp = fopen(git_path("MERGE_HEAD"), "r");
1686 if (fp == NULL)
1687 die_errno(_("could not open '%s' for reading"),
1688 git_path("MERGE_HEAD"));
1689 while (strbuf_getline(&m, fp, '\n') != EOF) {
1690 struct commit *parent;
1692 parent = get_merge_parent(m.buf);
1693 if (!parent)
1694 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1695 pptr = &commit_list_insert(parent, pptr)->next;
1697 fclose(fp);
1698 strbuf_release(&m);
1699 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1700 if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1701 die_errno(_("could not read MERGE_MODE"));
1702 if (!strcmp(sb.buf, "no-ff"))
1703 allow_fast_forward = 0;
1705 if (allow_fast_forward)
1706 parents = reduce_heads(parents);
1707 } else {
1708 if (!reflog_msg)
1709 reflog_msg = (whence == FROM_CHERRY_PICK)
1710 ? "commit (cherry-pick)"
1711 : "commit";
1712 pptr = &commit_list_insert(current_head, pptr)->next;
1715 /* Finally, get the commit message */
1716 strbuf_reset(&sb);
1717 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1718 int saved_errno = errno;
1719 rollback_index_files();
1720 die(_("could not read commit message: %s"), strerror(saved_errno));
1723 if (verbose || /* Truncate the message just before the diff, if any. */
1724 cleanup_mode == CLEANUP_SCISSORS)
1725 wt_status_truncate_message_at_cut_line(&sb);
1727 if (cleanup_mode != CLEANUP_NONE)
1728 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1729 if (template_untouched(&sb) && !allow_empty_message) {
1730 rollback_index_files();
1731 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1732 exit(1);
1734 if (message_is_empty(&sb) && !allow_empty_message) {
1735 rollback_index_files();
1736 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1737 exit(1);
1740 if (amend) {
1741 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1742 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1743 } else {
1744 struct commit_extra_header **tail = &extra;
1745 append_merge_tag_headers(parents, &tail);
1748 if (commit_tree_extended(&sb, active_cache_tree->sha1, parents, sha1,
1749 author_ident.buf, sign_commit, extra)) {
1750 rollback_index_files();
1751 die(_("failed to write commit object"));
1753 strbuf_release(&author_ident);
1754 free_commit_extra_headers(extra);
1756 ref_lock = lock_any_ref_for_update("HEAD",
1757 !current_head
1758 ? NULL
1759 : current_head->object.sha1,
1760 0, NULL);
1761 if (!ref_lock) {
1762 rollback_index_files();
1763 die(_("cannot lock HEAD ref"));
1766 nl = strchr(sb.buf, '\n');
1767 if (nl)
1768 strbuf_setlen(&sb, nl + 1 - sb.buf);
1769 else
1770 strbuf_addch(&sb, '\n');
1771 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1772 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1774 if (write_ref_sha1(ref_lock, sha1, sb.buf) < 0) {
1775 rollback_index_files();
1776 die(_("cannot update HEAD ref"));
1779 unlink(git_path("CHERRY_PICK_HEAD"));
1780 unlink(git_path("REVERT_HEAD"));
1781 unlink(git_path("MERGE_HEAD"));
1782 unlink(git_path("MERGE_MSG"));
1783 unlink(git_path("MERGE_MODE"));
1784 unlink(git_path("SQUASH_MSG"));
1786 if (commit_index_files())
1787 die (_("Repository has been updated, but unable to write\n"
1788 "new_index file. Check that disk is not full or quota is\n"
1789 "not exceeded, and then \"git reset HEAD\" to recover."));
1791 rerere(0);
1792 run_commit_hook(use_editor, get_index_file(), "post-commit", NULL);
1793 if (amend && !no_post_rewrite) {
1794 struct notes_rewrite_cfg *cfg;
1795 cfg = init_copy_notes_for_rewrite("amend");
1796 if (cfg) {
1797 /* we are amending, so current_head is not NULL */
1798 copy_note_for_rewrite(cfg, current_head->object.sha1, sha1);
1799 finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1801 run_rewrite_hook(current_head->object.sha1, sha1);
1803 if (!quiet)
1804 print_summary(prefix, sha1, !current_head);
1806 return 0;