strbuf: use strbuf_addstr() for adding C strings
[git.git] / builtin / commit.c
blob31d906bbf5973a6aad105ff018b31df951fecec4
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_addstr(&sb, 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 const 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 if (!skip_prefix(sb->buf, tmpl.buf, &start))
1033 start = sb->buf;
1034 strbuf_release(&tmpl);
1035 return rest_is_empty(sb, start - sb->buf);
1038 static const char *find_author_by_nickname(const char *name)
1040 struct rev_info revs;
1041 struct commit *commit;
1042 struct strbuf buf = STRBUF_INIT;
1043 struct string_list mailmap = STRING_LIST_INIT_NODUP;
1044 const char *av[20];
1045 int ac = 0;
1047 init_revisions(&revs, NULL);
1048 strbuf_addf(&buf, "--author=%s", name);
1049 av[++ac] = "--all";
1050 av[++ac] = "-i";
1051 av[++ac] = buf.buf;
1052 av[++ac] = NULL;
1053 setup_revisions(ac, av, &revs, NULL);
1054 revs.mailmap = &mailmap;
1055 read_mailmap(revs.mailmap, NULL);
1057 prepare_revision_walk(&revs);
1058 commit = get_revision(&revs);
1059 if (commit) {
1060 struct pretty_print_context ctx = {0};
1061 ctx.date_mode = DATE_NORMAL;
1062 strbuf_release(&buf);
1063 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
1064 clear_mailmap(&mailmap);
1065 return strbuf_detach(&buf, NULL);
1067 die(_("No existing author found with '%s'"), name);
1071 static void handle_untracked_files_arg(struct wt_status *s)
1073 if (!untracked_files_arg)
1074 ; /* default already initialized */
1075 else if (!strcmp(untracked_files_arg, "no"))
1076 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1077 else if (!strcmp(untracked_files_arg, "normal"))
1078 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1079 else if (!strcmp(untracked_files_arg, "all"))
1080 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1081 else
1082 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1085 static const char *read_commit_message(const char *name)
1087 const char *out_enc;
1088 struct commit *commit;
1090 commit = lookup_commit_reference_by_name(name);
1091 if (!commit)
1092 die(_("could not lookup commit %s"), name);
1093 out_enc = get_commit_output_encoding();
1094 return logmsg_reencode(commit, NULL, out_enc);
1098 * Enumerate what needs to be propagated when --porcelain
1099 * is not in effect here.
1101 static struct status_deferred_config {
1102 enum status_format status_format;
1103 int show_branch;
1104 } status_deferred_config = {
1105 STATUS_FORMAT_UNSPECIFIED,
1106 -1 /* unspecified */
1109 static void finalize_deferred_config(struct wt_status *s)
1111 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1112 !s->null_termination);
1114 if (s->null_termination) {
1115 if (status_format == STATUS_FORMAT_NONE ||
1116 status_format == STATUS_FORMAT_UNSPECIFIED)
1117 status_format = STATUS_FORMAT_PORCELAIN;
1118 else if (status_format == STATUS_FORMAT_LONG)
1119 die(_("--long and -z are incompatible"));
1122 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1123 status_format = status_deferred_config.status_format;
1124 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1125 status_format = STATUS_FORMAT_NONE;
1127 if (use_deferred_config && s->show_branch < 0)
1128 s->show_branch = status_deferred_config.show_branch;
1129 if (s->show_branch < 0)
1130 s->show_branch = 0;
1133 static int parse_and_validate_options(int argc, const char *argv[],
1134 const struct option *options,
1135 const char * const usage[],
1136 const char *prefix,
1137 struct commit *current_head,
1138 struct wt_status *s)
1140 int f = 0;
1142 argc = parse_options(argc, argv, prefix, options, usage, 0);
1143 finalize_deferred_config(s);
1145 if (force_author && !strchr(force_author, '>'))
1146 force_author = find_author_by_nickname(force_author);
1148 if (force_author && renew_authorship)
1149 die(_("Using both --reset-author and --author does not make sense"));
1151 if (logfile || have_option_m || use_message || fixup_message)
1152 use_editor = 0;
1153 if (0 <= edit_flag)
1154 use_editor = edit_flag;
1156 /* Sanity check options */
1157 if (amend && !current_head)
1158 die(_("You have nothing to amend."));
1159 if (amend && whence != FROM_COMMIT) {
1160 if (whence == FROM_MERGE)
1161 die(_("You are in the middle of a merge -- cannot amend."));
1162 else if (whence == FROM_CHERRY_PICK)
1163 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1165 if (fixup_message && squash_message)
1166 die(_("Options --squash and --fixup cannot be used together"));
1167 if (use_message)
1168 f++;
1169 if (edit_message)
1170 f++;
1171 if (fixup_message)
1172 f++;
1173 if (logfile)
1174 f++;
1175 if (f > 1)
1176 die(_("Only one of -c/-C/-F/--fixup can be used."));
1177 if (message.len && f > 0)
1178 die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1179 if (f || message.len)
1180 template_file = NULL;
1181 if (edit_message)
1182 use_message = edit_message;
1183 if (amend && !use_message && !fixup_message)
1184 use_message = "HEAD";
1185 if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1186 die(_("--reset-author can be used only with -C, -c or --amend."));
1187 if (use_message) {
1188 use_message_buffer = read_commit_message(use_message);
1189 if (!renew_authorship) {
1190 author_message = use_message;
1191 author_message_buffer = use_message_buffer;
1194 if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1195 author_message = "CHERRY_PICK_HEAD";
1196 author_message_buffer = read_commit_message(author_message);
1199 if (patch_interactive)
1200 interactive = 1;
1202 if (also + only + all + interactive > 1)
1203 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1204 if (argc == 0 && (also || (only && !amend)))
1205 die(_("No paths with --include/--only does not make sense."));
1206 if (argc == 0 && only && amend)
1207 only_include_assumed = _("Clever... amending the last one with dirty index.");
1208 if (argc > 0 && !also && !only)
1209 only_include_assumed = _("Explicit paths specified without -i or -o; assuming --only paths...");
1210 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1211 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
1212 else if (!strcmp(cleanup_arg, "verbatim"))
1213 cleanup_mode = CLEANUP_NONE;
1214 else if (!strcmp(cleanup_arg, "whitespace"))
1215 cleanup_mode = CLEANUP_SPACE;
1216 else if (!strcmp(cleanup_arg, "strip"))
1217 cleanup_mode = CLEANUP_ALL;
1218 else if (!strcmp(cleanup_arg, "scissors"))
1219 cleanup_mode = use_editor ? CLEANUP_SCISSORS : CLEANUP_SPACE;
1220 else
1221 die(_("Invalid cleanup mode %s"), cleanup_arg);
1223 handle_untracked_files_arg(s);
1225 if (all && argc > 0)
1226 die(_("Paths with -a does not make sense."));
1228 if (status_format != STATUS_FORMAT_NONE)
1229 dry_run = 1;
1231 return argc;
1234 static int dry_run_commit(int argc, const char **argv, const char *prefix,
1235 const struct commit *current_head, struct wt_status *s)
1237 int commitable;
1238 const char *index_file;
1240 index_file = prepare_index(argc, argv, prefix, current_head, 1);
1241 commitable = run_status(stdout, index_file, prefix, 0, s);
1242 rollback_index_files();
1244 return commitable ? 0 : 1;
1247 static int parse_status_slot(const char *var, int offset)
1249 if (!strcasecmp(var+offset, "header"))
1250 return WT_STATUS_HEADER;
1251 if (!strcasecmp(var+offset, "branch"))
1252 return WT_STATUS_ONBRANCH;
1253 if (!strcasecmp(var+offset, "updated")
1254 || !strcasecmp(var+offset, "added"))
1255 return WT_STATUS_UPDATED;
1256 if (!strcasecmp(var+offset, "changed"))
1257 return WT_STATUS_CHANGED;
1258 if (!strcasecmp(var+offset, "untracked"))
1259 return WT_STATUS_UNTRACKED;
1260 if (!strcasecmp(var+offset, "nobranch"))
1261 return WT_STATUS_NOBRANCH;
1262 if (!strcasecmp(var+offset, "unmerged"))
1263 return WT_STATUS_UNMERGED;
1264 return -1;
1267 static int git_status_config(const char *k, const char *v, void *cb)
1269 struct wt_status *s = cb;
1271 if (starts_with(k, "column."))
1272 return git_column_config(k, v, "status", &s->colopts);
1273 if (!strcmp(k, "status.submodulesummary")) {
1274 int is_bool;
1275 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1276 if (is_bool && s->submodule_summary)
1277 s->submodule_summary = -1;
1278 return 0;
1280 if (!strcmp(k, "status.short")) {
1281 if (git_config_bool(k, v))
1282 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1283 else
1284 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1285 return 0;
1287 if (!strcmp(k, "status.branch")) {
1288 status_deferred_config.show_branch = git_config_bool(k, v);
1289 return 0;
1291 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1292 s->use_color = git_config_colorbool(k, v);
1293 return 0;
1295 if (!strcmp(k, "status.displaycommentprefix")) {
1296 s->display_comment_prefix = git_config_bool(k, v);
1297 return 0;
1299 if (starts_with(k, "status.color.") || starts_with(k, "color.status.")) {
1300 int slot = parse_status_slot(k, 13);
1301 if (slot < 0)
1302 return 0;
1303 if (!v)
1304 return config_error_nonbool(k);
1305 color_parse(v, k, s->color_palette[slot]);
1306 return 0;
1308 if (!strcmp(k, "status.relativepaths")) {
1309 s->relative_paths = git_config_bool(k, v);
1310 return 0;
1312 if (!strcmp(k, "status.showuntrackedfiles")) {
1313 if (!v)
1314 return config_error_nonbool(k);
1315 else if (!strcmp(v, "no"))
1316 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1317 else if (!strcmp(v, "normal"))
1318 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1319 else if (!strcmp(v, "all"))
1320 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1321 else
1322 return error(_("Invalid untracked files mode '%s'"), v);
1323 return 0;
1325 return git_diff_ui_config(k, v, NULL);
1328 int cmd_status(int argc, const char **argv, const char *prefix)
1330 static struct wt_status s;
1331 int fd;
1332 unsigned char sha1[20];
1333 static struct option builtin_status_options[] = {
1334 OPT__VERBOSE(&verbose, N_("be verbose")),
1335 OPT_SET_INT('s', "short", &status_format,
1336 N_("show status concisely"), STATUS_FORMAT_SHORT),
1337 OPT_BOOL('b', "branch", &s.show_branch,
1338 N_("show branch information")),
1339 OPT_SET_INT(0, "porcelain", &status_format,
1340 N_("machine-readable output"),
1341 STATUS_FORMAT_PORCELAIN),
1342 OPT_SET_INT(0, "long", &status_format,
1343 N_("show status in long format (default)"),
1344 STATUS_FORMAT_LONG),
1345 OPT_BOOL('z', "null", &s.null_termination,
1346 N_("terminate entries with NUL")),
1347 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1348 N_("mode"),
1349 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1350 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1351 OPT_BOOL(0, "ignored", &show_ignored_in_status,
1352 N_("show ignored files")),
1353 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1354 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1355 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1356 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1357 OPT_END(),
1360 if (argc == 2 && !strcmp(argv[1], "-h"))
1361 usage_with_options(builtin_status_usage, builtin_status_options);
1363 status_init_config(&s, git_status_config);
1364 argc = parse_options(argc, argv, prefix,
1365 builtin_status_options,
1366 builtin_status_usage, 0);
1367 finalize_colopts(&s.colopts, -1);
1368 finalize_deferred_config(&s);
1370 handle_untracked_files_arg(&s);
1371 if (show_ignored_in_status)
1372 s.show_ignored_files = 1;
1373 parse_pathspec(&s.pathspec, 0,
1374 PATHSPEC_PREFER_FULL,
1375 prefix, argv);
1377 read_cache_preload(&s.pathspec);
1378 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &s.pathspec, NULL, NULL);
1380 fd = hold_locked_index(&index_lock, 0);
1381 if (0 <= fd)
1382 update_index_if_able(&the_index, &index_lock);
1384 s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1385 s.ignore_submodule_arg = ignore_submodule_arg;
1386 wt_status_collect(&s);
1388 if (s.relative_paths)
1389 s.prefix = prefix;
1391 switch (status_format) {
1392 case STATUS_FORMAT_SHORT:
1393 wt_shortstatus_print(&s);
1394 break;
1395 case STATUS_FORMAT_PORCELAIN:
1396 wt_porcelain_print(&s);
1397 break;
1398 case STATUS_FORMAT_UNSPECIFIED:
1399 die("BUG: finalize_deferred_config() should have been called");
1400 break;
1401 case STATUS_FORMAT_NONE:
1402 case STATUS_FORMAT_LONG:
1403 s.verbose = verbose;
1404 s.ignore_submodule_arg = ignore_submodule_arg;
1405 wt_status_print(&s);
1406 break;
1408 return 0;
1411 static void print_summary(const char *prefix, const unsigned char *sha1,
1412 int initial_commit)
1414 struct rev_info rev;
1415 struct commit *commit;
1416 struct strbuf format = STRBUF_INIT;
1417 unsigned char junk_sha1[20];
1418 const char *head;
1419 struct pretty_print_context pctx = {0};
1420 struct strbuf author_ident = STRBUF_INIT;
1421 struct strbuf committer_ident = STRBUF_INIT;
1423 commit = lookup_commit(sha1);
1424 if (!commit)
1425 die(_("couldn't look up newly created commit"));
1426 if (parse_commit(commit))
1427 die(_("could not parse newly created commit"));
1429 strbuf_addstr(&format, "format:%h] %s");
1431 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1432 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1433 if (strbuf_cmp(&author_ident, &committer_ident)) {
1434 strbuf_addstr(&format, "\n Author: ");
1435 strbuf_addbuf_percentquote(&format, &author_ident);
1437 if (author_date_is_interesting()) {
1438 struct strbuf date = STRBUF_INIT;
1439 format_commit_message(commit, "%ad", &date, &pctx);
1440 strbuf_addstr(&format, "\n Date: ");
1441 strbuf_addbuf_percentquote(&format, &date);
1442 strbuf_release(&date);
1444 if (!committer_ident_sufficiently_given()) {
1445 strbuf_addstr(&format, "\n Committer: ");
1446 strbuf_addbuf_percentquote(&format, &committer_ident);
1447 if (advice_implicit_identity) {
1448 strbuf_addch(&format, '\n');
1449 strbuf_addstr(&format, _(implicit_ident_advice));
1452 strbuf_release(&author_ident);
1453 strbuf_release(&committer_ident);
1455 init_revisions(&rev, prefix);
1456 setup_revisions(0, NULL, &rev, NULL);
1458 rev.diff = 1;
1459 rev.diffopt.output_format =
1460 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1462 rev.verbose_header = 1;
1463 rev.show_root_diff = 1;
1464 get_commit_format(format.buf, &rev);
1465 rev.always_show_header = 0;
1466 rev.diffopt.detect_rename = 1;
1467 rev.diffopt.break_opt = 0;
1468 diff_setup_done(&rev.diffopt);
1470 head = resolve_ref_unsafe("HEAD", junk_sha1, 0, NULL);
1471 printf("[%s%s ",
1472 starts_with(head, "refs/heads/") ?
1473 head + 11 :
1474 !strcmp(head, "HEAD") ?
1475 _("detached HEAD") :
1476 head,
1477 initial_commit ? _(" (root-commit)") : "");
1479 if (!log_tree_commit(&rev, commit)) {
1480 rev.always_show_header = 1;
1481 rev.use_terminator = 1;
1482 log_tree_commit(&rev, commit);
1485 strbuf_release(&format);
1488 static int git_commit_config(const char *k, const char *v, void *cb)
1490 struct wt_status *s = cb;
1491 int status;
1493 if (!strcmp(k, "commit.template"))
1494 return git_config_pathname(&template_file, k, v);
1495 if (!strcmp(k, "commit.status")) {
1496 include_status = git_config_bool(k, v);
1497 return 0;
1499 if (!strcmp(k, "commit.cleanup"))
1500 return git_config_string(&cleanup_arg, k, v);
1501 if (!strcmp(k, "commit.gpgsign")) {
1502 sign_commit = git_config_bool(k, v) ? "" : NULL;
1503 return 0;
1506 status = git_gpg_config(k, v, NULL);
1507 if (status)
1508 return status;
1509 return git_status_config(k, v, s);
1512 static int run_rewrite_hook(const unsigned char *oldsha1,
1513 const unsigned char *newsha1)
1515 /* oldsha1 SP newsha1 LF NUL */
1516 static char buf[2*40 + 3];
1517 struct child_process proc;
1518 const char *argv[3];
1519 int code;
1520 size_t n;
1522 argv[0] = find_hook("post-rewrite");
1523 if (!argv[0])
1524 return 0;
1526 argv[1] = "amend";
1527 argv[2] = NULL;
1529 memset(&proc, 0, sizeof(proc));
1530 proc.argv = argv;
1531 proc.in = -1;
1532 proc.stdout_to_stderr = 1;
1534 code = start_command(&proc);
1535 if (code)
1536 return code;
1537 n = snprintf(buf, sizeof(buf), "%s %s\n",
1538 sha1_to_hex(oldsha1), sha1_to_hex(newsha1));
1539 write_in_full(proc.in, buf, n);
1540 close(proc.in);
1541 return finish_command(&proc);
1544 int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...)
1546 const char *hook_env[3] = { NULL };
1547 char index[PATH_MAX];
1548 va_list args;
1549 int ret;
1551 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
1552 hook_env[0] = index;
1555 * Let the hook know that no editor will be launched.
1557 if (!editor_is_used)
1558 hook_env[1] = "GIT_EDITOR=:";
1560 va_start(args, name);
1561 ret = run_hook_ve(hook_env, name, args);
1562 va_end(args);
1564 return ret;
1567 int cmd_commit(int argc, const char **argv, const char *prefix)
1569 static struct wt_status s;
1570 static struct option builtin_commit_options[] = {
1571 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1572 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1574 OPT_GROUP(N_("Commit message options")),
1575 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1576 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1577 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1578 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1579 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1580 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1581 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1582 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1583 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1584 OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1585 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1586 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1587 OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
1588 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1589 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
1590 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1591 /* end commit message options */
1593 OPT_GROUP(N_("Commit contents options")),
1594 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1595 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1596 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1597 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1598 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1599 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit hook")),
1600 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1601 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1602 STATUS_FORMAT_SHORT),
1603 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1604 OPT_SET_INT(0, "porcelain", &status_format,
1605 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1606 OPT_SET_INT(0, "long", &status_format,
1607 N_("show status in long format (default)"),
1608 STATUS_FORMAT_LONG),
1609 OPT_BOOL('z', "null", &s.null_termination,
1610 N_("terminate entries with NUL")),
1611 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1612 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1613 { 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" },
1614 /* end commit contents options */
1616 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1617 N_("ok to record an empty change")),
1618 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1619 N_("ok to record a change with an empty message")),
1621 OPT_END()
1624 struct strbuf sb = STRBUF_INIT;
1625 struct strbuf author_ident = STRBUF_INIT;
1626 const char *index_file, *reflog_msg;
1627 char *nl;
1628 unsigned char sha1[20];
1629 struct ref_lock *ref_lock;
1630 struct commit_list *parents = NULL, **pptr = &parents;
1631 struct stat statbuf;
1632 struct commit *current_head = NULL;
1633 struct commit_extra_header *extra = NULL;
1635 if (argc == 2 && !strcmp(argv[1], "-h"))
1636 usage_with_options(builtin_commit_usage, builtin_commit_options);
1638 status_init_config(&s, git_commit_config);
1639 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1640 s.colopts = 0;
1642 if (get_sha1("HEAD", sha1))
1643 current_head = NULL;
1644 else {
1645 current_head = lookup_commit_or_die(sha1, "HEAD");
1646 if (parse_commit(current_head))
1647 die(_("could not parse HEAD commit"));
1649 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1650 builtin_commit_usage,
1651 prefix, current_head, &s);
1652 if (dry_run)
1653 return dry_run_commit(argc, argv, prefix, current_head, &s);
1654 index_file = prepare_index(argc, argv, prefix, current_head, 0);
1656 /* Set up everything for writing the commit object. This includes
1657 running hooks, writing the trees, and interacting with the user. */
1658 if (!prepare_to_commit(index_file, prefix,
1659 current_head, &s, &author_ident)) {
1660 rollback_index_files();
1661 return 1;
1664 /* Determine parents */
1665 reflog_msg = getenv("GIT_REFLOG_ACTION");
1666 if (!current_head) {
1667 if (!reflog_msg)
1668 reflog_msg = "commit (initial)";
1669 } else if (amend) {
1670 struct commit_list *c;
1672 if (!reflog_msg)
1673 reflog_msg = "commit (amend)";
1674 for (c = current_head->parents; c; c = c->next)
1675 pptr = &commit_list_insert(c->item, pptr)->next;
1676 } else if (whence == FROM_MERGE) {
1677 struct strbuf m = STRBUF_INIT;
1678 FILE *fp;
1679 int allow_fast_forward = 1;
1681 if (!reflog_msg)
1682 reflog_msg = "commit (merge)";
1683 pptr = &commit_list_insert(current_head, pptr)->next;
1684 fp = fopen(git_path("MERGE_HEAD"), "r");
1685 if (fp == NULL)
1686 die_errno(_("could not open '%s' for reading"),
1687 git_path("MERGE_HEAD"));
1688 while (strbuf_getline(&m, fp, '\n') != EOF) {
1689 struct commit *parent;
1691 parent = get_merge_parent(m.buf);
1692 if (!parent)
1693 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1694 pptr = &commit_list_insert(parent, pptr)->next;
1696 fclose(fp);
1697 strbuf_release(&m);
1698 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1699 if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1700 die_errno(_("could not read MERGE_MODE"));
1701 if (!strcmp(sb.buf, "no-ff"))
1702 allow_fast_forward = 0;
1704 if (allow_fast_forward)
1705 parents = reduce_heads(parents);
1706 } else {
1707 if (!reflog_msg)
1708 reflog_msg = (whence == FROM_CHERRY_PICK)
1709 ? "commit (cherry-pick)"
1710 : "commit";
1711 pptr = &commit_list_insert(current_head, pptr)->next;
1714 /* Finally, get the commit message */
1715 strbuf_reset(&sb);
1716 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1717 int saved_errno = errno;
1718 rollback_index_files();
1719 die(_("could not read commit message: %s"), strerror(saved_errno));
1722 if (verbose || /* Truncate the message just before the diff, if any. */
1723 cleanup_mode == CLEANUP_SCISSORS)
1724 wt_status_truncate_message_at_cut_line(&sb);
1726 if (cleanup_mode != CLEANUP_NONE)
1727 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1728 if (template_untouched(&sb) && !allow_empty_message) {
1729 rollback_index_files();
1730 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1731 exit(1);
1733 if (message_is_empty(&sb) && !allow_empty_message) {
1734 rollback_index_files();
1735 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1736 exit(1);
1739 if (amend) {
1740 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1741 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1742 } else {
1743 struct commit_extra_header **tail = &extra;
1744 append_merge_tag_headers(parents, &tail);
1747 if (commit_tree_extended(sb.buf, sb.len, active_cache_tree->sha1,
1748 parents, sha1, author_ident.buf, sign_commit, extra)) {
1749 rollback_index_files();
1750 die(_("failed to write commit object"));
1752 strbuf_release(&author_ident);
1753 free_commit_extra_headers(extra);
1755 ref_lock = lock_any_ref_for_update("HEAD",
1756 !current_head
1757 ? NULL
1758 : current_head->object.sha1,
1759 0, NULL);
1760 if (!ref_lock) {
1761 rollback_index_files();
1762 die(_("cannot lock HEAD ref"));
1765 nl = strchr(sb.buf, '\n');
1766 if (nl)
1767 strbuf_setlen(&sb, nl + 1 - sb.buf);
1768 else
1769 strbuf_addch(&sb, '\n');
1770 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1771 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1773 if (write_ref_sha1(ref_lock, sha1, sb.buf) < 0) {
1774 rollback_index_files();
1775 die(_("cannot update HEAD ref"));
1778 unlink(git_path("CHERRY_PICK_HEAD"));
1779 unlink(git_path("REVERT_HEAD"));
1780 unlink(git_path("MERGE_HEAD"));
1781 unlink(git_path("MERGE_MSG"));
1782 unlink(git_path("MERGE_MODE"));
1783 unlink(git_path("SQUASH_MSG"));
1785 if (commit_index_files())
1786 die (_("Repository has been updated, but unable to write\n"
1787 "new_index file. Check that disk is not full or quota is\n"
1788 "not exceeded, and then \"git reset HEAD\" to recover."));
1790 rerere(0);
1791 run_commit_hook(use_editor, get_index_file(), "post-commit", NULL);
1792 if (amend && !no_post_rewrite) {
1793 struct notes_rewrite_cfg *cfg;
1794 cfg = init_copy_notes_for_rewrite("amend");
1795 if (cfg) {
1796 /* we are amending, so current_head is not NULL */
1797 copy_note_for_rewrite(cfg, current_head->object.sha1, sha1);
1798 finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1800 run_rewrite_hook(current_head->object.sha1, sha1);
1802 if (!quiet)
1803 print_summary(prefix, sha1, !current_head);
1805 return 0;