Merge branch 'fc/status-printf-squelch-format-zero-length-warnings'
[git.git] / builtin / commit.c
blobd28505a857dad9e897896473a88e05f32f56bfb2
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 int prepare_to_commit(const char *index_file, const char *prefix,
624 struct commit *current_head,
625 struct wt_status *s,
626 struct strbuf *author_ident)
628 struct stat statbuf;
629 struct strbuf committer_ident = STRBUF_INIT;
630 int commitable;
631 struct strbuf sb = STRBUF_INIT;
632 const char *hook_arg1 = NULL;
633 const char *hook_arg2 = NULL;
634 int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
635 int old_display_comment_prefix;
637 /* This checks and barfs if author is badly specified */
638 determine_author_info(author_ident);
640 if (!no_verify && run_commit_hook(use_editor, index_file, "pre-commit", NULL))
641 return 0;
643 if (squash_message) {
645 * Insert the proper subject line before other commit
646 * message options add their content.
648 if (use_message && !strcmp(use_message, squash_message))
649 strbuf_addstr(&sb, "squash! ");
650 else {
651 struct pretty_print_context ctx = {0};
652 struct commit *c;
653 c = lookup_commit_reference_by_name(squash_message);
654 if (!c)
655 die(_("could not lookup commit %s"), squash_message);
656 ctx.output_encoding = get_commit_output_encoding();
657 format_commit_message(c, "squash! %s\n\n", &sb,
658 &ctx);
662 if (message.len) {
663 strbuf_addbuf(&sb, &message);
664 hook_arg1 = "message";
665 } else if (logfile && !strcmp(logfile, "-")) {
666 if (isatty(0))
667 fprintf(stderr, _("(reading log message from standard input)\n"));
668 if (strbuf_read(&sb, 0, 0) < 0)
669 die_errno(_("could not read log from standard input"));
670 hook_arg1 = "message";
671 } else if (logfile) {
672 if (strbuf_read_file(&sb, logfile, 0) < 0)
673 die_errno(_("could not read log file '%s'"),
674 logfile);
675 hook_arg1 = "message";
676 } else if (use_message) {
677 char *buffer;
678 buffer = strstr(use_message_buffer, "\n\n");
679 if (buffer)
680 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
681 hook_arg1 = "commit";
682 hook_arg2 = use_message;
683 } else if (fixup_message) {
684 struct pretty_print_context ctx = {0};
685 struct commit *commit;
686 commit = lookup_commit_reference_by_name(fixup_message);
687 if (!commit)
688 die(_("could not lookup commit %s"), fixup_message);
689 ctx.output_encoding = get_commit_output_encoding();
690 format_commit_message(commit, "fixup! %s\n\n",
691 &sb, &ctx);
692 hook_arg1 = "message";
693 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
694 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
695 die_errno(_("could not read MERGE_MSG"));
696 hook_arg1 = "merge";
697 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
698 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
699 die_errno(_("could not read SQUASH_MSG"));
700 hook_arg1 = "squash";
701 } else if (template_file) {
702 if (strbuf_read_file(&sb, template_file, 0) < 0)
703 die_errno(_("could not read '%s'"), template_file);
704 hook_arg1 = "template";
705 clean_message_contents = 0;
709 * The remaining cases don't modify the template message, but
710 * just set the argument(s) to the prepare-commit-msg hook.
712 else if (whence == FROM_MERGE)
713 hook_arg1 = "merge";
714 else if (whence == FROM_CHERRY_PICK) {
715 hook_arg1 = "commit";
716 hook_arg2 = "CHERRY_PICK_HEAD";
719 if (squash_message) {
721 * If squash_commit was used for the commit subject,
722 * then we're possibly hijacking other commit log options.
723 * Reset the hook args to tell the real story.
725 hook_arg1 = "message";
726 hook_arg2 = "";
729 s->fp = fopen(git_path(commit_editmsg), "w");
730 if (s->fp == NULL)
731 die_errno(_("could not open '%s'"), git_path(commit_editmsg));
733 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
734 old_display_comment_prefix = s->display_comment_prefix;
735 s->display_comment_prefix = 1;
738 * Most hints are counter-productive when the commit has
739 * already started.
741 s->hints = 0;
743 if (clean_message_contents)
744 stripspace(&sb, 0);
746 if (signoff) {
748 * See if we have a Conflicts: block at the end. If yes, count
749 * its size, so we can ignore it.
751 int ignore_footer = 0;
752 int i, eol, previous = 0;
753 const char *nl;
755 for (i = 0; i < sb.len; i++) {
756 nl = memchr(sb.buf + i, '\n', sb.len - i);
757 if (nl)
758 eol = nl - sb.buf;
759 else
760 eol = sb.len;
761 if (starts_with(sb.buf + previous, "\nConflicts:\n")) {
762 ignore_footer = sb.len - previous;
763 break;
765 while (i < eol)
766 i++;
767 previous = eol;
770 append_signoff(&sb, ignore_footer, 0);
773 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
774 die_errno(_("could not write commit template"));
776 strbuf_release(&sb);
778 /* This checks if committer ident is explicitly given */
779 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
780 if (use_editor && include_status) {
781 int ident_shown = 0;
782 int saved_color_setting;
783 struct ident_split ci, ai;
785 if (whence != FROM_COMMIT) {
786 if (cleanup_mode == CLEANUP_SCISSORS)
787 wt_status_add_cut_line(s->fp);
788 status_printf_ln(s, GIT_COLOR_NORMAL,
789 whence == FROM_MERGE
790 ? _("\n"
791 "It looks like you may be committing a merge.\n"
792 "If this is not correct, please remove the file\n"
793 " %s\n"
794 "and try again.\n")
795 : _("\n"
796 "It looks like you may be committing a cherry-pick.\n"
797 "If this is not correct, please remove the file\n"
798 " %s\n"
799 "and try again.\n"),
800 git_path(whence == FROM_MERGE
801 ? "MERGE_HEAD"
802 : "CHERRY_PICK_HEAD"));
805 fprintf(s->fp, "\n");
806 if (cleanup_mode == CLEANUP_ALL)
807 status_printf(s, GIT_COLOR_NORMAL,
808 _("Please enter the commit message for your changes."
809 " Lines starting\nwith '%c' will be ignored, and an empty"
810 " message aborts the commit.\n"), comment_line_char);
811 else if (cleanup_mode == CLEANUP_SCISSORS && whence == FROM_COMMIT)
812 wt_status_add_cut_line(s->fp);
813 else /* CLEANUP_SPACE, that is. */
814 status_printf(s, GIT_COLOR_NORMAL,
815 _("Please enter the commit message for your changes."
816 " Lines starting\n"
817 "with '%c' will be kept; you may remove them"
818 " yourself if you want to.\n"
819 "An empty message aborts the commit.\n"), comment_line_char);
820 if (only_include_assumed)
821 status_printf_ln(s, GIT_COLOR_NORMAL,
822 "%s", only_include_assumed);
824 split_ident_or_die(&ai, author_ident);
825 split_ident_or_die(&ci, &committer_ident);
827 if (ident_cmp(&ai, &ci))
828 status_printf_ln(s, GIT_COLOR_NORMAL,
829 _("%s"
830 "Author: %.*s <%.*s>"),
831 ident_shown++ ? "" : "\n",
832 (int)(ai.name_end - ai.name_begin), ai.name_begin,
833 (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);
835 if (author_date_is_interesting())
836 status_printf_ln(s, GIT_COLOR_NORMAL,
837 _("%s"
838 "Date: %s"),
839 ident_shown++ ? "" : "\n",
840 show_ident_date(&ai, DATE_NORMAL));
842 if (!committer_ident_sufficiently_given())
843 status_printf_ln(s, GIT_COLOR_NORMAL,
844 _("%s"
845 "Committer: %.*s <%.*s>"),
846 ident_shown++ ? "" : "\n",
847 (int)(ci.name_end - ci.name_begin), ci.name_begin,
848 (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
850 if (ident_shown)
851 status_printf_ln(s, GIT_COLOR_NORMAL, "%s", "");
853 saved_color_setting = s->use_color;
854 s->use_color = 0;
855 commitable = run_status(s->fp, index_file, prefix, 1, s);
856 s->use_color = saved_color_setting;
857 } else {
858 unsigned char sha1[20];
859 const char *parent = "HEAD";
861 if (!active_nr && read_cache() < 0)
862 die(_("Cannot read index"));
864 if (amend)
865 parent = "HEAD^1";
867 if (get_sha1(parent, sha1))
868 commitable = !!active_nr;
869 else
870 commitable = index_differs_from(parent, 0);
872 strbuf_release(&committer_ident);
874 fclose(s->fp);
877 * Reject an attempt to record a non-merge empty commit without
878 * explicit --allow-empty. In the cherry-pick case, it may be
879 * empty due to conflict resolution, which the user should okay.
881 if (!commitable && whence != FROM_MERGE && !allow_empty &&
882 !(amend && is_a_merge(current_head))) {
883 s->display_comment_prefix = old_display_comment_prefix;
884 run_status(stdout, index_file, prefix, 0, s);
885 if (amend)
886 fputs(_(empty_amend_advice), stderr);
887 else if (whence == FROM_CHERRY_PICK) {
888 fputs(_(empty_cherry_pick_advice), stderr);
889 if (!sequencer_in_use)
890 fputs(_(empty_cherry_pick_advice_single), stderr);
891 else
892 fputs(_(empty_cherry_pick_advice_multi), stderr);
894 return 0;
898 * Re-read the index as pre-commit hook could have updated it,
899 * and write it out as a tree. We must do this before we invoke
900 * the editor and after we invoke run_status above.
902 discard_cache();
903 read_cache_from(index_file);
904 if (update_main_cache_tree(0)) {
905 error(_("Error building trees"));
906 return 0;
909 if (run_commit_hook(use_editor, index_file, "prepare-commit-msg",
910 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
911 return 0;
913 if (use_editor) {
914 char index[PATH_MAX];
915 const char *env[2] = { NULL };
916 env[0] = index;
917 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
918 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
919 fprintf(stderr,
920 _("Please supply the message using either -m or -F option.\n"));
921 exit(1);
925 if (!no_verify &&
926 run_commit_hook(use_editor, index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
927 return 0;
930 return 1;
933 static int rest_is_empty(struct strbuf *sb, int start)
935 int i, eol;
936 const char *nl;
938 /* Check if the rest is just whitespace and Signed-of-by's. */
939 for (i = start; i < sb->len; i++) {
940 nl = memchr(sb->buf + i, '\n', sb->len - i);
941 if (nl)
942 eol = nl - sb->buf;
943 else
944 eol = sb->len;
946 if (strlen(sign_off_header) <= eol - i &&
947 starts_with(sb->buf + i, sign_off_header)) {
948 i = eol;
949 continue;
951 while (i < eol)
952 if (!isspace(sb->buf[i++]))
953 return 0;
956 return 1;
960 * Find out if the message in the strbuf contains only whitespace and
961 * Signed-off-by lines.
963 static int message_is_empty(struct strbuf *sb)
965 if (cleanup_mode == CLEANUP_NONE && sb->len)
966 return 0;
967 return rest_is_empty(sb, 0);
971 * See if the user edited the message in the editor or left what
972 * was in the template intact
974 static int template_untouched(struct strbuf *sb)
976 struct strbuf tmpl = STRBUF_INIT;
977 char *start;
979 if (cleanup_mode == CLEANUP_NONE && sb->len)
980 return 0;
982 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
983 return 0;
985 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
986 start = (char *)skip_prefix(sb->buf, tmpl.buf);
987 if (!start)
988 start = sb->buf;
989 strbuf_release(&tmpl);
990 return rest_is_empty(sb, start - sb->buf);
993 static const char *find_author_by_nickname(const char *name)
995 struct rev_info revs;
996 struct commit *commit;
997 struct strbuf buf = STRBUF_INIT;
998 struct string_list mailmap = STRING_LIST_INIT_NODUP;
999 const char *av[20];
1000 int ac = 0;
1002 init_revisions(&revs, NULL);
1003 strbuf_addf(&buf, "--author=%s", name);
1004 av[++ac] = "--all";
1005 av[++ac] = "-i";
1006 av[++ac] = buf.buf;
1007 av[++ac] = NULL;
1008 setup_revisions(ac, av, &revs, NULL);
1009 revs.mailmap = &mailmap;
1010 read_mailmap(revs.mailmap, NULL);
1012 prepare_revision_walk(&revs);
1013 commit = get_revision(&revs);
1014 if (commit) {
1015 struct pretty_print_context ctx = {0};
1016 ctx.date_mode = DATE_NORMAL;
1017 strbuf_release(&buf);
1018 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
1019 clear_mailmap(&mailmap);
1020 return strbuf_detach(&buf, NULL);
1022 die(_("No existing author found with '%s'"), name);
1026 static void handle_untracked_files_arg(struct wt_status *s)
1028 if (!untracked_files_arg)
1029 ; /* default already initialized */
1030 else if (!strcmp(untracked_files_arg, "no"))
1031 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1032 else if (!strcmp(untracked_files_arg, "normal"))
1033 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1034 else if (!strcmp(untracked_files_arg, "all"))
1035 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1036 else
1037 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1040 static const char *read_commit_message(const char *name)
1042 const char *out_enc;
1043 struct commit *commit;
1045 commit = lookup_commit_reference_by_name(name);
1046 if (!commit)
1047 die(_("could not lookup commit %s"), name);
1048 out_enc = get_commit_output_encoding();
1049 return logmsg_reencode(commit, NULL, out_enc);
1053 * Enumerate what needs to be propagated when --porcelain
1054 * is not in effect here.
1056 static struct status_deferred_config {
1057 enum status_format status_format;
1058 int show_branch;
1059 } status_deferred_config = {
1060 STATUS_FORMAT_UNSPECIFIED,
1061 -1 /* unspecified */
1064 static void finalize_deferred_config(struct wt_status *s)
1066 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1067 !s->null_termination);
1069 if (s->null_termination) {
1070 if (status_format == STATUS_FORMAT_NONE ||
1071 status_format == STATUS_FORMAT_UNSPECIFIED)
1072 status_format = STATUS_FORMAT_PORCELAIN;
1073 else if (status_format == STATUS_FORMAT_LONG)
1074 die(_("--long and -z are incompatible"));
1077 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1078 status_format = status_deferred_config.status_format;
1079 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1080 status_format = STATUS_FORMAT_NONE;
1082 if (use_deferred_config && s->show_branch < 0)
1083 s->show_branch = status_deferred_config.show_branch;
1084 if (s->show_branch < 0)
1085 s->show_branch = 0;
1088 static int parse_and_validate_options(int argc, const char *argv[],
1089 const struct option *options,
1090 const char * const usage[],
1091 const char *prefix,
1092 struct commit *current_head,
1093 struct wt_status *s)
1095 int f = 0;
1097 argc = parse_options(argc, argv, prefix, options, usage, 0);
1098 finalize_deferred_config(s);
1100 if (force_author && !strchr(force_author, '>'))
1101 force_author = find_author_by_nickname(force_author);
1103 if (force_author && renew_authorship)
1104 die(_("Using both --reset-author and --author does not make sense"));
1106 if (logfile || have_option_m || use_message || fixup_message)
1107 use_editor = 0;
1108 if (0 <= edit_flag)
1109 use_editor = edit_flag;
1111 /* Sanity check options */
1112 if (amend && !current_head)
1113 die(_("You have nothing to amend."));
1114 if (amend && whence != FROM_COMMIT) {
1115 if (whence == FROM_MERGE)
1116 die(_("You are in the middle of a merge -- cannot amend."));
1117 else if (whence == FROM_CHERRY_PICK)
1118 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1120 if (fixup_message && squash_message)
1121 die(_("Options --squash and --fixup cannot be used together"));
1122 if (use_message)
1123 f++;
1124 if (edit_message)
1125 f++;
1126 if (fixup_message)
1127 f++;
1128 if (logfile)
1129 f++;
1130 if (f > 1)
1131 die(_("Only one of -c/-C/-F/--fixup can be used."));
1132 if (message.len && f > 0)
1133 die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1134 if (f || message.len)
1135 template_file = NULL;
1136 if (edit_message)
1137 use_message = edit_message;
1138 if (amend && !use_message && !fixup_message)
1139 use_message = "HEAD";
1140 if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1141 die(_("--reset-author can be used only with -C, -c or --amend."));
1142 if (use_message) {
1143 use_message_buffer = read_commit_message(use_message);
1144 if (!renew_authorship) {
1145 author_message = use_message;
1146 author_message_buffer = use_message_buffer;
1149 if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1150 author_message = "CHERRY_PICK_HEAD";
1151 author_message_buffer = read_commit_message(author_message);
1154 if (patch_interactive)
1155 interactive = 1;
1157 if (also + only + all + interactive > 1)
1158 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1159 if (argc == 0 && (also || (only && !amend)))
1160 die(_("No paths with --include/--only does not make sense."));
1161 if (argc == 0 && only && amend)
1162 only_include_assumed = _("Clever... amending the last one with dirty index.");
1163 if (argc > 0 && !also && !only)
1164 only_include_assumed = _("Explicit paths specified without -i or -o; assuming --only paths...");
1165 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1166 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
1167 else if (!strcmp(cleanup_arg, "verbatim"))
1168 cleanup_mode = CLEANUP_NONE;
1169 else if (!strcmp(cleanup_arg, "whitespace"))
1170 cleanup_mode = CLEANUP_SPACE;
1171 else if (!strcmp(cleanup_arg, "strip"))
1172 cleanup_mode = CLEANUP_ALL;
1173 else if (!strcmp(cleanup_arg, "scissors"))
1174 cleanup_mode = use_editor ? CLEANUP_SCISSORS : CLEANUP_SPACE;
1175 else
1176 die(_("Invalid cleanup mode %s"), cleanup_arg);
1178 handle_untracked_files_arg(s);
1180 if (all && argc > 0)
1181 die(_("Paths with -a does not make sense."));
1183 if (status_format != STATUS_FORMAT_NONE)
1184 dry_run = 1;
1186 return argc;
1189 static int dry_run_commit(int argc, const char **argv, const char *prefix,
1190 const struct commit *current_head, struct wt_status *s)
1192 int commitable;
1193 const char *index_file;
1195 index_file = prepare_index(argc, argv, prefix, current_head, 1);
1196 commitable = run_status(stdout, index_file, prefix, 0, s);
1197 rollback_index_files();
1199 return commitable ? 0 : 1;
1202 static int parse_status_slot(const char *var, int offset)
1204 if (!strcasecmp(var+offset, "header"))
1205 return WT_STATUS_HEADER;
1206 if (!strcasecmp(var+offset, "branch"))
1207 return WT_STATUS_ONBRANCH;
1208 if (!strcasecmp(var+offset, "updated")
1209 || !strcasecmp(var+offset, "added"))
1210 return WT_STATUS_UPDATED;
1211 if (!strcasecmp(var+offset, "changed"))
1212 return WT_STATUS_CHANGED;
1213 if (!strcasecmp(var+offset, "untracked"))
1214 return WT_STATUS_UNTRACKED;
1215 if (!strcasecmp(var+offset, "nobranch"))
1216 return WT_STATUS_NOBRANCH;
1217 if (!strcasecmp(var+offset, "unmerged"))
1218 return WT_STATUS_UNMERGED;
1219 return -1;
1222 static int git_status_config(const char *k, const char *v, void *cb)
1224 struct wt_status *s = cb;
1226 if (starts_with(k, "column."))
1227 return git_column_config(k, v, "status", &s->colopts);
1228 if (!strcmp(k, "status.submodulesummary")) {
1229 int is_bool;
1230 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1231 if (is_bool && s->submodule_summary)
1232 s->submodule_summary = -1;
1233 return 0;
1235 if (!strcmp(k, "status.short")) {
1236 if (git_config_bool(k, v))
1237 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1238 else
1239 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1240 return 0;
1242 if (!strcmp(k, "status.branch")) {
1243 status_deferred_config.show_branch = git_config_bool(k, v);
1244 return 0;
1246 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1247 s->use_color = git_config_colorbool(k, v);
1248 return 0;
1250 if (!strcmp(k, "status.displaycommentprefix")) {
1251 s->display_comment_prefix = git_config_bool(k, v);
1252 return 0;
1254 if (starts_with(k, "status.color.") || starts_with(k, "color.status.")) {
1255 int slot = parse_status_slot(k, 13);
1256 if (slot < 0)
1257 return 0;
1258 if (!v)
1259 return config_error_nonbool(k);
1260 color_parse(v, k, s->color_palette[slot]);
1261 return 0;
1263 if (!strcmp(k, "status.relativepaths")) {
1264 s->relative_paths = git_config_bool(k, v);
1265 return 0;
1267 if (!strcmp(k, "status.showuntrackedfiles")) {
1268 if (!v)
1269 return config_error_nonbool(k);
1270 else if (!strcmp(v, "no"))
1271 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1272 else if (!strcmp(v, "normal"))
1273 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1274 else if (!strcmp(v, "all"))
1275 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1276 else
1277 return error(_("Invalid untracked files mode '%s'"), v);
1278 return 0;
1280 return git_diff_ui_config(k, v, NULL);
1283 int cmd_status(int argc, const char **argv, const char *prefix)
1285 static struct wt_status s;
1286 int fd;
1287 unsigned char sha1[20];
1288 static struct option builtin_status_options[] = {
1289 OPT__VERBOSE(&verbose, N_("be verbose")),
1290 OPT_SET_INT('s', "short", &status_format,
1291 N_("show status concisely"), STATUS_FORMAT_SHORT),
1292 OPT_BOOL('b', "branch", &s.show_branch,
1293 N_("show branch information")),
1294 OPT_SET_INT(0, "porcelain", &status_format,
1295 N_("machine-readable output"),
1296 STATUS_FORMAT_PORCELAIN),
1297 OPT_SET_INT(0, "long", &status_format,
1298 N_("show status in long format (default)"),
1299 STATUS_FORMAT_LONG),
1300 OPT_BOOL('z', "null", &s.null_termination,
1301 N_("terminate entries with NUL")),
1302 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1303 N_("mode"),
1304 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1305 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1306 OPT_BOOL(0, "ignored", &show_ignored_in_status,
1307 N_("show ignored files")),
1308 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1309 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1310 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1311 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1312 OPT_END(),
1315 if (argc == 2 && !strcmp(argv[1], "-h"))
1316 usage_with_options(builtin_status_usage, builtin_status_options);
1318 status_init_config(&s, git_status_config);
1319 argc = parse_options(argc, argv, prefix,
1320 builtin_status_options,
1321 builtin_status_usage, 0);
1322 finalize_colopts(&s.colopts, -1);
1323 finalize_deferred_config(&s);
1325 handle_untracked_files_arg(&s);
1326 if (show_ignored_in_status)
1327 s.show_ignored_files = 1;
1328 parse_pathspec(&s.pathspec, 0,
1329 PATHSPEC_PREFER_FULL,
1330 prefix, argv);
1332 read_cache_preload(&s.pathspec);
1333 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &s.pathspec, NULL, NULL);
1335 fd = hold_locked_index(&index_lock, 0);
1336 if (0 <= fd)
1337 update_index_if_able(&the_index, &index_lock);
1339 s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1340 s.ignore_submodule_arg = ignore_submodule_arg;
1341 wt_status_collect(&s);
1343 if (s.relative_paths)
1344 s.prefix = prefix;
1346 switch (status_format) {
1347 case STATUS_FORMAT_SHORT:
1348 wt_shortstatus_print(&s);
1349 break;
1350 case STATUS_FORMAT_PORCELAIN:
1351 wt_porcelain_print(&s);
1352 break;
1353 case STATUS_FORMAT_UNSPECIFIED:
1354 die("BUG: finalize_deferred_config() should have been called");
1355 break;
1356 case STATUS_FORMAT_NONE:
1357 case STATUS_FORMAT_LONG:
1358 s.verbose = verbose;
1359 s.ignore_submodule_arg = ignore_submodule_arg;
1360 wt_status_print(&s);
1361 break;
1363 return 0;
1366 static void print_summary(const char *prefix, const unsigned char *sha1,
1367 int initial_commit)
1369 struct rev_info rev;
1370 struct commit *commit;
1371 struct strbuf format = STRBUF_INIT;
1372 unsigned char junk_sha1[20];
1373 const char *head;
1374 struct pretty_print_context pctx = {0};
1375 struct strbuf author_ident = STRBUF_INIT;
1376 struct strbuf committer_ident = STRBUF_INIT;
1378 commit = lookup_commit(sha1);
1379 if (!commit)
1380 die(_("couldn't look up newly created commit"));
1381 if (parse_commit(commit))
1382 die(_("could not parse newly created commit"));
1384 strbuf_addstr(&format, "format:%h] %s");
1386 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1387 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1388 if (strbuf_cmp(&author_ident, &committer_ident)) {
1389 strbuf_addstr(&format, "\n Author: ");
1390 strbuf_addbuf_percentquote(&format, &author_ident);
1392 if (author_date_is_interesting()) {
1393 struct strbuf date = STRBUF_INIT;
1394 format_commit_message(commit, "%ad", &date, &pctx);
1395 strbuf_addstr(&format, "\n Date: ");
1396 strbuf_addbuf_percentquote(&format, &date);
1397 strbuf_release(&date);
1399 if (!committer_ident_sufficiently_given()) {
1400 strbuf_addstr(&format, "\n Committer: ");
1401 strbuf_addbuf_percentquote(&format, &committer_ident);
1402 if (advice_implicit_identity) {
1403 strbuf_addch(&format, '\n');
1404 strbuf_addstr(&format, _(implicit_ident_advice));
1407 strbuf_release(&author_ident);
1408 strbuf_release(&committer_ident);
1410 init_revisions(&rev, prefix);
1411 setup_revisions(0, NULL, &rev, NULL);
1413 rev.diff = 1;
1414 rev.diffopt.output_format =
1415 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1417 rev.verbose_header = 1;
1418 rev.show_root_diff = 1;
1419 get_commit_format(format.buf, &rev);
1420 rev.always_show_header = 0;
1421 rev.diffopt.detect_rename = 1;
1422 rev.diffopt.break_opt = 0;
1423 diff_setup_done(&rev.diffopt);
1425 head = resolve_ref_unsafe("HEAD", junk_sha1, 0, NULL);
1426 printf("[%s%s ",
1427 starts_with(head, "refs/heads/") ?
1428 head + 11 :
1429 !strcmp(head, "HEAD") ?
1430 _("detached HEAD") :
1431 head,
1432 initial_commit ? _(" (root-commit)") : "");
1434 if (!log_tree_commit(&rev, commit)) {
1435 rev.always_show_header = 1;
1436 rev.use_terminator = 1;
1437 log_tree_commit(&rev, commit);
1440 strbuf_release(&format);
1443 static int git_commit_config(const char *k, const char *v, void *cb)
1445 struct wt_status *s = cb;
1446 int status;
1448 if (!strcmp(k, "commit.template"))
1449 return git_config_pathname(&template_file, k, v);
1450 if (!strcmp(k, "commit.status")) {
1451 include_status = git_config_bool(k, v);
1452 return 0;
1454 if (!strcmp(k, "commit.cleanup"))
1455 return git_config_string(&cleanup_arg, k, v);
1456 if (!strcmp(k, "commit.gpgsign")) {
1457 sign_commit = git_config_bool(k, v) ? "" : NULL;
1458 return 0;
1461 status = git_gpg_config(k, v, NULL);
1462 if (status)
1463 return status;
1464 return git_status_config(k, v, s);
1467 static int run_rewrite_hook(const unsigned char *oldsha1,
1468 const unsigned char *newsha1)
1470 /* oldsha1 SP newsha1 LF NUL */
1471 static char buf[2*40 + 3];
1472 struct child_process proc;
1473 const char *argv[3];
1474 int code;
1475 size_t n;
1477 argv[0] = find_hook("post-rewrite");
1478 if (!argv[0])
1479 return 0;
1481 argv[1] = "amend";
1482 argv[2] = NULL;
1484 memset(&proc, 0, sizeof(proc));
1485 proc.argv = argv;
1486 proc.in = -1;
1487 proc.stdout_to_stderr = 1;
1489 code = start_command(&proc);
1490 if (code)
1491 return code;
1492 n = snprintf(buf, sizeof(buf), "%s %s\n",
1493 sha1_to_hex(oldsha1), sha1_to_hex(newsha1));
1494 write_in_full(proc.in, buf, n);
1495 close(proc.in);
1496 return finish_command(&proc);
1499 int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...)
1501 const char *hook_env[3] = { NULL };
1502 char index[PATH_MAX];
1503 va_list args;
1504 int ret;
1506 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
1507 hook_env[0] = index;
1510 * Let the hook know that no editor will be launched.
1512 if (!editor_is_used)
1513 hook_env[1] = "GIT_EDITOR=:";
1515 va_start(args, name);
1516 ret = run_hook_ve(hook_env, name, args);
1517 va_end(args);
1519 return ret;
1522 int cmd_commit(int argc, const char **argv, const char *prefix)
1524 static struct wt_status s;
1525 static struct option builtin_commit_options[] = {
1526 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1527 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1529 OPT_GROUP(N_("Commit message options")),
1530 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1531 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1532 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1533 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1534 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1535 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1536 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1537 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1538 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1539 OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1540 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1541 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1542 OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
1543 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1544 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
1545 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1546 /* end commit message options */
1548 OPT_GROUP(N_("Commit contents options")),
1549 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1550 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1551 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1552 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1553 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1554 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit hook")),
1555 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1556 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1557 STATUS_FORMAT_SHORT),
1558 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1559 OPT_SET_INT(0, "porcelain", &status_format,
1560 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1561 OPT_SET_INT(0, "long", &status_format,
1562 N_("show status in long format (default)"),
1563 STATUS_FORMAT_LONG),
1564 OPT_BOOL('z', "null", &s.null_termination,
1565 N_("terminate entries with NUL")),
1566 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1567 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1568 { 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" },
1569 /* end commit contents options */
1571 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1572 N_("ok to record an empty change")),
1573 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1574 N_("ok to record a change with an empty message")),
1576 OPT_END()
1579 struct strbuf sb = STRBUF_INIT;
1580 struct strbuf author_ident = STRBUF_INIT;
1581 const char *index_file, *reflog_msg;
1582 char *nl;
1583 unsigned char sha1[20];
1584 struct ref_lock *ref_lock;
1585 struct commit_list *parents = NULL, **pptr = &parents;
1586 struct stat statbuf;
1587 struct commit *current_head = NULL;
1588 struct commit_extra_header *extra = NULL;
1590 if (argc == 2 && !strcmp(argv[1], "-h"))
1591 usage_with_options(builtin_commit_usage, builtin_commit_options);
1593 status_init_config(&s, git_commit_config);
1594 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1595 s.colopts = 0;
1597 if (get_sha1("HEAD", sha1))
1598 current_head = NULL;
1599 else {
1600 current_head = lookup_commit_or_die(sha1, "HEAD");
1601 if (parse_commit(current_head))
1602 die(_("could not parse HEAD commit"));
1604 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1605 builtin_commit_usage,
1606 prefix, current_head, &s);
1607 if (dry_run)
1608 return dry_run_commit(argc, argv, prefix, current_head, &s);
1609 index_file = prepare_index(argc, argv, prefix, current_head, 0);
1611 /* Set up everything for writing the commit object. This includes
1612 running hooks, writing the trees, and interacting with the user. */
1613 if (!prepare_to_commit(index_file, prefix,
1614 current_head, &s, &author_ident)) {
1615 rollback_index_files();
1616 return 1;
1619 /* Determine parents */
1620 reflog_msg = getenv("GIT_REFLOG_ACTION");
1621 if (!current_head) {
1622 if (!reflog_msg)
1623 reflog_msg = "commit (initial)";
1624 } else if (amend) {
1625 struct commit_list *c;
1627 if (!reflog_msg)
1628 reflog_msg = "commit (amend)";
1629 for (c = current_head->parents; c; c = c->next)
1630 pptr = &commit_list_insert(c->item, pptr)->next;
1631 } else if (whence == FROM_MERGE) {
1632 struct strbuf m = STRBUF_INIT;
1633 FILE *fp;
1634 int allow_fast_forward = 1;
1636 if (!reflog_msg)
1637 reflog_msg = "commit (merge)";
1638 pptr = &commit_list_insert(current_head, pptr)->next;
1639 fp = fopen(git_path("MERGE_HEAD"), "r");
1640 if (fp == NULL)
1641 die_errno(_("could not open '%s' for reading"),
1642 git_path("MERGE_HEAD"));
1643 while (strbuf_getline(&m, fp, '\n') != EOF) {
1644 struct commit *parent;
1646 parent = get_merge_parent(m.buf);
1647 if (!parent)
1648 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1649 pptr = &commit_list_insert(parent, pptr)->next;
1651 fclose(fp);
1652 strbuf_release(&m);
1653 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1654 if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1655 die_errno(_("could not read MERGE_MODE"));
1656 if (!strcmp(sb.buf, "no-ff"))
1657 allow_fast_forward = 0;
1659 if (allow_fast_forward)
1660 parents = reduce_heads(parents);
1661 } else {
1662 if (!reflog_msg)
1663 reflog_msg = (whence == FROM_CHERRY_PICK)
1664 ? "commit (cherry-pick)"
1665 : "commit";
1666 pptr = &commit_list_insert(current_head, pptr)->next;
1669 /* Finally, get the commit message */
1670 strbuf_reset(&sb);
1671 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1672 int saved_errno = errno;
1673 rollback_index_files();
1674 die(_("could not read commit message: %s"), strerror(saved_errno));
1677 if (verbose || /* Truncate the message just before the diff, if any. */
1678 cleanup_mode == CLEANUP_SCISSORS)
1679 wt_status_truncate_message_at_cut_line(&sb);
1681 if (cleanup_mode != CLEANUP_NONE)
1682 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1683 if (template_untouched(&sb) && !allow_empty_message) {
1684 rollback_index_files();
1685 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1686 exit(1);
1688 if (message_is_empty(&sb) && !allow_empty_message) {
1689 rollback_index_files();
1690 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1691 exit(1);
1694 if (amend) {
1695 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1696 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1697 } else {
1698 struct commit_extra_header **tail = &extra;
1699 append_merge_tag_headers(parents, &tail);
1702 if (commit_tree_extended(&sb, active_cache_tree->sha1, parents, sha1,
1703 author_ident.buf, sign_commit, extra)) {
1704 rollback_index_files();
1705 die(_("failed to write commit object"));
1707 strbuf_release(&author_ident);
1708 free_commit_extra_headers(extra);
1710 ref_lock = lock_any_ref_for_update("HEAD",
1711 !current_head
1712 ? NULL
1713 : current_head->object.sha1,
1714 0, NULL);
1715 if (!ref_lock) {
1716 rollback_index_files();
1717 die(_("cannot lock HEAD ref"));
1720 nl = strchr(sb.buf, '\n');
1721 if (nl)
1722 strbuf_setlen(&sb, nl + 1 - sb.buf);
1723 else
1724 strbuf_addch(&sb, '\n');
1725 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1726 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1728 if (write_ref_sha1(ref_lock, sha1, sb.buf) < 0) {
1729 rollback_index_files();
1730 die(_("cannot update HEAD ref"));
1733 unlink(git_path("CHERRY_PICK_HEAD"));
1734 unlink(git_path("REVERT_HEAD"));
1735 unlink(git_path("MERGE_HEAD"));
1736 unlink(git_path("MERGE_MSG"));
1737 unlink(git_path("MERGE_MODE"));
1738 unlink(git_path("SQUASH_MSG"));
1740 if (commit_index_files())
1741 die (_("Repository has been updated, but unable to write\n"
1742 "new_index file. Check that disk is not full or quota is\n"
1743 "not exceeded, and then \"git reset HEAD\" to recover."));
1745 rerere(0);
1746 run_commit_hook(use_editor, get_index_file(), "post-commit", NULL);
1747 if (amend && !no_post_rewrite) {
1748 struct notes_rewrite_cfg *cfg;
1749 cfg = init_copy_notes_for_rewrite("amend");
1750 if (cfg) {
1751 /* we are amending, so current_head is not NULL */
1752 copy_note_for_rewrite(cfg, current_head->object.sha1, sha1);
1753 finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1755 run_rewrite_hook(current_head->object.sha1, sha1);
1757 if (!quiet)
1758 print_summary(prefix, sha1, !current_head);
1760 return 0;