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