Merge branch 'ad/commit-have-m-option'
[git.git] / builtin / commit.c
blob391126e58d12f4683e131a310d94d6de4571c7e6
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 "lockfile.h"
10 #include "cache-tree.h"
11 #include "color.h"
12 #include "dir.h"
13 #include "builtin.h"
14 #include "diff.h"
15 #include "diffcore.h"
16 #include "commit.h"
17 #include "revision.h"
18 #include "wt-status.h"
19 #include "run-command.h"
20 #include "refs.h"
21 #include "log-tree.h"
22 #include "strbuf.h"
23 #include "utf8.h"
24 #include "parse-options.h"
25 #include "string-list.h"
26 #include "rerere.h"
27 #include "unpack-trees.h"
28 #include "quote.h"
29 #include "submodule.h"
30 #include "gpg-interface.h"
31 #include "column.h"
32 #include "sequencer.h"
33 #include "notes-utils.h"
34 #include "mailmap.h"
35 #include "sigchain.h"
37 static const char * const builtin_commit_usage[] = {
38 N_("git commit [<options>] [--] <pathspec>..."),
39 NULL
42 static const char * const builtin_status_usage[] = {
43 N_("git status [<options>] [--] <pathspec>..."),
44 NULL
47 static const char implicit_ident_advice_noconfig[] =
48 N_("Your name and email address were configured automatically based\n"
49 "on your username and hostname. Please check that they are accurate.\n"
50 "You can suppress this message by setting them explicitly. Run the\n"
51 "following command and follow the instructions in your editor to edit\n"
52 "your configuration file:\n"
53 "\n"
54 " git config --global --edit\n"
55 "\n"
56 "After doing this, you may fix the identity used for this commit with:\n"
57 "\n"
58 " git commit --amend --reset-author\n");
60 static const char implicit_ident_advice_config[] =
61 N_("Your name and email address were configured automatically based\n"
62 "on your username and hostname. Please check that they are accurate.\n"
63 "You can suppress this message by setting them explicitly:\n"
64 "\n"
65 " git config --global user.name \"Your Name\"\n"
66 " git config --global user.email you@example.com\n"
67 "\n"
68 "After doing this, you may fix the identity used for this commit with:\n"
69 "\n"
70 " git commit --amend --reset-author\n");
72 static const char empty_amend_advice[] =
73 N_("You asked to amend the most recent commit, but doing so would make\n"
74 "it empty. You can repeat your command with --allow-empty, or you can\n"
75 "remove the commit entirely with \"git reset HEAD^\".\n");
77 static const char empty_cherry_pick_advice[] =
78 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
79 "If you wish to commit it anyway, use:\n"
80 "\n"
81 " git commit --allow-empty\n"
82 "\n");
84 static const char empty_cherry_pick_advice_single[] =
85 N_("Otherwise, please use 'git reset'\n");
87 static const char empty_cherry_pick_advice_multi[] =
88 N_("If you wish to skip this commit, use:\n"
89 "\n"
90 " git reset\n"
91 "\n"
92 "Then \"git cherry-pick --continue\" will resume cherry-picking\n"
93 "the remaining commits.\n");
95 static const char *use_message_buffer;
96 static const char commit_editmsg[] = "COMMIT_EDITMSG";
97 static struct lock_file index_lock; /* real index */
98 static struct lock_file false_lock; /* used only for partial commits */
99 static enum {
100 COMMIT_AS_IS = 1,
101 COMMIT_NORMAL,
102 COMMIT_PARTIAL
103 } commit_style;
105 static const char *logfile, *force_author;
106 static const char *template_file;
108 * The _message variables are commit names from which to take
109 * the commit message and/or authorship.
111 static const char *author_message, *author_message_buffer;
112 static char *edit_message, *use_message;
113 static char *fixup_message, *squash_message;
114 static int all, also, interactive, patch_interactive, only, amend, signoff;
115 static int edit_flag = -1; /* unspecified */
116 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
117 static int no_post_rewrite, allow_empty_message;
118 static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
119 static char *sign_commit;
122 * The default commit message cleanup mode will remove the lines
123 * beginning with # (shell comments) and leading and trailing
124 * whitespaces (empty lines or containing only whitespaces)
125 * if editor is used, and only the whitespaces if the message
126 * is specified explicitly.
128 static enum {
129 CLEANUP_SPACE,
130 CLEANUP_NONE,
131 CLEANUP_SCISSORS,
132 CLEANUP_ALL
133 } cleanup_mode;
134 static const char *cleanup_arg;
136 static enum commit_whence whence;
137 static int sequencer_in_use;
138 static int use_editor = 1, include_status = 1;
139 static int show_ignored_in_status, have_option_m;
140 static const char *only_include_assumed;
141 static struct strbuf message = STRBUF_INIT;
143 static enum status_format {
144 STATUS_FORMAT_NONE = 0,
145 STATUS_FORMAT_LONG,
146 STATUS_FORMAT_SHORT,
147 STATUS_FORMAT_PORCELAIN,
149 STATUS_FORMAT_UNSPECIFIED
150 } status_format = STATUS_FORMAT_UNSPECIFIED;
152 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
154 struct strbuf *buf = opt->value;
155 if (unset) {
156 have_option_m = 0;
157 strbuf_setlen(buf, 0);
158 } else {
159 have_option_m = 1;
160 if (buf->len)
161 strbuf_addch(buf, '\n');
162 strbuf_addstr(buf, arg);
163 strbuf_complete_line(buf);
165 return 0;
168 static void determine_whence(struct wt_status *s)
170 if (file_exists(git_path_merge_head()))
171 whence = FROM_MERGE;
172 else if (file_exists(git_path_cherry_pick_head())) {
173 whence = FROM_CHERRY_PICK;
174 if (file_exists(git_path(SEQ_DIR)))
175 sequencer_in_use = 1;
177 else
178 whence = FROM_COMMIT;
179 if (s)
180 s->whence = whence;
183 static void status_init_config(struct wt_status *s, config_fn_t fn)
185 wt_status_prepare(s);
186 gitmodules_config();
187 git_config(fn, s);
188 determine_whence(s);
189 init_diff_ui_defaults();
190 s->hints = advice_status_hints; /* must come after git_config() */
193 static void rollback_index_files(void)
195 switch (commit_style) {
196 case COMMIT_AS_IS:
197 break; /* nothing to do */
198 case COMMIT_NORMAL:
199 rollback_lock_file(&index_lock);
200 break;
201 case COMMIT_PARTIAL:
202 rollback_lock_file(&index_lock);
203 rollback_lock_file(&false_lock);
204 break;
208 static int commit_index_files(void)
210 int err = 0;
212 switch (commit_style) {
213 case COMMIT_AS_IS:
214 break; /* nothing to do */
215 case COMMIT_NORMAL:
216 err = commit_lock_file(&index_lock);
217 break;
218 case COMMIT_PARTIAL:
219 err = commit_lock_file(&index_lock);
220 rollback_lock_file(&false_lock);
221 break;
224 return err;
228 * Take a union of paths in the index and the named tree (typically, "HEAD"),
229 * and return the paths that match the given pattern in list.
231 static int list_paths(struct string_list *list, const char *with_tree,
232 const char *prefix, const struct pathspec *pattern)
234 int i, ret;
235 char *m;
237 if (!pattern->nr)
238 return 0;
240 m = xcalloc(1, pattern->nr);
242 if (with_tree) {
243 char *max_prefix = common_prefix(pattern);
244 overlay_tree_on_cache(with_tree, max_prefix ? max_prefix : prefix);
245 free(max_prefix);
248 for (i = 0; i < active_nr; i++) {
249 const struct cache_entry *ce = active_cache[i];
250 struct string_list_item *item;
252 if (ce->ce_flags & CE_UPDATE)
253 continue;
254 if (!ce_path_match(ce, pattern, m))
255 continue;
256 item = string_list_insert(list, ce->name);
257 if (ce_skip_worktree(ce))
258 item->util = item; /* better a valid pointer than a fake one */
261 ret = report_path_error(m, pattern, prefix);
262 free(m);
263 return ret;
266 static void add_remove_files(struct string_list *list)
268 int i;
269 for (i = 0; i < list->nr; i++) {
270 struct stat st;
271 struct string_list_item *p = &(list->items[i]);
273 /* p->util is skip-worktree */
274 if (p->util)
275 continue;
277 if (!lstat(p->string, &st)) {
278 if (add_to_cache(p->string, &st, 0))
279 die(_("updating files failed"));
280 } else
281 remove_file_from_cache(p->string);
285 static void create_base_index(const struct commit *current_head)
287 struct tree *tree;
288 struct unpack_trees_options opts;
289 struct tree_desc t;
291 if (!current_head) {
292 discard_cache();
293 return;
296 memset(&opts, 0, sizeof(opts));
297 opts.head_idx = 1;
298 opts.index_only = 1;
299 opts.merge = 1;
300 opts.src_index = &the_index;
301 opts.dst_index = &the_index;
303 opts.fn = oneway_merge;
304 tree = parse_tree_indirect(current_head->object.oid.hash);
305 if (!tree)
306 die(_("failed to unpack HEAD tree object"));
307 parse_tree(tree);
308 init_tree_desc(&t, tree->buffer, tree->size);
309 if (unpack_trees(1, &t, &opts))
310 exit(128); /* We've already reported the error, finish dying */
313 static void refresh_cache_or_die(int refresh_flags)
316 * refresh_flags contains REFRESH_QUIET, so the only errors
317 * are for unmerged entries.
319 if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
320 die_resolve_conflict("commit");
323 static const char *prepare_index(int argc, const char **argv, const char *prefix,
324 const struct commit *current_head, int is_status)
326 struct string_list partial;
327 struct pathspec pathspec;
328 int refresh_flags = REFRESH_QUIET;
329 const char *ret;
331 if (is_status)
332 refresh_flags |= REFRESH_UNMERGED;
333 parse_pathspec(&pathspec, 0,
334 PATHSPEC_PREFER_FULL,
335 prefix, argv);
337 if (read_cache_preload(&pathspec) < 0)
338 die(_("index file corrupt"));
340 if (interactive) {
341 char *old_index_env = NULL;
342 hold_locked_index(&index_lock, 1);
344 refresh_cache_or_die(refresh_flags);
346 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
347 die(_("unable to create temporary index"));
349 old_index_env = getenv(INDEX_ENVIRONMENT);
350 setenv(INDEX_ENVIRONMENT, get_lock_file_path(&index_lock), 1);
352 if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
353 die(_("interactive add failed"));
355 if (old_index_env && *old_index_env)
356 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
357 else
358 unsetenv(INDEX_ENVIRONMENT);
360 discard_cache();
361 read_cache_from(get_lock_file_path(&index_lock));
362 if (update_main_cache_tree(WRITE_TREE_SILENT) == 0) {
363 if (reopen_lock_file(&index_lock) < 0)
364 die(_("unable to write index file"));
365 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
366 die(_("unable to update temporary index"));
367 } else
368 warning(_("Failed to update main cache tree"));
370 commit_style = COMMIT_NORMAL;
371 return get_lock_file_path(&index_lock);
375 * Non partial, non as-is commit.
377 * (1) get the real index;
378 * (2) update the_index as necessary;
379 * (3) write the_index out to the real index (still locked);
380 * (4) return the name of the locked index file.
382 * The caller should run hooks on the locked real index, and
383 * (A) if all goes well, commit the real index;
384 * (B) on failure, rollback the real index.
386 if (all || (also && pathspec.nr)) {
387 hold_locked_index(&index_lock, 1);
388 add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
389 refresh_cache_or_die(refresh_flags);
390 update_main_cache_tree(WRITE_TREE_SILENT);
391 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
392 die(_("unable to write new_index file"));
393 commit_style = COMMIT_NORMAL;
394 return get_lock_file_path(&index_lock);
398 * As-is commit.
400 * (1) return the name of the real index file.
402 * The caller should run hooks on the real index,
403 * and create commit from the_index.
404 * We still need to refresh the index here.
406 if (!only && !pathspec.nr) {
407 hold_locked_index(&index_lock, 1);
408 refresh_cache_or_die(refresh_flags);
409 if (active_cache_changed
410 || !cache_tree_fully_valid(active_cache_tree))
411 update_main_cache_tree(WRITE_TREE_SILENT);
412 if (active_cache_changed) {
413 if (write_locked_index(&the_index, &index_lock,
414 COMMIT_LOCK))
415 die(_("unable to write new_index file"));
416 } else {
417 rollback_lock_file(&index_lock);
419 commit_style = COMMIT_AS_IS;
420 return get_index_file();
424 * A partial commit.
426 * (0) find the set of affected paths;
427 * (1) get lock on the real index file;
428 * (2) update the_index with the given paths;
429 * (3) write the_index out to the real index (still locked);
430 * (4) get lock on the false index file;
431 * (5) reset the_index from HEAD;
432 * (6) update the_index the same way as (2);
433 * (7) write the_index out to the false index file;
434 * (8) return the name of the false index file (still locked);
436 * The caller should run hooks on the locked false index, and
437 * create commit from it. Then
438 * (A) if all goes well, commit the real index;
439 * (B) on failure, rollback the real index;
440 * In either case, rollback the false index.
442 commit_style = COMMIT_PARTIAL;
444 if (whence != FROM_COMMIT) {
445 if (whence == FROM_MERGE)
446 die(_("cannot do a partial commit during a merge."));
447 else if (whence == FROM_CHERRY_PICK)
448 die(_("cannot do a partial commit during a cherry-pick."));
451 string_list_init(&partial, 1);
452 if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, &pathspec))
453 exit(1);
455 discard_cache();
456 if (read_cache() < 0)
457 die(_("cannot read the index"));
459 hold_locked_index(&index_lock, 1);
460 add_remove_files(&partial);
461 refresh_cache(REFRESH_QUIET);
462 update_main_cache_tree(WRITE_TREE_SILENT);
463 if (write_locked_index(&the_index, &index_lock, CLOSE_LOCK))
464 die(_("unable to write new_index file"));
466 hold_lock_file_for_update(&false_lock,
467 git_path("next-index-%"PRIuMAX,
468 (uintmax_t) getpid()),
469 LOCK_DIE_ON_ERROR);
471 create_base_index(current_head);
472 add_remove_files(&partial);
473 refresh_cache(REFRESH_QUIET);
475 if (write_locked_index(&the_index, &false_lock, CLOSE_LOCK))
476 die(_("unable to write temporary index file"));
478 discard_cache();
479 ret = get_lock_file_path(&false_lock);
480 read_cache_from(ret);
481 return ret;
484 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
485 struct wt_status *s)
487 unsigned char sha1[20];
489 if (s->relative_paths)
490 s->prefix = prefix;
492 if (amend) {
493 s->amend = 1;
494 s->reference = "HEAD^1";
496 s->verbose = verbose;
497 s->index_file = index_file;
498 s->fp = fp;
499 s->nowarn = nowarn;
500 s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
502 wt_status_collect(s);
504 switch (status_format) {
505 case STATUS_FORMAT_SHORT:
506 wt_shortstatus_print(s);
507 break;
508 case STATUS_FORMAT_PORCELAIN:
509 wt_porcelain_print(s);
510 break;
511 case STATUS_FORMAT_UNSPECIFIED:
512 die("BUG: finalize_deferred_config() should have been called");
513 break;
514 case STATUS_FORMAT_NONE:
515 case STATUS_FORMAT_LONG:
516 wt_status_print(s);
517 break;
520 return s->commitable;
523 static int is_a_merge(const struct commit *current_head)
525 return !!(current_head->parents && current_head->parents->next);
528 static void assert_split_ident(struct ident_split *id, const struct strbuf *buf)
530 if (split_ident_line(id, buf->buf, buf->len) || !id->date_begin)
531 die("BUG: unable to parse our own ident: %s", buf->buf);
534 static void export_one(const char *var, const char *s, const char *e, int hack)
536 struct strbuf buf = STRBUF_INIT;
537 if (hack)
538 strbuf_addch(&buf, hack);
539 strbuf_addf(&buf, "%.*s", (int)(e - s), s);
540 setenv(var, buf.buf, 1);
541 strbuf_release(&buf);
544 static int parse_force_date(const char *in, struct strbuf *out)
546 strbuf_addch(out, '@');
548 if (parse_date(in, out) < 0) {
549 int errors = 0;
550 unsigned long t = approxidate_careful(in, &errors);
551 if (errors)
552 return -1;
553 strbuf_addf(out, "%lu", t);
556 return 0;
559 static void set_ident_var(char **buf, char *val)
561 free(*buf);
562 *buf = val;
565 static void determine_author_info(struct strbuf *author_ident)
567 char *name, *email, *date;
568 struct ident_split author;
570 name = xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
571 email = xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
572 date = xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
574 if (author_message) {
575 struct ident_split ident;
576 size_t len;
577 const char *a;
579 a = find_commit_header(author_message_buffer, "author", &len);
580 if (!a)
581 die(_("commit '%s' lacks author header"), author_message);
582 if (split_ident_line(&ident, a, len) < 0)
583 die(_("commit '%s' has malformed author line"), author_message);
585 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
586 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
588 if (ident.date_begin) {
589 struct strbuf date_buf = STRBUF_INIT;
590 strbuf_addch(&date_buf, '@');
591 strbuf_add(&date_buf, ident.date_begin, ident.date_end - ident.date_begin);
592 strbuf_addch(&date_buf, ' ');
593 strbuf_add(&date_buf, ident.tz_begin, ident.tz_end - ident.tz_begin);
594 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
598 if (force_author) {
599 struct ident_split ident;
601 if (split_ident_line(&ident, force_author, strlen(force_author)) < 0)
602 die(_("malformed --author parameter"));
603 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
604 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
607 if (force_date) {
608 struct strbuf date_buf = STRBUF_INIT;
609 if (parse_force_date(force_date, &date_buf))
610 die(_("invalid date format: %s"), force_date);
611 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
614 strbuf_addstr(author_ident, fmt_ident(name, email, date, IDENT_STRICT));
615 assert_split_ident(&author, author_ident);
616 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
617 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
618 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
619 free(name);
620 free(email);
621 free(date);
624 static int author_date_is_interesting(void)
626 return author_message || force_date;
629 static void adjust_comment_line_char(const struct strbuf *sb)
631 char candidates[] = "#;@!$%^&|:";
632 char *candidate;
633 const char *p;
635 comment_line_char = candidates[0];
636 if (!memchr(sb->buf, comment_line_char, sb->len))
637 return;
639 p = sb->buf;
640 candidate = strchr(candidates, *p);
641 if (candidate)
642 *candidate = ' ';
643 for (p = sb->buf; *p; p++) {
644 if ((p[0] == '\n' || p[0] == '\r') && p[1]) {
645 candidate = strchr(candidates, p[1]);
646 if (candidate)
647 *candidate = ' ';
651 for (p = candidates; *p == ' '; p++)
653 if (!*p)
654 die(_("unable to select a comment character that is not used\n"
655 "in the current commit message"));
656 comment_line_char = *p;
659 static int prepare_to_commit(const char *index_file, const char *prefix,
660 struct commit *current_head,
661 struct wt_status *s,
662 struct strbuf *author_ident)
664 struct stat statbuf;
665 struct strbuf committer_ident = STRBUF_INIT;
666 int commitable;
667 struct strbuf sb = STRBUF_INIT;
668 const char *hook_arg1 = NULL;
669 const char *hook_arg2 = NULL;
670 int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
671 int old_display_comment_prefix;
673 /* This checks and barfs if author is badly specified */
674 determine_author_info(author_ident);
676 if (!no_verify && run_commit_hook(use_editor, index_file, "pre-commit", NULL))
677 return 0;
679 if (squash_message) {
681 * Insert the proper subject line before other commit
682 * message options add their content.
684 if (use_message && !strcmp(use_message, squash_message))
685 strbuf_addstr(&sb, "squash! ");
686 else {
687 struct pretty_print_context ctx = {0};
688 struct commit *c;
689 c = lookup_commit_reference_by_name(squash_message);
690 if (!c)
691 die(_("could not lookup commit %s"), squash_message);
692 ctx.output_encoding = get_commit_output_encoding();
693 format_commit_message(c, "squash! %s\n\n", &sb,
694 &ctx);
698 if (have_option_m) {
699 strbuf_addbuf(&sb, &message);
700 hook_arg1 = "message";
701 } else if (logfile && !strcmp(logfile, "-")) {
702 if (isatty(0))
703 fprintf(stderr, _("(reading log message from standard input)\n"));
704 if (strbuf_read(&sb, 0, 0) < 0)
705 die_errno(_("could not read log from standard input"));
706 hook_arg1 = "message";
707 } else if (logfile) {
708 if (strbuf_read_file(&sb, logfile, 0) < 0)
709 die_errno(_("could not read log file '%s'"),
710 logfile);
711 hook_arg1 = "message";
712 } else if (use_message) {
713 char *buffer;
714 buffer = strstr(use_message_buffer, "\n\n");
715 if (buffer)
716 strbuf_addstr(&sb, buffer + 2);
717 hook_arg1 = "commit";
718 hook_arg2 = use_message;
719 } else if (fixup_message) {
720 struct pretty_print_context ctx = {0};
721 struct commit *commit;
722 commit = lookup_commit_reference_by_name(fixup_message);
723 if (!commit)
724 die(_("could not lookup commit %s"), fixup_message);
725 ctx.output_encoding = get_commit_output_encoding();
726 format_commit_message(commit, "fixup! %s\n\n",
727 &sb, &ctx);
728 hook_arg1 = "message";
729 } else if (!stat(git_path_merge_msg(), &statbuf)) {
731 * prepend SQUASH_MSG here if it exists and a
732 * "merge --squash" was originally performed
734 if (!stat(git_path_squash_msg(), &statbuf)) {
735 if (strbuf_read_file(&sb, git_path_squash_msg(), 0) < 0)
736 die_errno(_("could not read SQUASH_MSG"));
737 hook_arg1 = "squash";
738 } else
739 hook_arg1 = "merge";
740 if (strbuf_read_file(&sb, git_path_merge_msg(), 0) < 0)
741 die_errno(_("could not read MERGE_MSG"));
742 } else if (!stat(git_path_squash_msg(), &statbuf)) {
743 if (strbuf_read_file(&sb, git_path_squash_msg(), 0) < 0)
744 die_errno(_("could not read SQUASH_MSG"));
745 hook_arg1 = "squash";
746 } else if (template_file) {
747 if (strbuf_read_file(&sb, template_file, 0) < 0)
748 die_errno(_("could not read '%s'"), template_file);
749 hook_arg1 = "template";
750 clean_message_contents = 0;
754 * The remaining cases don't modify the template message, but
755 * just set the argument(s) to the prepare-commit-msg hook.
757 else if (whence == FROM_MERGE)
758 hook_arg1 = "merge";
759 else if (whence == FROM_CHERRY_PICK) {
760 hook_arg1 = "commit";
761 hook_arg2 = "CHERRY_PICK_HEAD";
764 if (squash_message) {
766 * If squash_commit was used for the commit subject,
767 * then we're possibly hijacking other commit log options.
768 * Reset the hook args to tell the real story.
770 hook_arg1 = "message";
771 hook_arg2 = "";
774 s->fp = fopen_for_writing(git_path(commit_editmsg));
775 if (s->fp == NULL)
776 die_errno(_("could not open '%s'"), git_path(commit_editmsg));
778 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
779 old_display_comment_prefix = s->display_comment_prefix;
780 s->display_comment_prefix = 1;
783 * Most hints are counter-productive when the commit has
784 * already started.
786 s->hints = 0;
788 if (clean_message_contents)
789 strbuf_stripspace(&sb, 0);
791 if (signoff)
792 append_signoff(&sb, ignore_non_trailer(&sb), 0);
794 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
795 die_errno(_("could not write commit template"));
797 if (auto_comment_line_char)
798 adjust_comment_line_char(&sb);
799 strbuf_release(&sb);
801 /* This checks if committer ident is explicitly given */
802 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
803 if (use_editor && include_status) {
804 int ident_shown = 0;
805 int saved_color_setting;
806 struct ident_split ci, ai;
808 if (whence != FROM_COMMIT) {
809 if (cleanup_mode == CLEANUP_SCISSORS)
810 wt_status_add_cut_line(s->fp);
811 status_printf_ln(s, GIT_COLOR_NORMAL,
812 whence == FROM_MERGE
813 ? _("\n"
814 "It looks like you may be committing a merge.\n"
815 "If this is not correct, please remove the file\n"
816 " %s\n"
817 "and try again.\n")
818 : _("\n"
819 "It looks like you may be committing a cherry-pick.\n"
820 "If this is not correct, please remove the file\n"
821 " %s\n"
822 "and try again.\n"),
823 git_path(whence == FROM_MERGE
824 ? "MERGE_HEAD"
825 : "CHERRY_PICK_HEAD"));
828 fprintf(s->fp, "\n");
829 if (cleanup_mode == CLEANUP_ALL)
830 status_printf(s, GIT_COLOR_NORMAL,
831 _("Please enter the commit message for your changes."
832 " Lines starting\nwith '%c' will be ignored, and an empty"
833 " message aborts the commit.\n"), comment_line_char);
834 else if (cleanup_mode == CLEANUP_SCISSORS && whence == FROM_COMMIT)
835 wt_status_add_cut_line(s->fp);
836 else /* CLEANUP_SPACE, that is. */
837 status_printf(s, GIT_COLOR_NORMAL,
838 _("Please enter the commit message for your changes."
839 " Lines starting\n"
840 "with '%c' will be kept; you may remove them"
841 " yourself if you want to.\n"
842 "An empty message aborts the commit.\n"), comment_line_char);
843 if (only_include_assumed)
844 status_printf_ln(s, GIT_COLOR_NORMAL,
845 "%s", only_include_assumed);
848 * These should never fail because they come from our own
849 * fmt_ident. They may fail the sane_ident test, but we know
850 * that the name and mail pointers will at least be valid,
851 * which is enough for our tests and printing here.
853 assert_split_ident(&ai, author_ident);
854 assert_split_ident(&ci, &committer_ident);
856 if (ident_cmp(&ai, &ci))
857 status_printf_ln(s, GIT_COLOR_NORMAL,
858 _("%s"
859 "Author: %.*s <%.*s>"),
860 ident_shown++ ? "" : "\n",
861 (int)(ai.name_end - ai.name_begin), ai.name_begin,
862 (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);
864 if (author_date_is_interesting())
865 status_printf_ln(s, GIT_COLOR_NORMAL,
866 _("%s"
867 "Date: %s"),
868 ident_shown++ ? "" : "\n",
869 show_ident_date(&ai, DATE_MODE(NORMAL)));
871 if (!committer_ident_sufficiently_given())
872 status_printf_ln(s, GIT_COLOR_NORMAL,
873 _("%s"
874 "Committer: %.*s <%.*s>"),
875 ident_shown++ ? "" : "\n",
876 (int)(ci.name_end - ci.name_begin), ci.name_begin,
877 (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
879 if (ident_shown)
880 status_printf_ln(s, GIT_COLOR_NORMAL, "%s", "");
882 saved_color_setting = s->use_color;
883 s->use_color = 0;
884 commitable = run_status(s->fp, index_file, prefix, 1, s);
885 s->use_color = saved_color_setting;
886 } else {
887 unsigned char sha1[20];
888 const char *parent = "HEAD";
890 if (!active_nr && read_cache() < 0)
891 die(_("Cannot read index"));
893 if (amend)
894 parent = "HEAD^1";
896 if (get_sha1(parent, sha1))
897 commitable = !!active_nr;
898 else {
900 * Unless the user did explicitly request a submodule
901 * ignore mode by passing a command line option we do
902 * not ignore any changed submodule SHA-1s when
903 * comparing index and parent, no matter what is
904 * configured. Otherwise we won't commit any
905 * submodules which were manually staged, which would
906 * be really confusing.
908 int diff_flags = DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG;
909 if (ignore_submodule_arg &&
910 !strcmp(ignore_submodule_arg, "all"))
911 diff_flags |= DIFF_OPT_IGNORE_SUBMODULES;
912 commitable = index_differs_from(parent, diff_flags);
915 strbuf_release(&committer_ident);
917 fclose(s->fp);
920 * Reject an attempt to record a non-merge empty commit without
921 * explicit --allow-empty. In the cherry-pick case, it may be
922 * empty due to conflict resolution, which the user should okay.
924 if (!commitable && whence != FROM_MERGE && !allow_empty &&
925 !(amend && is_a_merge(current_head))) {
926 s->display_comment_prefix = old_display_comment_prefix;
927 run_status(stdout, index_file, prefix, 0, s);
928 if (amend)
929 fputs(_(empty_amend_advice), stderr);
930 else if (whence == FROM_CHERRY_PICK) {
931 fputs(_(empty_cherry_pick_advice), stderr);
932 if (!sequencer_in_use)
933 fputs(_(empty_cherry_pick_advice_single), stderr);
934 else
935 fputs(_(empty_cherry_pick_advice_multi), stderr);
937 return 0;
941 * Re-read the index as pre-commit hook could have updated it,
942 * and write it out as a tree. We must do this before we invoke
943 * the editor and after we invoke run_status above.
945 discard_cache();
946 read_cache_from(index_file);
947 if (update_main_cache_tree(0)) {
948 error(_("Error building trees"));
949 return 0;
952 if (run_commit_hook(use_editor, index_file, "prepare-commit-msg",
953 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
954 return 0;
956 if (use_editor) {
957 char index[PATH_MAX];
958 const char *env[2] = { NULL };
959 env[0] = index;
960 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
961 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
962 fprintf(stderr,
963 _("Please supply the message using either -m or -F option.\n"));
964 exit(1);
968 if (!no_verify &&
969 run_commit_hook(use_editor, index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
970 return 0;
973 return 1;
976 static int rest_is_empty(struct strbuf *sb, int start)
978 int i, eol;
979 const char *nl;
981 /* Check if the rest is just whitespace and Signed-of-by's. */
982 for (i = start; i < sb->len; i++) {
983 nl = memchr(sb->buf + i, '\n', sb->len - i);
984 if (nl)
985 eol = nl - sb->buf;
986 else
987 eol = sb->len;
989 if (strlen(sign_off_header) <= eol - i &&
990 starts_with(sb->buf + i, sign_off_header)) {
991 i = eol;
992 continue;
994 while (i < eol)
995 if (!isspace(sb->buf[i++]))
996 return 0;
999 return 1;
1003 * Find out if the message in the strbuf contains only whitespace and
1004 * Signed-off-by lines.
1006 static int message_is_empty(struct strbuf *sb)
1008 if (cleanup_mode == CLEANUP_NONE && sb->len)
1009 return 0;
1010 return rest_is_empty(sb, 0);
1014 * See if the user edited the message in the editor or left what
1015 * was in the template intact
1017 static int template_untouched(struct strbuf *sb)
1019 struct strbuf tmpl = STRBUF_INIT;
1020 const char *start;
1022 if (cleanup_mode == CLEANUP_NONE && sb->len)
1023 return 0;
1025 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
1026 return 0;
1028 strbuf_stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
1029 if (!skip_prefix(sb->buf, tmpl.buf, &start))
1030 start = sb->buf;
1031 strbuf_release(&tmpl);
1032 return rest_is_empty(sb, start - sb->buf);
1035 static const char *find_author_by_nickname(const char *name)
1037 struct rev_info revs;
1038 struct commit *commit;
1039 struct strbuf buf = STRBUF_INIT;
1040 struct string_list mailmap = STRING_LIST_INIT_NODUP;
1041 const char *av[20];
1042 int ac = 0;
1044 init_revisions(&revs, NULL);
1045 strbuf_addf(&buf, "--author=%s", name);
1046 av[++ac] = "--all";
1047 av[++ac] = "-i";
1048 av[++ac] = buf.buf;
1049 av[++ac] = NULL;
1050 setup_revisions(ac, av, &revs, NULL);
1051 revs.mailmap = &mailmap;
1052 read_mailmap(revs.mailmap, NULL);
1054 if (prepare_revision_walk(&revs))
1055 die(_("revision walk setup failed"));
1056 commit = get_revision(&revs);
1057 if (commit) {
1058 struct pretty_print_context ctx = {0};
1059 ctx.date_mode.type = DATE_NORMAL;
1060 strbuf_release(&buf);
1061 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
1062 clear_mailmap(&mailmap);
1063 return strbuf_detach(&buf, NULL);
1065 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name);
1069 static void handle_untracked_files_arg(struct wt_status *s)
1071 if (!untracked_files_arg)
1072 ; /* default already initialized */
1073 else if (!strcmp(untracked_files_arg, "no"))
1074 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1075 else if (!strcmp(untracked_files_arg, "normal"))
1076 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1077 else if (!strcmp(untracked_files_arg, "all"))
1078 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1079 else
1080 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1083 static const char *read_commit_message(const char *name)
1085 const char *out_enc;
1086 struct commit *commit;
1088 commit = lookup_commit_reference_by_name(name);
1089 if (!commit)
1090 die(_("could not lookup commit %s"), name);
1091 out_enc = get_commit_output_encoding();
1092 return logmsg_reencode(commit, NULL, out_enc);
1096 * Enumerate what needs to be propagated when --porcelain
1097 * is not in effect here.
1099 static struct status_deferred_config {
1100 enum status_format status_format;
1101 int show_branch;
1102 } status_deferred_config = {
1103 STATUS_FORMAT_UNSPECIFIED,
1104 -1 /* unspecified */
1107 static void finalize_deferred_config(struct wt_status *s)
1109 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1110 !s->null_termination);
1112 if (s->null_termination) {
1113 if (status_format == STATUS_FORMAT_NONE ||
1114 status_format == STATUS_FORMAT_UNSPECIFIED)
1115 status_format = STATUS_FORMAT_PORCELAIN;
1116 else if (status_format == STATUS_FORMAT_LONG)
1117 die(_("--long and -z are incompatible"));
1120 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1121 status_format = status_deferred_config.status_format;
1122 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1123 status_format = STATUS_FORMAT_NONE;
1125 if (use_deferred_config && s->show_branch < 0)
1126 s->show_branch = status_deferred_config.show_branch;
1127 if (s->show_branch < 0)
1128 s->show_branch = 0;
1131 static int parse_and_validate_options(int argc, const char *argv[],
1132 const struct option *options,
1133 const char * const usage[],
1134 const char *prefix,
1135 struct commit *current_head,
1136 struct wt_status *s)
1138 int f = 0;
1140 argc = parse_options(argc, argv, prefix, options, usage, 0);
1141 finalize_deferred_config(s);
1143 if (force_author && !strchr(force_author, '>'))
1144 force_author = find_author_by_nickname(force_author);
1146 if (force_author && renew_authorship)
1147 die(_("Using both --reset-author and --author does not make sense"));
1149 if (logfile || have_option_m || use_message || fixup_message)
1150 use_editor = 0;
1151 if (0 <= edit_flag)
1152 use_editor = edit_flag;
1154 /* Sanity check options */
1155 if (amend && !current_head)
1156 die(_("You have nothing to amend."));
1157 if (amend && whence != FROM_COMMIT) {
1158 if (whence == FROM_MERGE)
1159 die(_("You are in the middle of a merge -- cannot amend."));
1160 else if (whence == FROM_CHERRY_PICK)
1161 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1163 if (fixup_message && squash_message)
1164 die(_("Options --squash and --fixup cannot be used together"));
1165 if (use_message)
1166 f++;
1167 if (edit_message)
1168 f++;
1169 if (fixup_message)
1170 f++;
1171 if (logfile)
1172 f++;
1173 if (f > 1)
1174 die(_("Only one of -c/-C/-F/--fixup can be used."));
1175 if (have_option_m && f > 0)
1176 die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1177 if (f || have_option_m)
1178 template_file = NULL;
1179 if (edit_message)
1180 use_message = edit_message;
1181 if (amend && !use_message && !fixup_message)
1182 use_message = "HEAD";
1183 if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1184 die(_("--reset-author can be used only with -C, -c or --amend."));
1185 if (use_message) {
1186 use_message_buffer = read_commit_message(use_message);
1187 if (!renew_authorship) {
1188 author_message = use_message;
1189 author_message_buffer = use_message_buffer;
1192 if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1193 author_message = "CHERRY_PICK_HEAD";
1194 author_message_buffer = read_commit_message(author_message);
1197 if (patch_interactive)
1198 interactive = 1;
1200 if (also + only + all + interactive > 1)
1201 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1202 if (argc == 0 && (also || (only && !amend)))
1203 die(_("No paths with --include/--only does not make sense."));
1204 if (argc == 0 && only && amend)
1205 only_include_assumed = _("Clever... amending the last one with dirty index.");
1206 if (argc > 0 && !also && !only)
1207 only_include_assumed = _("Explicit paths specified without -i or -o; assuming --only paths...");
1208 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1209 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
1210 else if (!strcmp(cleanup_arg, "verbatim"))
1211 cleanup_mode = CLEANUP_NONE;
1212 else if (!strcmp(cleanup_arg, "whitespace"))
1213 cleanup_mode = CLEANUP_SPACE;
1214 else if (!strcmp(cleanup_arg, "strip"))
1215 cleanup_mode = CLEANUP_ALL;
1216 else if (!strcmp(cleanup_arg, "scissors"))
1217 cleanup_mode = use_editor ? CLEANUP_SCISSORS : CLEANUP_SPACE;
1218 else
1219 die(_("Invalid cleanup mode %s"), cleanup_arg);
1221 handle_untracked_files_arg(s);
1223 if (all && argc > 0)
1224 die(_("Paths with -a does not make sense."));
1226 if (status_format != STATUS_FORMAT_NONE)
1227 dry_run = 1;
1229 return argc;
1232 static int dry_run_commit(int argc, const char **argv, const char *prefix,
1233 const struct commit *current_head, struct wt_status *s)
1235 int commitable;
1236 const char *index_file;
1238 index_file = prepare_index(argc, argv, prefix, current_head, 1);
1239 commitable = run_status(stdout, index_file, prefix, 0, s);
1240 rollback_index_files();
1242 return commitable ? 0 : 1;
1245 static int parse_status_slot(const char *slot)
1247 if (!strcasecmp(slot, "header"))
1248 return WT_STATUS_HEADER;
1249 if (!strcasecmp(slot, "branch"))
1250 return WT_STATUS_ONBRANCH;
1251 if (!strcasecmp(slot, "updated") || !strcasecmp(slot, "added"))
1252 return WT_STATUS_UPDATED;
1253 if (!strcasecmp(slot, "changed"))
1254 return WT_STATUS_CHANGED;
1255 if (!strcasecmp(slot, "untracked"))
1256 return WT_STATUS_UNTRACKED;
1257 if (!strcasecmp(slot, "nobranch"))
1258 return WT_STATUS_NOBRANCH;
1259 if (!strcasecmp(slot, "unmerged"))
1260 return WT_STATUS_UNMERGED;
1261 return -1;
1264 static int git_status_config(const char *k, const char *v, void *cb)
1266 struct wt_status *s = cb;
1267 const char *slot_name;
1269 if (starts_with(k, "column."))
1270 return git_column_config(k, v, "status", &s->colopts);
1271 if (!strcmp(k, "status.submodulesummary")) {
1272 int is_bool;
1273 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1274 if (is_bool && s->submodule_summary)
1275 s->submodule_summary = -1;
1276 return 0;
1278 if (!strcmp(k, "status.short")) {
1279 if (git_config_bool(k, v))
1280 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1281 else
1282 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1283 return 0;
1285 if (!strcmp(k, "status.branch")) {
1286 status_deferred_config.show_branch = git_config_bool(k, v);
1287 return 0;
1289 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1290 s->use_color = git_config_colorbool(k, v);
1291 return 0;
1293 if (!strcmp(k, "status.displaycommentprefix")) {
1294 s->display_comment_prefix = git_config_bool(k, v);
1295 return 0;
1297 if (skip_prefix(k, "status.color.", &slot_name) ||
1298 skip_prefix(k, "color.status.", &slot_name)) {
1299 int slot = parse_status_slot(slot_name);
1300 if (slot < 0)
1301 return 0;
1302 if (!v)
1303 return config_error_nonbool(k);
1304 return color_parse(v, s->color_palette[slot]);
1306 if (!strcmp(k, "status.relativepaths")) {
1307 s->relative_paths = git_config_bool(k, v);
1308 return 0;
1310 if (!strcmp(k, "status.showuntrackedfiles")) {
1311 if (!v)
1312 return config_error_nonbool(k);
1313 else if (!strcmp(v, "no"))
1314 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1315 else if (!strcmp(v, "normal"))
1316 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1317 else if (!strcmp(v, "all"))
1318 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1319 else
1320 return error(_("Invalid untracked files mode '%s'"), v);
1321 return 0;
1323 return git_diff_ui_config(k, v, NULL);
1326 int cmd_status(int argc, const char **argv, const char *prefix)
1328 static struct wt_status s;
1329 int fd;
1330 unsigned char sha1[20];
1331 static struct option builtin_status_options[] = {
1332 OPT__VERBOSE(&verbose, N_("be verbose")),
1333 OPT_SET_INT('s', "short", &status_format,
1334 N_("show status concisely"), STATUS_FORMAT_SHORT),
1335 OPT_BOOL('b', "branch", &s.show_branch,
1336 N_("show branch information")),
1337 OPT_SET_INT(0, "porcelain", &status_format,
1338 N_("machine-readable output"),
1339 STATUS_FORMAT_PORCELAIN),
1340 OPT_SET_INT(0, "long", &status_format,
1341 N_("show status in long format (default)"),
1342 STATUS_FORMAT_LONG),
1343 OPT_BOOL('z', "null", &s.null_termination,
1344 N_("terminate entries with NUL")),
1345 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1346 N_("mode"),
1347 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1348 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1349 OPT_BOOL(0, "ignored", &show_ignored_in_status,
1350 N_("show ignored files")),
1351 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1352 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1353 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1354 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1355 OPT_END(),
1358 if (argc == 2 && !strcmp(argv[1], "-h"))
1359 usage_with_options(builtin_status_usage, builtin_status_options);
1361 status_init_config(&s, git_status_config);
1362 argc = parse_options(argc, argv, prefix,
1363 builtin_status_options,
1364 builtin_status_usage, 0);
1365 finalize_colopts(&s.colopts, -1);
1366 finalize_deferred_config(&s);
1368 handle_untracked_files_arg(&s);
1369 if (show_ignored_in_status)
1370 s.show_ignored_files = 1;
1371 parse_pathspec(&s.pathspec, 0,
1372 PATHSPEC_PREFER_FULL,
1373 prefix, argv);
1375 read_cache_preload(&s.pathspec);
1376 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &s.pathspec, NULL, NULL);
1378 fd = hold_locked_index(&index_lock, 0);
1380 s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1381 s.ignore_submodule_arg = ignore_submodule_arg;
1382 wt_status_collect(&s);
1384 if (0 <= fd)
1385 update_index_if_able(&the_index, &index_lock);
1387 if (s.relative_paths)
1388 s.prefix = prefix;
1390 switch (status_format) {
1391 case STATUS_FORMAT_SHORT:
1392 wt_shortstatus_print(&s);
1393 break;
1394 case STATUS_FORMAT_PORCELAIN:
1395 wt_porcelain_print(&s);
1396 break;
1397 case STATUS_FORMAT_UNSPECIFIED:
1398 die("BUG: finalize_deferred_config() should have been called");
1399 break;
1400 case STATUS_FORMAT_NONE:
1401 case STATUS_FORMAT_LONG:
1402 s.verbose = verbose;
1403 s.ignore_submodule_arg = ignore_submodule_arg;
1404 wt_status_print(&s);
1405 break;
1407 return 0;
1410 static const char *implicit_ident_advice(void)
1412 char *user_config = expand_user_path("~/.gitconfig");
1413 char *xdg_config = xdg_config_home("config");
1414 int config_exists = file_exists(user_config) || file_exists(xdg_config);
1416 free(user_config);
1417 free(xdg_config);
1419 if (config_exists)
1420 return _(implicit_ident_advice_config);
1421 else
1422 return _(implicit_ident_advice_noconfig);
1426 static void print_summary(const char *prefix, const unsigned char *sha1,
1427 int initial_commit)
1429 struct rev_info rev;
1430 struct commit *commit;
1431 struct strbuf format = STRBUF_INIT;
1432 unsigned char junk_sha1[20];
1433 const char *head;
1434 struct pretty_print_context pctx = {0};
1435 struct strbuf author_ident = STRBUF_INIT;
1436 struct strbuf committer_ident = STRBUF_INIT;
1438 commit = lookup_commit(sha1);
1439 if (!commit)
1440 die(_("couldn't look up newly created commit"));
1441 if (parse_commit(commit))
1442 die(_("could not parse newly created commit"));
1444 strbuf_addstr(&format, "format:%h] %s");
1446 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1447 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1448 if (strbuf_cmp(&author_ident, &committer_ident)) {
1449 strbuf_addstr(&format, "\n Author: ");
1450 strbuf_addbuf_percentquote(&format, &author_ident);
1452 if (author_date_is_interesting()) {
1453 struct strbuf date = STRBUF_INIT;
1454 format_commit_message(commit, "%ad", &date, &pctx);
1455 strbuf_addstr(&format, "\n Date: ");
1456 strbuf_addbuf_percentquote(&format, &date);
1457 strbuf_release(&date);
1459 if (!committer_ident_sufficiently_given()) {
1460 strbuf_addstr(&format, "\n Committer: ");
1461 strbuf_addbuf_percentquote(&format, &committer_ident);
1462 if (advice_implicit_identity) {
1463 strbuf_addch(&format, '\n');
1464 strbuf_addstr(&format, implicit_ident_advice());
1467 strbuf_release(&author_ident);
1468 strbuf_release(&committer_ident);
1470 init_revisions(&rev, prefix);
1471 setup_revisions(0, NULL, &rev, NULL);
1473 rev.diff = 1;
1474 rev.diffopt.output_format =
1475 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1477 rev.verbose_header = 1;
1478 rev.show_root_diff = 1;
1479 get_commit_format(format.buf, &rev);
1480 rev.always_show_header = 0;
1481 rev.diffopt.detect_rename = 1;
1482 rev.diffopt.break_opt = 0;
1483 diff_setup_done(&rev.diffopt);
1485 head = resolve_ref_unsafe("HEAD", 0, junk_sha1, NULL);
1486 if (!strcmp(head, "HEAD"))
1487 head = _("detached HEAD");
1488 else
1489 skip_prefix(head, "refs/heads/", &head);
1490 printf("[%s%s ", head, initial_commit ? _(" (root-commit)") : "");
1492 if (!log_tree_commit(&rev, commit)) {
1493 rev.always_show_header = 1;
1494 rev.use_terminator = 1;
1495 log_tree_commit(&rev, commit);
1498 strbuf_release(&format);
1501 static int git_commit_config(const char *k, const char *v, void *cb)
1503 struct wt_status *s = cb;
1504 int status;
1506 if (!strcmp(k, "commit.template"))
1507 return git_config_pathname(&template_file, k, v);
1508 if (!strcmp(k, "commit.status")) {
1509 include_status = git_config_bool(k, v);
1510 return 0;
1512 if (!strcmp(k, "commit.cleanup"))
1513 return git_config_string(&cleanup_arg, k, v);
1514 if (!strcmp(k, "commit.gpgsign")) {
1515 sign_commit = git_config_bool(k, v) ? "" : NULL;
1516 return 0;
1519 status = git_gpg_config(k, v, NULL);
1520 if (status)
1521 return status;
1522 return git_status_config(k, v, s);
1525 static int run_rewrite_hook(const unsigned char *oldsha1,
1526 const unsigned char *newsha1)
1528 /* oldsha1 SP newsha1 LF NUL */
1529 static char buf[2*40 + 3];
1530 struct child_process proc = CHILD_PROCESS_INIT;
1531 const char *argv[3];
1532 int code;
1533 size_t n;
1535 argv[0] = find_hook("post-rewrite");
1536 if (!argv[0])
1537 return 0;
1539 argv[1] = "amend";
1540 argv[2] = NULL;
1542 proc.argv = argv;
1543 proc.in = -1;
1544 proc.stdout_to_stderr = 1;
1546 code = start_command(&proc);
1547 if (code)
1548 return code;
1549 n = snprintf(buf, sizeof(buf), "%s %s\n",
1550 sha1_to_hex(oldsha1), sha1_to_hex(newsha1));
1551 sigchain_push(SIGPIPE, SIG_IGN);
1552 write_in_full(proc.in, buf, n);
1553 close(proc.in);
1554 sigchain_pop(SIGPIPE);
1555 return finish_command(&proc);
1558 int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...)
1560 const char *hook_env[3] = { NULL };
1561 char index[PATH_MAX];
1562 va_list args;
1563 int ret;
1565 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
1566 hook_env[0] = index;
1569 * Let the hook know that no editor will be launched.
1571 if (!editor_is_used)
1572 hook_env[1] = "GIT_EDITOR=:";
1574 va_start(args, name);
1575 ret = run_hook_ve(hook_env, name, args);
1576 va_end(args);
1578 return ret;
1581 int cmd_commit(int argc, const char **argv, const char *prefix)
1583 static struct wt_status s;
1584 static struct option builtin_commit_options[] = {
1585 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1586 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1588 OPT_GROUP(N_("Commit message options")),
1589 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1590 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1591 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1592 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1593 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1594 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1595 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1596 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1597 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1598 OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1599 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1600 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1601 OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
1602 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1603 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
1604 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1605 /* end commit message options */
1607 OPT_GROUP(N_("Commit contents options")),
1608 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1609 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1610 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1611 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1612 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1613 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit hook")),
1614 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1615 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1616 STATUS_FORMAT_SHORT),
1617 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1618 OPT_SET_INT(0, "porcelain", &status_format,
1619 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1620 OPT_SET_INT(0, "long", &status_format,
1621 N_("show status in long format (default)"),
1622 STATUS_FORMAT_LONG),
1623 OPT_BOOL('z', "null", &s.null_termination,
1624 N_("terminate entries with NUL")),
1625 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1626 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1627 { 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" },
1628 /* end commit contents options */
1630 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1631 N_("ok to record an empty change")),
1632 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1633 N_("ok to record a change with an empty message")),
1635 OPT_END()
1638 struct strbuf sb = STRBUF_INIT;
1639 struct strbuf author_ident = STRBUF_INIT;
1640 const char *index_file, *reflog_msg;
1641 char *nl;
1642 unsigned char sha1[20];
1643 struct commit_list *parents = NULL, **pptr = &parents;
1644 struct stat statbuf;
1645 struct commit *current_head = NULL;
1646 struct commit_extra_header *extra = NULL;
1647 struct ref_transaction *transaction;
1648 struct strbuf err = STRBUF_INIT;
1650 if (argc == 2 && !strcmp(argv[1], "-h"))
1651 usage_with_options(builtin_commit_usage, builtin_commit_options);
1653 status_init_config(&s, git_commit_config);
1654 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1655 s.colopts = 0;
1657 if (get_sha1("HEAD", sha1))
1658 current_head = NULL;
1659 else {
1660 current_head = lookup_commit_or_die(sha1, "HEAD");
1661 if (parse_commit(current_head))
1662 die(_("could not parse HEAD commit"));
1664 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1665 builtin_commit_usage,
1666 prefix, current_head, &s);
1667 if (dry_run)
1668 return dry_run_commit(argc, argv, prefix, current_head, &s);
1669 index_file = prepare_index(argc, argv, prefix, current_head, 0);
1671 /* Set up everything for writing the commit object. This includes
1672 running hooks, writing the trees, and interacting with the user. */
1673 if (!prepare_to_commit(index_file, prefix,
1674 current_head, &s, &author_ident)) {
1675 rollback_index_files();
1676 return 1;
1679 /* Determine parents */
1680 reflog_msg = getenv("GIT_REFLOG_ACTION");
1681 if (!current_head) {
1682 if (!reflog_msg)
1683 reflog_msg = "commit (initial)";
1684 } else if (amend) {
1685 struct commit_list *c;
1687 if (!reflog_msg)
1688 reflog_msg = "commit (amend)";
1689 for (c = current_head->parents; c; c = c->next)
1690 pptr = &commit_list_insert(c->item, pptr)->next;
1691 } else if (whence == FROM_MERGE) {
1692 struct strbuf m = STRBUF_INIT;
1693 FILE *fp;
1694 int allow_fast_forward = 1;
1696 if (!reflog_msg)
1697 reflog_msg = "commit (merge)";
1698 pptr = &commit_list_insert(current_head, pptr)->next;
1699 fp = fopen(git_path_merge_head(), "r");
1700 if (fp == NULL)
1701 die_errno(_("could not open '%s' for reading"),
1702 git_path_merge_head());
1703 while (strbuf_getline_lf(&m, fp) != EOF) {
1704 struct commit *parent;
1706 parent = get_merge_parent(m.buf);
1707 if (!parent)
1708 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1709 pptr = &commit_list_insert(parent, pptr)->next;
1711 fclose(fp);
1712 strbuf_release(&m);
1713 if (!stat(git_path_merge_mode(), &statbuf)) {
1714 if (strbuf_read_file(&sb, git_path_merge_mode(), 0) < 0)
1715 die_errno(_("could not read MERGE_MODE"));
1716 if (!strcmp(sb.buf, "no-ff"))
1717 allow_fast_forward = 0;
1719 if (allow_fast_forward)
1720 parents = reduce_heads(parents);
1721 } else {
1722 if (!reflog_msg)
1723 reflog_msg = (whence == FROM_CHERRY_PICK)
1724 ? "commit (cherry-pick)"
1725 : "commit";
1726 pptr = &commit_list_insert(current_head, pptr)->next;
1729 /* Finally, get the commit message */
1730 strbuf_reset(&sb);
1731 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1732 int saved_errno = errno;
1733 rollback_index_files();
1734 die(_("could not read commit message: %s"), strerror(saved_errno));
1737 if (verbose || /* Truncate the message just before the diff, if any. */
1738 cleanup_mode == CLEANUP_SCISSORS)
1739 wt_status_truncate_message_at_cut_line(&sb);
1741 if (cleanup_mode != CLEANUP_NONE)
1742 strbuf_stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1743 if (template_untouched(&sb) && !allow_empty_message) {
1744 rollback_index_files();
1745 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1746 exit(1);
1748 if (message_is_empty(&sb) && !allow_empty_message) {
1749 rollback_index_files();
1750 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1751 exit(1);
1754 if (amend) {
1755 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1756 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1757 } else {
1758 struct commit_extra_header **tail = &extra;
1759 append_merge_tag_headers(parents, &tail);
1762 if (commit_tree_extended(sb.buf, sb.len, active_cache_tree->sha1,
1763 parents, sha1, author_ident.buf, sign_commit, extra)) {
1764 rollback_index_files();
1765 die(_("failed to write commit object"));
1767 strbuf_release(&author_ident);
1768 free_commit_extra_headers(extra);
1770 nl = strchr(sb.buf, '\n');
1771 if (nl)
1772 strbuf_setlen(&sb, nl + 1 - sb.buf);
1773 else
1774 strbuf_addch(&sb, '\n');
1775 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1776 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1778 transaction = ref_transaction_begin(&err);
1779 if (!transaction ||
1780 ref_transaction_update(transaction, "HEAD", sha1,
1781 current_head
1782 ? current_head->object.oid.hash : null_sha1,
1783 0, sb.buf, &err) ||
1784 ref_transaction_commit(transaction, &err)) {
1785 rollback_index_files();
1786 die("%s", err.buf);
1788 ref_transaction_free(transaction);
1790 unlink(git_path_cherry_pick_head());
1791 unlink(git_path_revert_head());
1792 unlink(git_path_merge_head());
1793 unlink(git_path_merge_msg());
1794 unlink(git_path_merge_mode());
1795 unlink(git_path_squash_msg());
1797 if (commit_index_files())
1798 die (_("Repository has been updated, but unable to write\n"
1799 "new_index file. Check that disk is not full and quota is\n"
1800 "not exceeded, and then \"git reset HEAD\" to recover."));
1802 rerere(0);
1803 run_commit_hook(use_editor, get_index_file(), "post-commit", NULL);
1804 if (amend && !no_post_rewrite) {
1805 struct notes_rewrite_cfg *cfg;
1806 cfg = init_copy_notes_for_rewrite("amend");
1807 if (cfg) {
1808 /* we are amending, so current_head is not NULL */
1809 copy_note_for_rewrite(cfg, current_head->object.oid.hash, sha1);
1810 finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1812 run_rewrite_hook(current_head->object.oid.hash, sha1);
1814 if (!quiet)
1815 print_summary(prefix, sha1, !current_head);
1817 strbuf_release(&err);
1818 return 0;