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