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