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