Sync with master
[git/jrn.git] / builtin / commit.c
blobed89515b518bd87703d06f272dd17a76796b5e60
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_noconfig[] =
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. Run the\n"
49 "following command and follow the instructions in your editor to edit\n"
50 "your configuration file:\n"
51 "\n"
52 " git config --global --edit\n"
53 "\n"
54 "After doing this, you may fix the identity used for this commit with:\n"
55 "\n"
56 " git commit --amend --reset-author\n");
58 static const char implicit_ident_advice_config[] =
59 N_("Your name and email address were configured automatically based\n"
60 "on your username and hostname. Please check that they are accurate.\n"
61 "You can suppress this message by setting them explicitly:\n"
62 "\n"
63 " git config --global user.name \"Your Name\"\n"
64 " git config --global user.email you@example.com\n"
65 "\n"
66 "After doing this, you may fix the identity used for this commit with:\n"
67 "\n"
68 " git commit --amend --reset-author\n");
70 static const char empty_amend_advice[] =
71 N_("You asked to amend the most recent commit, but doing so would make\n"
72 "it empty. You can repeat your command with --allow-empty, or you can\n"
73 "remove the commit entirely with \"git reset HEAD^\".\n");
75 static const char empty_cherry_pick_advice[] =
76 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
77 "If you wish to commit it anyway, use:\n"
78 "\n"
79 " git commit --allow-empty\n"
80 "\n");
82 static const char empty_cherry_pick_advice_single[] =
83 N_("Otherwise, please use 'git reset'\n");
85 static const char empty_cherry_pick_advice_multi[] =
86 N_("If you wish to skip this commit, use:\n"
87 "\n"
88 " git reset\n"
89 "\n"
90 "Then \"git cherry-pick --continue\" will resume cherry-picking\n"
91 "the remaining commits.\n");
93 static const char *use_message_buffer;
94 static const char commit_editmsg[] = "COMMIT_EDITMSG";
95 static struct lock_file index_lock; /* real index */
96 static struct lock_file false_lock; /* used only for partial commits */
97 static enum {
98 COMMIT_AS_IS = 1,
99 COMMIT_NORMAL,
100 COMMIT_PARTIAL
101 } commit_style;
103 static const char *logfile, *force_author;
104 static const char *template_file;
106 * The _message variables are commit names from which to take
107 * the commit message and/or authorship.
109 static const char *author_message, *author_message_buffer;
110 static char *edit_message, *use_message;
111 static char *fixup_message, *squash_message;
112 static int all, also, interactive, patch_interactive, only, amend, signoff;
113 static int edit_flag = -1; /* unspecified */
114 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
115 static int no_post_rewrite, allow_empty_message;
116 static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
117 static char *sign_commit;
120 * The default commit message cleanup mode will remove the lines
121 * beginning with # (shell comments) and leading and trailing
122 * whitespaces (empty lines or containing only whitespaces)
123 * if editor is used, and only the whitespaces if the message
124 * is specified explicitly.
126 static enum {
127 CLEANUP_SPACE,
128 CLEANUP_NONE,
129 CLEANUP_SCISSORS,
130 CLEANUP_ALL
131 } cleanup_mode;
132 static const char *cleanup_arg;
134 static enum commit_whence whence;
135 static int sequencer_in_use;
136 static int use_editor = 1, include_status = 1;
137 static int show_ignored_in_status, have_option_m;
138 static const char *only_include_assumed;
139 static struct strbuf message = STRBUF_INIT;
141 static enum status_format {
142 STATUS_FORMAT_NONE = 0,
143 STATUS_FORMAT_LONG,
144 STATUS_FORMAT_SHORT,
145 STATUS_FORMAT_PORCELAIN,
147 STATUS_FORMAT_UNSPECIFIED
148 } status_format = STATUS_FORMAT_UNSPECIFIED;
150 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
152 struct strbuf *buf = opt->value;
153 if (unset) {
154 have_option_m = 0;
155 strbuf_setlen(buf, 0);
156 } else {
157 have_option_m = 1;
158 if (buf->len)
159 strbuf_addch(buf, '\n');
160 strbuf_addstr(buf, arg);
161 strbuf_complete_line(buf);
163 return 0;
166 static void determine_whence(struct wt_status *s)
168 if (file_exists(git_path("MERGE_HEAD")))
169 whence = FROM_MERGE;
170 else if (file_exists(git_path("CHERRY_PICK_HEAD"))) {
171 whence = FROM_CHERRY_PICK;
172 if (file_exists(git_path(SEQ_DIR)))
173 sequencer_in_use = 1;
175 else
176 whence = FROM_COMMIT;
177 if (s)
178 s->whence = whence;
181 static void status_init_config(struct wt_status *s, config_fn_t fn)
183 wt_status_prepare(s);
184 gitmodules_config();
185 git_config(fn, s);
186 determine_whence(s);
187 s->hints = advice_status_hints; /* must come after git_config() */
190 static void rollback_index_files(void)
192 switch (commit_style) {
193 case COMMIT_AS_IS:
194 break; /* nothing to do */
195 case COMMIT_NORMAL:
196 rollback_lock_file(&index_lock);
197 break;
198 case COMMIT_PARTIAL:
199 rollback_lock_file(&index_lock);
200 rollback_lock_file(&false_lock);
201 break;
205 static int commit_index_files(void)
207 int err = 0;
209 switch (commit_style) {
210 case COMMIT_AS_IS:
211 break; /* nothing to do */
212 case COMMIT_NORMAL:
213 err = commit_lock_file(&index_lock);
214 break;
215 case COMMIT_PARTIAL:
216 err = commit_lock_file(&index_lock);
217 rollback_lock_file(&false_lock);
218 break;
221 return err;
225 * Take a union of paths in the index and the named tree (typically, "HEAD"),
226 * and return the paths that match the given pattern in list.
228 static int list_paths(struct string_list *list, const char *with_tree,
229 const char *prefix, const struct pathspec *pattern)
231 int i;
232 char *m;
234 if (!pattern->nr)
235 return 0;
237 m = xcalloc(1, pattern->nr);
239 if (with_tree) {
240 char *max_prefix = common_prefix(pattern);
241 overlay_tree_on_cache(with_tree, max_prefix ? max_prefix : prefix);
242 free(max_prefix);
245 for (i = 0; i < active_nr; i++) {
246 const struct cache_entry *ce = active_cache[i];
247 struct string_list_item *item;
249 if (ce->ce_flags & CE_UPDATE)
250 continue;
251 if (!ce_path_match(ce, pattern, m))
252 continue;
253 item = string_list_insert(list, ce->name);
254 if (ce_skip_worktree(ce))
255 item->util = item; /* better a valid pointer than a fake one */
258 return report_path_error(m, pattern, prefix);
261 static void add_remove_files(struct string_list *list)
263 int i;
264 for (i = 0; i < list->nr; i++) {
265 struct stat st;
266 struct string_list_item *p = &(list->items[i]);
268 /* p->util is skip-worktree */
269 if (p->util)
270 continue;
272 if (!lstat(p->string, &st)) {
273 if (add_to_cache(p->string, &st, 0))
274 die(_("updating files failed"));
275 } else
276 remove_file_from_cache(p->string);
280 static void create_base_index(const struct commit *current_head)
282 struct tree *tree;
283 struct unpack_trees_options opts;
284 struct tree_desc t;
286 if (!current_head) {
287 discard_cache();
288 return;
291 memset(&opts, 0, sizeof(opts));
292 opts.head_idx = 1;
293 opts.index_only = 1;
294 opts.merge = 1;
295 opts.src_index = &the_index;
296 opts.dst_index = &the_index;
298 opts.fn = oneway_merge;
299 tree = parse_tree_indirect(current_head->object.sha1);
300 if (!tree)
301 die(_("failed to unpack HEAD tree object"));
302 parse_tree(tree);
303 init_tree_desc(&t, tree->buffer, tree->size);
304 if (unpack_trees(1, &t, &opts))
305 exit(128); /* We've already reported the error, finish dying */
308 static void refresh_cache_or_die(int refresh_flags)
311 * refresh_flags contains REFRESH_QUIET, so the only errors
312 * are for unmerged entries.
314 if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
315 die_resolve_conflict("commit");
318 static char *prepare_index(int argc, const char **argv, const char *prefix,
319 const struct commit *current_head, int is_status)
321 struct string_list partial;
322 struct pathspec pathspec;
323 int refresh_flags = REFRESH_QUIET;
325 if (is_status)
326 refresh_flags |= REFRESH_UNMERGED;
327 parse_pathspec(&pathspec, 0,
328 PATHSPEC_PREFER_FULL,
329 prefix, argv);
331 if (read_cache_preload(&pathspec) < 0)
332 die(_("index file corrupt"));
334 if (interactive) {
335 char *old_index_env = NULL;
336 hold_locked_index(&index_lock, 1);
338 refresh_cache_or_die(refresh_flags);
340 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
341 die(_("unable to create temporary index"));
343 old_index_env = getenv(INDEX_ENVIRONMENT);
344 setenv(INDEX_ENVIRONMENT, index_lock.filename, 1);
346 if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
347 die(_("interactive add failed"));
349 if (old_index_env && *old_index_env)
350 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
351 else
352 unsetenv(INDEX_ENVIRONMENT);
354 discard_cache();
355 read_cache_from(index_lock.filename);
356 if (update_main_cache_tree(WRITE_TREE_SILENT) == 0) {
357 if (reopen_lock_file(&index_lock) < 0)
358 die(_("unable to write index file"));
359 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
360 die(_("unable to update temporary index"));
361 } else
362 warning(_("Failed to update main cache tree"));
364 commit_style = COMMIT_NORMAL;
365 return index_lock.filename;
369 * Non partial, non as-is commit.
371 * (1) get the real index;
372 * (2) update the_index as necessary;
373 * (3) write the_index out to the real index (still locked);
374 * (4) return the name of the locked index file.
376 * The caller should run hooks on the locked real index, and
377 * (A) if all goes well, commit the real index;
378 * (B) on failure, rollback the real index.
380 if (all || (also && pathspec.nr)) {
381 hold_locked_index(&index_lock, 1);
382 add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
383 refresh_cache_or_die(refresh_flags);
384 update_main_cache_tree(WRITE_TREE_SILENT);
385 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
386 die(_("unable to write new_index file"));
387 commit_style = COMMIT_NORMAL;
388 return index_lock.filename;
392 * As-is commit.
394 * (1) return the name of the real index file.
396 * The caller should run hooks on the real index,
397 * and create commit from the_index.
398 * We still need to refresh the index here.
400 if (!only && !pathspec.nr) {
401 hold_locked_index(&index_lock, 1);
402 refresh_cache_or_die(refresh_flags);
403 if (active_cache_changed
404 || !cache_tree_fully_valid(active_cache_tree)) {
405 update_main_cache_tree(WRITE_TREE_SILENT);
406 active_cache_changed = 1;
408 if (active_cache_changed) {
409 if (write_locked_index(&the_index, &index_lock,
410 COMMIT_LOCK))
411 die(_("unable to write new_index file"));
412 } else {
413 rollback_lock_file(&index_lock);
415 commit_style = COMMIT_AS_IS;
416 return get_index_file();
420 * A partial commit.
422 * (0) find the set of affected paths;
423 * (1) get lock on the real index file;
424 * (2) update the_index with the given paths;
425 * (3) write the_index out to the real index (still locked);
426 * (4) get lock on the false index file;
427 * (5) reset the_index from HEAD;
428 * (6) update the_index the same way as (2);
429 * (7) write the_index out to the false index file;
430 * (8) return the name of the false index file (still locked);
432 * The caller should run hooks on the locked false index, and
433 * create commit from it. Then
434 * (A) if all goes well, commit the real index;
435 * (B) on failure, rollback the real index;
436 * In either case, rollback the false index.
438 commit_style = COMMIT_PARTIAL;
440 if (whence != FROM_COMMIT) {
441 if (whence == FROM_MERGE)
442 die(_("cannot do a partial commit during a merge."));
443 else if (whence == FROM_CHERRY_PICK)
444 die(_("cannot do a partial commit during a cherry-pick."));
447 string_list_init(&partial, 1);
448 if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, &pathspec))
449 exit(1);
451 discard_cache();
452 if (read_cache() < 0)
453 die(_("cannot read the index"));
455 hold_locked_index(&index_lock, 1);
456 add_remove_files(&partial);
457 refresh_cache(REFRESH_QUIET);
458 update_main_cache_tree(WRITE_TREE_SILENT);
459 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
460 die(_("unable to write new_index file"));
462 hold_lock_file_for_update(&false_lock,
463 git_path("next-index-%"PRIuMAX,
464 (uintmax_t) getpid()),
465 LOCK_DIE_ON_ERROR);
467 create_base_index(current_head);
468 add_remove_files(&partial);
469 refresh_cache(REFRESH_QUIET);
471 if (write_locked_index(&the_index, &false_lock, CLOSE_LOCK))
472 die(_("unable to write temporary index file"));
474 discard_cache();
475 read_cache_from(false_lock.filename);
477 return false_lock.filename;
480 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
481 struct wt_status *s)
483 unsigned char sha1[20];
485 if (s->relative_paths)
486 s->prefix = prefix;
488 if (amend) {
489 s->amend = 1;
490 s->reference = "HEAD^1";
492 s->verbose = verbose;
493 s->index_file = index_file;
494 s->fp = fp;
495 s->nowarn = nowarn;
496 s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
498 wt_status_collect(s);
500 switch (status_format) {
501 case STATUS_FORMAT_SHORT:
502 wt_shortstatus_print(s);
503 break;
504 case STATUS_FORMAT_PORCELAIN:
505 wt_porcelain_print(s);
506 break;
507 case STATUS_FORMAT_UNSPECIFIED:
508 die("BUG: finalize_deferred_config() should have been called");
509 break;
510 case STATUS_FORMAT_NONE:
511 case STATUS_FORMAT_LONG:
512 wt_status_print(s);
513 break;
516 return s->commitable;
519 static int is_a_merge(const struct commit *current_head)
521 return !!(current_head->parents && current_head->parents->next);
524 static void export_one(const char *var, const char *s, const char *e, int hack)
526 struct strbuf buf = STRBUF_INIT;
527 if (hack)
528 strbuf_addch(&buf, hack);
529 strbuf_addf(&buf, "%.*s", (int)(e - s), s);
530 setenv(var, buf.buf, 1);
531 strbuf_release(&buf);
534 static int sane_ident_split(struct ident_split *person)
536 if (!person->name_begin || !person->name_end ||
537 person->name_begin == person->name_end)
538 return 0; /* no human readable name */
539 if (!person->mail_begin || !person->mail_end ||
540 person->mail_begin == person->mail_end)
541 return 0; /* no usable mail */
542 if (!person->date_begin || !person->date_end ||
543 !person->tz_begin || !person->tz_end)
544 return 0;
545 return 1;
548 static int parse_force_date(const char *in, char *out, int len)
550 if (len < 1)
551 return -1;
552 *out++ = '@';
553 len--;
555 if (parse_date(in, out, len) < 0) {
556 int errors = 0;
557 unsigned long t = approxidate_careful(in, &errors);
558 if (errors)
559 return -1;
560 snprintf(out, len, "%lu", t);
563 return 0;
566 static void determine_author_info(struct strbuf *author_ident)
568 char *name, *email, *date;
569 struct ident_split author;
570 char date_buf[64];
572 name = getenv("GIT_AUTHOR_NAME");
573 email = getenv("GIT_AUTHOR_EMAIL");
574 date = getenv("GIT_AUTHOR_DATE");
576 if (author_message) {
577 const char *a, *lb, *rb, *eol;
578 size_t len;
580 a = strstr(author_message_buffer, "\nauthor ");
581 if (!a)
582 die(_("invalid commit: %s"), author_message);
584 lb = strchrnul(a + strlen("\nauthor "), '<');
585 rb = strchrnul(lb, '>');
586 eol = strchrnul(rb, '\n');
587 if (!*lb || !*rb || !*eol)
588 die(_("invalid commit: %s"), author_message);
590 if (lb == a + strlen("\nauthor "))
591 /* \nauthor <foo@example.com> */
592 name = xcalloc(1, 1);
593 else
594 name = xmemdupz(a + strlen("\nauthor "),
595 (lb - strlen(" ") -
596 (a + strlen("\nauthor "))));
597 email = xmemdupz(lb + strlen("<"), rb - (lb + strlen("<")));
598 len = eol - (rb + strlen("> "));
599 date = xmalloc(len + 2);
600 *date = '@';
601 memcpy(date + 1, rb + strlen("> "), len);
602 date[len + 1] = '\0';
605 if (force_author) {
606 const char *lb = strstr(force_author, " <");
607 const char *rb = strchr(force_author, '>');
609 if (!lb || !rb)
610 die(_("malformed --author parameter"));
611 name = xstrndup(force_author, lb - force_author);
612 email = xstrndup(lb + 2, rb - (lb + 2));
615 if (force_date) {
616 if (parse_force_date(force_date, date_buf, sizeof(date_buf)))
617 die(_("invalid date format: %s"), force_date);
618 date = date_buf;
621 strbuf_addstr(author_ident, fmt_ident(name, email, date, IDENT_STRICT));
622 if (!split_ident_line(&author, author_ident->buf, author_ident->len) &&
623 sane_ident_split(&author)) {
624 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
625 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
626 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
630 static void split_ident_or_die(struct ident_split *id, const struct strbuf *buf)
632 if (split_ident_line(id, buf->buf, buf->len) ||
633 !sane_ident_split(id))
634 die(_("Malformed ident string: '%s'"), buf->buf);
637 static int author_date_is_interesting(void)
639 return author_message || force_date;
642 static void adjust_comment_line_char(const struct strbuf *sb)
644 char candidates[] = "#;@!$%^&|:";
645 char *candidate;
646 const char *p;
648 comment_line_char = candidates[0];
649 if (!memchr(sb->buf, comment_line_char, sb->len))
650 return;
652 p = sb->buf;
653 candidate = strchr(candidates, *p);
654 if (candidate)
655 *candidate = ' ';
656 for (p = sb->buf; *p; p++) {
657 if ((p[0] == '\n' || p[0] == '\r') && p[1]) {
658 candidate = strchr(candidates, p[1]);
659 if (candidate)
660 *candidate = ' ';
664 for (p = candidates; *p == ' '; p++)
666 if (!*p)
667 die(_("unable to select a comment character that is not used\n"
668 "in the current commit message"));
669 comment_line_char = *p;
672 static int prepare_to_commit(const char *index_file, const char *prefix,
673 struct commit *current_head,
674 struct wt_status *s,
675 struct strbuf *author_ident)
677 struct stat statbuf;
678 struct strbuf committer_ident = STRBUF_INIT;
679 int commitable;
680 struct strbuf sb = STRBUF_INIT;
681 const char *hook_arg1 = NULL;
682 const char *hook_arg2 = NULL;
683 int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
684 int old_display_comment_prefix;
686 /* This checks and barfs if author is badly specified */
687 determine_author_info(author_ident);
689 if (!no_verify && run_commit_hook(use_editor, index_file, "pre-commit", NULL))
690 return 0;
692 if (squash_message) {
694 * Insert the proper subject line before other commit
695 * message options add their content.
697 if (use_message && !strcmp(use_message, squash_message))
698 strbuf_addstr(&sb, "squash! ");
699 else {
700 struct pretty_print_context ctx = {0};
701 struct commit *c;
702 c = lookup_commit_reference_by_name(squash_message);
703 if (!c)
704 die(_("could not lookup commit %s"), squash_message);
705 ctx.output_encoding = get_commit_output_encoding();
706 format_commit_message(c, "squash! %s\n\n", &sb,
707 &ctx);
711 if (message.len) {
712 strbuf_addbuf(&sb, &message);
713 hook_arg1 = "message";
714 } else if (logfile && !strcmp(logfile, "-")) {
715 if (isatty(0))
716 fprintf(stderr, _("(reading log message from standard input)\n"));
717 if (strbuf_read(&sb, 0, 0) < 0)
718 die_errno(_("could not read log from standard input"));
719 hook_arg1 = "message";
720 } else if (logfile) {
721 if (strbuf_read_file(&sb, logfile, 0) < 0)
722 die_errno(_("could not read log file '%s'"),
723 logfile);
724 hook_arg1 = "message";
725 } else if (use_message) {
726 char *buffer;
727 buffer = strstr(use_message_buffer, "\n\n");
728 if (buffer)
729 strbuf_addstr(&sb, buffer + 2);
730 hook_arg1 = "commit";
731 hook_arg2 = use_message;
732 } else if (fixup_message) {
733 struct pretty_print_context ctx = {0};
734 struct commit *commit;
735 commit = lookup_commit_reference_by_name(fixup_message);
736 if (!commit)
737 die(_("could not lookup commit %s"), fixup_message);
738 ctx.output_encoding = get_commit_output_encoding();
739 format_commit_message(commit, "fixup! %s\n\n",
740 &sb, &ctx);
741 hook_arg1 = "message";
742 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
743 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
744 die_errno(_("could not read MERGE_MSG"));
745 hook_arg1 = "merge";
746 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
747 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
748 die_errno(_("could not read SQUASH_MSG"));
749 hook_arg1 = "squash";
750 } else if (template_file) {
751 if (strbuf_read_file(&sb, template_file, 0) < 0)
752 die_errno(_("could not read '%s'"), template_file);
753 hook_arg1 = "template";
754 clean_message_contents = 0;
758 * The remaining cases don't modify the template message, but
759 * just set the argument(s) to the prepare-commit-msg hook.
761 else if (whence == FROM_MERGE)
762 hook_arg1 = "merge";
763 else if (whence == FROM_CHERRY_PICK) {
764 hook_arg1 = "commit";
765 hook_arg2 = "CHERRY_PICK_HEAD";
768 if (squash_message) {
770 * If squash_commit was used for the commit subject,
771 * then we're possibly hijacking other commit log options.
772 * Reset the hook args to tell the real story.
774 hook_arg1 = "message";
775 hook_arg2 = "";
778 s->fp = fopen(git_path(commit_editmsg), "w");
779 if (s->fp == NULL)
780 die_errno(_("could not open '%s'"), git_path(commit_editmsg));
782 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
783 old_display_comment_prefix = s->display_comment_prefix;
784 s->display_comment_prefix = 1;
787 * Most hints are counter-productive when the commit has
788 * already started.
790 s->hints = 0;
792 if (clean_message_contents)
793 stripspace(&sb, 0);
795 if (signoff) {
797 * See if we have a Conflicts: block at the end. If yes, count
798 * its size, so we can ignore it.
800 int ignore_footer = 0;
801 int i, eol, previous = 0;
802 const char *nl;
804 for (i = 0; i < sb.len; i++) {
805 nl = memchr(sb.buf + i, '\n', sb.len - i);
806 if (nl)
807 eol = nl - sb.buf;
808 else
809 eol = sb.len;
810 if (starts_with(sb.buf + previous, "\nConflicts:\n")) {
811 ignore_footer = sb.len - previous;
812 break;
814 while (i < eol)
815 i++;
816 previous = eol;
819 append_signoff(&sb, ignore_footer, 0);
822 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
823 die_errno(_("could not write commit template"));
825 if (auto_comment_line_char)
826 adjust_comment_line_char(&sb);
827 strbuf_release(&sb);
829 /* This checks if committer ident is explicitly given */
830 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
831 if (use_editor && include_status) {
832 int ident_shown = 0;
833 int saved_color_setting;
834 struct ident_split ci, ai;
836 if (whence != FROM_COMMIT) {
837 if (cleanup_mode == CLEANUP_SCISSORS)
838 wt_status_add_cut_line(s->fp);
839 status_printf_ln(s, GIT_COLOR_NORMAL,
840 whence == FROM_MERGE
841 ? _("\n"
842 "It looks like you may be committing a merge.\n"
843 "If this is not correct, please remove the file\n"
844 " %s\n"
845 "and try again.\n")
846 : _("\n"
847 "It looks like you may be committing a cherry-pick.\n"
848 "If this is not correct, please remove the file\n"
849 " %s\n"
850 "and try again.\n"),
851 git_path(whence == FROM_MERGE
852 ? "MERGE_HEAD"
853 : "CHERRY_PICK_HEAD"));
856 fprintf(s->fp, "\n");
857 if (cleanup_mode == CLEANUP_ALL)
858 status_printf(s, GIT_COLOR_NORMAL,
859 _("Please enter the commit message for your changes."
860 " Lines starting\nwith '%c' will be ignored, and an empty"
861 " message aborts the commit.\n"), comment_line_char);
862 else if (cleanup_mode == CLEANUP_SCISSORS && whence == FROM_COMMIT)
863 wt_status_add_cut_line(s->fp);
864 else /* CLEANUP_SPACE, that is. */
865 status_printf(s, GIT_COLOR_NORMAL,
866 _("Please enter the commit message for your changes."
867 " Lines starting\n"
868 "with '%c' will be kept; you may remove them"
869 " yourself if you want to.\n"
870 "An empty message aborts the commit.\n"), comment_line_char);
871 if (only_include_assumed)
872 status_printf_ln(s, GIT_COLOR_NORMAL,
873 "%s", only_include_assumed);
875 split_ident_or_die(&ai, author_ident);
876 split_ident_or_die(&ci, &committer_ident);
878 if (ident_cmp(&ai, &ci))
879 status_printf_ln(s, GIT_COLOR_NORMAL,
880 _("%s"
881 "Author: %.*s <%.*s>"),
882 ident_shown++ ? "" : "\n",
883 (int)(ai.name_end - ai.name_begin), ai.name_begin,
884 (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);
886 if (author_date_is_interesting())
887 status_printf_ln(s, GIT_COLOR_NORMAL,
888 _("%s"
889 "Date: %s"),
890 ident_shown++ ? "" : "\n",
891 show_ident_date(&ai, DATE_NORMAL));
893 if (!committer_ident_sufficiently_given())
894 status_printf_ln(s, GIT_COLOR_NORMAL,
895 _("%s"
896 "Committer: %.*s <%.*s>"),
897 ident_shown++ ? "" : "\n",
898 (int)(ci.name_end - ci.name_begin), ci.name_begin,
899 (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
901 if (ident_shown)
902 status_printf_ln(s, GIT_COLOR_NORMAL, "%s", "");
904 saved_color_setting = s->use_color;
905 s->use_color = 0;
906 commitable = run_status(s->fp, index_file, prefix, 1, s);
907 s->use_color = saved_color_setting;
908 } else {
909 unsigned char sha1[20];
910 const char *parent = "HEAD";
912 if (!active_nr && read_cache() < 0)
913 die(_("Cannot read index"));
915 if (amend)
916 parent = "HEAD^1";
918 if (get_sha1(parent, sha1))
919 commitable = !!active_nr;
920 else {
922 * Unless the user did explicitly request a submodule
923 * ignore mode by passing a command line option we do
924 * not ignore any changed submodule SHA-1s when
925 * comparing index and parent, no matter what is
926 * configured. Otherwise we won't commit any
927 * submodules which were manually staged, which would
928 * be really confusing.
930 int diff_flags = DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG;
931 if (ignore_submodule_arg &&
932 !strcmp(ignore_submodule_arg, "all"))
933 diff_flags |= DIFF_OPT_IGNORE_SUBMODULES;
934 commitable = index_differs_from(parent, diff_flags);
937 strbuf_release(&committer_ident);
939 fclose(s->fp);
942 * Reject an attempt to record a non-merge empty commit without
943 * explicit --allow-empty. In the cherry-pick case, it may be
944 * empty due to conflict resolution, which the user should okay.
946 if (!commitable && whence != FROM_MERGE && !allow_empty &&
947 !(amend && is_a_merge(current_head))) {
948 s->display_comment_prefix = old_display_comment_prefix;
949 run_status(stdout, index_file, prefix, 0, s);
950 if (amend)
951 fputs(_(empty_amend_advice), stderr);
952 else if (whence == FROM_CHERRY_PICK) {
953 fputs(_(empty_cherry_pick_advice), stderr);
954 if (!sequencer_in_use)
955 fputs(_(empty_cherry_pick_advice_single), stderr);
956 else
957 fputs(_(empty_cherry_pick_advice_multi), stderr);
959 return 0;
963 * Re-read the index as pre-commit hook could have updated it,
964 * and write it out as a tree. We must do this before we invoke
965 * the editor and after we invoke run_status above.
967 discard_cache();
968 read_cache_from(index_file);
969 if (update_main_cache_tree(0)) {
970 error(_("Error building trees"));
971 return 0;
974 if (run_commit_hook(use_editor, index_file, "prepare-commit-msg",
975 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
976 return 0;
978 if (use_editor) {
979 char index[PATH_MAX];
980 const char *env[2] = { NULL };
981 env[0] = index;
982 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
983 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
984 fprintf(stderr,
985 _("Please supply the message using either -m or -F option.\n"));
986 exit(1);
990 if (!no_verify &&
991 run_commit_hook(use_editor, index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
992 return 0;
995 return 1;
998 static int rest_is_empty(struct strbuf *sb, int start)
1000 int i, eol;
1001 const char *nl;
1003 /* Check if the rest is just whitespace and Signed-of-by's. */
1004 for (i = start; i < sb->len; i++) {
1005 nl = memchr(sb->buf + i, '\n', sb->len - i);
1006 if (nl)
1007 eol = nl - sb->buf;
1008 else
1009 eol = sb->len;
1011 if (strlen(sign_off_header) <= eol - i &&
1012 starts_with(sb->buf + i, sign_off_header)) {
1013 i = eol;
1014 continue;
1016 while (i < eol)
1017 if (!isspace(sb->buf[i++]))
1018 return 0;
1021 return 1;
1025 * Find out if the message in the strbuf contains only whitespace and
1026 * Signed-off-by lines.
1028 static int message_is_empty(struct strbuf *sb)
1030 if (cleanup_mode == CLEANUP_NONE && sb->len)
1031 return 0;
1032 return rest_is_empty(sb, 0);
1036 * See if the user edited the message in the editor or left what
1037 * was in the template intact
1039 static int template_untouched(struct strbuf *sb)
1041 struct strbuf tmpl = STRBUF_INIT;
1042 const char *start;
1044 if (cleanup_mode == CLEANUP_NONE && sb->len)
1045 return 0;
1047 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
1048 return 0;
1050 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
1051 if (!skip_prefix(sb->buf, tmpl.buf, &start))
1052 start = sb->buf;
1053 strbuf_release(&tmpl);
1054 return rest_is_empty(sb, start - sb->buf);
1057 static const char *find_author_by_nickname(const char *name)
1059 struct rev_info revs;
1060 struct commit *commit;
1061 struct strbuf buf = STRBUF_INIT;
1062 struct string_list mailmap = STRING_LIST_INIT_NODUP;
1063 const char *av[20];
1064 int ac = 0;
1066 init_revisions(&revs, NULL);
1067 strbuf_addf(&buf, "--author=%s", name);
1068 av[++ac] = "--all";
1069 av[++ac] = "-i";
1070 av[++ac] = buf.buf;
1071 av[++ac] = NULL;
1072 setup_revisions(ac, av, &revs, NULL);
1073 revs.mailmap = &mailmap;
1074 read_mailmap(revs.mailmap, NULL);
1076 prepare_revision_walk(&revs);
1077 commit = get_revision(&revs);
1078 if (commit) {
1079 struct pretty_print_context ctx = {0};
1080 ctx.date_mode = DATE_NORMAL;
1081 strbuf_release(&buf);
1082 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
1083 clear_mailmap(&mailmap);
1084 return strbuf_detach(&buf, NULL);
1086 die(_("No existing author found with '%s'"), name);
1090 static void handle_untracked_files_arg(struct wt_status *s)
1092 if (!untracked_files_arg)
1093 ; /* default already initialized */
1094 else if (!strcmp(untracked_files_arg, "no"))
1095 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1096 else if (!strcmp(untracked_files_arg, "normal"))
1097 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1098 else if (!strcmp(untracked_files_arg, "all"))
1099 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1100 else
1101 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1104 static const char *read_commit_message(const char *name)
1106 const char *out_enc;
1107 struct commit *commit;
1109 commit = lookup_commit_reference_by_name(name);
1110 if (!commit)
1111 die(_("could not lookup commit %s"), name);
1112 out_enc = get_commit_output_encoding();
1113 return logmsg_reencode(commit, NULL, out_enc);
1117 * Enumerate what needs to be propagated when --porcelain
1118 * is not in effect here.
1120 static struct status_deferred_config {
1121 enum status_format status_format;
1122 int show_branch;
1123 } status_deferred_config = {
1124 STATUS_FORMAT_UNSPECIFIED,
1125 -1 /* unspecified */
1128 static void finalize_deferred_config(struct wt_status *s)
1130 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1131 !s->null_termination);
1133 if (s->null_termination) {
1134 if (status_format == STATUS_FORMAT_NONE ||
1135 status_format == STATUS_FORMAT_UNSPECIFIED)
1136 status_format = STATUS_FORMAT_PORCELAIN;
1137 else if (status_format == STATUS_FORMAT_LONG)
1138 die(_("--long and -z are incompatible"));
1141 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1142 status_format = status_deferred_config.status_format;
1143 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1144 status_format = STATUS_FORMAT_NONE;
1146 if (use_deferred_config && s->show_branch < 0)
1147 s->show_branch = status_deferred_config.show_branch;
1148 if (s->show_branch < 0)
1149 s->show_branch = 0;
1152 static int parse_and_validate_options(int argc, const char *argv[],
1153 const struct option *options,
1154 const char * const usage[],
1155 const char *prefix,
1156 struct commit *current_head,
1157 struct wt_status *s)
1159 int f = 0;
1161 argc = parse_options(argc, argv, prefix, options, usage, 0);
1162 finalize_deferred_config(s);
1164 if (force_author && !strchr(force_author, '>'))
1165 force_author = find_author_by_nickname(force_author);
1167 if (force_author && renew_authorship)
1168 die(_("Using both --reset-author and --author does not make sense"));
1170 if (logfile || have_option_m || use_message || fixup_message)
1171 use_editor = 0;
1172 if (0 <= edit_flag)
1173 use_editor = edit_flag;
1175 /* Sanity check options */
1176 if (amend && !current_head)
1177 die(_("You have nothing to amend."));
1178 if (amend && whence != FROM_COMMIT) {
1179 if (whence == FROM_MERGE)
1180 die(_("You are in the middle of a merge -- cannot amend."));
1181 else if (whence == FROM_CHERRY_PICK)
1182 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1184 if (fixup_message && squash_message)
1185 die(_("Options --squash and --fixup cannot be used together"));
1186 if (use_message)
1187 f++;
1188 if (edit_message)
1189 f++;
1190 if (fixup_message)
1191 f++;
1192 if (logfile)
1193 f++;
1194 if (f > 1)
1195 die(_("Only one of -c/-C/-F/--fixup can be used."));
1196 if (message.len && f > 0)
1197 die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1198 if (f || message.len)
1199 template_file = NULL;
1200 if (edit_message)
1201 use_message = edit_message;
1202 if (amend && !use_message && !fixup_message)
1203 use_message = "HEAD";
1204 if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1205 die(_("--reset-author can be used only with -C, -c or --amend."));
1206 if (use_message) {
1207 use_message_buffer = read_commit_message(use_message);
1208 if (!renew_authorship) {
1209 author_message = use_message;
1210 author_message_buffer = use_message_buffer;
1213 if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1214 author_message = "CHERRY_PICK_HEAD";
1215 author_message_buffer = read_commit_message(author_message);
1218 if (patch_interactive)
1219 interactive = 1;
1221 if (also + only + all + interactive > 1)
1222 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1223 if (argc == 0 && (also || (only && !amend)))
1224 die(_("No paths with --include/--only does not make sense."));
1225 if (argc == 0 && only && amend)
1226 only_include_assumed = _("Clever... amending the last one with dirty index.");
1227 if (argc > 0 && !also && !only)
1228 only_include_assumed = _("Explicit paths specified without -i or -o; assuming --only paths...");
1229 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1230 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
1231 else if (!strcmp(cleanup_arg, "verbatim"))
1232 cleanup_mode = CLEANUP_NONE;
1233 else if (!strcmp(cleanup_arg, "whitespace"))
1234 cleanup_mode = CLEANUP_SPACE;
1235 else if (!strcmp(cleanup_arg, "strip"))
1236 cleanup_mode = CLEANUP_ALL;
1237 else if (!strcmp(cleanup_arg, "scissors"))
1238 cleanup_mode = use_editor ? CLEANUP_SCISSORS : CLEANUP_SPACE;
1239 else
1240 die(_("Invalid cleanup mode %s"), cleanup_arg);
1242 handle_untracked_files_arg(s);
1244 if (all && argc > 0)
1245 die(_("Paths with -a does not make sense."));
1247 if (status_format != STATUS_FORMAT_NONE)
1248 dry_run = 1;
1250 return argc;
1253 static int dry_run_commit(int argc, const char **argv, const char *prefix,
1254 const struct commit *current_head, struct wt_status *s)
1256 int commitable;
1257 const char *index_file;
1259 index_file = prepare_index(argc, argv, prefix, current_head, 1);
1260 commitable = run_status(stdout, index_file, prefix, 0, s);
1261 rollback_index_files();
1263 return commitable ? 0 : 1;
1266 static int parse_status_slot(const char *var, int offset)
1268 if (!strcasecmp(var+offset, "header"))
1269 return WT_STATUS_HEADER;
1270 if (!strcasecmp(var+offset, "branch"))
1271 return WT_STATUS_ONBRANCH;
1272 if (!strcasecmp(var+offset, "updated")
1273 || !strcasecmp(var+offset, "added"))
1274 return WT_STATUS_UPDATED;
1275 if (!strcasecmp(var+offset, "changed"))
1276 return WT_STATUS_CHANGED;
1277 if (!strcasecmp(var+offset, "untracked"))
1278 return WT_STATUS_UNTRACKED;
1279 if (!strcasecmp(var+offset, "nobranch"))
1280 return WT_STATUS_NOBRANCH;
1281 if (!strcasecmp(var+offset, "unmerged"))
1282 return WT_STATUS_UNMERGED;
1283 return -1;
1286 static int git_status_config(const char *k, const char *v, void *cb)
1288 struct wt_status *s = cb;
1290 if (starts_with(k, "column."))
1291 return git_column_config(k, v, "status", &s->colopts);
1292 if (!strcmp(k, "status.submodulesummary")) {
1293 int is_bool;
1294 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1295 if (is_bool && s->submodule_summary)
1296 s->submodule_summary = -1;
1297 return 0;
1299 if (!strcmp(k, "status.short")) {
1300 if (git_config_bool(k, v))
1301 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1302 else
1303 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1304 return 0;
1306 if (!strcmp(k, "status.branch")) {
1307 status_deferred_config.show_branch = git_config_bool(k, v);
1308 return 0;
1310 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1311 s->use_color = git_config_colorbool(k, v);
1312 return 0;
1314 if (!strcmp(k, "status.displaycommentprefix")) {
1315 s->display_comment_prefix = git_config_bool(k, v);
1316 return 0;
1318 if (starts_with(k, "status.color.") || starts_with(k, "color.status.")) {
1319 int slot = parse_status_slot(k, 13);
1320 if (slot < 0)
1321 return 0;
1322 if (!v)
1323 return config_error_nonbool(k);
1324 color_parse(v, k, s->color_palette[slot]);
1325 return 0;
1327 if (!strcmp(k, "status.relativepaths")) {
1328 s->relative_paths = git_config_bool(k, v);
1329 return 0;
1331 if (!strcmp(k, "status.showuntrackedfiles")) {
1332 if (!v)
1333 return config_error_nonbool(k);
1334 else if (!strcmp(v, "no"))
1335 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1336 else if (!strcmp(v, "normal"))
1337 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1338 else if (!strcmp(v, "all"))
1339 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1340 else
1341 return error(_("Invalid untracked files mode '%s'"), v);
1342 return 0;
1344 return git_diff_ui_config(k, v, NULL);
1347 int cmd_status(int argc, const char **argv, const char *prefix)
1349 static struct wt_status s;
1350 int fd;
1351 unsigned char sha1[20];
1352 static struct option builtin_status_options[] = {
1353 OPT__VERBOSE(&verbose, N_("be verbose")),
1354 OPT_SET_INT('s', "short", &status_format,
1355 N_("show status concisely"), STATUS_FORMAT_SHORT),
1356 OPT_BOOL('b', "branch", &s.show_branch,
1357 N_("show branch information")),
1358 OPT_SET_INT(0, "porcelain", &status_format,
1359 N_("machine-readable output"),
1360 STATUS_FORMAT_PORCELAIN),
1361 OPT_SET_INT(0, "long", &status_format,
1362 N_("show status in long format (default)"),
1363 STATUS_FORMAT_LONG),
1364 OPT_BOOL('z', "null", &s.null_termination,
1365 N_("terminate entries with NUL")),
1366 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1367 N_("mode"),
1368 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1369 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1370 OPT_BOOL(0, "ignored", &show_ignored_in_status,
1371 N_("show ignored files")),
1372 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1373 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1374 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1375 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1376 OPT_END(),
1379 if (argc == 2 && !strcmp(argv[1], "-h"))
1380 usage_with_options(builtin_status_usage, builtin_status_options);
1382 status_init_config(&s, git_status_config);
1383 argc = parse_options(argc, argv, prefix,
1384 builtin_status_options,
1385 builtin_status_usage, 0);
1386 finalize_colopts(&s.colopts, -1);
1387 finalize_deferred_config(&s);
1389 handle_untracked_files_arg(&s);
1390 if (show_ignored_in_status)
1391 s.show_ignored_files = 1;
1392 parse_pathspec(&s.pathspec, 0,
1393 PATHSPEC_PREFER_FULL,
1394 prefix, argv);
1396 read_cache_preload(&s.pathspec);
1397 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &s.pathspec, NULL, NULL);
1399 fd = hold_locked_index(&index_lock, 0);
1400 if (0 <= fd)
1401 update_index_if_able(&the_index, &index_lock);
1403 s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1404 s.ignore_submodule_arg = ignore_submodule_arg;
1405 wt_status_collect(&s);
1407 if (s.relative_paths)
1408 s.prefix = prefix;
1410 switch (status_format) {
1411 case STATUS_FORMAT_SHORT:
1412 wt_shortstatus_print(&s);
1413 break;
1414 case STATUS_FORMAT_PORCELAIN:
1415 wt_porcelain_print(&s);
1416 break;
1417 case STATUS_FORMAT_UNSPECIFIED:
1418 die("BUG: finalize_deferred_config() should have been called");
1419 break;
1420 case STATUS_FORMAT_NONE:
1421 case STATUS_FORMAT_LONG:
1422 s.verbose = verbose;
1423 s.ignore_submodule_arg = ignore_submodule_arg;
1424 wt_status_print(&s);
1425 break;
1427 return 0;
1430 static const char *implicit_ident_advice(void)
1432 char *user_config = NULL;
1433 char *xdg_config = NULL;
1434 int config_exists;
1436 home_config_paths(&user_config, &xdg_config, "config");
1437 config_exists = file_exists(user_config) || file_exists(xdg_config);
1438 free(user_config);
1439 free(xdg_config);
1441 if (config_exists)
1442 return _(implicit_ident_advice_config);
1443 else
1444 return _(implicit_ident_advice_noconfig);
1448 static void print_summary(const char *prefix, const unsigned char *sha1,
1449 int initial_commit)
1451 struct rev_info rev;
1452 struct commit *commit;
1453 struct strbuf format = STRBUF_INIT;
1454 unsigned char junk_sha1[20];
1455 const char *head;
1456 struct pretty_print_context pctx = {0};
1457 struct strbuf author_ident = STRBUF_INIT;
1458 struct strbuf committer_ident = STRBUF_INIT;
1460 commit = lookup_commit(sha1);
1461 if (!commit)
1462 die(_("couldn't look up newly created commit"));
1463 if (parse_commit(commit))
1464 die(_("could not parse newly created commit"));
1466 strbuf_addstr(&format, "format:%h] %s");
1468 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1469 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1470 if (strbuf_cmp(&author_ident, &committer_ident)) {
1471 strbuf_addstr(&format, "\n Author: ");
1472 strbuf_addbuf_percentquote(&format, &author_ident);
1474 if (author_date_is_interesting()) {
1475 struct strbuf date = STRBUF_INIT;
1476 format_commit_message(commit, "%ad", &date, &pctx);
1477 strbuf_addstr(&format, "\n Date: ");
1478 strbuf_addbuf_percentquote(&format, &date);
1479 strbuf_release(&date);
1481 if (!committer_ident_sufficiently_given()) {
1482 strbuf_addstr(&format, "\n Committer: ");
1483 strbuf_addbuf_percentquote(&format, &committer_ident);
1484 if (advice_implicit_identity) {
1485 strbuf_addch(&format, '\n');
1486 strbuf_addstr(&format, implicit_ident_advice());
1489 strbuf_release(&author_ident);
1490 strbuf_release(&committer_ident);
1492 init_revisions(&rev, prefix);
1493 setup_revisions(0, NULL, &rev, NULL);
1495 rev.diff = 1;
1496 rev.diffopt.output_format =
1497 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1499 rev.verbose_header = 1;
1500 rev.show_root_diff = 1;
1501 get_commit_format(format.buf, &rev);
1502 rev.always_show_header = 0;
1503 rev.diffopt.detect_rename = 1;
1504 rev.diffopt.break_opt = 0;
1505 diff_setup_done(&rev.diffopt);
1507 head = resolve_ref_unsafe("HEAD", junk_sha1, 0, NULL);
1508 printf("[%s%s ",
1509 starts_with(head, "refs/heads/") ?
1510 head + 11 :
1511 !strcmp(head, "HEAD") ?
1512 _("detached HEAD") :
1513 head,
1514 initial_commit ? _(" (root-commit)") : "");
1516 if (!log_tree_commit(&rev, commit)) {
1517 rev.always_show_header = 1;
1518 rev.use_terminator = 1;
1519 log_tree_commit(&rev, commit);
1522 strbuf_release(&format);
1525 static int git_commit_config(const char *k, const char *v, void *cb)
1527 struct wt_status *s = cb;
1528 int status;
1530 if (!strcmp(k, "commit.template"))
1531 return git_config_pathname(&template_file, k, v);
1532 if (!strcmp(k, "commit.status")) {
1533 include_status = git_config_bool(k, v);
1534 return 0;
1536 if (!strcmp(k, "commit.cleanup"))
1537 return git_config_string(&cleanup_arg, k, v);
1538 if (!strcmp(k, "commit.gpgsign")) {
1539 sign_commit = git_config_bool(k, v) ? "" : NULL;
1540 return 0;
1543 status = git_gpg_config(k, v, NULL);
1544 if (status)
1545 return status;
1546 return git_status_config(k, v, s);
1549 static int run_rewrite_hook(const unsigned char *oldsha1,
1550 const unsigned char *newsha1)
1552 /* oldsha1 SP newsha1 LF NUL */
1553 static char buf[2*40 + 3];
1554 struct child_process proc;
1555 const char *argv[3];
1556 int code;
1557 size_t n;
1559 argv[0] = find_hook("post-rewrite");
1560 if (!argv[0])
1561 return 0;
1563 argv[1] = "amend";
1564 argv[2] = NULL;
1566 memset(&proc, 0, sizeof(proc));
1567 proc.argv = argv;
1568 proc.in = -1;
1569 proc.stdout_to_stderr = 1;
1571 code = start_command(&proc);
1572 if (code)
1573 return code;
1574 n = snprintf(buf, sizeof(buf), "%s %s\n",
1575 sha1_to_hex(oldsha1), sha1_to_hex(newsha1));
1576 write_in_full(proc.in, buf, n);
1577 close(proc.in);
1578 return finish_command(&proc);
1581 int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...)
1583 const char *hook_env[3] = { NULL };
1584 char index[PATH_MAX];
1585 va_list args;
1586 int ret;
1588 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
1589 hook_env[0] = index;
1592 * Let the hook know that no editor will be launched.
1594 if (!editor_is_used)
1595 hook_env[1] = "GIT_EDITOR=:";
1597 va_start(args, name);
1598 ret = run_hook_ve(hook_env, name, args);
1599 va_end(args);
1601 return ret;
1604 int cmd_commit(int argc, const char **argv, const char *prefix)
1606 static struct wt_status s;
1607 static struct option builtin_commit_options[] = {
1608 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1609 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1611 OPT_GROUP(N_("Commit message options")),
1612 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1613 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1614 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1615 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1616 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1617 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1618 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1619 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1620 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1621 OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1622 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1623 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1624 OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
1625 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1626 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
1627 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1628 /* end commit message options */
1630 OPT_GROUP(N_("Commit contents options")),
1631 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1632 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1633 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1634 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1635 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1636 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit hook")),
1637 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1638 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1639 STATUS_FORMAT_SHORT),
1640 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1641 OPT_SET_INT(0, "porcelain", &status_format,
1642 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1643 OPT_SET_INT(0, "long", &status_format,
1644 N_("show status in long format (default)"),
1645 STATUS_FORMAT_LONG),
1646 OPT_BOOL('z', "null", &s.null_termination,
1647 N_("terminate entries with NUL")),
1648 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1649 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1650 { 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" },
1651 /* end commit contents options */
1653 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1654 N_("ok to record an empty change")),
1655 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1656 N_("ok to record a change with an empty message")),
1658 OPT_END()
1661 struct strbuf sb = STRBUF_INIT;
1662 struct strbuf author_ident = STRBUF_INIT;
1663 const char *index_file, *reflog_msg;
1664 char *nl;
1665 unsigned char sha1[20];
1666 struct ref_lock *ref_lock;
1667 struct commit_list *parents = NULL, **pptr = &parents;
1668 struct stat statbuf;
1669 struct commit *current_head = NULL;
1670 struct commit_extra_header *extra = NULL;
1672 if (argc == 2 && !strcmp(argv[1], "-h"))
1673 usage_with_options(builtin_commit_usage, builtin_commit_options);
1675 status_init_config(&s, git_commit_config);
1676 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1677 s.colopts = 0;
1679 if (get_sha1("HEAD", sha1))
1680 current_head = NULL;
1681 else {
1682 current_head = lookup_commit_or_die(sha1, "HEAD");
1683 if (parse_commit(current_head))
1684 die(_("could not parse HEAD commit"));
1686 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1687 builtin_commit_usage,
1688 prefix, current_head, &s);
1689 if (dry_run)
1690 return dry_run_commit(argc, argv, prefix, current_head, &s);
1691 index_file = prepare_index(argc, argv, prefix, current_head, 0);
1693 /* Set up everything for writing the commit object. This includes
1694 running hooks, writing the trees, and interacting with the user. */
1695 if (!prepare_to_commit(index_file, prefix,
1696 current_head, &s, &author_ident)) {
1697 rollback_index_files();
1698 return 1;
1701 /* Determine parents */
1702 reflog_msg = getenv("GIT_REFLOG_ACTION");
1703 if (!current_head) {
1704 if (!reflog_msg)
1705 reflog_msg = "commit (initial)";
1706 } else if (amend) {
1707 struct commit_list *c;
1709 if (!reflog_msg)
1710 reflog_msg = "commit (amend)";
1711 for (c = current_head->parents; c; c = c->next)
1712 pptr = &commit_list_insert(c->item, pptr)->next;
1713 } else if (whence == FROM_MERGE) {
1714 struct strbuf m = STRBUF_INIT;
1715 FILE *fp;
1716 int allow_fast_forward = 1;
1718 if (!reflog_msg)
1719 reflog_msg = "commit (merge)";
1720 pptr = &commit_list_insert(current_head, pptr)->next;
1721 fp = fopen(git_path("MERGE_HEAD"), "r");
1722 if (fp == NULL)
1723 die_errno(_("could not open '%s' for reading"),
1724 git_path("MERGE_HEAD"));
1725 while (strbuf_getline(&m, fp, '\n') != EOF) {
1726 struct commit *parent;
1728 parent = get_merge_parent(m.buf);
1729 if (!parent)
1730 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1731 pptr = &commit_list_insert(parent, pptr)->next;
1733 fclose(fp);
1734 strbuf_release(&m);
1735 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1736 if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1737 die_errno(_("could not read MERGE_MODE"));
1738 if (!strcmp(sb.buf, "no-ff"))
1739 allow_fast_forward = 0;
1741 if (allow_fast_forward)
1742 parents = reduce_heads(parents);
1743 } else {
1744 if (!reflog_msg)
1745 reflog_msg = (whence == FROM_CHERRY_PICK)
1746 ? "commit (cherry-pick)"
1747 : "commit";
1748 pptr = &commit_list_insert(current_head, pptr)->next;
1751 /* Finally, get the commit message */
1752 strbuf_reset(&sb);
1753 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1754 int saved_errno = errno;
1755 rollback_index_files();
1756 die(_("could not read commit message: %s"), strerror(saved_errno));
1759 if (verbose || /* Truncate the message just before the diff, if any. */
1760 cleanup_mode == CLEANUP_SCISSORS)
1761 wt_status_truncate_message_at_cut_line(&sb);
1763 if (cleanup_mode != CLEANUP_NONE)
1764 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1765 if (template_untouched(&sb) && !allow_empty_message) {
1766 rollback_index_files();
1767 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1768 exit(1);
1770 if (message_is_empty(&sb) && !allow_empty_message) {
1771 rollback_index_files();
1772 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1773 exit(1);
1776 if (amend) {
1777 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1778 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1779 } else {
1780 struct commit_extra_header **tail = &extra;
1781 append_merge_tag_headers(parents, &tail);
1784 if (commit_tree_extended(sb.buf, sb.len, active_cache_tree->sha1,
1785 parents, sha1, author_ident.buf, sign_commit, extra)) {
1786 rollback_index_files();
1787 die(_("failed to write commit object"));
1789 strbuf_release(&author_ident);
1790 free_commit_extra_headers(extra);
1792 ref_lock = lock_any_ref_for_update("HEAD",
1793 !current_head
1794 ? NULL
1795 : current_head->object.sha1,
1796 0, NULL);
1797 if (!ref_lock) {
1798 rollback_index_files();
1799 die(_("cannot lock HEAD ref"));
1802 nl = strchr(sb.buf, '\n');
1803 if (nl)
1804 strbuf_setlen(&sb, nl + 1 - sb.buf);
1805 else
1806 strbuf_addch(&sb, '\n');
1807 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1808 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1810 if (write_ref_sha1(ref_lock, sha1, sb.buf) < 0) {
1811 rollback_index_files();
1812 die(_("cannot update HEAD ref"));
1815 unlink(git_path("CHERRY_PICK_HEAD"));
1816 unlink(git_path("REVERT_HEAD"));
1817 unlink(git_path("MERGE_HEAD"));
1818 unlink(git_path("MERGE_MSG"));
1819 unlink(git_path("MERGE_MODE"));
1820 unlink(git_path("SQUASH_MSG"));
1822 if (commit_index_files())
1823 die (_("Repository has been updated, but unable to write\n"
1824 "new_index file. Check that disk is not full or quota is\n"
1825 "not exceeded, and then \"git reset HEAD\" to recover."));
1827 rerere(0);
1828 run_commit_hook(use_editor, get_index_file(), "post-commit", NULL);
1829 if (amend && !no_post_rewrite) {
1830 struct notes_rewrite_cfg *cfg;
1831 cfg = init_copy_notes_for_rewrite("amend");
1832 if (cfg) {
1833 /* we are amending, so current_head is not NULL */
1834 copy_note_for_rewrite(cfg, current_head->object.sha1, sha1);
1835 finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1837 run_rewrite_hook(current_head->object.sha1, sha1);
1839 if (!quiet)
1840 print_summary(prefix, sha1, !current_head);
1842 return 0;