1/*
2 * Builtin "git commit"
3 *
4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
6 */
7#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"
34static const char * const builtin_commit_usage[] = {
36 N_("git commit [options] [--] <pathspec>..."),
37 NULL
38};
39static const char * const builtin_status_usage[] = {
41 N_("git status [options] [--] <pathspec>..."),
42 NULL
43};
44static const char implicit_ident_advice[] =
46N_("Your name and email address were configured automatically based\n"
47"on your username and hostname. Please check that they are accurate.\n"
48"You can suppress this message by setting them explicitly:\n"
49"\n"
50" git config --global user.name \"Your Name\"\n"
51" git config --global user.email you@example.com\n"
52"\n"
53"After doing this, you may fix the identity used for this commit with:\n"
54"\n"
55" git commit --amend --reset-author\n");
56static const char empty_amend_advice[] =
58N_("You asked to amend the most recent commit, but doing so would make\n"
59"it empty. You can repeat your command with --allow-empty, or you can\n"
60"remove the commit entirely with \"git reset HEAD^\".\n");
61static const char empty_cherry_pick_advice[] =
63N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
64"If you wish to commit it anyway, use:\n"
65"\n"
66" git commit --allow-empty\n"
67"\n");
68static const char empty_cherry_pick_advice_single[] =
70N_("Otherwise, please use 'git reset'\n");
71static const char empty_cherry_pick_advice_multi[] =
73N_("If you wish to skip this commit, use:\n"
74"\n"
75" git reset\n"
76"\n"
77"Then \"git cherry-pick --continue\" will resume cherry-picking\n"
78"the remaining commits.\n");
79static const char *use_message_buffer;
81static const char commit_editmsg[] = "COMMIT_EDITMSG";
82static struct lock_file index_lock; /* real index */
83static struct lock_file false_lock; /* used only for partial commits */
84static enum {
85 COMMIT_AS_IS = 1,
86 COMMIT_NORMAL,
87 COMMIT_PARTIAL
88} commit_style;
89static const char *logfile, *force_author;
91static const char *template_file;
92/*
93 * The _message variables are commit names from which to take
94 * the commit message and/or authorship.
95 */
96static const char *author_message, *author_message_buffer;
97static char *edit_message, *use_message;
98static char *fixup_message, *squash_message;
99static int all, also, interactive, patch_interactive, only, amend, signoff;
100static int edit_flag = -1; /* unspecified */
101static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
102static int no_post_rewrite, allow_empty_message;
103static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
104static char *sign_commit;
105/*
107 * The default commit message cleanup mode will remove the lines
108 * beginning with # (shell comments) and leading and trailing
109 * whitespaces (empty lines or containing only whitespaces)
110 * if editor is used, and only the whitespaces if the message
111 * is specified explicitly.
112 */
113static enum {
114 CLEANUP_SPACE,
115 CLEANUP_NONE,
116 CLEANUP_SCISSORS,
117 CLEANUP_ALL
118} cleanup_mode;
119static const char *cleanup_arg;
120static enum commit_whence whence;
122static int sequencer_in_use;
123static int use_editor = 1, include_status = 1;
124static int show_ignored_in_status, have_option_m;
125static const char *only_include_assumed;
126static struct strbuf message = STRBUF_INIT;
127static enum status_format {
129 STATUS_FORMAT_NONE = 0,
130 STATUS_FORMAT_LONG,
131 STATUS_FORMAT_SHORT,
132 STATUS_FORMAT_PORCELAIN,
133 STATUS_FORMAT_UNSPECIFIED
135} status_format = STATUS_FORMAT_UNSPECIFIED;
136static int opt_parse_m(const struct option *opt, const char *arg, int unset)
138{
139 struct strbuf *buf = opt->value;
140 if (unset) {
141 have_option_m = 0;
142 strbuf_setlen(buf, 0);
143 } else {
144 have_option_m = 1;
145 if (buf->len)
146 strbuf_addch(buf, '\n');
147 strbuf_addstr(buf, arg);
148 strbuf_complete_line(buf);
149 }
150 return 0;
151}
152static void determine_whence(struct wt_status *s)
154{
155 if (file_exists(git_path("MERGE_HEAD")))
156 whence = FROM_MERGE;
157 else if (file_exists(git_path("CHERRY_PICK_HEAD"))) {
158 whence = FROM_CHERRY_PICK;
159 if (file_exists(git_path("sequencer")))
160 sequencer_in_use = 1;
161 }
162 else
163 whence = FROM_COMMIT;
164 if (s)
165 s->whence = whence;
166}
167static void status_init_config(struct wt_status *s, config_fn_t fn)
169{
170 wt_status_prepare(s);
171 gitmodules_config();
172 git_config(fn, s);
173 determine_whence(s);
174 s->hints = advice_status_hints; /* must come after git_config() */
175}
176static void rollback_index_files(void)
178{
179 switch (commit_style) {
180 case COMMIT_AS_IS:
181 break; /* nothing to do */
182 case COMMIT_NORMAL:
183 rollback_lock_file(&index_lock);
184 break;
185 case COMMIT_PARTIAL:
186 rollback_lock_file(&index_lock);
187 rollback_lock_file(&false_lock);
188 break;
189 }
190}
191static int commit_index_files(void)
193{
194 int err = 0;
195 switch (commit_style) {
197 case COMMIT_AS_IS:
198 break; /* nothing to do */
199 case COMMIT_NORMAL:
200 err = commit_lock_file(&index_lock);
201 break;
202 case COMMIT_PARTIAL:
203 err = commit_lock_file(&index_lock);
204 rollback_lock_file(&false_lock);
205 break;
206 }
207 return err;
209}
210/*
212 * Take a union of paths in the index and the named tree (typically, "HEAD"),
213 * and return the paths that match the given pattern in list.
214 */
215static int list_paths(struct string_list *list, const char *with_tree,
216 const char *prefix, const struct pathspec *pattern)
217{
218 int i;
219 char *m;
220 if (!pattern->nr)
222 return 0;
223 m = xcalloc(1, pattern->nr);
225 if (with_tree) {
227 char *max_prefix = common_prefix(pattern);
228 overlay_tree_on_cache(with_tree, max_prefix ? max_prefix : prefix);
229 free(max_prefix);
230 }
231 for (i = 0; i < active_nr; i++) {
233 const struct cache_entry *ce = active_cache[i];
234 struct string_list_item *item;
235 if (ce->ce_flags & CE_UPDATE)
237 continue;
238 if (!ce_path_match(ce, pattern, m))
239 continue;
240 item = string_list_insert(list, ce->name);
241 if (ce_skip_worktree(ce))
242 item->util = item; /* better a valid pointer than a fake one */
243 }
244 return report_path_error(m, pattern, prefix);
246}
247static void add_remove_files(struct string_list *list)
249{
250 int i;
251 for (i = 0; i < list->nr; i++) {
252 struct stat st;
253 struct string_list_item *p = &(list->items[i]);
254 /* p->util is skip-worktree */
256 if (p->util)
257 continue;
258 if (!lstat(p->string, &st)) {
260 if (add_to_cache(p->string, &st, 0))
261 die(_("updating files failed"));
262 } else
263 remove_file_from_cache(p->string);
264 }
265}
266static void create_base_index(const struct commit *current_head)
268{
269 struct tree *tree;
270 struct unpack_trees_options opts;
271 struct tree_desc t;
272 if (!current_head) {
274 discard_cache();
275 return;
276 }
277 memset(&opts, 0, sizeof(opts));
279 opts.head_idx = 1;
280 opts.index_only = 1;
281 opts.merge = 1;
282 opts.src_index = &the_index;
283 opts.dst_index = &the_index;
284 opts.fn = oneway_merge;
286 tree = parse_tree_indirect(current_head->object.sha1);
287 if (!tree)
288 die(_("failed to unpack HEAD tree object"));
289 parse_tree(tree);
290 init_tree_desc(&t, tree->buffer, tree->size);
291 if (unpack_trees(1, &t, &opts))
292 exit(128); /* We've already reported the error, finish dying */
293}
294static void refresh_cache_or_die(int refresh_flags)
296{
297 /*
298 * refresh_flags contains REFRESH_QUIET, so the only errors
299 * are for unmerged entries.
300 */
301 if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
302 die_resolve_conflict("commit");
303}
304static char *prepare_index(int argc, const char **argv, const char *prefix,
306 const struct commit *current_head, int is_status)
307{
308 int fd;
309 struct string_list partial;
310 struct pathspec pathspec;
311 int refresh_flags = REFRESH_QUIET;
312 if (is_status)
314 refresh_flags |= REFRESH_UNMERGED;
315 parse_pathspec(&pathspec, 0,
316 PATHSPEC_PREFER_FULL,
317 prefix, argv);
318 if (read_cache_preload(&pathspec) < 0)
320 die(_("index file corrupt"));
321 if (interactive) {
323 char *old_index_env = NULL;
324 fd = hold_locked_index(&index_lock, 1);
325 refresh_cache_or_die(refresh_flags);
327 if (write_cache(fd, active_cache, active_nr) ||
329 close_lock_file(&index_lock))
330 die(_("unable to create temporary index"));
331 old_index_env = getenv(INDEX_ENVIRONMENT);
333 setenv(INDEX_ENVIRONMENT, index_lock.filename, 1);
334 if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
336 die(_("interactive add failed"));
337 if (old_index_env && *old_index_env)
339 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
340 else
341 unsetenv(INDEX_ENVIRONMENT);
342 discard_cache();
344 read_cache_from(index_lock.filename);
345 commit_style = COMMIT_NORMAL;
347 return index_lock.filename;
348 }
349 /*
351 * Non partial, non as-is commit.
352 *
353 * (1) get the real index;
354 * (2) update the_index as necessary;
355 * (3) write the_index out to the real index (still locked);
356 * (4) return the name of the locked index file.
357 *
358 * The caller should run hooks on the locked real index, and
359 * (A) if all goes well, commit the real index;
360 * (B) on failure, rollback the real index.
361 */
362 if (all || (also && pathspec.nr)) {
363 fd = hold_locked_index(&index_lock, 1);
364 add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
365 refresh_cache_or_die(refresh_flags);
366 update_main_cache_tree(WRITE_TREE_SILENT);
367 if (write_cache(fd, active_cache, active_nr) ||
368 close_lock_file(&index_lock))
369 die(_("unable to write new_index file"));
370 commit_style = COMMIT_NORMAL;
371 return index_lock.filename;
372 }
373 /*
375 * As-is commit.
376 *
377 * (1) return the name of the real index file.
378 *
379 * The caller should run hooks on the real index,
380 * and create commit from the_index.
381 * We still need to refresh the index here.
382 */
383 if (!only && !pathspec.nr) {
384 fd = hold_locked_index(&index_lock, 1);
385 refresh_cache_or_die(refresh_flags);
386 if (active_cache_changed) {
387 update_main_cache_tree(WRITE_TREE_SILENT);
388 if (write_cache(fd, active_cache, active_nr) ||
389 commit_locked_index(&index_lock))
390 die(_("unable to write new_index file"));
391 } else {
392 rollback_lock_file(&index_lock);
393 }
394 commit_style = COMMIT_AS_IS;
395 return get_index_file();
396 }
397 /*
399 * A partial commit.
400 *
401 * (0) find the set of affected paths;
402 * (1) get lock on the real index file;
403 * (2) update the_index with the given paths;
404 * (3) write the_index out to the real index (still locked);
405 * (4) get lock on the false index file;
406 * (5) reset the_index from HEAD;
407 * (6) update the_index the same way as (2);
408 * (7) write the_index out to the false index file;
409 * (8) return the name of the false index file (still locked);
410 *
411 * The caller should run hooks on the locked false index, and
412 * create commit from it. Then
413 * (A) if all goes well, commit the real index;
414 * (B) on failure, rollback the real index;
415 * In either case, rollback the false index.
416 */
417 commit_style = COMMIT_PARTIAL;
418 if (whence != FROM_COMMIT) {
420 if (whence == FROM_MERGE)
421 die(_("cannot do a partial commit during a merge."));
422 else if (whence == FROM_CHERRY_PICK)
423 die(_("cannot do a partial commit during a cherry-pick."));
424 }
425 memset(&partial, 0, sizeof(partial));
427 partial.strdup_strings = 1;
428 if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, &pathspec))
429 exit(1);
430 discard_cache();
432 if (read_cache() < 0)
433 die(_("cannot read the index"));
434 fd = hold_locked_index(&index_lock, 1);
436 add_remove_files(&partial);
437 refresh_cache(REFRESH_QUIET);
438 if (write_cache(fd, active_cache, active_nr) ||
439 close_lock_file(&index_lock))
440 die(_("unable to write new_index file"));
441 fd = hold_lock_file_for_update(&false_lock,
443 git_path("next-index-%"PRIuMAX,
444 (uintmax_t) getpid()),
445 LOCK_DIE_ON_ERROR);
446 create_base_index(current_head);
448 add_remove_files(&partial);
449 refresh_cache(REFRESH_QUIET);
450 if (write_cache(fd, active_cache, active_nr) ||
452 close_lock_file(&false_lock))
453 die(_("unable to write temporary index file"));
454 discard_cache();
456 read_cache_from(false_lock.filename);
457 return false_lock.filename;
459}
460static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
462 struct wt_status *s)
463{
464 unsigned char sha1[20];
465 if (s->relative_paths)
467 s->prefix = prefix;
468 if (amend) {
470 s->amend = 1;
471 s->reference = "HEAD^1";
472 }
473 s->verbose = verbose;
474 s->index_file = index_file;
475 s->fp = fp;
476 s->nowarn = nowarn;
477 s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
478 wt_status_collect(s);
480 switch (status_format) {
482 case STATUS_FORMAT_SHORT:
483 wt_shortstatus_print(s);
484 break;
485 case STATUS_FORMAT_PORCELAIN:
486 wt_porcelain_print(s);
487 break;
488 case STATUS_FORMAT_UNSPECIFIED:
489 die("BUG: finalize_deferred_config() should have been called");
490 break;
491 case STATUS_FORMAT_NONE:
492 case STATUS_FORMAT_LONG:
493 wt_status_print(s);
494 break;
495 }
496 return s->commitable;
498}
499static int is_a_merge(const struct commit *current_head)
501{
502 return !!(current_head->parents && current_head->parents->next);
503}
504static void export_one(const char *var, const char *s, const char *e, int hack)
506{
507 struct strbuf buf = STRBUF_INIT;
508 if (hack)
509 strbuf_addch(&buf, hack);
510 strbuf_addf(&buf, "%.*s", (int)(e - s), s);
511 setenv(var, buf.buf, 1);
512 strbuf_release(&buf);
513}
514static int sane_ident_split(struct ident_split *person)
516{
517 if (!person->name_begin || !person->name_end ||
518 person->name_begin == person->name_end)
519 return 0; /* no human readable name */
520 if (!person->mail_begin || !person->mail_end ||
521 person->mail_begin == person->mail_end)
522 return 0; /* no usable mail */
523 if (!person->date_begin || !person->date_end ||
524 !person->tz_begin || !person->tz_end)
525 return 0;
526 return 1;
527}
528static void determine_author_info(struct strbuf *author_ident)
530{
531 char *name, *email, *date;
532 struct ident_split author;
533 name = getenv("GIT_AUTHOR_NAME");
535 email = getenv("GIT_AUTHOR_EMAIL");
536 date = getenv("GIT_AUTHOR_DATE");
537 if (author_message) {
539 const char *a, *lb, *rb, *eol;
540 size_t len;
541 a = strstr(author_message_buffer, "\nauthor ");
543 if (!a)
544 die(_("invalid commit: %s"), author_message);
545 lb = strchrnul(a + strlen("\nauthor "), '<');
547 rb = strchrnul(lb, '>');
548 eol = strchrnul(rb, '\n');
549 if (!*lb || !*rb || !*eol)
550 die(_("invalid commit: %s"), author_message);
551 if (lb == a + strlen("\nauthor "))
553 /* \nauthor <foo@example.com> */
554 name = xcalloc(1, 1);
555 else
556 name = xmemdupz(a + strlen("\nauthor "),
557 (lb - strlen(" ") -
558 (a + strlen("\nauthor "))));
559 email = xmemdupz(lb + strlen("<"), rb - (lb + strlen("<")));
560 len = eol - (rb + strlen("> "));
561 date = xmalloc(len + 2);
562 *date = '@';
563 memcpy(date + 1, rb + strlen("> "), len);
564 date[len + 1] = '\0';
565 }
566 if (force_author) {
568 const char *lb = strstr(force_author, " <");
569 const char *rb = strchr(force_author, '>');
570 if (!lb || !rb)
572 die(_("malformed --author parameter"));
573 name = xstrndup(force_author, lb - force_author);
574 email = xstrndup(lb + 2, rb - (lb + 2));
575 }
576 if (force_date)
578 date = force_date;
579 strbuf_addstr(author_ident, fmt_ident(name, email, date, IDENT_STRICT));
580 if (!split_ident_line(&author, author_ident->buf, author_ident->len) &&
581 sane_ident_split(&author)) {
582 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
583 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
584 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
585 }
586}
587static char *cut_ident_timestamp_part(char *string)
589{
590 char *ket = strrchr(string, '>');
591 if (!ket || ket[1] != ' ')
592 die(_("Malformed ident string: '%s'"), string);
593 *++ket = '\0';
594 return ket;
595}
596static int prepare_to_commit(const char *index_file, const char *prefix,
598 struct commit *current_head,
599 struct wt_status *s,
600 struct strbuf *author_ident)
601{
602 struct stat statbuf;
603 struct strbuf committer_ident = STRBUF_INIT;
604 int commitable;
605 struct strbuf sb = STRBUF_INIT;
606 const char *hook_arg1 = NULL;
607 const char *hook_arg2 = NULL;
608 int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
609 int old_display_comment_prefix;
610 /* This checks and barfs if author is badly specified */
612 determine_author_info(author_ident);
613 if (!no_verify && run_hook(index_file, "pre-commit", NULL))
615 return 0;
616 if (squash_message) {
618 /*
619 * Insert the proper subject line before other commit
620 * message options add their content.
621 */
622 if (use_message && !strcmp(use_message, squash_message))
623 strbuf_addstr(&sb, "squash! ");
624 else {
625 struct pretty_print_context ctx = {0};
626 struct commit *c;
627 c = lookup_commit_reference_by_name(squash_message);
628 if (!c)
629 die(_("could not lookup commit %s"), squash_message);
630 ctx.output_encoding = get_commit_output_encoding();
631 format_commit_message(c, "squash! %s\n\n", &sb,
632 &ctx);
633 }
634 }
635 if (message.len) {
637 strbuf_addbuf(&sb, &message);
638 hook_arg1 = "message";
639 } else if (logfile && !strcmp(logfile, "-")) {
640 if (isatty(0))
641 fprintf(stderr, _("(reading log message from standard input)\n"));
642 if (strbuf_read(&sb, 0, 0) < 0)
643 die_errno(_("could not read log from standard input"));
644 hook_arg1 = "message";
645 } else if (logfile) {
646 if (strbuf_read_file(&sb, logfile, 0) < 0)
647 die_errno(_("could not read log file '%s'"),
648 logfile);
649 hook_arg1 = "message";
650 } else if (use_message) {
651 char *buffer;
652 buffer = strstr(use_message_buffer, "\n\n");
653 if (!use_editor && (!buffer || buffer[2] == '\0'))
654 die(_("commit has empty message"));
655 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
656 hook_arg1 = "commit";
657 hook_arg2 = use_message;
658 } else if (fixup_message) {
659 struct pretty_print_context ctx = {0};
660 struct commit *commit;
661 commit = lookup_commit_reference_by_name(fixup_message);
662 if (!commit)
663 die(_("could not lookup commit %s"), fixup_message);
664 ctx.output_encoding = get_commit_output_encoding();
665 format_commit_message(commit, "fixup! %s\n\n",
666 &sb, &ctx);
667 hook_arg1 = "message";
668 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
669 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
670 die_errno(_("could not read MERGE_MSG"));
671 hook_arg1 = "merge";
672 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
673 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
674 die_errno(_("could not read SQUASH_MSG"));
675 hook_arg1 = "squash";
676 } else if (template_file) {
677 if (strbuf_read_file(&sb, template_file, 0) < 0)
678 die_errno(_("could not read '%s'"), template_file);
679 hook_arg1 = "template";
680 clean_message_contents = 0;
681 }
682 /*
684 * The remaining cases don't modify the template message, but
685 * just set the argument(s) to the prepare-commit-msg hook.
686 */
687 else if (whence == FROM_MERGE)
688 hook_arg1 = "merge";
689 else if (whence == FROM_CHERRY_PICK) {
690 hook_arg1 = "commit";
691 hook_arg2 = "CHERRY_PICK_HEAD";
692 }
693 if (squash_message) {
695 /*
696 * If squash_commit was used for the commit subject,
697 * then we're possibly hijacking other commit log options.
698 * Reset the hook args to tell the real story.
699 */
700 hook_arg1 = "message";
701 hook_arg2 = "";
702 }
703 s->fp = fopen(git_path(commit_editmsg), "w");
705 if (s->fp == NULL)
706 die_errno(_("could not open '%s'"), git_path(commit_editmsg));
707 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
709 old_display_comment_prefix = s->display_comment_prefix;
710 s->display_comment_prefix = 1;
711 /*
713 * Most hints are counter-productive when the commit has
714 * already started.
715 */
716 s->hints = 0;
717 if (clean_message_contents)
719 stripspace(&sb, 0);
720 if (signoff) {
722 /*
723 * See if we have a Conflicts: block at the end. If yes, count
724 * its size, so we can ignore it.
725 */
726 int ignore_footer = 0;
727 int i, eol, previous = 0;
728 const char *nl;
729 for (i = 0; i < sb.len; i++) {
731 nl = memchr(sb.buf + i, '\n', sb.len - i);
732 if (nl)
733 eol = nl - sb.buf;
734 else
735 eol = sb.len;
736 if (starts_with(sb.buf + previous, "\nConflicts:\n")) {
737 ignore_footer = sb.len - previous;
738 break;
739 }
740 while (i < eol)
741 i++;
742 previous = eol;
743 }
744 append_signoff(&sb, ignore_footer, 0);
746 }
747 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
749 die_errno(_("could not write commit template"));
750 strbuf_release(&sb);
752 /* This checks if committer ident is explicitly given */
754 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
755 if (use_editor && include_status) {
756 int ident_shown = 0;
757 int saved_color_setting;
758 char *ai_tmp, *ci_tmp;
759 if (whence != FROM_COMMIT) {
760 if (cleanup_mode == CLEANUP_SCISSORS)
761 wt_status_add_cut_line(s->fp);
762 status_printf_ln(s, GIT_COLOR_NORMAL,
763 whence == FROM_MERGE
764 ? _("\n"
765 "It looks like you may be committing a merge.\n"
766 "If this is not correct, please remove the file\n"
767 " %s\n"
768 "and try again.\n")
769 : _("\n"
770 "It looks like you may be committing a cherry-pick.\n"
771 "If this is not correct, please remove the file\n"
772 " %s\n"
773 "and try again.\n"),
774 git_path(whence == FROM_MERGE
775 ? "MERGE_HEAD"
776 : "CHERRY_PICK_HEAD"));
777 }
778 fprintf(s->fp, "\n");
780 if (cleanup_mode == CLEANUP_ALL)
781 status_printf(s, GIT_COLOR_NORMAL,
782 _("Please enter the commit message for your changes."
783 " Lines starting\nwith '%c' will be ignored, and an empty"
784 " message aborts the commit.\n"), comment_line_char);
785 else if (cleanup_mode == CLEANUP_SCISSORS && whence == FROM_COMMIT)
786 wt_status_add_cut_line(s->fp);
787 else /* CLEANUP_SPACE, that is. */
788 status_printf(s, GIT_COLOR_NORMAL,
789 _("Please enter the commit message for your changes."
790 " Lines starting\n"
791 "with '%c' will be kept; you may remove them"
792 " yourself if you want to.\n"
793 "An empty message aborts the commit.\n"), comment_line_char);
794 if (only_include_assumed)
795 status_printf_ln(s, GIT_COLOR_NORMAL,
796 "%s", only_include_assumed);
797 ai_tmp = cut_ident_timestamp_part(author_ident->buf);
799 ci_tmp = cut_ident_timestamp_part(committer_ident.buf);
800 if (strcmp(author_ident->buf, committer_ident.buf))
801 status_printf_ln(s, GIT_COLOR_NORMAL,
802 _("%s"
803 "Author: %s"),
804 ident_shown++ ? "" : "\n",
805 author_ident->buf);
806 if (!committer_ident_sufficiently_given())
808 status_printf_ln(s, GIT_COLOR_NORMAL,
809 _("%s"
810 "Committer: %s"),
811 ident_shown++ ? "" : "\n",
812 committer_ident.buf);
813 if (ident_shown)
815 status_printf_ln(s, GIT_COLOR_NORMAL, "");
816 saved_color_setting = s->use_color;
818 s->use_color = 0;
819 commitable = run_status(s->fp, index_file, prefix, 1, s);
820 s->use_color = saved_color_setting;
821 *ai_tmp = ' ';
823 *ci_tmp = ' ';
824 } else {
825 unsigned char sha1[20];
826 const char *parent = "HEAD";
827 if (!active_nr && read_cache() < 0)
829 die(_("Cannot read index"));
830 if (amend)
832 parent = "HEAD^1";
833 if (get_sha1(parent, sha1))
835 commitable = !!active_nr;
836 else
837 commitable = index_differs_from(parent, 0);
838 }
839 strbuf_release(&committer_ident);
840 fclose(s->fp);
842 /*
844 * Reject an attempt to record a non-merge empty commit without
845 * explicit --allow-empty. In the cherry-pick case, it may be
846 * empty due to conflict resolution, which the user should okay.
847 */
848 if (!commitable && whence != FROM_MERGE && !allow_empty &&
849 !(amend && is_a_merge(current_head))) {
850 s->display_comment_prefix = old_display_comment_prefix;
851 run_status(stdout, index_file, prefix, 0, s);
852 if (amend)
853 fputs(_(empty_amend_advice), stderr);
854 else if (whence == FROM_CHERRY_PICK) {
855 fputs(_(empty_cherry_pick_advice), stderr);
856 if (!sequencer_in_use)
857 fputs(_(empty_cherry_pick_advice_single), stderr);
858 else
859 fputs(_(empty_cherry_pick_advice_multi), stderr);
860 }
861 return 0;
862 }
863 /*
865 * Re-read the index as pre-commit hook could have updated it,
866 * and write it out as a tree. We must do this before we invoke
867 * the editor and after we invoke run_status above.
868 */
869 discard_cache();
870 read_cache_from(index_file);
871 if (update_main_cache_tree(0)) {
872 error(_("Error building trees"));
873 return 0;
874 }
875 if (run_hook(index_file, "prepare-commit-msg",
877 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
878 return 0;
879 if (use_editor) {
881 char index[PATH_MAX];
882 const char *env[2] = { NULL };
883 env[0] = index;
884 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
885 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
886 fprintf(stderr,
887 _("Please supply the message using either -m or -F option.\n"));
888 exit(1);
889 }
890 }
891 if (!no_verify &&
893 run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
894 return 0;
895 }
896 return 1;
898}
899static int rest_is_empty(struct strbuf *sb, int start)
901{
902 int i, eol;
903 const char *nl;
904 /* Check if the rest is just whitespace and Signed-of-by's. */
906 for (i = start; i < sb->len; i++) {
907 nl = memchr(sb->buf + i, '\n', sb->len - i);
908 if (nl)
909 eol = nl - sb->buf;
910 else
911 eol = sb->len;
912 if (strlen(sign_off_header) <= eol - i &&
914 starts_with(sb->buf + i, sign_off_header)) {
915 i = eol;
916 continue;
917 }
918 while (i < eol)
919 if (!isspace(sb->buf[i++]))
920 return 0;
921 }
922 return 1;
924}
925/*
927 * Find out if the message in the strbuf contains only whitespace and
928 * Signed-off-by lines.
929 */
930static int message_is_empty(struct strbuf *sb)
931{
932 if (cleanup_mode == CLEANUP_NONE && sb->len)
933 return 0;
934 return rest_is_empty(sb, 0);
935}
936/*
938 * See if the user edited the message in the editor or left what
939 * was in the template intact
940 */
941static int template_untouched(struct strbuf *sb)
942{
943 struct strbuf tmpl = STRBUF_INIT;
944 char *start;
945 if (cleanup_mode == CLEANUP_NONE && sb->len)
947 return 0;
948 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
950 return 0;
951 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
953 start = (char *)skip_prefix(sb->buf, tmpl.buf);
954 if (!start)
955 start = sb->buf;
956 strbuf_release(&tmpl);
957 return rest_is_empty(sb, start - sb->buf);
958}
959static const char *find_author_by_nickname(const char *name)
961{
962 struct rev_info revs;
963 struct commit *commit;
964 struct strbuf buf = STRBUF_INIT;
965 struct string_list mailmap = STRING_LIST_INIT_NODUP;
966 const char *av[20];
967 int ac = 0;
968 init_revisions(&revs, NULL);
970 strbuf_addf(&buf, "--author=%s", name);
971 av[++ac] = "--all";
972 av[++ac] = "-i";
973 av[++ac] = buf.buf;
974 av[++ac] = NULL;
975 setup_revisions(ac, av, &revs, NULL);
976 revs.mailmap = &mailmap;
977 read_mailmap(revs.mailmap, NULL);
978 prepare_revision_walk(&revs);
980 commit = get_revision(&revs);
981 if (commit) {
982 struct pretty_print_context ctx = {0};
983 ctx.date_mode = DATE_NORMAL;
984 strbuf_release(&buf);
985 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
986 clear_mailmap(&mailmap);
987 return strbuf_detach(&buf, NULL);
988 }
989 die(_("No existing author found with '%s'"), name);
990}
991static void handle_untracked_files_arg(struct wt_status *s)
994{
995 if (!untracked_files_arg)
996 ; /* default already initialized */
997 else if (!strcmp(untracked_files_arg, "no"))
998 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
999 else if (!strcmp(untracked_files_arg, "normal"))
1000 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1001 else if (!strcmp(untracked_files_arg, "all"))
1002 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1003 else
1004 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1005}
1006static const char *read_commit_message(const char *name)
1008{
1009 const char *out_enc;
1010 struct commit *commit;
1011 commit = lookup_commit_reference_by_name(name);
1013 if (!commit)
1014 die(_("could not lookup commit %s"), name);
1015 out_enc = get_commit_output_encoding();
1016 return logmsg_reencode(commit, NULL, out_enc);
1017}
1018/*
1020 * Enumerate what needs to be propagated when --porcelain
1021 * is not in effect here.
1022 */
1023static struct status_deferred_config {
1024 enum status_format status_format;
1025 int show_branch;
1026} status_deferred_config = {
1027 STATUS_FORMAT_UNSPECIFIED,
1028 -1 /* unspecified */
1029};
1030static void finalize_deferred_config(struct wt_status *s)
1032{
1033 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1034 !s->null_termination);
1035 if (s->null_termination) {
1037 if (status_format == STATUS_FORMAT_NONE ||
1038 status_format == STATUS_FORMAT_UNSPECIFIED)
1039 status_format = STATUS_FORMAT_PORCELAIN;
1040 else if (status_format == STATUS_FORMAT_LONG)
1041 die(_("--long and -z are incompatible"));
1042 }
1043 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1045 status_format = status_deferred_config.status_format;
1046 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1047 status_format = STATUS_FORMAT_NONE;
1048 if (use_deferred_config && s->show_branch < 0)
1050 s->show_branch = status_deferred_config.show_branch;
1051 if (s->show_branch < 0)
1052 s->show_branch = 0;
1053}
1054static int parse_and_validate_options(int argc, const char *argv[],
1056 const struct option *options,
1057 const char * const usage[],
1058 const char *prefix,
1059 struct commit *current_head,
1060 struct wt_status *s)
1061{
1062 int f = 0;
1063 argc = parse_options(argc, argv, prefix, options, usage, 0);
1065 finalize_deferred_config(s);
1066 if (force_author && !strchr(force_author, '>'))
1068 force_author = find_author_by_nickname(force_author);
1069 if (force_author && renew_authorship)
1071 die(_("Using both --reset-author and --author does not make sense"));
1072 if (logfile || have_option_m || use_message || fixup_message)
1074 use_editor = 0;
1075 if (0 <= edit_flag)
1076 use_editor = edit_flag;
1077 if (!use_editor)
1078 setenv("GIT_EDITOR", ":", 1);
1079 /* Sanity check options */
1081 if (amend && !current_head)
1082 die(_("You have nothing to amend."));
1083 if (amend && whence != FROM_COMMIT) {
1084 if (whence == FROM_MERGE)
1085 die(_("You are in the middle of a merge -- cannot amend."));
1086 else if (whence == FROM_CHERRY_PICK)
1087 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1088 }
1089 if (fixup_message && squash_message)
1090 die(_("Options --squash and --fixup cannot be used together"));
1091 if (use_message)
1092 f++;
1093 if (edit_message)
1094 f++;
1095 if (fixup_message)
1096 f++;
1097 if (logfile)
1098 f++;
1099 if (f > 1)
1100 die(_("Only one of -c/-C/-F/--fixup can be used."));
1101 if (message.len && f > 0)
1102 die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1103 if (f || message.len)
1104 template_file = NULL;
1105 if (edit_message)
1106 use_message = edit_message;
1107 if (amend && !use_message && !fixup_message)
1108 use_message = "HEAD";
1109 if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1110 die(_("--reset-author can be used only with -C, -c or --amend."));
1111 if (use_message) {
1112 use_message_buffer = read_commit_message(use_message);
1113 if (!renew_authorship) {
1114 author_message = use_message;
1115 author_message_buffer = use_message_buffer;
1116 }
1117 }
1118 if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1119 author_message = "CHERRY_PICK_HEAD";
1120 author_message_buffer = read_commit_message(author_message);
1121 }
1122 if (patch_interactive)
1124 interactive = 1;
1125 if (also + only + all + interactive > 1)
1127 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1128 if (argc == 0 && (also || (only && !amend)))
1129 die(_("No paths with --include/--only does not make sense."));
1130 if (argc == 0 && only && amend)
1131 only_include_assumed = _("Clever... amending the last one with dirty index.");
1132 if (argc > 0 && !also && !only)
1133 only_include_assumed = _("Explicit paths specified without -i nor -o; assuming --only paths...");
1134 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
1135 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
1136 else if (!strcmp(cleanup_arg, "verbatim"))
1137 cleanup_mode = CLEANUP_NONE;
1138 else if (!strcmp(cleanup_arg, "whitespace"))
1139 cleanup_mode = CLEANUP_SPACE;
1140 else if (!strcmp(cleanup_arg, "strip"))
1141 cleanup_mode = CLEANUP_ALL;
1142 else if (!strcmp(cleanup_arg, "scissors"))
1143 cleanup_mode = use_editor ? CLEANUP_SCISSORS : CLEANUP_SPACE;
1144 else
1145 die(_("Invalid cleanup mode %s"), cleanup_arg);
1146 handle_untracked_files_arg(s);
1148 if (all && argc > 0)
1150 die(_("Paths with -a does not make sense."));
1151 if (status_format != STATUS_FORMAT_NONE)
1153 dry_run = 1;
1154 return argc;
1156}
1157static int dry_run_commit(int argc, const char **argv, const char *prefix,
1159 const struct commit *current_head, struct wt_status *s)
1160{
1161 int commitable;
1162 const char *index_file;
1163 index_file = prepare_index(argc, argv, prefix, current_head, 1);
1165 commitable = run_status(stdout, index_file, prefix, 0, s);
1166 rollback_index_files();
1167 return commitable ? 0 : 1;
1169}
1170static int parse_status_slot(const char *var, int offset)
1172{
1173 if (!strcasecmp(var+offset, "header"))
1174 return WT_STATUS_HEADER;
1175 if (!strcasecmp(var+offset, "branch"))
1176 return WT_STATUS_ONBRANCH;
1177 if (!strcasecmp(var+offset, "updated")
1178 || !strcasecmp(var+offset, "added"))
1179 return WT_STATUS_UPDATED;
1180 if (!strcasecmp(var+offset, "changed"))
1181 return WT_STATUS_CHANGED;
1182 if (!strcasecmp(var+offset, "untracked"))
1183 return WT_STATUS_UNTRACKED;
1184 if (!strcasecmp(var+offset, "nobranch"))
1185 return WT_STATUS_NOBRANCH;
1186 if (!strcasecmp(var+offset, "unmerged"))
1187 return WT_STATUS_UNMERGED;
1188 return -1;
1189}
1190static int git_status_config(const char *k, const char *v, void *cb)
1192{
1193 struct wt_status *s = cb;
1194 if (starts_with(k, "column."))
1196 return git_column_config(k, v, "status", &s->colopts);
1197 if (!strcmp(k, "status.submodulesummary")) {
1198 int is_bool;
1199 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1200 if (is_bool && s->submodule_summary)
1201 s->submodule_summary = -1;
1202 return 0;
1203 }
1204 if (!strcmp(k, "status.short")) {
1205 if (git_config_bool(k, v))
1206 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1207 else
1208 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1209 return 0;
1210 }
1211 if (!strcmp(k, "status.branch")) {
1212 status_deferred_config.show_branch = git_config_bool(k, v);
1213 return 0;
1214 }
1215 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1216 s->use_color = git_config_colorbool(k, v);
1217 return 0;
1218 }
1219 if (!strcmp(k, "status.displaycommentprefix")) {
1220 s->display_comment_prefix = git_config_bool(k, v);
1221 return 0;
1222 }
1223 if (starts_with(k, "status.color.") || starts_with(k, "color.status.")) {
1224 int slot = parse_status_slot(k, 13);
1225 if (slot < 0)
1226 return 0;
1227 if (!v)
1228 return config_error_nonbool(k);
1229 color_parse(v, k, s->color_palette[slot]);
1230 return 0;
1231 }
1232 if (!strcmp(k, "status.relativepaths")) {
1233 s->relative_paths = git_config_bool(k, v);
1234 return 0;
1235 }
1236 if (!strcmp(k, "status.showuntrackedfiles")) {
1237 if (!v)
1238 return config_error_nonbool(k);
1239 else if (!strcmp(v, "no"))
1240 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1241 else if (!strcmp(v, "normal"))
1242 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1243 else if (!strcmp(v, "all"))
1244 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1245 else
1246 return error(_("Invalid untracked files mode '%s'"), v);
1247 return 0;
1248 }
1249 return git_diff_ui_config(k, v, NULL);
1250}
1251int cmd_status(int argc, const char **argv, const char *prefix)
1253{
1254 static struct wt_status s;
1255 int fd;
1256 unsigned char sha1[20];
1257 static struct option builtin_status_options[] = {
1258 OPT__VERBOSE(&verbose, N_("be verbose")),
1259 OPT_SET_INT('s', "short", &status_format,
1260 N_("show status concisely"), STATUS_FORMAT_SHORT),
1261 OPT_BOOL('b', "branch", &s.show_branch,
1262 N_("show branch information")),
1263 OPT_SET_INT(0, "porcelain", &status_format,
1264 N_("machine-readable output"),
1265 STATUS_FORMAT_PORCELAIN),
1266 OPT_SET_INT(0, "long", &status_format,
1267 N_("show status in long format (default)"),
1268 STATUS_FORMAT_LONG),
1269 OPT_BOOL('z', "null", &s.null_termination,
1270 N_("terminate entries with NUL")),
1271 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1272 N_("mode"),
1273 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1274 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1275 OPT_BOOL(0, "ignored", &show_ignored_in_status,
1276 N_("show ignored files")),
1277 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1278 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1279 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1280 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1281 OPT_END(),
1282 };
1283 if (argc == 2 && !strcmp(argv[1], "-h"))
1285 usage_with_options(builtin_status_usage, builtin_status_options);
1286 status_init_config(&s, git_status_config);
1288 argc = parse_options(argc, argv, prefix,
1289 builtin_status_options,
1290 builtin_status_usage, 0);
1291 finalize_colopts(&s.colopts, -1);
1292 finalize_deferred_config(&s);
1293 handle_untracked_files_arg(&s);
1295 if (show_ignored_in_status)
1296 s.show_ignored_files = 1;
1297 parse_pathspec(&s.pathspec, 0,
1298 PATHSPEC_PREFER_FULL,
1299 prefix, argv);
1300 read_cache_preload(&s.pathspec);
1302 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &s.pathspec, NULL, NULL);
1303 fd = hold_locked_index(&index_lock, 0);
1305 if (0 <= fd)
1306 update_index_if_able(&the_index, &index_lock);
1307 s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1309 s.ignore_submodule_arg = ignore_submodule_arg;
1310 wt_status_collect(&s);
1311 if (s.relative_paths)
1313 s.prefix = prefix;
1314 switch (status_format) {
1316 case STATUS_FORMAT_SHORT:
1317 wt_shortstatus_print(&s);
1318 break;
1319 case STATUS_FORMAT_PORCELAIN:
1320 wt_porcelain_print(&s);
1321 break;
1322 case STATUS_FORMAT_UNSPECIFIED:
1323 die("BUG: finalize_deferred_config() should have been called");
1324 break;
1325 case STATUS_FORMAT_NONE:
1326 case STATUS_FORMAT_LONG:
1327 s.verbose = verbose;
1328 s.ignore_submodule_arg = ignore_submodule_arg;
1329 wt_status_print(&s);
1330 break;
1331 }
1332 return 0;
1333}
1334static void print_summary(const char *prefix, const unsigned char *sha1,
1336 int initial_commit)
1337{
1338 struct rev_info rev;
1339 struct commit *commit;
1340 struct strbuf format = STRBUF_INIT;
1341 unsigned char junk_sha1[20];
1342 const char *head;
1343 struct pretty_print_context pctx = {0};
1344 struct strbuf author_ident = STRBUF_INIT;
1345 struct strbuf committer_ident = STRBUF_INIT;
1346 commit = lookup_commit(sha1);
1348 if (!commit)
1349 die(_("couldn't look up newly created commit"));
1350 if (parse_commit(commit))
1351 die(_("could not parse newly created commit"));
1352 strbuf_addstr(&format, "format:%h] %s");
1354 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1356 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1357 if (strbuf_cmp(&author_ident, &committer_ident)) {
1358 strbuf_addstr(&format, "\n Author: ");
1359 strbuf_addbuf_percentquote(&format, &author_ident);
1360 }
1361 if (!committer_ident_sufficiently_given()) {
1362 strbuf_addstr(&format, "\n Committer: ");
1363 strbuf_addbuf_percentquote(&format, &committer_ident);
1364 if (advice_implicit_identity) {
1365 strbuf_addch(&format, '\n');
1366 strbuf_addstr(&format, _(implicit_ident_advice));
1367 }
1368 }
1369 strbuf_release(&author_ident);
1370 strbuf_release(&committer_ident);
1371 init_revisions(&rev, prefix);
1373 setup_revisions(0, NULL, &rev, NULL);
1374 rev.diff = 1;
1376 rev.diffopt.output_format =
1377 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1378 rev.verbose_header = 1;
1380 rev.show_root_diff = 1;
1381 get_commit_format(format.buf, &rev);
1382 rev.always_show_header = 0;
1383 rev.diffopt.detect_rename = 1;
1384 rev.diffopt.break_opt = 0;
1385 diff_setup_done(&rev.diffopt);
1386 head = resolve_ref_unsafe("HEAD", junk_sha1, 0, NULL);
1388 printf("[%s%s ",
1389 starts_with(head, "refs/heads/") ?
1390 head + 11 :
1391 !strcmp(head, "HEAD") ?
1392 _("detached HEAD") :
1393 head,
1394 initial_commit ? _(" (root-commit)") : "");
1395 if (!log_tree_commit(&rev, commit)) {
1397 rev.always_show_header = 1;
1398 rev.use_terminator = 1;
1399 log_tree_commit(&rev, commit);
1400 }
1401 strbuf_release(&format);
1403}
1404static int git_commit_config(const char *k, const char *v, void *cb)
1406{
1407 struct wt_status *s = cb;
1408 int status;
1409 if (!strcmp(k, "commit.template"))
1411 return git_config_pathname(&template_file, k, v);
1412 if (!strcmp(k, "commit.status")) {
1413 include_status = git_config_bool(k, v);
1414 return 0;
1415 }
1416 if (!strcmp(k, "commit.cleanup"))
1417 return git_config_string(&cleanup_arg, k, v);
1418 if (!strcmp(k, "commit.gpgsign")) {
1419 sign_commit = git_config_bool(k, v) ? "" : NULL;
1420 return 0;
1421 }
1422 status = git_gpg_config(k, v, NULL);
1424 if (status)
1425 return status;
1426 return git_status_config(k, v, s);
1427}
1428static int run_rewrite_hook(const unsigned char *oldsha1,
1430 const unsigned char *newsha1)
1431{
1432 /* oldsha1 SP newsha1 LF NUL */
1433 static char buf[2*40 + 3];
1434 struct child_process proc;
1435 const char *argv[3];
1436 int code;
1437 size_t n;
1438 argv[0] = find_hook("post-rewrite");
1440 if (!argv[0])
1441 return 0;
1442 argv[1] = "amend";
1444 argv[2] = NULL;
1445 memset(&proc, 0, sizeof(proc));
1447 proc.argv = argv;
1448 proc.in = -1;
1449 proc.stdout_to_stderr = 1;
1450 code = start_command(&proc);
1452 if (code)
1453 return code;
1454 n = snprintf(buf, sizeof(buf), "%s %s\n",
1455 sha1_to_hex(oldsha1), sha1_to_hex(newsha1));
1456 write_in_full(proc.in, buf, n);
1457 close(proc.in);
1458 return finish_command(&proc);
1459}
1460int cmd_commit(int argc, const char **argv, const char *prefix)
1462{
1463 static struct wt_status s;
1464 static struct option builtin_commit_options[] = {
1465 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1466 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1467 OPT_GROUP(N_("Commit message options")),
1469 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1470 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1471 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1472 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1473 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1474 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1475 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1476 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1477 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1478 OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1479 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1480 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1481 OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
1482 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1483 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key id"),
1484 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1485 /* end commit message options */
1486 OPT_GROUP(N_("Commit contents options")),
1488 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1489 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1490 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1491 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1492 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1493 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit hook")),
1494 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1495 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1496 STATUS_FORMAT_SHORT),
1497 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1498 OPT_SET_INT(0, "porcelain", &status_format,
1499 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1500 OPT_SET_INT(0, "long", &status_format,
1501 N_("show status in long format (default)"),
1502 STATUS_FORMAT_LONG),
1503 OPT_BOOL('z', "null", &s.null_termination,
1504 N_("terminate entries with NUL")),
1505 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1506 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1507 { 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" },
1508 /* end commit contents options */
1509 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1511 N_("ok to record an empty change")),
1512 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1513 N_("ok to record a change with an empty message")),
1514 OPT_END()
1516 };
1517 struct strbuf sb = STRBUF_INIT;
1519 struct strbuf author_ident = STRBUF_INIT;
1520 const char *index_file, *reflog_msg;
1521 char *nl;
1522 unsigned char sha1[20];
1523 struct ref_lock *ref_lock;
1524 struct commit_list *parents = NULL, **pptr = &parents;
1525 struct stat statbuf;
1526 struct commit *current_head = NULL;
1527 struct commit_extra_header *extra = NULL;
1528 if (argc == 2 && !strcmp(argv[1], "-h"))
1530 usage_with_options(builtin_commit_usage, builtin_commit_options);
1531 status_init_config(&s, git_commit_config);
1533 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1534 s.colopts = 0;
1535 if (get_sha1("HEAD", sha1))
1537 current_head = NULL;
1538 else {
1539 current_head = lookup_commit_or_die(sha1, "HEAD");
1540 if (parse_commit(current_head))
1541 die(_("could not parse HEAD commit"));
1542 }
1543 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1544 builtin_commit_usage,
1545 prefix, current_head, &s);
1546 if (dry_run)
1547 return dry_run_commit(argc, argv, prefix, current_head, &s);
1548 index_file = prepare_index(argc, argv, prefix, current_head, 0);
1549 /* Set up everything for writing the commit object. This includes
1551 running hooks, writing the trees, and interacting with the user. */
1552 if (!prepare_to_commit(index_file, prefix,
1553 current_head, &s, &author_ident)) {
1554 rollback_index_files();
1555 return 1;
1556 }
1557 /* Determine parents */
1559 reflog_msg = getenv("GIT_REFLOG_ACTION");
1560 if (!current_head) {
1561 if (!reflog_msg)
1562 reflog_msg = "commit (initial)";
1563 } else if (amend) {
1564 struct commit_list *c;
1565 if (!reflog_msg)
1567 reflog_msg = "commit (amend)";
1568 for (c = current_head->parents; c; c = c->next)
1569 pptr = &commit_list_insert(c->item, pptr)->next;
1570 } else if (whence == FROM_MERGE) {
1571 struct strbuf m = STRBUF_INIT;
1572 FILE *fp;
1573 int allow_fast_forward = 1;
1574 if (!reflog_msg)
1576 reflog_msg = "commit (merge)";
1577 pptr = &commit_list_insert(current_head, pptr)->next;
1578 fp = fopen(git_path("MERGE_HEAD"), "r");
1579 if (fp == NULL)
1580 die_errno(_("could not open '%s' for reading"),
1581 git_path("MERGE_HEAD"));
1582 while (strbuf_getline(&m, fp, '\n') != EOF) {
1583 struct commit *parent;
1584 parent = get_merge_parent(m.buf);
1586 if (!parent)
1587 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1588 pptr = &commit_list_insert(parent, pptr)->next;
1589 }
1590 fclose(fp);
1591 strbuf_release(&m);
1592 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1593 if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1594 die_errno(_("could not read MERGE_MODE"));
1595 if (!strcmp(sb.buf, "no-ff"))
1596 allow_fast_forward = 0;
1597 }
1598 if (allow_fast_forward)
1599 parents = reduce_heads(parents);
1600 } else {
1601 if (!reflog_msg)
1602 reflog_msg = (whence == FROM_CHERRY_PICK)
1603 ? "commit (cherry-pick)"
1604 : "commit";
1605 pptr = &commit_list_insert(current_head, pptr)->next;
1606 }
1607 /* Finally, get the commit message */
1609 strbuf_reset(&sb);
1610 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1611 int saved_errno = errno;
1612 rollback_index_files();
1613 die(_("could not read commit message: %s"), strerror(saved_errno));
1614 }
1615 if (verbose || /* Truncate the message just before the diff, if any. */
1617 cleanup_mode == CLEANUP_SCISSORS)
1618 wt_status_truncate_message_at_cut_line(&sb);
1619 if (cleanup_mode != CLEANUP_NONE)
1621 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1622 if (template_untouched(&sb) && !allow_empty_message) {
1623 rollback_index_files();
1624 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1625 exit(1);
1626 }
1627 if (message_is_empty(&sb) && !allow_empty_message) {
1628 rollback_index_files();
1629 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1630 exit(1);
1631 }
1632 if (amend) {
1634 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1635 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1636 } else {
1637 struct commit_extra_header **tail = &extra;
1638 append_merge_tag_headers(parents, &tail);
1639 }
1640 if (commit_tree_extended(&sb, active_cache_tree->sha1, parents, sha1,
1642 author_ident.buf, sign_commit, extra)) {
1643 rollback_index_files();
1644 die(_("failed to write commit object"));
1645 }
1646 strbuf_release(&author_ident);
1647 free_commit_extra_headers(extra);
1648 ref_lock = lock_any_ref_for_update("HEAD",
1650 !current_head
1651 ? NULL
1652 : current_head->object.sha1,
1653 0, NULL);
1654 nl = strchr(sb.buf, '\n');
1656 if (nl)
1657 strbuf_setlen(&sb, nl + 1 - sb.buf);
1658 else
1659 strbuf_addch(&sb, '\n');
1660 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1661 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1662 if (!ref_lock) {
1664 rollback_index_files();
1665 die(_("cannot lock HEAD ref"));
1666 }
1667 if (write_ref_sha1(ref_lock, sha1, sb.buf) < 0) {
1668 rollback_index_files();
1669 die(_("cannot update HEAD ref"));
1670 }
1671 unlink(git_path("CHERRY_PICK_HEAD"));
1673 unlink(git_path("REVERT_HEAD"));
1674 unlink(git_path("MERGE_HEAD"));
1675 unlink(git_path("MERGE_MSG"));
1676 unlink(git_path("MERGE_MODE"));
1677 unlink(git_path("SQUASH_MSG"));
1678 if (commit_index_files())
1680 die (_("Repository has been updated, but unable to write\n"
1681 "new_index file. Check that disk is not full or quota is\n"
1682 "not exceeded, and then \"git reset HEAD\" to recover."));
1683 rerere(0);
1685 run_hook(get_index_file(), "post-commit", NULL);
1686 if (amend && !no_post_rewrite) {
1687 struct notes_rewrite_cfg *cfg;
1688 cfg = init_copy_notes_for_rewrite("amend");
1689 if (cfg) {
1690 /* we are amending, so current_head is not NULL */
1691 copy_note_for_rewrite(cfg, current_head->object.sha1, sha1);
1692 finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1693 }
1694 run_rewrite_hook(current_head->object.sha1, sha1);
1695 }
1696 if (!quiet)
1697 print_summary(prefix, sha1, !current_head);
1698 return 0;
1700}