cd455aa36b084c1c4d957568941414ff4e5c52ef
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
8#include "cache.h"
9#include "cache-tree.h"
10#include "color.h"
11#include "dir.h"
12#include "builtin.h"
13#include "diff.h"
14#include "diffcore.h"
15#include "commit.h"
16#include "revision.h"
17#include "wt-status.h"
18#include "run-command.h"
19#include "refs.h"
20#include "log-tree.h"
21#include "strbuf.h"
22#include "utf8.h"
23#include "parse-options.h"
24#include "string-list.h"
25#include "rerere.h"
26#include "unpack-trees.h"
27#include "quote.h"
28#include "submodule.h"
29#include "gpg-interface.h"
30#include "column.h"
31#include "sequencer.h"
32#include "notes-utils.h"
33#include "mailmap.h"
34
35static const char * const builtin_commit_usage[] = {
36 N_("git commit [options] [--] <pathspec>..."),
37 NULL
38};
39
40static const char * const builtin_status_usage[] = {
41 N_("git status [options] [--] <pathspec>..."),
42 NULL
43};
44
45static 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");
56
57static 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");
61
62static 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");
68
69static const char empty_cherry_pick_advice_single[] =
70N_("Otherwise, please use 'git reset'\n");
71
72static 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");
79
80static 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;
89
90static 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
106/*
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;
119
120static 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;
126
127static enum status_format {
128 STATUS_FORMAT_NONE = 0,
129 STATUS_FORMAT_LONG,
130 STATUS_FORMAT_SHORT,
131 STATUS_FORMAT_PORCELAIN,
132
133 STATUS_FORMAT_UNSPECIFIED
134} status_format = STATUS_FORMAT_UNSPECIFIED;
135
136static 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}
151
152static 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}
166
167static void status_init_config(struct wt_status *s, config_fn_t fn)
168{
169 wt_status_prepare(s);
170 gitmodules_config();
171 git_config(fn, s);
172 determine_whence(s);
173 s->hints = advice_status_hints; /* must come after git_config() */
174}
175
176static void rollback_index_files(void)
177{
178 switch (commit_style) {
179 case COMMIT_AS_IS:
180 break; /* nothing to do */
181 case COMMIT_NORMAL:
182 rollback_lock_file(&index_lock);
183 break;
184 case COMMIT_PARTIAL:
185 rollback_lock_file(&index_lock);
186 rollback_lock_file(&false_lock);
187 break;
188 }
189}
190
191static int commit_index_files(void)
192{
193 int err = 0;
194
195 switch (commit_style) {
196 case COMMIT_AS_IS:
197 break; /* nothing to do */
198 case COMMIT_NORMAL:
199 err = commit_lock_file(&index_lock);
200 break;
201 case COMMIT_PARTIAL:
202 err = commit_lock_file(&index_lock);
203 rollback_lock_file(&false_lock);
204 break;
205 }
206
207 return err;
208}
209
210/*
211 * Take a union of paths in the index and the named tree (typically, "HEAD"),
212 * and return the paths that match the given pattern in list.
213 */
214static int list_paths(struct string_list *list, const char *with_tree,
215 const char *prefix, const struct pathspec *pattern)
216{
217 int i;
218 char *m;
219
220 if (!pattern->nr)
221 return 0;
222
223 m = xcalloc(1, pattern->nr);
224
225 if (with_tree) {
226 char *max_prefix = common_prefix(pattern);
227 overlay_tree_on_cache(with_tree, max_prefix ? max_prefix : prefix);
228 free(max_prefix);
229 }
230
231 for (i = 0; i < active_nr; i++) {
232 const struct cache_entry *ce = active_cache[i];
233 struct string_list_item *item;
234
235 if (ce->ce_flags & CE_UPDATE)
236 continue;
237 if (!match_pathspec_depth(pattern, ce->name, ce_namelen(ce), 0, m))
238 continue;
239 item = string_list_insert(list, ce->name);
240 if (ce_skip_worktree(ce))
241 item->util = item; /* better a valid pointer than a fake one */
242 }
243
244 return report_path_error(m, pattern, prefix);
245}
246
247static void add_remove_files(struct string_list *list)
248{
249 int i;
250 for (i = 0; i < list->nr; i++) {
251 struct stat st;
252 struct string_list_item *p = &(list->items[i]);
253
254 /* p->util is skip-worktree */
255 if (p->util)
256 continue;
257
258 if (!lstat(p->string, &st)) {
259 if (add_to_cache(p->string, &st, 0))
260 die(_("updating files failed"));
261 } else
262 remove_file_from_cache(p->string);
263 }
264}
265
266static void create_base_index(const struct commit *current_head)
267{
268 struct tree *tree;
269 struct unpack_trees_options opts;
270 struct tree_desc t;
271
272 if (!current_head) {
273 discard_cache();
274 return;
275 }
276
277 memset(&opts, 0, sizeof(opts));
278 opts.head_idx = 1;
279 opts.index_only = 1;
280 opts.merge = 1;
281 opts.src_index = &the_index;
282 opts.dst_index = &the_index;
283
284 opts.fn = oneway_merge;
285 tree = parse_tree_indirect(current_head->object.sha1);
286 if (!tree)
287 die(_("failed to unpack HEAD tree object"));
288 parse_tree(tree);
289 init_tree_desc(&t, tree->buffer, tree->size);
290 if (unpack_trees(1, &t, &opts))
291 exit(128); /* We've already reported the error, finish dying */
292}
293
294static void refresh_cache_or_die(int refresh_flags)
295{
296 /*
297 * refresh_flags contains REFRESH_QUIET, so the only errors
298 * are for unmerged entries.
299 */
300 if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
301 die_resolve_conflict("commit");
302}
303
304static char *prepare_index(int argc, const char **argv, const char *prefix,
305 const struct commit *current_head, int is_status)
306{
307 int fd;
308 struct string_list partial;
309 struct pathspec pathspec;
310 char *old_index_env = NULL;
311 int refresh_flags = REFRESH_QUIET;
312
313 if (is_status)
314 refresh_flags |= REFRESH_UNMERGED;
315 parse_pathspec(&pathspec, 0,
316 PATHSPEC_PREFER_FULL,
317 prefix, argv);
318
319 if (read_cache_preload(&pathspec) < 0)
320 die(_("index file corrupt"));
321
322 if (interactive) {
323 fd = hold_locked_index(&index_lock, 1);
324
325 refresh_cache_or_die(refresh_flags);
326
327 if (write_cache(fd, active_cache, active_nr) ||
328 close_lock_file(&index_lock))
329 die(_("unable to create temporary index"));
330
331 old_index_env = getenv(INDEX_ENVIRONMENT);
332 setenv(INDEX_ENVIRONMENT, index_lock.filename, 1);
333
334 if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
335 die(_("interactive add failed"));
336
337 if (old_index_env && *old_index_env)
338 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
339 else
340 unsetenv(INDEX_ENVIRONMENT);
341
342 discard_cache();
343 read_cache_from(index_lock.filename);
344
345 commit_style = COMMIT_NORMAL;
346 return index_lock.filename;
347 }
348
349 /*
350 * Non partial, non as-is commit.
351 *
352 * (1) get the real index;
353 * (2) update the_index as necessary;
354 * (3) write the_index out to the real index (still locked);
355 * (4) return the name of the locked index file.
356 *
357 * The caller should run hooks on the locked real index, and
358 * (A) if all goes well, commit the real index;
359 * (B) on failure, rollback the real index.
360 */
361 if (all || (also && pathspec.nr)) {
362 fd = hold_locked_index(&index_lock, 1);
363 add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
364 refresh_cache_or_die(refresh_flags);
365 update_main_cache_tree(WRITE_TREE_SILENT);
366 if (write_cache(fd, active_cache, active_nr) ||
367 close_lock_file(&index_lock))
368 die(_("unable to write new_index file"));
369 commit_style = COMMIT_NORMAL;
370 return index_lock.filename;
371 }
372
373 /*
374 * As-is commit.
375 *
376 * (1) return the name of the real index file.
377 *
378 * The caller should run hooks on the real index,
379 * and create commit from the_index.
380 * We still need to refresh the index here.
381 */
382 if (!only && !pathspec.nr) {
383 fd = hold_locked_index(&index_lock, 1);
384 refresh_cache_or_die(refresh_flags);
385 if (active_cache_changed) {
386 update_main_cache_tree(WRITE_TREE_SILENT);
387 if (write_cache(fd, active_cache, active_nr) ||
388 commit_locked_index(&index_lock))
389 die(_("unable to write new_index file"));
390 } else {
391 rollback_lock_file(&index_lock);
392 }
393 commit_style = COMMIT_AS_IS;
394 return get_index_file();
395 }
396
397 /*
398 * A partial commit.
399 *
400 * (0) find the set of affected paths;
401 * (1) get lock on the real index file;
402 * (2) update the_index with the given paths;
403 * (3) write the_index out to the real index (still locked);
404 * (4) get lock on the false index file;
405 * (5) reset the_index from HEAD;
406 * (6) update the_index the same way as (2);
407 * (7) write the_index out to the false index file;
408 * (8) return the name of the false index file (still locked);
409 *
410 * The caller should run hooks on the locked false index, and
411 * create commit from it. Then
412 * (A) if all goes well, commit the real index;
413 * (B) on failure, rollback the real index;
414 * In either case, rollback the false index.
415 */
416 commit_style = COMMIT_PARTIAL;
417
418 if (whence != FROM_COMMIT) {
419 if (whence == FROM_MERGE)
420 die(_("cannot do a partial commit during a merge."));
421 else if (whence == FROM_CHERRY_PICK)
422 die(_("cannot do a partial commit during a cherry-pick."));
423 }
424
425 memset(&partial, 0, sizeof(partial));
426 partial.strdup_strings = 1;
427 if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, &pathspec))
428 exit(1);
429
430 discard_cache();
431 if (read_cache() < 0)
432 die(_("cannot read the index"));
433
434 fd = hold_locked_index(&index_lock, 1);
435 add_remove_files(&partial);
436 refresh_cache(REFRESH_QUIET);
437 if (write_cache(fd, active_cache, active_nr) ||
438 close_lock_file(&index_lock))
439 die(_("unable to write new_index file"));
440
441 fd = hold_lock_file_for_update(&false_lock,
442 git_path("next-index-%"PRIuMAX,
443 (uintmax_t) getpid()),
444 LOCK_DIE_ON_ERROR);
445
446 create_base_index(current_head);
447 add_remove_files(&partial);
448 refresh_cache(REFRESH_QUIET);
449
450 if (write_cache(fd, active_cache, active_nr) ||
451 close_lock_file(&false_lock))
452 die(_("unable to write temporary index file"));
453
454 discard_cache();
455 read_cache_from(false_lock.filename);
456
457 return false_lock.filename;
458}
459
460static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
461 struct wt_status *s)
462{
463 unsigned char sha1[20];
464
465 if (s->relative_paths)
466 s->prefix = prefix;
467
468 if (amend) {
469 s->amend = 1;
470 s->reference = "HEAD^1";
471 }
472 s->verbose = verbose;
473 s->index_file = index_file;
474 s->fp = fp;
475 s->nowarn = nowarn;
476 s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
477
478 wt_status_collect(s);
479
480 switch (status_format) {
481 case STATUS_FORMAT_SHORT:
482 wt_shortstatus_print(s);
483 break;
484 case STATUS_FORMAT_PORCELAIN:
485 wt_porcelain_print(s);
486 break;
487 case STATUS_FORMAT_UNSPECIFIED:
488 die("BUG: finalize_deferred_config() should have been called");
489 break;
490 case STATUS_FORMAT_NONE:
491 case STATUS_FORMAT_LONG:
492 wt_status_print(s);
493 break;
494 }
495
496 return s->commitable;
497}
498
499static int is_a_merge(const struct commit *current_head)
500{
501 return !!(current_head->parents && current_head->parents->next);
502}
503
504static void export_one(const char *var, const char *s, const char *e, int hack)
505{
506 struct strbuf buf = STRBUF_INIT;
507 if (hack)
508 strbuf_addch(&buf, hack);
509 strbuf_addf(&buf, "%.*s", (int)(e - s), s);
510 setenv(var, buf.buf, 1);
511 strbuf_release(&buf);
512}
513
514static int sane_ident_split(struct ident_split *person)
515{
516 if (!person->name_begin || !person->name_end ||
517 person->name_begin == person->name_end)
518 return 0; /* no human readable name */
519 if (!person->mail_begin || !person->mail_end ||
520 person->mail_begin == person->mail_end)
521 return 0; /* no usable mail */
522 if (!person->date_begin || !person->date_end ||
523 !person->tz_begin || !person->tz_end)
524 return 0;
525 return 1;
526}
527
528static void determine_author_info(struct strbuf *author_ident)
529{
530 char *name, *email, *date;
531 struct ident_split author;
532
533 name = getenv("GIT_AUTHOR_NAME");
534 email = getenv("GIT_AUTHOR_EMAIL");
535 date = getenv("GIT_AUTHOR_DATE");
536
537 if (author_message) {
538 const char *a, *lb, *rb, *eol;
539 size_t len;
540
541 a = strstr(author_message_buffer, "\nauthor ");
542 if (!a)
543 die(_("invalid commit: %s"), author_message);
544
545 lb = strchrnul(a + strlen("\nauthor "), '<');
546 rb = strchrnul(lb, '>');
547 eol = strchrnul(rb, '\n');
548 if (!*lb || !*rb || !*eol)
549 die(_("invalid commit: %s"), author_message);
550
551 if (lb == a + strlen("\nauthor "))
552 /* \nauthor <foo@example.com> */
553 name = xcalloc(1, 1);
554 else
555 name = xmemdupz(a + strlen("\nauthor "),
556 (lb - strlen(" ") -
557 (a + strlen("\nauthor "))));
558 email = xmemdupz(lb + strlen("<"), rb - (lb + strlen("<")));
559 len = eol - (rb + strlen("> "));
560 date = xmalloc(len + 2);
561 *date = '@';
562 memcpy(date + 1, rb + strlen("> "), len);
563 date[len + 1] = '\0';
564 }
565
566 if (force_author) {
567 const char *lb = strstr(force_author, " <");
568 const char *rb = strchr(force_author, '>');
569
570 if (!lb || !rb)
571 die(_("malformed --author parameter"));
572 name = xstrndup(force_author, lb - force_author);
573 email = xstrndup(lb + 2, rb - (lb + 2));
574 }
575
576 if (force_date)
577 date = force_date;
578 strbuf_addstr(author_ident, fmt_ident(name, email, date, IDENT_STRICT));
579 if (!split_ident_line(&author, author_ident->buf, author_ident->len) &&
580 sane_ident_split(&author)) {
581 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
582 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
583 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
584 }
585}
586
587static char *cut_ident_timestamp_part(char *string)
588{
589 char *ket = strrchr(string, '>');
590 if (!ket || ket[1] != ' ')
591 die(_("Malformed ident string: '%s'"), string);
592 *++ket = '\0';
593 return ket;
594}
595
596/*
597 * Inspect sb and determine the true "end" of the log message, in
598 * order to find where to put a new Signed-off-by: line. Ignored are
599 * trailing "Conflict:" block.
600 *
601 * Returns the number of bytes from the tail to ignore, to be fed as
602 * the second parameter to append_signoff().
603 */
604static int ignore_non_trailer(struct strbuf *sb)
605{
606 int ignore_footer = 0;
607 int i, eol, previous = 0;
608 const char *nl;
609
610 for (i = 0; i < sb->len; i++) {
611 nl = memchr(sb->buf + i, '\n', sb->len - i);
612 if (nl)
613 eol = nl - sb->buf;
614 else
615 eol = sb->len;
616 if (!prefixcmp(sb->buf + previous, "\nConflicts:\n")) {
617 ignore_footer = sb->len - previous;
618 break;
619 }
620 while (i < eol)
621 i++;
622 previous = eol;
623 }
624 return ignore_footer;
625}
626
627static int prepare_to_commit(const char *index_file, const char *prefix,
628 struct commit *current_head,
629 struct wt_status *s,
630 struct strbuf *author_ident)
631{
632 struct stat statbuf;
633 struct strbuf committer_ident = STRBUF_INIT;
634 int commitable, saved_color_setting;
635 struct strbuf sb = STRBUF_INIT;
636 char *buffer;
637 const char *hook_arg1 = NULL;
638 const char *hook_arg2 = NULL;
639 int ident_shown = 0;
640 int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
641 int old_display_comment_prefix;
642
643 /* This checks and barfs if author is badly specified */
644 determine_author_info(author_ident);
645
646 if (!no_verify && run_hook(index_file, "pre-commit", NULL))
647 return 0;
648
649 if (squash_message) {
650 /*
651 * Insert the proper subject line before other commit
652 * message options add their content.
653 */
654 if (use_message && !strcmp(use_message, squash_message))
655 strbuf_addstr(&sb, "squash! ");
656 else {
657 struct pretty_print_context ctx = {0};
658 struct commit *c;
659 c = lookup_commit_reference_by_name(squash_message);
660 if (!c)
661 die(_("could not lookup commit %s"), squash_message);
662 ctx.output_encoding = get_commit_output_encoding();
663 format_commit_message(c, "squash! %s\n\n", &sb,
664 &ctx);
665 }
666 }
667
668 if (message.len) {
669 strbuf_addbuf(&sb, &message);
670 hook_arg1 = "message";
671 } else if (logfile && !strcmp(logfile, "-")) {
672 if (isatty(0))
673 fprintf(stderr, _("(reading log message from standard input)\n"));
674 if (strbuf_read(&sb, 0, 0) < 0)
675 die_errno(_("could not read log from standard input"));
676 hook_arg1 = "message";
677 } else if (logfile) {
678 if (strbuf_read_file(&sb, logfile, 0) < 0)
679 die_errno(_("could not read log file '%s'"),
680 logfile);
681 hook_arg1 = "message";
682 } else if (use_message) {
683 buffer = strstr(use_message_buffer, "\n\n");
684 if (!use_editor && (!buffer || buffer[2] == '\0'))
685 die(_("commit has empty message"));
686 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
687 hook_arg1 = "commit";
688 hook_arg2 = use_message;
689 } else if (fixup_message) {
690 struct pretty_print_context ctx = {0};
691 struct commit *commit;
692 commit = lookup_commit_reference_by_name(fixup_message);
693 if (!commit)
694 die(_("could not lookup commit %s"), fixup_message);
695 ctx.output_encoding = get_commit_output_encoding();
696 format_commit_message(commit, "fixup! %s\n\n",
697 &sb, &ctx);
698 hook_arg1 = "message";
699 } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
700 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
701 die_errno(_("could not read MERGE_MSG"));
702 hook_arg1 = "merge";
703 } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
704 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
705 die_errno(_("could not read SQUASH_MSG"));
706 hook_arg1 = "squash";
707 } else if (template_file) {
708 if (strbuf_read_file(&sb, template_file, 0) < 0)
709 die_errno(_("could not read '%s'"), template_file);
710 hook_arg1 = "template";
711 clean_message_contents = 0;
712 }
713
714 /*
715 * The remaining cases don't modify the template message, but
716 * just set the argument(s) to the prepare-commit-msg hook.
717 */
718 else if (whence == FROM_MERGE)
719 hook_arg1 = "merge";
720 else if (whence == FROM_CHERRY_PICK) {
721 hook_arg1 = "commit";
722 hook_arg2 = "CHERRY_PICK_HEAD";
723 }
724
725 if (squash_message) {
726 /*
727 * If squash_commit was used for the commit subject,
728 * then we're possibly hijacking other commit log options.
729 * Reset the hook args to tell the real story.
730 */
731 hook_arg1 = "message";
732 hook_arg2 = "";
733 }
734
735 s->fp = fopen(git_path(commit_editmsg), "w");
736 if (s->fp == NULL)
737 die_errno(_("could not open '%s'"), git_path(commit_editmsg));
738
739 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
740 old_display_comment_prefix = s->display_comment_prefix;
741 s->display_comment_prefix = 1;
742
743 /*
744 * Most hints are counter-productive when the commit has
745 * already started.
746 */
747 s->hints = 0;
748
749 if (clean_message_contents)
750 stripspace(&sb, 0);
751
752 if (signoff)
753 append_signoff(&sb, ignore_non_trailer(&sb), 0);
754
755 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
756 die_errno(_("could not write commit template"));
757
758 strbuf_release(&sb);
759
760 /* This checks if committer ident is explicitly given */
761 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
762 if (use_editor && include_status) {
763 char *ai_tmp, *ci_tmp;
764 if (whence != FROM_COMMIT)
765 status_printf_ln(s, GIT_COLOR_NORMAL,
766 whence == FROM_MERGE
767 ? _("\n"
768 "It looks like you may be committing a merge.\n"
769 "If this is not correct, please remove the file\n"
770 " %s\n"
771 "and try again.\n")
772 : _("\n"
773 "It looks like you may be committing a cherry-pick.\n"
774 "If this is not correct, please remove the file\n"
775 " %s\n"
776 "and try again.\n"),
777 git_path(whence == FROM_MERGE
778 ? "MERGE_HEAD"
779 : "CHERRY_PICK_HEAD"));
780
781 fprintf(s->fp, "\n");
782 if (cleanup_mode == CLEANUP_ALL)
783 status_printf(s, GIT_COLOR_NORMAL,
784 _("Please enter the commit message for your changes."
785 " Lines starting\nwith '%c' will be ignored, and an empty"
786 " message aborts the commit.\n"), comment_line_char);
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
798 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
807 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
814 if (ident_shown)
815 status_printf_ln(s, GIT_COLOR_NORMAL, "");
816
817 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
822 *ai_tmp = ' ';
823 *ci_tmp = ' ';
824 } else {
825 unsigned char sha1[20];
826 const char *parent = "HEAD";
827
828 if (!active_nr && read_cache() < 0)
829 die(_("Cannot read index"));
830
831 if (amend)
832 parent = "HEAD^1";
833
834 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
841 fclose(s->fp);
842
843 /*
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
864 /*
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
876 if (run_hook(index_file, "prepare-commit-msg",
877 git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
878 return 0;
879
880 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
892 if (!no_verify &&
893 run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
894 return 0;
895 }
896
897 return 1;
898}
899
900static int rest_is_empty(struct strbuf *sb, int start)
901{
902 int i, eol;
903 const char *nl;
904
905 /* 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
913 if (strlen(sign_off_header) <= eol - i &&
914 !prefixcmp(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
923 return 1;
924}
925
926/*
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
937/*
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
946 if (cleanup_mode == CLEANUP_NONE && sb->len)
947 return 0;
948
949 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
950 return 0;
951
952 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}
959
960static 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
969 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
979 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}
991
992
993static 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}
1006
1007static const char *read_commit_message(const char *name)
1008{
1009 const char *out_enc;
1010 struct commit *commit;
1011
1012 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
1019/*
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};
1030
1031static void finalize_deferred_config(struct wt_status *s)
1032{
1033 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1034 !s->null_termination);
1035
1036 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
1044 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
1049 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}
1054
1055static 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
1064 argc = parse_options(argc, argv, prefix, options, usage, 0);
1065 finalize_deferred_config(s);
1066
1067 if (force_author && !strchr(force_author, '>'))
1068 force_author = find_author_by_nickname(force_author);
1069
1070 if (force_author && renew_authorship)
1071 die(_("Using both --reset-author and --author does not make sense"));
1072
1073 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
1080 /* 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
1123 if (patch_interactive)
1124 interactive = 1;
1125
1126 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
1143 die(_("Invalid cleanup mode %s"), cleanup_arg);
1144
1145 handle_untracked_files_arg(s);
1146
1147 if (all && argc > 0)
1148 die(_("Paths with -a does not make sense."));
1149
1150 if (status_format != STATUS_FORMAT_NONE)
1151 dry_run = 1;
1152
1153 return argc;
1154}
1155
1156static int dry_run_commit(int argc, const char **argv, const char *prefix,
1157 const struct commit *current_head, struct wt_status *s)
1158{
1159 int commitable;
1160 const char *index_file;
1161
1162 index_file = prepare_index(argc, argv, prefix, current_head, 1);
1163 commitable = run_status(stdout, index_file, prefix, 0, s);
1164 rollback_index_files();
1165
1166 return commitable ? 0 : 1;
1167}
1168
1169static int parse_status_slot(const char *var, int offset)
1170{
1171 if (!strcasecmp(var+offset, "header"))
1172 return WT_STATUS_HEADER;
1173 if (!strcasecmp(var+offset, "branch"))
1174 return WT_STATUS_ONBRANCH;
1175 if (!strcasecmp(var+offset, "updated")
1176 || !strcasecmp(var+offset, "added"))
1177 return WT_STATUS_UPDATED;
1178 if (!strcasecmp(var+offset, "changed"))
1179 return WT_STATUS_CHANGED;
1180 if (!strcasecmp(var+offset, "untracked"))
1181 return WT_STATUS_UNTRACKED;
1182 if (!strcasecmp(var+offset, "nobranch"))
1183 return WT_STATUS_NOBRANCH;
1184 if (!strcasecmp(var+offset, "unmerged"))
1185 return WT_STATUS_UNMERGED;
1186 return -1;
1187}
1188
1189static int git_status_config(const char *k, const char *v, void *cb)
1190{
1191 struct wt_status *s = cb;
1192
1193 if (!prefixcmp(k, "column."))
1194 return git_column_config(k, v, "status", &s->colopts);
1195 if (!strcmp(k, "status.submodulesummary")) {
1196 int is_bool;
1197 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1198 if (is_bool && s->submodule_summary)
1199 s->submodule_summary = -1;
1200 return 0;
1201 }
1202 if (!strcmp(k, "status.short")) {
1203 if (git_config_bool(k, v))
1204 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1205 else
1206 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1207 return 0;
1208 }
1209 if (!strcmp(k, "status.branch")) {
1210 status_deferred_config.show_branch = git_config_bool(k, v);
1211 return 0;
1212 }
1213 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1214 s->use_color = git_config_colorbool(k, v);
1215 return 0;
1216 }
1217 if (!strcmp(k, "status.displaycommentprefix")) {
1218 s->display_comment_prefix = git_config_bool(k, v);
1219 return 0;
1220 }
1221 if (!prefixcmp(k, "status.color.") || !prefixcmp(k, "color.status.")) {
1222 int slot = parse_status_slot(k, 13);
1223 if (slot < 0)
1224 return 0;
1225 if (!v)
1226 return config_error_nonbool(k);
1227 color_parse(v, k, s->color_palette[slot]);
1228 return 0;
1229 }
1230 if (!strcmp(k, "status.relativepaths")) {
1231 s->relative_paths = git_config_bool(k, v);
1232 return 0;
1233 }
1234 if (!strcmp(k, "status.showuntrackedfiles")) {
1235 if (!v)
1236 return config_error_nonbool(k);
1237 else if (!strcmp(v, "no"))
1238 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1239 else if (!strcmp(v, "normal"))
1240 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1241 else if (!strcmp(v, "all"))
1242 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1243 else
1244 return error(_("Invalid untracked files mode '%s'"), v);
1245 return 0;
1246 }
1247 return git_diff_ui_config(k, v, NULL);
1248}
1249
1250int cmd_status(int argc, const char **argv, const char *prefix)
1251{
1252 static struct wt_status s;
1253 int fd;
1254 unsigned char sha1[20];
1255 static struct option builtin_status_options[] = {
1256 OPT__VERBOSE(&verbose, N_("be verbose")),
1257 OPT_SET_INT('s', "short", &status_format,
1258 N_("show status concisely"), STATUS_FORMAT_SHORT),
1259 OPT_BOOL('b', "branch", &s.show_branch,
1260 N_("show branch information")),
1261 OPT_SET_INT(0, "porcelain", &status_format,
1262 N_("machine-readable output"),
1263 STATUS_FORMAT_PORCELAIN),
1264 OPT_SET_INT(0, "long", &status_format,
1265 N_("show status in long format (default)"),
1266 STATUS_FORMAT_LONG),
1267 OPT_BOOL('z', "null", &s.null_termination,
1268 N_("terminate entries with NUL")),
1269 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1270 N_("mode"),
1271 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1272 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1273 OPT_BOOL(0, "ignored", &show_ignored_in_status,
1274 N_("show ignored files")),
1275 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1276 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1277 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1278 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1279 OPT_END(),
1280 };
1281
1282 if (argc == 2 && !strcmp(argv[1], "-h"))
1283 usage_with_options(builtin_status_usage, builtin_status_options);
1284
1285 status_init_config(&s, git_status_config);
1286 argc = parse_options(argc, argv, prefix,
1287 builtin_status_options,
1288 builtin_status_usage, 0);
1289 finalize_colopts(&s.colopts, -1);
1290 finalize_deferred_config(&s);
1291
1292 handle_untracked_files_arg(&s);
1293 if (show_ignored_in_status)
1294 s.show_ignored_files = 1;
1295 parse_pathspec(&s.pathspec, 0,
1296 PATHSPEC_PREFER_FULL,
1297 prefix, argv);
1298
1299 read_cache_preload(&s.pathspec);
1300 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, &s.pathspec, NULL, NULL);
1301
1302 fd = hold_locked_index(&index_lock, 0);
1303 if (0 <= fd)
1304 update_index_if_able(&the_index, &index_lock);
1305
1306 s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1307 s.ignore_submodule_arg = ignore_submodule_arg;
1308 wt_status_collect(&s);
1309
1310 if (s.relative_paths)
1311 s.prefix = prefix;
1312
1313 switch (status_format) {
1314 case STATUS_FORMAT_SHORT:
1315 wt_shortstatus_print(&s);
1316 break;
1317 case STATUS_FORMAT_PORCELAIN:
1318 wt_porcelain_print(&s);
1319 break;
1320 case STATUS_FORMAT_UNSPECIFIED:
1321 die("BUG: finalize_deferred_config() should have been called");
1322 break;
1323 case STATUS_FORMAT_NONE:
1324 case STATUS_FORMAT_LONG:
1325 s.verbose = verbose;
1326 s.ignore_submodule_arg = ignore_submodule_arg;
1327 wt_status_print(&s);
1328 break;
1329 }
1330 return 0;
1331}
1332
1333static void print_summary(const char *prefix, const unsigned char *sha1,
1334 int initial_commit)
1335{
1336 struct rev_info rev;
1337 struct commit *commit;
1338 struct strbuf format = STRBUF_INIT;
1339 unsigned char junk_sha1[20];
1340 const char *head;
1341 struct pretty_print_context pctx = {0};
1342 struct strbuf author_ident = STRBUF_INIT;
1343 struct strbuf committer_ident = STRBUF_INIT;
1344
1345 commit = lookup_commit(sha1);
1346 if (!commit)
1347 die(_("couldn't look up newly created commit"));
1348 if (!commit || parse_commit(commit))
1349 die(_("could not parse newly created commit"));
1350
1351 strbuf_addstr(&format, "format:%h] %s");
1352
1353 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1354 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1355 if (strbuf_cmp(&author_ident, &committer_ident)) {
1356 strbuf_addstr(&format, "\n Author: ");
1357 strbuf_addbuf_percentquote(&format, &author_ident);
1358 }
1359 if (!committer_ident_sufficiently_given()) {
1360 strbuf_addstr(&format, "\n Committer: ");
1361 strbuf_addbuf_percentquote(&format, &committer_ident);
1362 if (advice_implicit_identity) {
1363 strbuf_addch(&format, '\n');
1364 strbuf_addstr(&format, _(implicit_ident_advice));
1365 }
1366 }
1367 strbuf_release(&author_ident);
1368 strbuf_release(&committer_ident);
1369
1370 init_revisions(&rev, prefix);
1371 setup_revisions(0, NULL, &rev, NULL);
1372
1373 rev.diff = 1;
1374 rev.diffopt.output_format =
1375 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1376
1377 rev.verbose_header = 1;
1378 rev.show_root_diff = 1;
1379 get_commit_format(format.buf, &rev);
1380 rev.always_show_header = 0;
1381 rev.diffopt.detect_rename = 1;
1382 rev.diffopt.break_opt = 0;
1383 diff_setup_done(&rev.diffopt);
1384
1385 head = resolve_ref_unsafe("HEAD", junk_sha1, 0, NULL);
1386 printf("[%s%s ",
1387 !prefixcmp(head, "refs/heads/") ?
1388 head + 11 :
1389 !strcmp(head, "HEAD") ?
1390 _("detached HEAD") :
1391 head,
1392 initial_commit ? _(" (root-commit)") : "");
1393
1394 if (!log_tree_commit(&rev, commit)) {
1395 rev.always_show_header = 1;
1396 rev.use_terminator = 1;
1397 log_tree_commit(&rev, commit);
1398 }
1399
1400 strbuf_release(&format);
1401}
1402
1403static int git_commit_config(const char *k, const char *v, void *cb)
1404{
1405 struct wt_status *s = cb;
1406 int status;
1407
1408 if (!strcmp(k, "commit.template"))
1409 return git_config_pathname(&template_file, k, v);
1410 if (!strcmp(k, "commit.status")) {
1411 include_status = git_config_bool(k, v);
1412 return 0;
1413 }
1414 if (!strcmp(k, "commit.cleanup"))
1415 return git_config_string(&cleanup_arg, k, v);
1416
1417 status = git_gpg_config(k, v, NULL);
1418 if (status)
1419 return status;
1420 return git_status_config(k, v, s);
1421}
1422
1423static int run_rewrite_hook(const unsigned char *oldsha1,
1424 const unsigned char *newsha1)
1425{
1426 /* oldsha1 SP newsha1 LF NUL */
1427 static char buf[2*40 + 3];
1428 struct child_process proc;
1429 const char *argv[3];
1430 int code;
1431 size_t n;
1432
1433 argv[0] = find_hook("post-rewrite");
1434 if (!argv[0])
1435 return 0;
1436
1437 argv[1] = "amend";
1438 argv[2] = NULL;
1439
1440 memset(&proc, 0, sizeof(proc));
1441 proc.argv = argv;
1442 proc.in = -1;
1443 proc.stdout_to_stderr = 1;
1444
1445 code = start_command(&proc);
1446 if (code)
1447 return code;
1448 n = snprintf(buf, sizeof(buf), "%s %s\n",
1449 sha1_to_hex(oldsha1), sha1_to_hex(newsha1));
1450 write_in_full(proc.in, buf, n);
1451 close(proc.in);
1452 return finish_command(&proc);
1453}
1454
1455int cmd_commit(int argc, const char **argv, const char *prefix)
1456{
1457 static struct wt_status s;
1458 static struct option builtin_commit_options[] = {
1459 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1460 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1461
1462 OPT_GROUP(N_("Commit message options")),
1463 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1464 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1465 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1466 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1467 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1468 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1469 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1470 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1471 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1472 OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1473 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1474 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1475 OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
1476 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1477 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key id"),
1478 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1479 /* end commit message options */
1480
1481 OPT_GROUP(N_("Commit contents options")),
1482 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1483 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1484 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1485 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1486 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1487 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit hook")),
1488 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1489 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1490 STATUS_FORMAT_SHORT),
1491 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1492 OPT_SET_INT(0, "porcelain", &status_format,
1493 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1494 OPT_SET_INT(0, "long", &status_format,
1495 N_("show status in long format (default)"),
1496 STATUS_FORMAT_LONG),
1497 OPT_BOOL('z', "null", &s.null_termination,
1498 N_("terminate entries with NUL")),
1499 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1500 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1501 { 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" },
1502 /* end commit contents options */
1503
1504 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1505 N_("ok to record an empty change")),
1506 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1507 N_("ok to record a change with an empty message")),
1508
1509 OPT_END()
1510 };
1511
1512 struct strbuf sb = STRBUF_INIT;
1513 struct strbuf author_ident = STRBUF_INIT;
1514 const char *index_file, *reflog_msg;
1515 char *nl;
1516 unsigned char sha1[20];
1517 struct ref_lock *ref_lock;
1518 struct commit_list *parents = NULL, **pptr = &parents;
1519 struct stat statbuf;
1520 int allow_fast_forward = 1;
1521 struct commit *current_head = NULL;
1522 struct commit_extra_header *extra = NULL;
1523
1524 if (argc == 2 && !strcmp(argv[1], "-h"))
1525 usage_with_options(builtin_commit_usage, builtin_commit_options);
1526
1527 status_init_config(&s, git_commit_config);
1528 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1529 s.colopts = 0;
1530
1531 if (get_sha1("HEAD", sha1))
1532 current_head = NULL;
1533 else {
1534 current_head = lookup_commit_or_die(sha1, "HEAD");
1535 if (!current_head || parse_commit(current_head))
1536 die(_("could not parse HEAD commit"));
1537 }
1538 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1539 builtin_commit_usage,
1540 prefix, current_head, &s);
1541 if (dry_run)
1542 return dry_run_commit(argc, argv, prefix, current_head, &s);
1543 index_file = prepare_index(argc, argv, prefix, current_head, 0);
1544
1545 /* Set up everything for writing the commit object. This includes
1546 running hooks, writing the trees, and interacting with the user. */
1547 if (!prepare_to_commit(index_file, prefix,
1548 current_head, &s, &author_ident)) {
1549 rollback_index_files();
1550 return 1;
1551 }
1552
1553 /* Determine parents */
1554 reflog_msg = getenv("GIT_REFLOG_ACTION");
1555 if (!current_head) {
1556 if (!reflog_msg)
1557 reflog_msg = "commit (initial)";
1558 } else if (amend) {
1559 struct commit_list *c;
1560
1561 if (!reflog_msg)
1562 reflog_msg = "commit (amend)";
1563 for (c = current_head->parents; c; c = c->next)
1564 pptr = &commit_list_insert(c->item, pptr)->next;
1565 } else if (whence == FROM_MERGE) {
1566 struct strbuf m = STRBUF_INIT;
1567 FILE *fp;
1568
1569 if (!reflog_msg)
1570 reflog_msg = "commit (merge)";
1571 pptr = &commit_list_insert(current_head, pptr)->next;
1572 fp = fopen(git_path("MERGE_HEAD"), "r");
1573 if (fp == NULL)
1574 die_errno(_("could not open '%s' for reading"),
1575 git_path("MERGE_HEAD"));
1576 while (strbuf_getline(&m, fp, '\n') != EOF) {
1577 struct commit *parent;
1578
1579 parent = get_merge_parent(m.buf);
1580 if (!parent)
1581 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1582 pptr = &commit_list_insert(parent, pptr)->next;
1583 }
1584 fclose(fp);
1585 strbuf_release(&m);
1586 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1587 if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1588 die_errno(_("could not read MERGE_MODE"));
1589 if (!strcmp(sb.buf, "no-ff"))
1590 allow_fast_forward = 0;
1591 }
1592 if (allow_fast_forward)
1593 parents = reduce_heads(parents);
1594 } else {
1595 if (!reflog_msg)
1596 reflog_msg = (whence == FROM_CHERRY_PICK)
1597 ? "commit (cherry-pick)"
1598 : "commit";
1599 pptr = &commit_list_insert(current_head, pptr)->next;
1600 }
1601
1602 /* Finally, get the commit message */
1603 strbuf_reset(&sb);
1604 if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1605 int saved_errno = errno;
1606 rollback_index_files();
1607 die(_("could not read commit message: %s"), strerror(saved_errno));
1608 }
1609
1610 /* Truncate the message just before the diff, if any. */
1611 if (verbose)
1612 wt_status_truncate_message_at_cut_line(&sb);
1613
1614 if (cleanup_mode != CLEANUP_NONE)
1615 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1616 if (template_untouched(&sb) && !allow_empty_message) {
1617 rollback_index_files();
1618 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1619 exit(1);
1620 }
1621 if (message_is_empty(&sb) && !allow_empty_message) {
1622 rollback_index_files();
1623 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1624 exit(1);
1625 }
1626
1627 if (amend) {
1628 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1629 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1630 } else {
1631 struct commit_extra_header **tail = &extra;
1632 append_merge_tag_headers(parents, &tail);
1633 }
1634
1635 if (commit_tree_extended(&sb, active_cache_tree->sha1, parents, sha1,
1636 author_ident.buf, sign_commit, extra)) {
1637 rollback_index_files();
1638 die(_("failed to write commit object"));
1639 }
1640 strbuf_release(&author_ident);
1641 free_commit_extra_headers(extra);
1642
1643 ref_lock = lock_any_ref_for_update("HEAD",
1644 !current_head
1645 ? NULL
1646 : current_head->object.sha1,
1647 0, NULL);
1648
1649 nl = strchr(sb.buf, '\n');
1650 if (nl)
1651 strbuf_setlen(&sb, nl + 1 - sb.buf);
1652 else
1653 strbuf_addch(&sb, '\n');
1654 strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1655 strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1656
1657 if (!ref_lock) {
1658 rollback_index_files();
1659 die(_("cannot lock HEAD ref"));
1660 }
1661 if (write_ref_sha1(ref_lock, sha1, sb.buf) < 0) {
1662 rollback_index_files();
1663 die(_("cannot update HEAD ref"));
1664 }
1665
1666 unlink(git_path("CHERRY_PICK_HEAD"));
1667 unlink(git_path("REVERT_HEAD"));
1668 unlink(git_path("MERGE_HEAD"));
1669 unlink(git_path("MERGE_MSG"));
1670 unlink(git_path("MERGE_MODE"));
1671 unlink(git_path("SQUASH_MSG"));
1672
1673 if (commit_index_files())
1674 die (_("Repository has been updated, but unable to write\n"
1675 "new_index file. Check that disk is not full or quota is\n"
1676 "not exceeded, and then \"git reset HEAD\" to recover."));
1677
1678 rerere(0);
1679 run_hook(get_index_file(), "post-commit", NULL);
1680 if (amend && !no_post_rewrite) {
1681 struct notes_rewrite_cfg *cfg;
1682 cfg = init_copy_notes_for_rewrite("amend");
1683 if (cfg) {
1684 /* we are amending, so current_head is not NULL */
1685 copy_note_for_rewrite(cfg, current_head->object.sha1, sha1);
1686 finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1687 }
1688 run_rewrite_hook(current_head->object.sha1, sha1);
1689 }
1690 if (!quiet)
1691 print_summary(prefix, sha1, !current_head);
1692
1693 return 0;
1694}