Merge branch 'jb/midx-doc-update'
[alt-git.git] / builtin / commit.c
blob505fe60956db385d94aa7fd14e016a3dfeb9345c
1 /*
2 * Builtin "git commit"
4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
6 */
8 #define USE_THE_INDEX_COMPATIBILITY_MACROS
9 #include "cache.h"
10 #include "config.h"
11 #include "lockfile.h"
12 #include "cache-tree.h"
13 #include "color.h"
14 #include "dir.h"
15 #include "builtin.h"
16 #include "diff.h"
17 #include "diffcore.h"
18 #include "commit.h"
19 #include "revision.h"
20 #include "wt-status.h"
21 #include "run-command.h"
22 #include "refs.h"
23 #include "log-tree.h"
24 #include "strbuf.h"
25 #include "utf8.h"
26 #include "parse-options.h"
27 #include "string-list.h"
28 #include "rerere.h"
29 #include "unpack-trees.h"
30 #include "quote.h"
31 #include "submodule.h"
32 #include "gpg-interface.h"
33 #include "column.h"
34 #include "sequencer.h"
35 #include "mailmap.h"
36 #include "help.h"
37 #include "commit-reach.h"
38 #include "commit-graph.h"
40 static const char * const builtin_commit_usage[] = {
41 N_("git commit [<options>] [--] <pathspec>..."),
42 NULL
45 static const char * const builtin_status_usage[] = {
46 N_("git status [<options>] [--] <pathspec>..."),
47 NULL
50 static const char empty_amend_advice[] =
51 N_("You asked to amend the most recent commit, but doing so would make\n"
52 "it empty. You can repeat your command with --allow-empty, or you can\n"
53 "remove the commit entirely with \"git reset HEAD^\".\n");
55 static const char empty_cherry_pick_advice[] =
56 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
57 "If you wish to commit it anyway, use:\n"
58 "\n"
59 " git commit --allow-empty\n"
60 "\n");
62 static const char empty_rebase_pick_advice[] =
63 N_("Otherwise, please use 'git rebase --skip'\n");
65 static const char empty_cherry_pick_advice_single[] =
66 N_("Otherwise, please use 'git cherry-pick --skip'\n");
68 static const char empty_cherry_pick_advice_multi[] =
69 N_("and then use:\n"
70 "\n"
71 " git cherry-pick --continue\n"
72 "\n"
73 "to resume cherry-picking the remaining commits.\n"
74 "If you wish to skip this commit, use:\n"
75 "\n"
76 " git cherry-pick --skip\n"
77 "\n");
79 static const char *color_status_slots[] = {
80 [WT_STATUS_HEADER] = "header",
81 [WT_STATUS_UPDATED] = "updated",
82 [WT_STATUS_CHANGED] = "changed",
83 [WT_STATUS_UNTRACKED] = "untracked",
84 [WT_STATUS_NOBRANCH] = "noBranch",
85 [WT_STATUS_UNMERGED] = "unmerged",
86 [WT_STATUS_LOCAL_BRANCH] = "localBranch",
87 [WT_STATUS_REMOTE_BRANCH] = "remoteBranch",
88 [WT_STATUS_ONBRANCH] = "branch",
91 static const char *use_message_buffer;
92 static struct lock_file index_lock; /* real index */
93 static struct lock_file false_lock; /* used only for partial commits */
94 static enum {
95 COMMIT_AS_IS = 1,
96 COMMIT_NORMAL,
97 COMMIT_PARTIAL
98 } commit_style;
100 static const char *logfile, *force_author;
101 static const char *template_file;
103 * The _message variables are commit names from which to take
104 * the commit message and/or authorship.
106 static const char *author_message, *author_message_buffer;
107 static char *edit_message, *use_message;
108 static char *fixup_message, *squash_message;
109 static int all, also, interactive, patch_interactive, only, amend, signoff;
110 static int edit_flag = -1; /* unspecified */
111 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
112 static int config_commit_verbose = -1; /* unspecified */
113 static int no_post_rewrite, allow_empty_message, pathspec_file_nul;
114 static char *untracked_files_arg, *force_date, *ignore_submodule_arg, *ignored_arg;
115 static char *sign_commit, *pathspec_from_file;
118 * The default commit message cleanup mode will remove the lines
119 * beginning with # (shell comments) and leading and trailing
120 * whitespaces (empty lines or containing only whitespaces)
121 * if editor is used, and only the whitespaces if the message
122 * is specified explicitly.
124 static enum commit_msg_cleanup_mode cleanup_mode;
125 static const char *cleanup_arg;
127 static enum commit_whence whence;
128 static int use_editor = 1, include_status = 1;
129 static int have_option_m;
130 static struct strbuf message = STRBUF_INIT;
132 static enum wt_status_format status_format = STATUS_FORMAT_UNSPECIFIED;
134 static int opt_parse_porcelain(const struct option *opt, const char *arg, int unset)
136 enum wt_status_format *value = (enum wt_status_format *)opt->value;
137 if (unset)
138 *value = STATUS_FORMAT_NONE;
139 else if (!arg)
140 *value = STATUS_FORMAT_PORCELAIN;
141 else if (!strcmp(arg, "v1") || !strcmp(arg, "1"))
142 *value = STATUS_FORMAT_PORCELAIN;
143 else if (!strcmp(arg, "v2") || !strcmp(arg, "2"))
144 *value = STATUS_FORMAT_PORCELAIN_V2;
145 else
146 die("unsupported porcelain version '%s'", arg);
148 return 0;
151 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
153 struct strbuf *buf = opt->value;
154 if (unset) {
155 have_option_m = 0;
156 strbuf_setlen(buf, 0);
157 } else {
158 have_option_m = 1;
159 if (buf->len)
160 strbuf_addch(buf, '\n');
161 strbuf_addstr(buf, arg);
162 strbuf_complete_line(buf);
164 return 0;
167 static int opt_parse_rename_score(const struct option *opt, const char *arg, int unset)
169 const char **value = opt->value;
171 BUG_ON_OPT_NEG(unset);
173 if (arg != NULL && *arg == '=')
174 arg = arg + 1;
176 *value = arg;
177 return 0;
180 static void determine_whence(struct wt_status *s)
182 if (file_exists(git_path_merge_head(the_repository)))
183 whence = FROM_MERGE;
184 else if (!sequencer_determine_whence(the_repository, &whence))
185 whence = FROM_COMMIT;
186 if (s)
187 s->whence = whence;
190 static void status_init_config(struct wt_status *s, config_fn_t fn)
192 wt_status_prepare(the_repository, s);
193 init_diff_ui_defaults();
194 git_config(fn, s);
195 determine_whence(s);
196 s->hints = advice_status_hints; /* must come after git_config() */
199 static void rollback_index_files(void)
201 switch (commit_style) {
202 case COMMIT_AS_IS:
203 break; /* nothing to do */
204 case COMMIT_NORMAL:
205 rollback_lock_file(&index_lock);
206 break;
207 case COMMIT_PARTIAL:
208 rollback_lock_file(&index_lock);
209 rollback_lock_file(&false_lock);
210 break;
214 static int commit_index_files(void)
216 int err = 0;
218 switch (commit_style) {
219 case COMMIT_AS_IS:
220 break; /* nothing to do */
221 case COMMIT_NORMAL:
222 err = commit_lock_file(&index_lock);
223 break;
224 case COMMIT_PARTIAL:
225 err = commit_lock_file(&index_lock);
226 rollback_lock_file(&false_lock);
227 break;
230 return err;
234 * Take a union of paths in the index and the named tree (typically, "HEAD"),
235 * and return the paths that match the given pattern in list.
237 static int list_paths(struct string_list *list, const char *with_tree,
238 const struct pathspec *pattern)
240 int i, ret;
241 char *m;
243 if (!pattern->nr)
244 return 0;
246 m = xcalloc(1, pattern->nr);
248 if (with_tree) {
249 char *max_prefix = common_prefix(pattern);
250 overlay_tree_on_index(&the_index, with_tree, max_prefix);
251 free(max_prefix);
254 for (i = 0; i < active_nr; i++) {
255 const struct cache_entry *ce = active_cache[i];
256 struct string_list_item *item;
258 if (ce->ce_flags & CE_UPDATE)
259 continue;
260 if (!ce_path_match(&the_index, ce, pattern, m))
261 continue;
262 item = string_list_insert(list, ce->name);
263 if (ce_skip_worktree(ce))
264 item->util = item; /* better a valid pointer than a fake one */
267 ret = report_path_error(m, pattern);
268 free(m);
269 return ret;
272 static void add_remove_files(struct string_list *list)
274 int i;
275 for (i = 0; i < list->nr; i++) {
276 struct stat st;
277 struct string_list_item *p = &(list->items[i]);
279 /* p->util is skip-worktree */
280 if (p->util)
281 continue;
283 if (!lstat(p->string, &st)) {
284 if (add_to_cache(p->string, &st, 0))
285 die(_("updating files failed"));
286 } else
287 remove_file_from_cache(p->string);
291 static void create_base_index(const struct commit *current_head)
293 struct tree *tree;
294 struct unpack_trees_options opts;
295 struct tree_desc t;
297 if (!current_head) {
298 discard_cache();
299 return;
302 memset(&opts, 0, sizeof(opts));
303 opts.head_idx = 1;
304 opts.index_only = 1;
305 opts.merge = 1;
306 opts.src_index = &the_index;
307 opts.dst_index = &the_index;
309 opts.fn = oneway_merge;
310 tree = parse_tree_indirect(&current_head->object.oid);
311 if (!tree)
312 die(_("failed to unpack HEAD tree object"));
313 parse_tree(tree);
314 init_tree_desc(&t, tree->buffer, tree->size);
315 if (unpack_trees(1, &t, &opts))
316 exit(128); /* We've already reported the error, finish dying */
319 static void refresh_cache_or_die(int refresh_flags)
322 * refresh_flags contains REFRESH_QUIET, so the only errors
323 * are for unmerged entries.
325 if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
326 die_resolve_conflict("commit");
329 static const char *prepare_index(const char **argv, const char *prefix,
330 const struct commit *current_head, int is_status)
332 struct string_list partial = STRING_LIST_INIT_DUP;
333 struct pathspec pathspec;
334 int refresh_flags = REFRESH_QUIET;
335 const char *ret;
337 if (is_status)
338 refresh_flags |= REFRESH_UNMERGED;
339 parse_pathspec(&pathspec, 0,
340 PATHSPEC_PREFER_FULL,
341 prefix, argv);
343 if (pathspec_from_file) {
344 if (interactive)
345 die(_("--pathspec-from-file is incompatible with --interactive/--patch"));
347 if (all)
348 die(_("--pathspec-from-file with -a does not make sense"));
350 if (pathspec.nr)
351 die(_("--pathspec-from-file is incompatible with pathspec arguments"));
353 parse_pathspec_file(&pathspec, 0,
354 PATHSPEC_PREFER_FULL,
355 prefix, pathspec_from_file, pathspec_file_nul);
356 } else if (pathspec_file_nul) {
357 die(_("--pathspec-file-nul requires --pathspec-from-file"));
360 if (!pathspec.nr && (also || (only && !amend && !allow_empty)))
361 die(_("No paths with --include/--only does not make sense."));
363 if (read_cache_preload(&pathspec) < 0)
364 die(_("index file corrupt"));
366 if (interactive) {
367 char *old_index_env = NULL, *old_repo_index_file;
368 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
370 refresh_cache_or_die(refresh_flags);
372 if (write_locked_index(&the_index, &index_lock, 0))
373 die(_("unable to create temporary index"));
375 old_repo_index_file = the_repository->index_file;
376 the_repository->index_file =
377 (char *)get_lock_file_path(&index_lock);
378 old_index_env = xstrdup_or_null(getenv(INDEX_ENVIRONMENT));
379 setenv(INDEX_ENVIRONMENT, the_repository->index_file, 1);
381 if (interactive_add(argv, prefix, patch_interactive) != 0)
382 die(_("interactive add failed"));
384 the_repository->index_file = old_repo_index_file;
385 if (old_index_env && *old_index_env)
386 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
387 else
388 unsetenv(INDEX_ENVIRONMENT);
389 FREE_AND_NULL(old_index_env);
391 discard_cache();
392 read_cache_from(get_lock_file_path(&index_lock));
393 if (update_main_cache_tree(WRITE_TREE_SILENT) == 0) {
394 if (reopen_lock_file(&index_lock) < 0)
395 die(_("unable to write index file"));
396 if (write_locked_index(&the_index, &index_lock, 0))
397 die(_("unable to update temporary index"));
398 } else
399 warning(_("Failed to update main cache tree"));
401 commit_style = COMMIT_NORMAL;
402 ret = get_lock_file_path(&index_lock);
403 goto out;
407 * Non partial, non as-is commit.
409 * (1) get the real index;
410 * (2) update the_index as necessary;
411 * (3) write the_index out to the real index (still locked);
412 * (4) return the name of the locked index file.
414 * The caller should run hooks on the locked real index, and
415 * (A) if all goes well, commit the real index;
416 * (B) on failure, rollback the real index.
418 if (all || (also && pathspec.nr)) {
419 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
420 add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
421 refresh_cache_or_die(refresh_flags);
422 update_main_cache_tree(WRITE_TREE_SILENT);
423 if (write_locked_index(&the_index, &index_lock, 0))
424 die(_("unable to write new_index file"));
425 commit_style = COMMIT_NORMAL;
426 ret = get_lock_file_path(&index_lock);
427 goto out;
431 * As-is commit.
433 * (1) return the name of the real index file.
435 * The caller should run hooks on the real index,
436 * and create commit from the_index.
437 * We still need to refresh the index here.
439 if (!only && !pathspec.nr) {
440 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
441 refresh_cache_or_die(refresh_flags);
442 if (active_cache_changed
443 || !cache_tree_fully_valid(active_cache_tree))
444 update_main_cache_tree(WRITE_TREE_SILENT);
445 if (write_locked_index(&the_index, &index_lock,
446 COMMIT_LOCK | SKIP_IF_UNCHANGED))
447 die(_("unable to write new_index file"));
448 commit_style = COMMIT_AS_IS;
449 ret = get_index_file();
450 goto out;
454 * A partial commit.
456 * (0) find the set of affected paths;
457 * (1) get lock on the real index file;
458 * (2) update the_index with the given paths;
459 * (3) write the_index out to the real index (still locked);
460 * (4) get lock on the false index file;
461 * (5) reset the_index from HEAD;
462 * (6) update the_index the same way as (2);
463 * (7) write the_index out to the false index file;
464 * (8) return the name of the false index file (still locked);
466 * The caller should run hooks on the locked false index, and
467 * create commit from it. Then
468 * (A) if all goes well, commit the real index;
469 * (B) on failure, rollback the real index;
470 * In either case, rollback the false index.
472 commit_style = COMMIT_PARTIAL;
474 if (whence != FROM_COMMIT) {
475 if (whence == FROM_MERGE)
476 die(_("cannot do a partial commit during a merge."));
477 else if (is_from_cherry_pick(whence))
478 die(_("cannot do a partial commit during a cherry-pick."));
479 else if (is_from_rebase(whence))
480 die(_("cannot do a partial commit during a rebase."));
483 if (list_paths(&partial, !current_head ? NULL : "HEAD", &pathspec))
484 exit(1);
486 discard_cache();
487 if (read_cache() < 0)
488 die(_("cannot read the index"));
490 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
491 add_remove_files(&partial);
492 refresh_cache(REFRESH_QUIET);
493 update_main_cache_tree(WRITE_TREE_SILENT);
494 if (write_locked_index(&the_index, &index_lock, 0))
495 die(_("unable to write new_index file"));
497 hold_lock_file_for_update(&false_lock,
498 git_path("next-index-%"PRIuMAX,
499 (uintmax_t) getpid()),
500 LOCK_DIE_ON_ERROR);
502 create_base_index(current_head);
503 add_remove_files(&partial);
504 refresh_cache(REFRESH_QUIET);
506 if (write_locked_index(&the_index, &false_lock, 0))
507 die(_("unable to write temporary index file"));
509 discard_cache();
510 ret = get_lock_file_path(&false_lock);
511 read_cache_from(ret);
512 out:
513 string_list_clear(&partial, 0);
514 clear_pathspec(&pathspec);
515 return ret;
518 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
519 struct wt_status *s)
521 struct object_id oid;
523 if (s->relative_paths)
524 s->prefix = prefix;
526 if (amend) {
527 s->amend = 1;
528 s->reference = "HEAD^1";
530 s->verbose = verbose;
531 s->index_file = index_file;
532 s->fp = fp;
533 s->nowarn = nowarn;
534 s->is_initial = get_oid(s->reference, &oid) ? 1 : 0;
535 if (!s->is_initial)
536 oidcpy(&s->oid_commit, &oid);
537 s->status_format = status_format;
538 s->ignore_submodule_arg = ignore_submodule_arg;
540 wt_status_collect(s);
541 wt_status_print(s);
542 wt_status_collect_free_buffers(s);
544 return s->committable;
547 static int is_a_merge(const struct commit *current_head)
549 return !!(current_head->parents && current_head->parents->next);
552 static void assert_split_ident(struct ident_split *id, const struct strbuf *buf)
554 if (split_ident_line(id, buf->buf, buf->len) || !id->date_begin)
555 BUG("unable to parse our own ident: %s", buf->buf);
558 static void export_one(const char *var, const char *s, const char *e, int hack)
560 struct strbuf buf = STRBUF_INIT;
561 if (hack)
562 strbuf_addch(&buf, hack);
563 strbuf_add(&buf, s, e - s);
564 setenv(var, buf.buf, 1);
565 strbuf_release(&buf);
568 static int parse_force_date(const char *in, struct strbuf *out)
570 strbuf_addch(out, '@');
572 if (parse_date(in, out) < 0) {
573 int errors = 0;
574 unsigned long t = approxidate_careful(in, &errors);
575 if (errors)
576 return -1;
577 strbuf_addf(out, "%lu", t);
580 return 0;
583 static void set_ident_var(char **buf, char *val)
585 free(*buf);
586 *buf = val;
589 static void determine_author_info(struct strbuf *author_ident)
591 char *name, *email, *date;
592 struct ident_split author;
594 name = xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
595 email = xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
596 date = xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
598 if (author_message) {
599 struct ident_split ident;
600 size_t len;
601 const char *a;
603 a = find_commit_header(author_message_buffer, "author", &len);
604 if (!a)
605 die(_("commit '%s' lacks author header"), author_message);
606 if (split_ident_line(&ident, a, len) < 0)
607 die(_("commit '%s' has malformed author line"), author_message);
609 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
610 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
612 if (ident.date_begin) {
613 struct strbuf date_buf = STRBUF_INIT;
614 strbuf_addch(&date_buf, '@');
615 strbuf_add(&date_buf, ident.date_begin, ident.date_end - ident.date_begin);
616 strbuf_addch(&date_buf, ' ');
617 strbuf_add(&date_buf, ident.tz_begin, ident.tz_end - ident.tz_begin);
618 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
622 if (force_author) {
623 struct ident_split ident;
625 if (split_ident_line(&ident, force_author, strlen(force_author)) < 0)
626 die(_("malformed --author parameter"));
627 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
628 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
631 if (force_date) {
632 struct strbuf date_buf = STRBUF_INIT;
633 if (parse_force_date(force_date, &date_buf))
634 die(_("invalid date format: %s"), force_date);
635 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
638 strbuf_addstr(author_ident, fmt_ident(name, email, WANT_AUTHOR_IDENT, date,
639 IDENT_STRICT));
640 assert_split_ident(&author, author_ident);
641 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
642 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
643 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
644 free(name);
645 free(email);
646 free(date);
649 static int author_date_is_interesting(void)
651 return author_message || force_date;
654 static void adjust_comment_line_char(const struct strbuf *sb)
656 char candidates[] = "#;@!$%^&|:";
657 char *candidate;
658 const char *p;
660 comment_line_char = candidates[0];
661 if (!memchr(sb->buf, comment_line_char, sb->len))
662 return;
664 p = sb->buf;
665 candidate = strchr(candidates, *p);
666 if (candidate)
667 *candidate = ' ';
668 for (p = sb->buf; *p; p++) {
669 if ((p[0] == '\n' || p[0] == '\r') && p[1]) {
670 candidate = strchr(candidates, p[1]);
671 if (candidate)
672 *candidate = ' ';
676 for (p = candidates; *p == ' '; p++)
678 if (!*p)
679 die(_("unable to select a comment character that is not used\n"
680 "in the current commit message"));
681 comment_line_char = *p;
684 static int prepare_to_commit(const char *index_file, const char *prefix,
685 struct commit *current_head,
686 struct wt_status *s,
687 struct strbuf *author_ident)
689 struct stat statbuf;
690 struct strbuf committer_ident = STRBUF_INIT;
691 int committable;
692 struct strbuf sb = STRBUF_INIT;
693 const char *hook_arg1 = NULL;
694 const char *hook_arg2 = NULL;
695 int clean_message_contents = (cleanup_mode != COMMIT_MSG_CLEANUP_NONE);
696 int old_display_comment_prefix;
697 int merge_contains_scissors = 0;
699 /* This checks and barfs if author is badly specified */
700 determine_author_info(author_ident);
702 if (!no_verify && run_commit_hook(use_editor, index_file, "pre-commit", NULL))
703 return 0;
705 if (squash_message) {
707 * Insert the proper subject line before other commit
708 * message options add their content.
710 if (use_message && !strcmp(use_message, squash_message))
711 strbuf_addstr(&sb, "squash! ");
712 else {
713 struct pretty_print_context ctx = {0};
714 struct commit *c;
715 c = lookup_commit_reference_by_name(squash_message);
716 if (!c)
717 die(_("could not lookup commit %s"), squash_message);
718 ctx.output_encoding = get_commit_output_encoding();
719 format_commit_message(c, "squash! %s\n\n", &sb,
720 &ctx);
724 if (have_option_m && !fixup_message) {
725 strbuf_addbuf(&sb, &message);
726 hook_arg1 = "message";
727 } else if (logfile && !strcmp(logfile, "-")) {
728 if (isatty(0))
729 fprintf(stderr, _("(reading log message from standard input)\n"));
730 if (strbuf_read(&sb, 0, 0) < 0)
731 die_errno(_("could not read log from standard input"));
732 hook_arg1 = "message";
733 } else if (logfile) {
734 if (strbuf_read_file(&sb, logfile, 0) < 0)
735 die_errno(_("could not read log file '%s'"),
736 logfile);
737 hook_arg1 = "message";
738 } else if (use_message) {
739 char *buffer;
740 buffer = strstr(use_message_buffer, "\n\n");
741 if (buffer)
742 strbuf_addstr(&sb, skip_blank_lines(buffer + 2));
743 hook_arg1 = "commit";
744 hook_arg2 = use_message;
745 } else if (fixup_message) {
746 struct pretty_print_context ctx = {0};
747 struct commit *commit;
748 commit = lookup_commit_reference_by_name(fixup_message);
749 if (!commit)
750 die(_("could not lookup commit %s"), fixup_message);
751 ctx.output_encoding = get_commit_output_encoding();
752 format_commit_message(commit, "fixup! %s\n\n",
753 &sb, &ctx);
754 if (have_option_m)
755 strbuf_addbuf(&sb, &message);
756 hook_arg1 = "message";
757 } else if (!stat(git_path_merge_msg(the_repository), &statbuf)) {
758 size_t merge_msg_start;
761 * prepend SQUASH_MSG here if it exists and a
762 * "merge --squash" was originally performed
764 if (!stat(git_path_squash_msg(the_repository), &statbuf)) {
765 if (strbuf_read_file(&sb, git_path_squash_msg(the_repository), 0) < 0)
766 die_errno(_("could not read SQUASH_MSG"));
767 hook_arg1 = "squash";
768 } else
769 hook_arg1 = "merge";
771 merge_msg_start = sb.len;
772 if (strbuf_read_file(&sb, git_path_merge_msg(the_repository), 0) < 0)
773 die_errno(_("could not read MERGE_MSG"));
775 if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS &&
776 wt_status_locate_end(sb.buf + merge_msg_start,
777 sb.len - merge_msg_start) <
778 sb.len - merge_msg_start)
779 merge_contains_scissors = 1;
780 } else if (!stat(git_path_squash_msg(the_repository), &statbuf)) {
781 if (strbuf_read_file(&sb, git_path_squash_msg(the_repository), 0) < 0)
782 die_errno(_("could not read SQUASH_MSG"));
783 hook_arg1 = "squash";
784 } else if (template_file) {
785 if (strbuf_read_file(&sb, template_file, 0) < 0)
786 die_errno(_("could not read '%s'"), template_file);
787 hook_arg1 = "template";
788 clean_message_contents = 0;
792 * The remaining cases don't modify the template message, but
793 * just set the argument(s) to the prepare-commit-msg hook.
795 else if (whence == FROM_MERGE)
796 hook_arg1 = "merge";
797 else if (is_from_cherry_pick(whence) || whence == FROM_REBASE_PICK) {
798 hook_arg1 = "commit";
799 hook_arg2 = "CHERRY_PICK_HEAD";
802 if (squash_message) {
804 * If squash_commit was used for the commit subject,
805 * then we're possibly hijacking other commit log options.
806 * Reset the hook args to tell the real story.
808 hook_arg1 = "message";
809 hook_arg2 = "";
812 s->fp = fopen_for_writing(git_path_commit_editmsg());
813 if (s->fp == NULL)
814 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
816 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
817 old_display_comment_prefix = s->display_comment_prefix;
818 s->display_comment_prefix = 1;
821 * Most hints are counter-productive when the commit has
822 * already started.
824 s->hints = 0;
826 if (clean_message_contents)
827 strbuf_stripspace(&sb, 0);
829 if (signoff)
830 append_signoff(&sb, ignore_non_trailer(sb.buf, sb.len), 0);
832 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
833 die_errno(_("could not write commit template"));
835 if (auto_comment_line_char)
836 adjust_comment_line_char(&sb);
837 strbuf_release(&sb);
839 /* This checks if committer ident is explicitly given */
840 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
841 if (use_editor && include_status) {
842 int ident_shown = 0;
843 int saved_color_setting;
844 struct ident_split ci, ai;
846 if (whence != FROM_COMMIT) {
847 if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS &&
848 !merge_contains_scissors)
849 wt_status_add_cut_line(s->fp);
850 status_printf_ln(
851 s, GIT_COLOR_NORMAL,
852 whence == FROM_MERGE ?
853 _("\n"
854 "It looks like you may be committing a merge.\n"
855 "If this is not correct, please run\n"
856 " git update-ref -d MERGE_HEAD\n"
857 "and try again.\n") :
858 _("\n"
859 "It looks like you may be committing a cherry-pick.\n"
860 "If this is not correct, please run\n"
861 " git update-ref -d CHERRY_PICK_HEAD\n"
862 "and try again.\n"));
865 fprintf(s->fp, "\n");
866 if (cleanup_mode == COMMIT_MSG_CLEANUP_ALL)
867 status_printf(s, GIT_COLOR_NORMAL,
868 _("Please enter the commit message for your changes."
869 " Lines starting\nwith '%c' will be ignored, and an empty"
870 " message aborts the commit.\n"), comment_line_char);
871 else if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS) {
872 if (whence == FROM_COMMIT && !merge_contains_scissors)
873 wt_status_add_cut_line(s->fp);
874 } else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
875 status_printf(s, GIT_COLOR_NORMAL,
876 _("Please enter the commit message for your changes."
877 " Lines starting\n"
878 "with '%c' will be kept; you may remove them"
879 " yourself if you want to.\n"
880 "An empty message aborts the commit.\n"), comment_line_char);
883 * These should never fail because they come from our own
884 * fmt_ident. They may fail the sane_ident test, but we know
885 * that the name and mail pointers will at least be valid,
886 * which is enough for our tests and printing here.
888 assert_split_ident(&ai, author_ident);
889 assert_split_ident(&ci, &committer_ident);
891 if (ident_cmp(&ai, &ci))
892 status_printf_ln(s, GIT_COLOR_NORMAL,
893 _("%s"
894 "Author: %.*s <%.*s>"),
895 ident_shown++ ? "" : "\n",
896 (int)(ai.name_end - ai.name_begin), ai.name_begin,
897 (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);
899 if (author_date_is_interesting())
900 status_printf_ln(s, GIT_COLOR_NORMAL,
901 _("%s"
902 "Date: %s"),
903 ident_shown++ ? "" : "\n",
904 show_ident_date(&ai, DATE_MODE(NORMAL)));
906 if (!committer_ident_sufficiently_given())
907 status_printf_ln(s, GIT_COLOR_NORMAL,
908 _("%s"
909 "Committer: %.*s <%.*s>"),
910 ident_shown++ ? "" : "\n",
911 (int)(ci.name_end - ci.name_begin), ci.name_begin,
912 (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
914 status_printf_ln(s, GIT_COLOR_NORMAL, "%s", ""); /* Add new line for clarity */
916 saved_color_setting = s->use_color;
917 s->use_color = 0;
918 committable = run_status(s->fp, index_file, prefix, 1, s);
919 s->use_color = saved_color_setting;
920 string_list_clear(&s->change, 1);
921 } else {
922 struct object_id oid;
923 const char *parent = "HEAD";
925 if (!active_nr && read_cache() < 0)
926 die(_("Cannot read index"));
928 if (amend)
929 parent = "HEAD^1";
931 if (get_oid(parent, &oid)) {
932 int i, ita_nr = 0;
934 for (i = 0; i < active_nr; i++)
935 if (ce_intent_to_add(active_cache[i]))
936 ita_nr++;
937 committable = active_nr - ita_nr > 0;
938 } else {
940 * Unless the user did explicitly request a submodule
941 * ignore mode by passing a command line option we do
942 * not ignore any changed submodule SHA-1s when
943 * comparing index and parent, no matter what is
944 * configured. Otherwise we won't commit any
945 * submodules which were manually staged, which would
946 * be really confusing.
948 struct diff_flags flags = DIFF_FLAGS_INIT;
949 flags.override_submodule_config = 1;
950 if (ignore_submodule_arg &&
951 !strcmp(ignore_submodule_arg, "all"))
952 flags.ignore_submodules = 1;
953 committable = index_differs_from(the_repository,
954 parent, &flags, 1);
957 strbuf_release(&committer_ident);
959 fclose(s->fp);
962 * Reject an attempt to record a non-merge empty commit without
963 * explicit --allow-empty. In the cherry-pick case, it may be
964 * empty due to conflict resolution, which the user should okay.
966 if (!committable && whence != FROM_MERGE && !allow_empty &&
967 !(amend && is_a_merge(current_head))) {
968 s->hints = advice_status_hints;
969 s->display_comment_prefix = old_display_comment_prefix;
970 run_status(stdout, index_file, prefix, 0, s);
971 if (amend)
972 fputs(_(empty_amend_advice), stderr);
973 else if (is_from_cherry_pick(whence) ||
974 whence == FROM_REBASE_PICK) {
975 fputs(_(empty_cherry_pick_advice), stderr);
976 if (whence == FROM_CHERRY_PICK_SINGLE)
977 fputs(_(empty_cherry_pick_advice_single), stderr);
978 else if (whence == FROM_CHERRY_PICK_MULTI)
979 fputs(_(empty_cherry_pick_advice_multi), stderr);
980 else
981 fputs(_(empty_rebase_pick_advice), stderr);
983 return 0;
986 if (!no_verify && find_hook("pre-commit")) {
988 * Re-read the index as pre-commit hook could have updated it,
989 * and write it out as a tree. We must do this before we invoke
990 * the editor and after we invoke run_status above.
992 discard_cache();
994 read_cache_from(index_file);
996 if (update_main_cache_tree(0)) {
997 error(_("Error building trees"));
998 return 0;
1001 if (run_commit_hook(use_editor, index_file, "prepare-commit-msg",
1002 git_path_commit_editmsg(), hook_arg1, hook_arg2, NULL))
1003 return 0;
1005 if (use_editor) {
1006 struct strvec env = STRVEC_INIT;
1008 strvec_pushf(&env, "GIT_INDEX_FILE=%s", index_file);
1009 if (launch_editor(git_path_commit_editmsg(), NULL, env.v)) {
1010 fprintf(stderr,
1011 _("Please supply the message using either -m or -F option.\n"));
1012 exit(1);
1014 strvec_clear(&env);
1017 if (!no_verify &&
1018 run_commit_hook(use_editor, index_file, "commit-msg", git_path_commit_editmsg(), NULL)) {
1019 return 0;
1022 return 1;
1025 static const char *find_author_by_nickname(const char *name)
1027 struct rev_info revs;
1028 struct commit *commit;
1029 struct strbuf buf = STRBUF_INIT;
1030 struct string_list mailmap = STRING_LIST_INIT_NODUP;
1031 const char *av[20];
1032 int ac = 0;
1034 repo_init_revisions(the_repository, &revs, NULL);
1035 strbuf_addf(&buf, "--author=%s", name);
1036 av[++ac] = "--all";
1037 av[++ac] = "-i";
1038 av[++ac] = buf.buf;
1039 av[++ac] = NULL;
1040 setup_revisions(ac, av, &revs, NULL);
1041 revs.mailmap = &mailmap;
1042 read_mailmap(revs.mailmap, NULL);
1044 if (prepare_revision_walk(&revs))
1045 die(_("revision walk setup failed"));
1046 commit = get_revision(&revs);
1047 if (commit) {
1048 struct pretty_print_context ctx = {0};
1049 ctx.date_mode.type = DATE_NORMAL;
1050 strbuf_release(&buf);
1051 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
1052 clear_mailmap(&mailmap);
1053 return strbuf_detach(&buf, NULL);
1055 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name);
1058 static void handle_ignored_arg(struct wt_status *s)
1060 if (!ignored_arg)
1061 ; /* default already initialized */
1062 else if (!strcmp(ignored_arg, "traditional"))
1063 s->show_ignored_mode = SHOW_TRADITIONAL_IGNORED;
1064 else if (!strcmp(ignored_arg, "no"))
1065 s->show_ignored_mode = SHOW_NO_IGNORED;
1066 else if (!strcmp(ignored_arg, "matching"))
1067 s->show_ignored_mode = SHOW_MATCHING_IGNORED;
1068 else
1069 die(_("Invalid ignored mode '%s'"), ignored_arg);
1072 static void handle_untracked_files_arg(struct wt_status *s)
1074 if (!untracked_files_arg)
1075 ; /* default already initialized */
1076 else if (!strcmp(untracked_files_arg, "no"))
1077 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1078 else if (!strcmp(untracked_files_arg, "normal"))
1079 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1080 else if (!strcmp(untracked_files_arg, "all"))
1081 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1083 * Please update $__git_untracked_file_modes in
1084 * git-completion.bash when you add new options
1086 else
1087 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1090 static const char *read_commit_message(const char *name)
1092 const char *out_enc;
1093 struct commit *commit;
1095 commit = lookup_commit_reference_by_name(name);
1096 if (!commit)
1097 die(_("could not lookup commit %s"), name);
1098 out_enc = get_commit_output_encoding();
1099 return logmsg_reencode(commit, NULL, out_enc);
1103 * Enumerate what needs to be propagated when --porcelain
1104 * is not in effect here.
1106 static struct status_deferred_config {
1107 enum wt_status_format status_format;
1108 int show_branch;
1109 enum ahead_behind_flags ahead_behind;
1110 } status_deferred_config = {
1111 STATUS_FORMAT_UNSPECIFIED,
1112 -1, /* unspecified */
1113 AHEAD_BEHIND_UNSPECIFIED,
1116 static void finalize_deferred_config(struct wt_status *s)
1118 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1119 status_format != STATUS_FORMAT_PORCELAIN_V2 &&
1120 !s->null_termination);
1122 if (s->null_termination) {
1123 if (status_format == STATUS_FORMAT_NONE ||
1124 status_format == STATUS_FORMAT_UNSPECIFIED)
1125 status_format = STATUS_FORMAT_PORCELAIN;
1126 else if (status_format == STATUS_FORMAT_LONG)
1127 die(_("--long and -z are incompatible"));
1130 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1131 status_format = status_deferred_config.status_format;
1132 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1133 status_format = STATUS_FORMAT_NONE;
1135 if (use_deferred_config && s->show_branch < 0)
1136 s->show_branch = status_deferred_config.show_branch;
1137 if (s->show_branch < 0)
1138 s->show_branch = 0;
1141 * If the user did not give a "--[no]-ahead-behind" command
1142 * line argument *AND* we will print in a human-readable format
1143 * (short, long etc.) then we inherit from the status.aheadbehind
1144 * config setting. In all other cases (and porcelain V[12] formats
1145 * in particular), we inherit _FULL for backwards compatibility.
1147 if (use_deferred_config &&
1148 s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
1149 s->ahead_behind_flags = status_deferred_config.ahead_behind;
1151 if (s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
1152 s->ahead_behind_flags = AHEAD_BEHIND_FULL;
1155 static int parse_and_validate_options(int argc, const char *argv[],
1156 const struct option *options,
1157 const char * const usage[],
1158 const char *prefix,
1159 struct commit *current_head,
1160 struct wt_status *s)
1162 int f = 0;
1164 argc = parse_options(argc, argv, prefix, options, usage, 0);
1165 finalize_deferred_config(s);
1167 if (force_author && !strchr(force_author, '>'))
1168 force_author = find_author_by_nickname(force_author);
1170 if (force_author && renew_authorship)
1171 die(_("Using both --reset-author and --author does not make sense"));
1173 if (logfile || have_option_m || use_message || fixup_message)
1174 use_editor = 0;
1175 if (0 <= edit_flag)
1176 use_editor = edit_flag;
1178 /* Sanity check options */
1179 if (amend && !current_head)
1180 die(_("You have nothing to amend."));
1181 if (amend && whence != FROM_COMMIT) {
1182 if (whence == FROM_MERGE)
1183 die(_("You are in the middle of a merge -- cannot amend."));
1184 else if (is_from_cherry_pick(whence))
1185 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1186 else if (whence == FROM_REBASE_PICK)
1187 die(_("You are in the middle of a rebase -- cannot amend."));
1189 if (fixup_message && squash_message)
1190 die(_("Options --squash and --fixup cannot be used together"));
1191 if (use_message)
1192 f++;
1193 if (edit_message)
1194 f++;
1195 if (fixup_message)
1196 f++;
1197 if (logfile)
1198 f++;
1199 if (f > 1)
1200 die(_("Only one of -c/-C/-F/--fixup can be used."));
1201 if (have_option_m && (edit_message || use_message || logfile))
1202 die((_("Option -m cannot be combined with -c/-C/-F.")));
1203 if (f || have_option_m)
1204 template_file = NULL;
1205 if (edit_message)
1206 use_message = edit_message;
1207 if (amend && !use_message && !fixup_message)
1208 use_message = "HEAD";
1209 if (!use_message && !is_from_cherry_pick(whence) &&
1210 !is_from_rebase(whence) && renew_authorship)
1211 die(_("--reset-author can be used only with -C, -c or --amend."));
1212 if (use_message) {
1213 use_message_buffer = read_commit_message(use_message);
1214 if (!renew_authorship) {
1215 author_message = use_message;
1216 author_message_buffer = use_message_buffer;
1219 if ((is_from_cherry_pick(whence) || whence == FROM_REBASE_PICK) &&
1220 !renew_authorship) {
1221 author_message = "CHERRY_PICK_HEAD";
1222 author_message_buffer = read_commit_message(author_message);
1225 if (patch_interactive)
1226 interactive = 1;
1228 if (also + only + all + interactive > 1)
1229 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1230 cleanup_mode = get_cleanup_mode(cleanup_arg, use_editor);
1232 handle_untracked_files_arg(s);
1234 if (all && argc > 0)
1235 die(_("paths '%s ...' with -a does not make sense"),
1236 argv[0]);
1238 if (status_format != STATUS_FORMAT_NONE)
1239 dry_run = 1;
1241 return argc;
1244 static int dry_run_commit(const char **argv, const char *prefix,
1245 const struct commit *current_head, struct wt_status *s)
1247 int committable;
1248 const char *index_file;
1250 index_file = prepare_index(argv, prefix, current_head, 1);
1251 committable = run_status(stdout, index_file, prefix, 0, s);
1252 rollback_index_files();
1254 return committable ? 0 : 1;
1257 define_list_config_array_extra(color_status_slots, {"added"});
1259 static int parse_status_slot(const char *slot)
1261 if (!strcasecmp(slot, "added"))
1262 return WT_STATUS_UPDATED;
1264 return LOOKUP_CONFIG(color_status_slots, slot);
1267 static int git_status_config(const char *k, const char *v, void *cb)
1269 struct wt_status *s = cb;
1270 const char *slot_name;
1272 if (starts_with(k, "column."))
1273 return git_column_config(k, v, "status", &s->colopts);
1274 if (!strcmp(k, "status.submodulesummary")) {
1275 int is_bool;
1276 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1277 if (is_bool && s->submodule_summary)
1278 s->submodule_summary = -1;
1279 return 0;
1281 if (!strcmp(k, "status.short")) {
1282 if (git_config_bool(k, v))
1283 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1284 else
1285 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1286 return 0;
1288 if (!strcmp(k, "status.branch")) {
1289 status_deferred_config.show_branch = git_config_bool(k, v);
1290 return 0;
1292 if (!strcmp(k, "status.aheadbehind")) {
1293 status_deferred_config.ahead_behind = git_config_bool(k, v);
1294 return 0;
1296 if (!strcmp(k, "status.showstash")) {
1297 s->show_stash = git_config_bool(k, v);
1298 return 0;
1300 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1301 s->use_color = git_config_colorbool(k, v);
1302 return 0;
1304 if (!strcmp(k, "status.displaycommentprefix")) {
1305 s->display_comment_prefix = git_config_bool(k, v);
1306 return 0;
1308 if (skip_prefix(k, "status.color.", &slot_name) ||
1309 skip_prefix(k, "color.status.", &slot_name)) {
1310 int slot = parse_status_slot(slot_name);
1311 if (slot < 0)
1312 return 0;
1313 if (!v)
1314 return config_error_nonbool(k);
1315 return color_parse(v, s->color_palette[slot]);
1317 if (!strcmp(k, "status.relativepaths")) {
1318 s->relative_paths = git_config_bool(k, v);
1319 return 0;
1321 if (!strcmp(k, "status.showuntrackedfiles")) {
1322 if (!v)
1323 return config_error_nonbool(k);
1324 else if (!strcmp(v, "no"))
1325 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1326 else if (!strcmp(v, "normal"))
1327 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1328 else if (!strcmp(v, "all"))
1329 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1330 else
1331 return error(_("Invalid untracked files mode '%s'"), v);
1332 return 0;
1334 if (!strcmp(k, "diff.renamelimit")) {
1335 if (s->rename_limit == -1)
1336 s->rename_limit = git_config_int(k, v);
1337 return 0;
1339 if (!strcmp(k, "status.renamelimit")) {
1340 s->rename_limit = git_config_int(k, v);
1341 return 0;
1343 if (!strcmp(k, "diff.renames")) {
1344 if (s->detect_rename == -1)
1345 s->detect_rename = git_config_rename(k, v);
1346 return 0;
1348 if (!strcmp(k, "status.renames")) {
1349 s->detect_rename = git_config_rename(k, v);
1350 return 0;
1352 return git_diff_ui_config(k, v, NULL);
1355 int cmd_status(int argc, const char **argv, const char *prefix)
1357 static int no_renames = -1;
1358 static const char *rename_score_arg = (const char *)-1;
1359 static struct wt_status s;
1360 unsigned int progress_flag = 0;
1361 int fd;
1362 struct object_id oid;
1363 static struct option builtin_status_options[] = {
1364 OPT__VERBOSE(&verbose, N_("be verbose")),
1365 OPT_SET_INT('s', "short", &status_format,
1366 N_("show status concisely"), STATUS_FORMAT_SHORT),
1367 OPT_BOOL('b', "branch", &s.show_branch,
1368 N_("show branch information")),
1369 OPT_BOOL(0, "show-stash", &s.show_stash,
1370 N_("show stash information")),
1371 OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
1372 N_("compute full ahead/behind values")),
1373 OPT_CALLBACK_F(0, "porcelain", &status_format,
1374 N_("version"), N_("machine-readable output"),
1375 PARSE_OPT_OPTARG, opt_parse_porcelain),
1376 OPT_SET_INT(0, "long", &status_format,
1377 N_("show status in long format (default)"),
1378 STATUS_FORMAT_LONG),
1379 OPT_BOOL('z', "null", &s.null_termination,
1380 N_("terminate entries with NUL")),
1381 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1382 N_("mode"),
1383 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1384 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1385 { OPTION_STRING, 0, "ignored", &ignored_arg,
1386 N_("mode"),
1387 N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1388 PARSE_OPT_OPTARG, NULL, (intptr_t)"traditional" },
1389 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1390 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1391 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1392 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1393 OPT_BOOL(0, "no-renames", &no_renames, N_("do not detect renames")),
1394 OPT_CALLBACK_F('M', "find-renames", &rename_score_arg,
1395 N_("n"), N_("detect renames, optionally set similarity index"),
1396 PARSE_OPT_OPTARG | PARSE_OPT_NONEG, opt_parse_rename_score),
1397 OPT_END(),
1400 if (argc == 2 && !strcmp(argv[1], "-h"))
1401 usage_with_options(builtin_status_usage, builtin_status_options);
1403 status_init_config(&s, git_status_config);
1404 argc = parse_options(argc, argv, prefix,
1405 builtin_status_options,
1406 builtin_status_usage, 0);
1407 finalize_colopts(&s.colopts, -1);
1408 finalize_deferred_config(&s);
1410 handle_untracked_files_arg(&s);
1411 handle_ignored_arg(&s);
1413 if (s.show_ignored_mode == SHOW_MATCHING_IGNORED &&
1414 s.show_untracked_files == SHOW_NO_UNTRACKED_FILES)
1415 die(_("Unsupported combination of ignored and untracked-files arguments"));
1417 parse_pathspec(&s.pathspec, 0,
1418 PATHSPEC_PREFER_FULL,
1419 prefix, argv);
1421 if (status_format != STATUS_FORMAT_PORCELAIN &&
1422 status_format != STATUS_FORMAT_PORCELAIN_V2)
1423 progress_flag = REFRESH_PROGRESS;
1424 repo_read_index(the_repository);
1425 refresh_index(&the_index,
1426 REFRESH_QUIET|REFRESH_UNMERGED|progress_flag,
1427 &s.pathspec, NULL, NULL);
1429 if (use_optional_locks())
1430 fd = hold_locked_index(&index_lock, 0);
1431 else
1432 fd = -1;
1434 s.is_initial = get_oid(s.reference, &oid) ? 1 : 0;
1435 if (!s.is_initial)
1436 oidcpy(&s.oid_commit, &oid);
1438 s.ignore_submodule_arg = ignore_submodule_arg;
1439 s.status_format = status_format;
1440 s.verbose = verbose;
1441 if (no_renames != -1)
1442 s.detect_rename = !no_renames;
1443 if ((intptr_t)rename_score_arg != -1) {
1444 if (s.detect_rename < DIFF_DETECT_RENAME)
1445 s.detect_rename = DIFF_DETECT_RENAME;
1446 if (rename_score_arg)
1447 s.rename_score = parse_rename_score(&rename_score_arg);
1450 wt_status_collect(&s);
1452 if (0 <= fd)
1453 repo_update_index_if_able(the_repository, &index_lock);
1455 if (s.relative_paths)
1456 s.prefix = prefix;
1458 wt_status_print(&s);
1459 wt_status_collect_free_buffers(&s);
1461 return 0;
1464 static int git_commit_config(const char *k, const char *v, void *cb)
1466 struct wt_status *s = cb;
1467 int status;
1469 if (!strcmp(k, "commit.template"))
1470 return git_config_pathname(&template_file, k, v);
1471 if (!strcmp(k, "commit.status")) {
1472 include_status = git_config_bool(k, v);
1473 return 0;
1475 if (!strcmp(k, "commit.cleanup"))
1476 return git_config_string(&cleanup_arg, k, v);
1477 if (!strcmp(k, "commit.gpgsign")) {
1478 sign_commit = git_config_bool(k, v) ? "" : NULL;
1479 return 0;
1481 if (!strcmp(k, "commit.verbose")) {
1482 int is_bool;
1483 config_commit_verbose = git_config_bool_or_int(k, v, &is_bool);
1484 return 0;
1487 status = git_gpg_config(k, v, NULL);
1488 if (status)
1489 return status;
1490 return git_status_config(k, v, s);
1493 int cmd_commit(int argc, const char **argv, const char *prefix)
1495 static struct wt_status s;
1496 static struct option builtin_commit_options[] = {
1497 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1498 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1500 OPT_GROUP(N_("Commit message options")),
1501 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1502 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1503 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1504 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1505 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1506 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1507 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1508 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1509 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1510 OPT_BOOL('s', "signoff", &signoff, N_("add a Signed-off-by trailer")),
1511 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1512 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1513 OPT_CLEANUP(&cleanup_arg),
1514 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1515 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
1516 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1517 /* end commit message options */
1519 OPT_GROUP(N_("Commit contents options")),
1520 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1521 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1522 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1523 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1524 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1525 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit and commit-msg hooks")),
1526 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1527 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1528 STATUS_FORMAT_SHORT),
1529 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1530 OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
1531 N_("compute full ahead/behind values")),
1532 OPT_SET_INT(0, "porcelain", &status_format,
1533 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1534 OPT_SET_INT(0, "long", &status_format,
1535 N_("show status in long format (default)"),
1536 STATUS_FORMAT_LONG),
1537 OPT_BOOL('z', "null", &s.null_termination,
1538 N_("terminate entries with NUL")),
1539 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1540 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1541 { 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" },
1542 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
1543 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
1544 /* end commit contents options */
1546 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1547 N_("ok to record an empty change")),
1548 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1549 N_("ok to record a change with an empty message")),
1551 OPT_END()
1554 struct strbuf sb = STRBUF_INIT;
1555 struct strbuf author_ident = STRBUF_INIT;
1556 const char *index_file, *reflog_msg;
1557 struct object_id oid;
1558 struct commit_list *parents = NULL;
1559 struct stat statbuf;
1560 struct commit *current_head = NULL;
1561 struct commit_extra_header *extra = NULL;
1562 struct strbuf err = STRBUF_INIT;
1564 if (argc == 2 && !strcmp(argv[1], "-h"))
1565 usage_with_options(builtin_commit_usage, builtin_commit_options);
1567 status_init_config(&s, git_commit_config);
1568 s.commit_template = 1;
1569 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1570 s.colopts = 0;
1572 if (get_oid("HEAD", &oid))
1573 current_head = NULL;
1574 else {
1575 current_head = lookup_commit_or_die(&oid, "HEAD");
1576 if (parse_commit(current_head))
1577 die(_("could not parse HEAD commit"));
1579 verbose = -1; /* unspecified */
1580 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1581 builtin_commit_usage,
1582 prefix, current_head, &s);
1583 if (verbose == -1)
1584 verbose = (config_commit_verbose < 0) ? 0 : config_commit_verbose;
1586 if (dry_run)
1587 return dry_run_commit(argv, prefix, current_head, &s);
1588 index_file = prepare_index(argv, prefix, current_head, 0);
1590 /* Set up everything for writing the commit object. This includes
1591 running hooks, writing the trees, and interacting with the user. */
1592 if (!prepare_to_commit(index_file, prefix,
1593 current_head, &s, &author_ident)) {
1594 rollback_index_files();
1595 return 1;
1598 /* Determine parents */
1599 reflog_msg = getenv("GIT_REFLOG_ACTION");
1600 if (!current_head) {
1601 if (!reflog_msg)
1602 reflog_msg = "commit (initial)";
1603 } else if (amend) {
1604 if (!reflog_msg)
1605 reflog_msg = "commit (amend)";
1606 parents = copy_commit_list(current_head->parents);
1607 } else if (whence == FROM_MERGE) {
1608 struct strbuf m = STRBUF_INIT;
1609 FILE *fp;
1610 int allow_fast_forward = 1;
1611 struct commit_list **pptr = &parents;
1613 if (!reflog_msg)
1614 reflog_msg = "commit (merge)";
1615 pptr = commit_list_append(current_head, pptr);
1616 fp = xfopen(git_path_merge_head(the_repository), "r");
1617 while (strbuf_getline_lf(&m, fp) != EOF) {
1618 struct commit *parent;
1620 parent = get_merge_parent(m.buf);
1621 if (!parent)
1622 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1623 pptr = commit_list_append(parent, pptr);
1625 fclose(fp);
1626 strbuf_release(&m);
1627 if (!stat(git_path_merge_mode(the_repository), &statbuf)) {
1628 if (strbuf_read_file(&sb, git_path_merge_mode(the_repository), 0) < 0)
1629 die_errno(_("could not read MERGE_MODE"));
1630 if (!strcmp(sb.buf, "no-ff"))
1631 allow_fast_forward = 0;
1633 if (allow_fast_forward)
1634 reduce_heads_replace(&parents);
1635 } else {
1636 if (!reflog_msg)
1637 reflog_msg = is_from_cherry_pick(whence)
1638 ? "commit (cherry-pick)"
1639 : is_from_rebase(whence)
1640 ? "commit (rebase)"
1641 : "commit";
1642 commit_list_insert(current_head, &parents);
1645 /* Finally, get the commit message */
1646 strbuf_reset(&sb);
1647 if (strbuf_read_file(&sb, git_path_commit_editmsg(), 0) < 0) {
1648 int saved_errno = errno;
1649 rollback_index_files();
1650 die(_("could not read commit message: %s"), strerror(saved_errno));
1653 cleanup_message(&sb, cleanup_mode, verbose);
1655 if (message_is_empty(&sb, cleanup_mode) && !allow_empty_message) {
1656 rollback_index_files();
1657 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1658 exit(1);
1660 if (template_untouched(&sb, template_file, cleanup_mode) && !allow_empty_message) {
1661 rollback_index_files();
1662 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1663 exit(1);
1666 if (amend) {
1667 const char *exclude_gpgsig[3] = { "gpgsig", "gpgsig-sha256", NULL };
1668 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1669 } else {
1670 struct commit_extra_header **tail = &extra;
1671 append_merge_tag_headers(parents, &tail);
1674 if (commit_tree_extended(sb.buf, sb.len, &active_cache_tree->oid,
1675 parents, &oid, author_ident.buf, NULL,
1676 sign_commit, extra)) {
1677 rollback_index_files();
1678 die(_("failed to write commit object"));
1680 strbuf_release(&author_ident);
1681 free_commit_extra_headers(extra);
1683 if (update_head_with_reflog(current_head, &oid, reflog_msg, &sb,
1684 &err)) {
1685 rollback_index_files();
1686 die("%s", err.buf);
1689 sequencer_post_commit_cleanup(the_repository, 0);
1690 unlink(git_path_merge_head(the_repository));
1691 unlink(git_path_merge_msg(the_repository));
1692 unlink(git_path_merge_mode(the_repository));
1693 unlink(git_path_squash_msg(the_repository));
1695 if (commit_index_files())
1696 die(_("repository has been updated, but unable to write\n"
1697 "new_index file. Check that disk is not full and quota is\n"
1698 "not exceeded, and then \"git restore --staged :/\" to recover."));
1700 git_test_write_commit_graph_or_die();
1702 repo_rerere(the_repository, 0);
1703 run_auto_maintenance(quiet);
1704 run_commit_hook(use_editor, get_index_file(), "post-commit", NULL);
1705 if (amend && !no_post_rewrite) {
1706 commit_post_rewrite(the_repository, current_head, &oid);
1708 if (!quiet) {
1709 unsigned int flags = 0;
1711 if (!current_head)
1712 flags |= SUMMARY_INITIAL_COMMIT;
1713 if (author_date_is_interesting())
1714 flags |= SUMMARY_SHOW_AUTHOR_DATE;
1715 print_commit_summary(the_repository, prefix,
1716 &oid, flags);
1719 apply_autostash(git_path_merge_autostash(the_repository));
1721 UNLEAK(err);
1722 UNLEAK(sb);
1723 return 0;