commit: forbid --pathspec-from-file --all
[git.git] / builtin / commit.c
blobc040dc92a4d4523e43c25c0e426fdb305726833b
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_cherry_pick_advice_single[] =
63 N_("Otherwise, please use 'git cherry-pick --skip'\n");
65 static const char empty_cherry_pick_advice_multi[] =
66 N_("and then use:\n"
67 "\n"
68 " git cherry-pick --continue\n"
69 "\n"
70 "to resume cherry-picking the remaining commits.\n"
71 "If you wish to skip this commit, use:\n"
72 "\n"
73 " git cherry-pick --skip\n"
74 "\n");
76 static const char *color_status_slots[] = {
77 [WT_STATUS_HEADER] = "header",
78 [WT_STATUS_UPDATED] = "updated",
79 [WT_STATUS_CHANGED] = "changed",
80 [WT_STATUS_UNTRACKED] = "untracked",
81 [WT_STATUS_NOBRANCH] = "noBranch",
82 [WT_STATUS_UNMERGED] = "unmerged",
83 [WT_STATUS_LOCAL_BRANCH] = "localBranch",
84 [WT_STATUS_REMOTE_BRANCH] = "remoteBranch",
85 [WT_STATUS_ONBRANCH] = "branch",
88 static const char *use_message_buffer;
89 static struct lock_file index_lock; /* real index */
90 static struct lock_file false_lock; /* used only for partial commits */
91 static enum {
92 COMMIT_AS_IS = 1,
93 COMMIT_NORMAL,
94 COMMIT_PARTIAL
95 } commit_style;
97 static const char *logfile, *force_author;
98 static const char *template_file;
100 * The _message variables are commit names from which to take
101 * the commit message and/or authorship.
103 static const char *author_message, *author_message_buffer;
104 static char *edit_message, *use_message;
105 static char *fixup_message, *squash_message;
106 static int all, also, interactive, patch_interactive, only, amend, signoff;
107 static int edit_flag = -1; /* unspecified */
108 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
109 static int config_commit_verbose = -1; /* unspecified */
110 static int no_post_rewrite, allow_empty_message, pathspec_file_nul;
111 static char *untracked_files_arg, *force_date, *ignore_submodule_arg, *ignored_arg;
112 static char *sign_commit, *pathspec_from_file;
115 * The default commit message cleanup mode will remove the lines
116 * beginning with # (shell comments) and leading and trailing
117 * whitespaces (empty lines or containing only whitespaces)
118 * if editor is used, and only the whitespaces if the message
119 * is specified explicitly.
121 static enum commit_msg_cleanup_mode cleanup_mode;
122 static const char *cleanup_arg;
124 static enum commit_whence whence;
125 static int sequencer_in_use;
126 static int use_editor = 1, include_status = 1;
127 static int have_option_m;
128 static struct strbuf message = STRBUF_INIT;
130 static enum wt_status_format status_format = STATUS_FORMAT_UNSPECIFIED;
132 static int opt_parse_porcelain(const struct option *opt, const char *arg, int unset)
134 enum wt_status_format *value = (enum wt_status_format *)opt->value;
135 if (unset)
136 *value = STATUS_FORMAT_NONE;
137 else if (!arg)
138 *value = STATUS_FORMAT_PORCELAIN;
139 else if (!strcmp(arg, "v1") || !strcmp(arg, "1"))
140 *value = STATUS_FORMAT_PORCELAIN;
141 else if (!strcmp(arg, "v2") || !strcmp(arg, "2"))
142 *value = STATUS_FORMAT_PORCELAIN_V2;
143 else
144 die("unsupported porcelain version '%s'", arg);
146 return 0;
149 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
151 struct strbuf *buf = opt->value;
152 if (unset) {
153 have_option_m = 0;
154 strbuf_setlen(buf, 0);
155 } else {
156 have_option_m = 1;
157 if (buf->len)
158 strbuf_addch(buf, '\n');
159 strbuf_addstr(buf, arg);
160 strbuf_complete_line(buf);
162 return 0;
165 static int opt_parse_rename_score(const struct option *opt, const char *arg, int unset)
167 const char **value = opt->value;
169 BUG_ON_OPT_NEG(unset);
171 if (arg != NULL && *arg == '=')
172 arg = arg + 1;
174 *value = arg;
175 return 0;
178 static void determine_whence(struct wt_status *s)
180 if (file_exists(git_path_merge_head(the_repository)))
181 whence = FROM_MERGE;
182 else if (file_exists(git_path_cherry_pick_head(the_repository))) {
183 whence = FROM_CHERRY_PICK;
184 if (file_exists(git_path_seq_dir()))
185 sequencer_in_use = 1;
187 else
188 whence = FROM_COMMIT;
189 if (s)
190 s->whence = whence;
193 static void status_init_config(struct wt_status *s, config_fn_t fn)
195 wt_status_prepare(the_repository, s);
196 init_diff_ui_defaults();
197 git_config(fn, s);
198 determine_whence(s);
199 s->hints = advice_status_hints; /* must come after git_config() */
202 static void rollback_index_files(void)
204 switch (commit_style) {
205 case COMMIT_AS_IS:
206 break; /* nothing to do */
207 case COMMIT_NORMAL:
208 rollback_lock_file(&index_lock);
209 break;
210 case COMMIT_PARTIAL:
211 rollback_lock_file(&index_lock);
212 rollback_lock_file(&false_lock);
213 break;
217 static int commit_index_files(void)
219 int err = 0;
221 switch (commit_style) {
222 case COMMIT_AS_IS:
223 break; /* nothing to do */
224 case COMMIT_NORMAL:
225 err = commit_lock_file(&index_lock);
226 break;
227 case COMMIT_PARTIAL:
228 err = commit_lock_file(&index_lock);
229 rollback_lock_file(&false_lock);
230 break;
233 return err;
237 * Take a union of paths in the index and the named tree (typically, "HEAD"),
238 * and return the paths that match the given pattern in list.
240 static int list_paths(struct string_list *list, const char *with_tree,
241 const struct pathspec *pattern)
243 int i, ret;
244 char *m;
246 if (!pattern->nr)
247 return 0;
249 m = xcalloc(1, pattern->nr);
251 if (with_tree) {
252 char *max_prefix = common_prefix(pattern);
253 overlay_tree_on_index(&the_index, with_tree, max_prefix);
254 free(max_prefix);
257 for (i = 0; i < active_nr; i++) {
258 const struct cache_entry *ce = active_cache[i];
259 struct string_list_item *item;
261 if (ce->ce_flags & CE_UPDATE)
262 continue;
263 if (!ce_path_match(&the_index, ce, pattern, m))
264 continue;
265 item = string_list_insert(list, ce->name);
266 if (ce_skip_worktree(ce))
267 item->util = item; /* better a valid pointer than a fake one */
270 ret = report_path_error(m, pattern);
271 free(m);
272 return ret;
275 static void add_remove_files(struct string_list *list)
277 int i;
278 for (i = 0; i < list->nr; i++) {
279 struct stat st;
280 struct string_list_item *p = &(list->items[i]);
282 /* p->util is skip-worktree */
283 if (p->util)
284 continue;
286 if (!lstat(p->string, &st)) {
287 if (add_to_cache(p->string, &st, 0))
288 die(_("updating files failed"));
289 } else
290 remove_file_from_cache(p->string);
294 static void create_base_index(const struct commit *current_head)
296 struct tree *tree;
297 struct unpack_trees_options opts;
298 struct tree_desc t;
300 if (!current_head) {
301 discard_cache();
302 return;
305 memset(&opts, 0, sizeof(opts));
306 opts.head_idx = 1;
307 opts.index_only = 1;
308 opts.merge = 1;
309 opts.src_index = &the_index;
310 opts.dst_index = &the_index;
312 opts.fn = oneway_merge;
313 tree = parse_tree_indirect(&current_head->object.oid);
314 if (!tree)
315 die(_("failed to unpack HEAD tree object"));
316 parse_tree(tree);
317 init_tree_desc(&t, tree->buffer, tree->size);
318 if (unpack_trees(1, &t, &opts))
319 exit(128); /* We've already reported the error, finish dying */
322 static void refresh_cache_or_die(int refresh_flags)
325 * refresh_flags contains REFRESH_QUIET, so the only errors
326 * are for unmerged entries.
328 if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
329 die_resolve_conflict("commit");
332 static const char *prepare_index(int argc, const char **argv, const char *prefix,
333 const struct commit *current_head, int is_status)
335 struct string_list partial = STRING_LIST_INIT_DUP;
336 struct pathspec pathspec;
337 int refresh_flags = REFRESH_QUIET;
338 const char *ret;
340 if (is_status)
341 refresh_flags |= REFRESH_UNMERGED;
342 parse_pathspec(&pathspec, 0,
343 PATHSPEC_PREFER_FULL,
344 prefix, argv);
346 if (pathspec_from_file) {
347 if (interactive)
348 die(_("--pathspec-from-file is incompatible with --interactive/--patch"));
350 if (all)
351 die(_("--pathspec-from-file with -a does not make sense"));
353 if (pathspec.nr)
354 die(_("--pathspec-from-file is incompatible with pathspec arguments"));
356 parse_pathspec_file(&pathspec, 0,
357 PATHSPEC_PREFER_FULL,
358 prefix, pathspec_from_file, pathspec_file_nul);
359 } else if (pathspec_file_nul) {
360 die(_("--pathspec-file-nul requires --pathspec-from-file"));
363 if (!pathspec.nr && (also || (only && !amend && !allow_empty)))
364 die(_("No paths with --include/--only does not make sense."));
366 if (read_cache_preload(&pathspec) < 0)
367 die(_("index file corrupt"));
369 if (interactive) {
370 char *old_index_env = NULL;
371 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
373 refresh_cache_or_die(refresh_flags);
375 if (write_locked_index(&the_index, &index_lock, 0))
376 die(_("unable to create temporary index"));
378 old_index_env = xstrdup_or_null(getenv(INDEX_ENVIRONMENT));
379 setenv(INDEX_ENVIRONMENT, get_lock_file_path(&index_lock), 1);
381 if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
382 die(_("interactive add failed"));
384 if (old_index_env && *old_index_env)
385 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
386 else
387 unsetenv(INDEX_ENVIRONMENT);
388 FREE_AND_NULL(old_index_env);
390 discard_cache();
391 read_cache_from(get_lock_file_path(&index_lock));
392 if (update_main_cache_tree(WRITE_TREE_SILENT) == 0) {
393 if (reopen_lock_file(&index_lock) < 0)
394 die(_("unable to write index file"));
395 if (write_locked_index(&the_index, &index_lock, 0))
396 die(_("unable to update temporary index"));
397 } else
398 warning(_("Failed to update main cache tree"));
400 commit_style = COMMIT_NORMAL;
401 ret = get_lock_file_path(&index_lock);
402 goto out;
406 * Non partial, non as-is commit.
408 * (1) get the real index;
409 * (2) update the_index as necessary;
410 * (3) write the_index out to the real index (still locked);
411 * (4) return the name of the locked index file.
413 * The caller should run hooks on the locked real index, and
414 * (A) if all goes well, commit the real index;
415 * (B) on failure, rollback the real index.
417 if (all || (also && pathspec.nr)) {
418 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
419 add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
420 refresh_cache_or_die(refresh_flags);
421 update_main_cache_tree(WRITE_TREE_SILENT);
422 if (write_locked_index(&the_index, &index_lock, 0))
423 die(_("unable to write new_index file"));
424 commit_style = COMMIT_NORMAL;
425 ret = get_lock_file_path(&index_lock);
426 goto out;
430 * As-is commit.
432 * (1) return the name of the real index file.
434 * The caller should run hooks on the real index,
435 * and create commit from the_index.
436 * We still need to refresh the index here.
438 if (!only && !pathspec.nr) {
439 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
440 refresh_cache_or_die(refresh_flags);
441 if (active_cache_changed
442 || !cache_tree_fully_valid(active_cache_tree))
443 update_main_cache_tree(WRITE_TREE_SILENT);
444 if (write_locked_index(&the_index, &index_lock,
445 COMMIT_LOCK | SKIP_IF_UNCHANGED))
446 die(_("unable to write new_index file"));
447 commit_style = COMMIT_AS_IS;
448 ret = get_index_file();
449 goto out;
453 * A partial commit.
455 * (0) find the set of affected paths;
456 * (1) get lock on the real index file;
457 * (2) update the_index with the given paths;
458 * (3) write the_index out to the real index (still locked);
459 * (4) get lock on the false index file;
460 * (5) reset the_index from HEAD;
461 * (6) update the_index the same way as (2);
462 * (7) write the_index out to the false index file;
463 * (8) return the name of the false index file (still locked);
465 * The caller should run hooks on the locked false index, and
466 * create commit from it. Then
467 * (A) if all goes well, commit the real index;
468 * (B) on failure, rollback the real index;
469 * In either case, rollback the false index.
471 commit_style = COMMIT_PARTIAL;
473 if (whence != FROM_COMMIT) {
474 if (whence == FROM_MERGE)
475 die(_("cannot do a partial commit during a merge."));
476 else if (whence == FROM_CHERRY_PICK)
477 die(_("cannot do a partial commit during a cherry-pick."));
480 if (list_paths(&partial, !current_head ? NULL : "HEAD", &pathspec))
481 exit(1);
483 discard_cache();
484 if (read_cache() < 0)
485 die(_("cannot read the index"));
487 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
488 add_remove_files(&partial);
489 refresh_cache(REFRESH_QUIET);
490 update_main_cache_tree(WRITE_TREE_SILENT);
491 if (write_locked_index(&the_index, &index_lock, 0))
492 die(_("unable to write new_index file"));
494 hold_lock_file_for_update(&false_lock,
495 git_path("next-index-%"PRIuMAX,
496 (uintmax_t) getpid()),
497 LOCK_DIE_ON_ERROR);
499 create_base_index(current_head);
500 add_remove_files(&partial);
501 refresh_cache(REFRESH_QUIET);
503 if (write_locked_index(&the_index, &false_lock, 0))
504 die(_("unable to write temporary index file"));
506 discard_cache();
507 ret = get_lock_file_path(&false_lock);
508 read_cache_from(ret);
509 out:
510 string_list_clear(&partial, 0);
511 clear_pathspec(&pathspec);
512 return ret;
515 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
516 struct wt_status *s)
518 struct object_id oid;
520 if (s->relative_paths)
521 s->prefix = prefix;
523 if (amend) {
524 s->amend = 1;
525 s->reference = "HEAD^1";
527 s->verbose = verbose;
528 s->index_file = index_file;
529 s->fp = fp;
530 s->nowarn = nowarn;
531 s->is_initial = get_oid(s->reference, &oid) ? 1 : 0;
532 if (!s->is_initial)
533 oidcpy(&s->oid_commit, &oid);
534 s->status_format = status_format;
535 s->ignore_submodule_arg = ignore_submodule_arg;
537 wt_status_collect(s);
538 wt_status_print(s);
539 wt_status_collect_free_buffers(s);
541 return s->committable;
544 static int is_a_merge(const struct commit *current_head)
546 return !!(current_head->parents && current_head->parents->next);
549 static void assert_split_ident(struct ident_split *id, const struct strbuf *buf)
551 if (split_ident_line(id, buf->buf, buf->len) || !id->date_begin)
552 BUG("unable to parse our own ident: %s", buf->buf);
555 static void export_one(const char *var, const char *s, const char *e, int hack)
557 struct strbuf buf = STRBUF_INIT;
558 if (hack)
559 strbuf_addch(&buf, hack);
560 strbuf_addf(&buf, "%.*s", (int)(e - s), s);
561 setenv(var, buf.buf, 1);
562 strbuf_release(&buf);
565 static int parse_force_date(const char *in, struct strbuf *out)
567 strbuf_addch(out, '@');
569 if (parse_date(in, out) < 0) {
570 int errors = 0;
571 unsigned long t = approxidate_careful(in, &errors);
572 if (errors)
573 return -1;
574 strbuf_addf(out, "%lu", t);
577 return 0;
580 static void set_ident_var(char **buf, char *val)
582 free(*buf);
583 *buf = val;
586 static void determine_author_info(struct strbuf *author_ident)
588 char *name, *email, *date;
589 struct ident_split author;
591 name = xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
592 email = xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
593 date = xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
595 if (author_message) {
596 struct ident_split ident;
597 size_t len;
598 const char *a;
600 a = find_commit_header(author_message_buffer, "author", &len);
601 if (!a)
602 die(_("commit '%s' lacks author header"), author_message);
603 if (split_ident_line(&ident, a, len) < 0)
604 die(_("commit '%s' has malformed author line"), author_message);
606 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
607 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
609 if (ident.date_begin) {
610 struct strbuf date_buf = STRBUF_INIT;
611 strbuf_addch(&date_buf, '@');
612 strbuf_add(&date_buf, ident.date_begin, ident.date_end - ident.date_begin);
613 strbuf_addch(&date_buf, ' ');
614 strbuf_add(&date_buf, ident.tz_begin, ident.tz_end - ident.tz_begin);
615 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
619 if (force_author) {
620 struct ident_split ident;
622 if (split_ident_line(&ident, force_author, strlen(force_author)) < 0)
623 die(_("malformed --author parameter"));
624 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
625 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
628 if (force_date) {
629 struct strbuf date_buf = STRBUF_INIT;
630 if (parse_force_date(force_date, &date_buf))
631 die(_("invalid date format: %s"), force_date);
632 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
635 strbuf_addstr(author_ident, fmt_ident(name, email, WANT_AUTHOR_IDENT, date,
636 IDENT_STRICT));
637 assert_split_ident(&author, author_ident);
638 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
639 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
640 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
641 free(name);
642 free(email);
643 free(date);
646 static int author_date_is_interesting(void)
648 return author_message || force_date;
651 static void adjust_comment_line_char(const struct strbuf *sb)
653 char candidates[] = "#;@!$%^&|:";
654 char *candidate;
655 const char *p;
657 comment_line_char = candidates[0];
658 if (!memchr(sb->buf, comment_line_char, sb->len))
659 return;
661 p = sb->buf;
662 candidate = strchr(candidates, *p);
663 if (candidate)
664 *candidate = ' ';
665 for (p = sb->buf; *p; p++) {
666 if ((p[0] == '\n' || p[0] == '\r') && p[1]) {
667 candidate = strchr(candidates, p[1]);
668 if (candidate)
669 *candidate = ' ';
673 for (p = candidates; *p == ' '; p++)
675 if (!*p)
676 die(_("unable to select a comment character that is not used\n"
677 "in the current commit message"));
678 comment_line_char = *p;
681 static int prepare_to_commit(const char *index_file, const char *prefix,
682 struct commit *current_head,
683 struct wt_status *s,
684 struct strbuf *author_ident)
686 struct stat statbuf;
687 struct strbuf committer_ident = STRBUF_INIT;
688 int committable;
689 struct strbuf sb = STRBUF_INIT;
690 const char *hook_arg1 = NULL;
691 const char *hook_arg2 = NULL;
692 int clean_message_contents = (cleanup_mode != COMMIT_MSG_CLEANUP_NONE);
693 int old_display_comment_prefix;
694 int merge_contains_scissors = 0;
696 /* This checks and barfs if author is badly specified */
697 determine_author_info(author_ident);
699 if (!no_verify && run_commit_hook(use_editor, index_file, "pre-commit", NULL))
700 return 0;
702 if (squash_message) {
704 * Insert the proper subject line before other commit
705 * message options add their content.
707 if (use_message && !strcmp(use_message, squash_message))
708 strbuf_addstr(&sb, "squash! ");
709 else {
710 struct pretty_print_context ctx = {0};
711 struct commit *c;
712 c = lookup_commit_reference_by_name(squash_message);
713 if (!c)
714 die(_("could not lookup commit %s"), squash_message);
715 ctx.output_encoding = get_commit_output_encoding();
716 format_commit_message(c, "squash! %s\n\n", &sb,
717 &ctx);
721 if (have_option_m && !fixup_message) {
722 strbuf_addbuf(&sb, &message);
723 hook_arg1 = "message";
724 } else if (logfile && !strcmp(logfile, "-")) {
725 if (isatty(0))
726 fprintf(stderr, _("(reading log message from standard input)\n"));
727 if (strbuf_read(&sb, 0, 0) < 0)
728 die_errno(_("could not read log from standard input"));
729 hook_arg1 = "message";
730 } else if (logfile) {
731 if (strbuf_read_file(&sb, logfile, 0) < 0)
732 die_errno(_("could not read log file '%s'"),
733 logfile);
734 hook_arg1 = "message";
735 } else if (use_message) {
736 char *buffer;
737 buffer = strstr(use_message_buffer, "\n\n");
738 if (buffer)
739 strbuf_addstr(&sb, skip_blank_lines(buffer + 2));
740 hook_arg1 = "commit";
741 hook_arg2 = use_message;
742 } else if (fixup_message) {
743 struct pretty_print_context ctx = {0};
744 struct commit *commit;
745 commit = lookup_commit_reference_by_name(fixup_message);
746 if (!commit)
747 die(_("could not lookup commit %s"), fixup_message);
748 ctx.output_encoding = get_commit_output_encoding();
749 format_commit_message(commit, "fixup! %s\n\n",
750 &sb, &ctx);
751 if (have_option_m)
752 strbuf_addbuf(&sb, &message);
753 hook_arg1 = "message";
754 } else if (!stat(git_path_merge_msg(the_repository), &statbuf)) {
755 size_t merge_msg_start;
758 * prepend SQUASH_MSG here if it exists and a
759 * "merge --squash" was originally performed
761 if (!stat(git_path_squash_msg(the_repository), &statbuf)) {
762 if (strbuf_read_file(&sb, git_path_squash_msg(the_repository), 0) < 0)
763 die_errno(_("could not read SQUASH_MSG"));
764 hook_arg1 = "squash";
765 } else
766 hook_arg1 = "merge";
768 merge_msg_start = sb.len;
769 if (strbuf_read_file(&sb, git_path_merge_msg(the_repository), 0) < 0)
770 die_errno(_("could not read MERGE_MSG"));
772 if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS &&
773 wt_status_locate_end(sb.buf + merge_msg_start,
774 sb.len - merge_msg_start) <
775 sb.len - merge_msg_start)
776 merge_contains_scissors = 1;
777 } else if (!stat(git_path_squash_msg(the_repository), &statbuf)) {
778 if (strbuf_read_file(&sb, git_path_squash_msg(the_repository), 0) < 0)
779 die_errno(_("could not read SQUASH_MSG"));
780 hook_arg1 = "squash";
781 } else if (template_file) {
782 if (strbuf_read_file(&sb, template_file, 0) < 0)
783 die_errno(_("could not read '%s'"), template_file);
784 hook_arg1 = "template";
785 clean_message_contents = 0;
789 * The remaining cases don't modify the template message, but
790 * just set the argument(s) to the prepare-commit-msg hook.
792 else if (whence == FROM_MERGE)
793 hook_arg1 = "merge";
794 else if (whence == FROM_CHERRY_PICK) {
795 hook_arg1 = "commit";
796 hook_arg2 = "CHERRY_PICK_HEAD";
799 if (squash_message) {
801 * If squash_commit was used for the commit subject,
802 * then we're possibly hijacking other commit log options.
803 * Reset the hook args to tell the real story.
805 hook_arg1 = "message";
806 hook_arg2 = "";
809 s->fp = fopen_for_writing(git_path_commit_editmsg());
810 if (s->fp == NULL)
811 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
813 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
814 old_display_comment_prefix = s->display_comment_prefix;
815 s->display_comment_prefix = 1;
818 * Most hints are counter-productive when the commit has
819 * already started.
821 s->hints = 0;
823 if (clean_message_contents)
824 strbuf_stripspace(&sb, 0);
826 if (signoff)
827 append_signoff(&sb, ignore_non_trailer(sb.buf, sb.len), 0);
829 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
830 die_errno(_("could not write commit template"));
832 if (auto_comment_line_char)
833 adjust_comment_line_char(&sb);
834 strbuf_release(&sb);
836 /* This checks if committer ident is explicitly given */
837 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
838 if (use_editor && include_status) {
839 int ident_shown = 0;
840 int saved_color_setting;
841 struct ident_split ci, ai;
843 if (whence != FROM_COMMIT) {
844 if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS &&
845 !merge_contains_scissors)
846 wt_status_add_cut_line(s->fp);
847 status_printf_ln(s, GIT_COLOR_NORMAL,
848 whence == FROM_MERGE
849 ? _("\n"
850 "It looks like you may be committing a merge.\n"
851 "If this is not correct, please remove the file\n"
852 " %s\n"
853 "and try again.\n")
854 : _("\n"
855 "It looks like you may be committing a cherry-pick.\n"
856 "If this is not correct, please remove the file\n"
857 " %s\n"
858 "and try again.\n"),
859 whence == FROM_MERGE ?
860 git_path_merge_head(the_repository) :
861 git_path_cherry_pick_head(the_repository));
864 fprintf(s->fp, "\n");
865 if (cleanup_mode == COMMIT_MSG_CLEANUP_ALL)
866 status_printf(s, GIT_COLOR_NORMAL,
867 _("Please enter the commit message for your changes."
868 " Lines starting\nwith '%c' will be ignored, and an empty"
869 " message aborts the commit.\n"), comment_line_char);
870 else if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS) {
871 if (whence == FROM_COMMIT && !merge_contains_scissors)
872 wt_status_add_cut_line(s->fp);
873 } else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
874 status_printf(s, GIT_COLOR_NORMAL,
875 _("Please enter the commit message for your changes."
876 " Lines starting\n"
877 "with '%c' will be kept; you may remove them"
878 " yourself if you want to.\n"
879 "An empty message aborts the commit.\n"), comment_line_char);
882 * These should never fail because they come from our own
883 * fmt_ident. They may fail the sane_ident test, but we know
884 * that the name and mail pointers will at least be valid,
885 * which is enough for our tests and printing here.
887 assert_split_ident(&ai, author_ident);
888 assert_split_ident(&ci, &committer_ident);
890 if (ident_cmp(&ai, &ci))
891 status_printf_ln(s, GIT_COLOR_NORMAL,
892 _("%s"
893 "Author: %.*s <%.*s>"),
894 ident_shown++ ? "" : "\n",
895 (int)(ai.name_end - ai.name_begin), ai.name_begin,
896 (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);
898 if (author_date_is_interesting())
899 status_printf_ln(s, GIT_COLOR_NORMAL,
900 _("%s"
901 "Date: %s"),
902 ident_shown++ ? "" : "\n",
903 show_ident_date(&ai, DATE_MODE(NORMAL)));
905 if (!committer_ident_sufficiently_given())
906 status_printf_ln(s, GIT_COLOR_NORMAL,
907 _("%s"
908 "Committer: %.*s <%.*s>"),
909 ident_shown++ ? "" : "\n",
910 (int)(ci.name_end - ci.name_begin), ci.name_begin,
911 (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
913 status_printf_ln(s, GIT_COLOR_NORMAL, "%s", ""); /* Add new line for clarity */
915 saved_color_setting = s->use_color;
916 s->use_color = 0;
917 committable = run_status(s->fp, index_file, prefix, 1, s);
918 s->use_color = saved_color_setting;
919 string_list_clear(&s->change, 1);
920 } else {
921 struct object_id oid;
922 const char *parent = "HEAD";
924 if (!active_nr && read_cache() < 0)
925 die(_("Cannot read index"));
927 if (amend)
928 parent = "HEAD^1";
930 if (get_oid(parent, &oid)) {
931 int i, ita_nr = 0;
933 for (i = 0; i < active_nr; i++)
934 if (ce_intent_to_add(active_cache[i]))
935 ita_nr++;
936 committable = active_nr - ita_nr > 0;
937 } else {
939 * Unless the user did explicitly request a submodule
940 * ignore mode by passing a command line option we do
941 * not ignore any changed submodule SHA-1s when
942 * comparing index and parent, no matter what is
943 * configured. Otherwise we won't commit any
944 * submodules which were manually staged, which would
945 * be really confusing.
947 struct diff_flags flags = DIFF_FLAGS_INIT;
948 flags.override_submodule_config = 1;
949 if (ignore_submodule_arg &&
950 !strcmp(ignore_submodule_arg, "all"))
951 flags.ignore_submodules = 1;
952 committable = index_differs_from(the_repository,
953 parent, &flags, 1);
956 strbuf_release(&committer_ident);
958 fclose(s->fp);
961 * Reject an attempt to record a non-merge empty commit without
962 * explicit --allow-empty. In the cherry-pick case, it may be
963 * empty due to conflict resolution, which the user should okay.
965 if (!committable && whence != FROM_MERGE && !allow_empty &&
966 !(amend && is_a_merge(current_head))) {
967 s->display_comment_prefix = old_display_comment_prefix;
968 run_status(stdout, index_file, prefix, 0, s);
969 if (amend)
970 fputs(_(empty_amend_advice), stderr);
971 else if (whence == FROM_CHERRY_PICK) {
972 fputs(_(empty_cherry_pick_advice), stderr);
973 if (!sequencer_in_use)
974 fputs(_(empty_cherry_pick_advice_single), stderr);
975 else
976 fputs(_(empty_cherry_pick_advice_multi), stderr);
978 return 0;
981 if (!no_verify && find_hook("pre-commit")) {
983 * Re-read the index as pre-commit hook could have updated it,
984 * and write it out as a tree. We must do this before we invoke
985 * the editor and after we invoke run_status above.
987 discard_cache();
989 read_cache_from(index_file);
991 if (update_main_cache_tree(0)) {
992 error(_("Error building trees"));
993 return 0;
996 if (run_commit_hook(use_editor, index_file, "prepare-commit-msg",
997 git_path_commit_editmsg(), hook_arg1, hook_arg2, NULL))
998 return 0;
1000 if (use_editor) {
1001 struct argv_array env = ARGV_ARRAY_INIT;
1003 argv_array_pushf(&env, "GIT_INDEX_FILE=%s", index_file);
1004 if (launch_editor(git_path_commit_editmsg(), NULL, env.argv)) {
1005 fprintf(stderr,
1006 _("Please supply the message using either -m or -F option.\n"));
1007 exit(1);
1009 argv_array_clear(&env);
1012 if (!no_verify &&
1013 run_commit_hook(use_editor, index_file, "commit-msg", git_path_commit_editmsg(), NULL)) {
1014 return 0;
1017 return 1;
1020 static const char *find_author_by_nickname(const char *name)
1022 struct rev_info revs;
1023 struct commit *commit;
1024 struct strbuf buf = STRBUF_INIT;
1025 struct string_list mailmap = STRING_LIST_INIT_NODUP;
1026 const char *av[20];
1027 int ac = 0;
1029 repo_init_revisions(the_repository, &revs, NULL);
1030 strbuf_addf(&buf, "--author=%s", name);
1031 av[++ac] = "--all";
1032 av[++ac] = "-i";
1033 av[++ac] = buf.buf;
1034 av[++ac] = NULL;
1035 setup_revisions(ac, av, &revs, NULL);
1036 revs.mailmap = &mailmap;
1037 read_mailmap(revs.mailmap, NULL);
1039 if (prepare_revision_walk(&revs))
1040 die(_("revision walk setup failed"));
1041 commit = get_revision(&revs);
1042 if (commit) {
1043 struct pretty_print_context ctx = {0};
1044 ctx.date_mode.type = DATE_NORMAL;
1045 strbuf_release(&buf);
1046 format_commit_message(commit, "%aN <%aE>", &buf, &ctx);
1047 clear_mailmap(&mailmap);
1048 return strbuf_detach(&buf, NULL);
1050 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name);
1053 static void handle_ignored_arg(struct wt_status *s)
1055 if (!ignored_arg)
1056 ; /* default already initialized */
1057 else if (!strcmp(ignored_arg, "traditional"))
1058 s->show_ignored_mode = SHOW_TRADITIONAL_IGNORED;
1059 else if (!strcmp(ignored_arg, "no"))
1060 s->show_ignored_mode = SHOW_NO_IGNORED;
1061 else if (!strcmp(ignored_arg, "matching"))
1062 s->show_ignored_mode = SHOW_MATCHING_IGNORED;
1063 else
1064 die(_("Invalid ignored mode '%s'"), ignored_arg);
1067 static void handle_untracked_files_arg(struct wt_status *s)
1069 if (!untracked_files_arg)
1070 ; /* default already initialized */
1071 else if (!strcmp(untracked_files_arg, "no"))
1072 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1073 else if (!strcmp(untracked_files_arg, "normal"))
1074 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1075 else if (!strcmp(untracked_files_arg, "all"))
1076 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1078 * Please update $__git_untracked_file_modes in
1079 * git-completion.bash when you add new options
1081 else
1082 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1085 static const char *read_commit_message(const char *name)
1087 const char *out_enc;
1088 struct commit *commit;
1090 commit = lookup_commit_reference_by_name(name);
1091 if (!commit)
1092 die(_("could not lookup commit %s"), name);
1093 out_enc = get_commit_output_encoding();
1094 return logmsg_reencode(commit, NULL, out_enc);
1098 * Enumerate what needs to be propagated when --porcelain
1099 * is not in effect here.
1101 static struct status_deferred_config {
1102 enum wt_status_format status_format;
1103 int show_branch;
1104 enum ahead_behind_flags ahead_behind;
1105 } status_deferred_config = {
1106 STATUS_FORMAT_UNSPECIFIED,
1107 -1, /* unspecified */
1108 AHEAD_BEHIND_UNSPECIFIED,
1111 static void finalize_deferred_config(struct wt_status *s)
1113 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1114 status_format != STATUS_FORMAT_PORCELAIN_V2 &&
1115 !s->null_termination);
1117 if (s->null_termination) {
1118 if (status_format == STATUS_FORMAT_NONE ||
1119 status_format == STATUS_FORMAT_UNSPECIFIED)
1120 status_format = STATUS_FORMAT_PORCELAIN;
1121 else if (status_format == STATUS_FORMAT_LONG)
1122 die(_("--long and -z are incompatible"));
1125 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1126 status_format = status_deferred_config.status_format;
1127 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1128 status_format = STATUS_FORMAT_NONE;
1130 if (use_deferred_config && s->show_branch < 0)
1131 s->show_branch = status_deferred_config.show_branch;
1132 if (s->show_branch < 0)
1133 s->show_branch = 0;
1136 * If the user did not give a "--[no]-ahead-behind" command
1137 * line argument *AND* we will print in a human-readable format
1138 * (short, long etc.) then we inherit from the status.aheadbehind
1139 * config setting. In all other cases (and porcelain V[12] formats
1140 * in particular), we inherit _FULL for backwards compatibility.
1142 if (use_deferred_config &&
1143 s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
1144 s->ahead_behind_flags = status_deferred_config.ahead_behind;
1146 if (s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
1147 s->ahead_behind_flags = AHEAD_BEHIND_FULL;
1150 static int parse_and_validate_options(int argc, const char *argv[],
1151 const struct option *options,
1152 const char * const usage[],
1153 const char *prefix,
1154 struct commit *current_head,
1155 struct wt_status *s)
1157 int f = 0;
1159 argc = parse_options(argc, argv, prefix, options, usage, 0);
1160 finalize_deferred_config(s);
1162 if (force_author && !strchr(force_author, '>'))
1163 force_author = find_author_by_nickname(force_author);
1165 if (force_author && renew_authorship)
1166 die(_("Using both --reset-author and --author does not make sense"));
1168 if (logfile || have_option_m || use_message || fixup_message)
1169 use_editor = 0;
1170 if (0 <= edit_flag)
1171 use_editor = edit_flag;
1173 /* Sanity check options */
1174 if (amend && !current_head)
1175 die(_("You have nothing to amend."));
1176 if (amend && whence != FROM_COMMIT) {
1177 if (whence == FROM_MERGE)
1178 die(_("You are in the middle of a merge -- cannot amend."));
1179 else if (whence == FROM_CHERRY_PICK)
1180 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1182 if (fixup_message && squash_message)
1183 die(_("Options --squash and --fixup cannot be used together"));
1184 if (use_message)
1185 f++;
1186 if (edit_message)
1187 f++;
1188 if (fixup_message)
1189 f++;
1190 if (logfile)
1191 f++;
1192 if (f > 1)
1193 die(_("Only one of -c/-C/-F/--fixup can be used."));
1194 if (have_option_m && (edit_message || use_message || logfile))
1195 die((_("Option -m cannot be combined with -c/-C/-F.")));
1196 if (f || have_option_m)
1197 template_file = NULL;
1198 if (edit_message)
1199 use_message = edit_message;
1200 if (amend && !use_message && !fixup_message)
1201 use_message = "HEAD";
1202 if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1203 die(_("--reset-author can be used only with -C, -c or --amend."));
1204 if (use_message) {
1205 use_message_buffer = read_commit_message(use_message);
1206 if (!renew_authorship) {
1207 author_message = use_message;
1208 author_message_buffer = use_message_buffer;
1211 if (whence == FROM_CHERRY_PICK && !renew_authorship) {
1212 author_message = "CHERRY_PICK_HEAD";
1213 author_message_buffer = read_commit_message(author_message);
1216 if (patch_interactive)
1217 interactive = 1;
1219 if (also + only + all + interactive > 1)
1220 die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
1221 cleanup_mode = get_cleanup_mode(cleanup_arg, use_editor);
1223 handle_untracked_files_arg(s);
1225 if (all && argc > 0)
1226 die(_("paths '%s ...' with -a does not make sense"),
1227 argv[0]);
1229 if (status_format != STATUS_FORMAT_NONE)
1230 dry_run = 1;
1232 return argc;
1235 static int dry_run_commit(int argc, const char **argv, const char *prefix,
1236 const struct commit *current_head, struct wt_status *s)
1238 int committable;
1239 const char *index_file;
1241 index_file = prepare_index(argc, argv, prefix, current_head, 1);
1242 committable = run_status(stdout, index_file, prefix, 0, s);
1243 rollback_index_files();
1245 return committable ? 0 : 1;
1248 define_list_config_array_extra(color_status_slots, {"added"});
1250 static int parse_status_slot(const char *slot)
1252 if (!strcasecmp(slot, "added"))
1253 return WT_STATUS_UPDATED;
1255 return LOOKUP_CONFIG(color_status_slots, slot);
1258 static int git_status_config(const char *k, const char *v, void *cb)
1260 struct wt_status *s = cb;
1261 const char *slot_name;
1263 if (starts_with(k, "column."))
1264 return git_column_config(k, v, "status", &s->colopts);
1265 if (!strcmp(k, "status.submodulesummary")) {
1266 int is_bool;
1267 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1268 if (is_bool && s->submodule_summary)
1269 s->submodule_summary = -1;
1270 return 0;
1272 if (!strcmp(k, "status.short")) {
1273 if (git_config_bool(k, v))
1274 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1275 else
1276 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1277 return 0;
1279 if (!strcmp(k, "status.branch")) {
1280 status_deferred_config.show_branch = git_config_bool(k, v);
1281 return 0;
1283 if (!strcmp(k, "status.aheadbehind")) {
1284 status_deferred_config.ahead_behind = git_config_bool(k, v);
1285 return 0;
1287 if (!strcmp(k, "status.showstash")) {
1288 s->show_stash = git_config_bool(k, v);
1289 return 0;
1291 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1292 s->use_color = git_config_colorbool(k, v);
1293 return 0;
1295 if (!strcmp(k, "status.displaycommentprefix")) {
1296 s->display_comment_prefix = git_config_bool(k, v);
1297 return 0;
1299 if (skip_prefix(k, "status.color.", &slot_name) ||
1300 skip_prefix(k, "color.status.", &slot_name)) {
1301 int slot = parse_status_slot(slot_name);
1302 if (slot < 0)
1303 return 0;
1304 if (!v)
1305 return config_error_nonbool(k);
1306 return color_parse(v, s->color_palette[slot]);
1308 if (!strcmp(k, "status.relativepaths")) {
1309 s->relative_paths = git_config_bool(k, v);
1310 return 0;
1312 if (!strcmp(k, "status.showuntrackedfiles")) {
1313 if (!v)
1314 return config_error_nonbool(k);
1315 else if (!strcmp(v, "no"))
1316 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1317 else if (!strcmp(v, "normal"))
1318 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1319 else if (!strcmp(v, "all"))
1320 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1321 else
1322 return error(_("Invalid untracked files mode '%s'"), v);
1323 return 0;
1325 if (!strcmp(k, "diff.renamelimit")) {
1326 if (s->rename_limit == -1)
1327 s->rename_limit = git_config_int(k, v);
1328 return 0;
1330 if (!strcmp(k, "status.renamelimit")) {
1331 s->rename_limit = git_config_int(k, v);
1332 return 0;
1334 if (!strcmp(k, "diff.renames")) {
1335 if (s->detect_rename == -1)
1336 s->detect_rename = git_config_rename(k, v);
1337 return 0;
1339 if (!strcmp(k, "status.renames")) {
1340 s->detect_rename = git_config_rename(k, v);
1341 return 0;
1343 return git_diff_ui_config(k, v, NULL);
1346 int cmd_status(int argc, const char **argv, const char *prefix)
1348 static int no_renames = -1;
1349 static const char *rename_score_arg = (const char *)-1;
1350 static struct wt_status s;
1351 unsigned int progress_flag = 0;
1352 int fd;
1353 struct object_id oid;
1354 static struct option builtin_status_options[] = {
1355 OPT__VERBOSE(&verbose, N_("be verbose")),
1356 OPT_SET_INT('s', "short", &status_format,
1357 N_("show status concisely"), STATUS_FORMAT_SHORT),
1358 OPT_BOOL('b', "branch", &s.show_branch,
1359 N_("show branch information")),
1360 OPT_BOOL(0, "show-stash", &s.show_stash,
1361 N_("show stash information")),
1362 OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
1363 N_("compute full ahead/behind values")),
1364 { OPTION_CALLBACK, 0, "porcelain", &status_format,
1365 N_("version"), N_("machine-readable output"),
1366 PARSE_OPT_OPTARG, opt_parse_porcelain },
1367 OPT_SET_INT(0, "long", &status_format,
1368 N_("show status in long format (default)"),
1369 STATUS_FORMAT_LONG),
1370 OPT_BOOL('z', "null", &s.null_termination,
1371 N_("terminate entries with NUL")),
1372 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1373 N_("mode"),
1374 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1375 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1376 { OPTION_STRING, 0, "ignored", &ignored_arg,
1377 N_("mode"),
1378 N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1379 PARSE_OPT_OPTARG, NULL, (intptr_t)"traditional" },
1380 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1381 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1382 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1383 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1384 OPT_BOOL(0, "no-renames", &no_renames, N_("do not detect renames")),
1385 { OPTION_CALLBACK, 'M', "find-renames", &rename_score_arg,
1386 N_("n"), N_("detect renames, optionally set similarity index"),
1387 PARSE_OPT_OPTARG | PARSE_OPT_NONEG, opt_parse_rename_score },
1388 OPT_END(),
1391 if (argc == 2 && !strcmp(argv[1], "-h"))
1392 usage_with_options(builtin_status_usage, builtin_status_options);
1394 status_init_config(&s, git_status_config);
1395 argc = parse_options(argc, argv, prefix,
1396 builtin_status_options,
1397 builtin_status_usage, 0);
1398 finalize_colopts(&s.colopts, -1);
1399 finalize_deferred_config(&s);
1401 handle_untracked_files_arg(&s);
1402 handle_ignored_arg(&s);
1404 if (s.show_ignored_mode == SHOW_MATCHING_IGNORED &&
1405 s.show_untracked_files == SHOW_NO_UNTRACKED_FILES)
1406 die(_("Unsupported combination of ignored and untracked-files arguments"));
1408 parse_pathspec(&s.pathspec, 0,
1409 PATHSPEC_PREFER_FULL,
1410 prefix, argv);
1412 if (status_format != STATUS_FORMAT_PORCELAIN &&
1413 status_format != STATUS_FORMAT_PORCELAIN_V2)
1414 progress_flag = REFRESH_PROGRESS;
1415 repo_read_index(the_repository);
1416 refresh_index(&the_index,
1417 REFRESH_QUIET|REFRESH_UNMERGED|progress_flag,
1418 &s.pathspec, NULL, NULL);
1420 if (use_optional_locks())
1421 fd = hold_locked_index(&index_lock, 0);
1422 else
1423 fd = -1;
1425 s.is_initial = get_oid(s.reference, &oid) ? 1 : 0;
1426 if (!s.is_initial)
1427 oidcpy(&s.oid_commit, &oid);
1429 s.ignore_submodule_arg = ignore_submodule_arg;
1430 s.status_format = status_format;
1431 s.verbose = verbose;
1432 if (no_renames != -1)
1433 s.detect_rename = !no_renames;
1434 if ((intptr_t)rename_score_arg != -1) {
1435 if (s.detect_rename < DIFF_DETECT_RENAME)
1436 s.detect_rename = DIFF_DETECT_RENAME;
1437 if (rename_score_arg)
1438 s.rename_score = parse_rename_score(&rename_score_arg);
1441 wt_status_collect(&s);
1443 if (0 <= fd)
1444 repo_update_index_if_able(the_repository, &index_lock);
1446 if (s.relative_paths)
1447 s.prefix = prefix;
1449 wt_status_print(&s);
1450 wt_status_collect_free_buffers(&s);
1452 return 0;
1455 static int git_commit_config(const char *k, const char *v, void *cb)
1457 struct wt_status *s = cb;
1458 int status;
1460 if (!strcmp(k, "commit.template"))
1461 return git_config_pathname(&template_file, k, v);
1462 if (!strcmp(k, "commit.status")) {
1463 include_status = git_config_bool(k, v);
1464 return 0;
1466 if (!strcmp(k, "commit.cleanup"))
1467 return git_config_string(&cleanup_arg, k, v);
1468 if (!strcmp(k, "commit.gpgsign")) {
1469 sign_commit = git_config_bool(k, v) ? "" : NULL;
1470 return 0;
1472 if (!strcmp(k, "commit.verbose")) {
1473 int is_bool;
1474 config_commit_verbose = git_config_bool_or_int(k, v, &is_bool);
1475 return 0;
1478 status = git_gpg_config(k, v, NULL);
1479 if (status)
1480 return status;
1481 return git_status_config(k, v, s);
1484 int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...)
1486 struct argv_array hook_env = ARGV_ARRAY_INIT;
1487 va_list args;
1488 int ret;
1490 argv_array_pushf(&hook_env, "GIT_INDEX_FILE=%s", index_file);
1493 * Let the hook know that no editor will be launched.
1495 if (!editor_is_used)
1496 argv_array_push(&hook_env, "GIT_EDITOR=:");
1498 va_start(args, name);
1499 ret = run_hook_ve(hook_env.argv,name, args);
1500 va_end(args);
1501 argv_array_clear(&hook_env);
1503 return ret;
1506 int cmd_commit(int argc, const char **argv, const char *prefix)
1508 const char *argv_gc_auto[] = {"gc", "--auto", NULL};
1509 static struct wt_status s;
1510 static struct option builtin_commit_options[] = {
1511 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1512 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1514 OPT_GROUP(N_("Commit message options")),
1515 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1516 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1517 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1518 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1519 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1520 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1521 OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
1522 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1523 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1524 OPT_BOOL('s', "signoff", &signoff, N_("add Signed-off-by:")),
1525 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1526 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1527 OPT_CLEANUP(&cleanup_arg),
1528 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1529 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
1530 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1531 /* end commit message options */
1533 OPT_GROUP(N_("Commit contents options")),
1534 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1535 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1536 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1537 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1538 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1539 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit and commit-msg hooks")),
1540 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1541 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1542 STATUS_FORMAT_SHORT),
1543 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1544 OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
1545 N_("compute full ahead/behind values")),
1546 OPT_SET_INT(0, "porcelain", &status_format,
1547 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1548 OPT_SET_INT(0, "long", &status_format,
1549 N_("show status in long format (default)"),
1550 STATUS_FORMAT_LONG),
1551 OPT_BOOL('z', "null", &s.null_termination,
1552 N_("terminate entries with NUL")),
1553 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1554 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1555 { 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" },
1556 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
1557 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
1558 /* end commit contents options */
1560 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1561 N_("ok to record an empty change")),
1562 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1563 N_("ok to record a change with an empty message")),
1565 OPT_END()
1568 struct strbuf sb = STRBUF_INIT;
1569 struct strbuf author_ident = STRBUF_INIT;
1570 const char *index_file, *reflog_msg;
1571 struct object_id oid;
1572 struct commit_list *parents = NULL;
1573 struct stat statbuf;
1574 struct commit *current_head = NULL;
1575 struct commit_extra_header *extra = NULL;
1576 struct strbuf err = STRBUF_INIT;
1578 if (argc == 2 && !strcmp(argv[1], "-h"))
1579 usage_with_options(builtin_commit_usage, builtin_commit_options);
1581 status_init_config(&s, git_commit_config);
1582 s.commit_template = 1;
1583 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1584 s.colopts = 0;
1586 if (get_oid("HEAD", &oid))
1587 current_head = NULL;
1588 else {
1589 current_head = lookup_commit_or_die(&oid, "HEAD");
1590 if (parse_commit(current_head))
1591 die(_("could not parse HEAD commit"));
1593 verbose = -1; /* unspecified */
1594 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1595 builtin_commit_usage,
1596 prefix, current_head, &s);
1597 if (verbose == -1)
1598 verbose = (config_commit_verbose < 0) ? 0 : config_commit_verbose;
1600 if (dry_run)
1601 return dry_run_commit(argc, argv, prefix, current_head, &s);
1602 index_file = prepare_index(argc, argv, prefix, current_head, 0);
1604 /* Set up everything for writing the commit object. This includes
1605 running hooks, writing the trees, and interacting with the user. */
1606 if (!prepare_to_commit(index_file, prefix,
1607 current_head, &s, &author_ident)) {
1608 rollback_index_files();
1609 return 1;
1612 /* Determine parents */
1613 reflog_msg = getenv("GIT_REFLOG_ACTION");
1614 if (!current_head) {
1615 if (!reflog_msg)
1616 reflog_msg = "commit (initial)";
1617 } else if (amend) {
1618 if (!reflog_msg)
1619 reflog_msg = "commit (amend)";
1620 parents = copy_commit_list(current_head->parents);
1621 } else if (whence == FROM_MERGE) {
1622 struct strbuf m = STRBUF_INIT;
1623 FILE *fp;
1624 int allow_fast_forward = 1;
1625 struct commit_list **pptr = &parents;
1627 if (!reflog_msg)
1628 reflog_msg = "commit (merge)";
1629 pptr = commit_list_append(current_head, pptr);
1630 fp = xfopen(git_path_merge_head(the_repository), "r");
1631 while (strbuf_getline_lf(&m, fp) != EOF) {
1632 struct commit *parent;
1634 parent = get_merge_parent(m.buf);
1635 if (!parent)
1636 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1637 pptr = commit_list_append(parent, pptr);
1639 fclose(fp);
1640 strbuf_release(&m);
1641 if (!stat(git_path_merge_mode(the_repository), &statbuf)) {
1642 if (strbuf_read_file(&sb, git_path_merge_mode(the_repository), 0) < 0)
1643 die_errno(_("could not read MERGE_MODE"));
1644 if (!strcmp(sb.buf, "no-ff"))
1645 allow_fast_forward = 0;
1647 if (allow_fast_forward)
1648 reduce_heads_replace(&parents);
1649 } else {
1650 if (!reflog_msg)
1651 reflog_msg = (whence == FROM_CHERRY_PICK)
1652 ? "commit (cherry-pick)"
1653 : "commit";
1654 commit_list_insert(current_head, &parents);
1657 /* Finally, get the commit message */
1658 strbuf_reset(&sb);
1659 if (strbuf_read_file(&sb, git_path_commit_editmsg(), 0) < 0) {
1660 int saved_errno = errno;
1661 rollback_index_files();
1662 die(_("could not read commit message: %s"), strerror(saved_errno));
1665 cleanup_message(&sb, cleanup_mode, verbose);
1667 if (message_is_empty(&sb, cleanup_mode) && !allow_empty_message) {
1668 rollback_index_files();
1669 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1670 exit(1);
1672 if (template_untouched(&sb, template_file, cleanup_mode) && !allow_empty_message) {
1673 rollback_index_files();
1674 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1675 exit(1);
1678 if (amend) {
1679 const char *exclude_gpgsig[2] = { "gpgsig", NULL };
1680 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1681 } else {
1682 struct commit_extra_header **tail = &extra;
1683 append_merge_tag_headers(parents, &tail);
1686 if (commit_tree_extended(sb.buf, sb.len, &active_cache_tree->oid,
1687 parents, &oid, author_ident.buf, sign_commit,
1688 extra)) {
1689 rollback_index_files();
1690 die(_("failed to write commit object"));
1692 strbuf_release(&author_ident);
1693 free_commit_extra_headers(extra);
1695 if (update_head_with_reflog(current_head, &oid, reflog_msg, &sb,
1696 &err)) {
1697 rollback_index_files();
1698 die("%s", err.buf);
1701 sequencer_post_commit_cleanup(the_repository, 0);
1702 unlink(git_path_merge_head(the_repository));
1703 unlink(git_path_merge_msg(the_repository));
1704 unlink(git_path_merge_mode(the_repository));
1705 unlink(git_path_squash_msg(the_repository));
1707 if (commit_index_files())
1708 die(_("repository has been updated, but unable to write\n"
1709 "new_index file. Check that disk is not full and quota is\n"
1710 "not exceeded, and then \"git restore --staged :/\" to recover."));
1712 if (git_env_bool(GIT_TEST_COMMIT_GRAPH, 0) &&
1713 write_commit_graph_reachable(get_object_directory(), 0, NULL))
1714 return 1;
1716 repo_rerere(the_repository, 0);
1717 run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
1718 run_commit_hook(use_editor, get_index_file(), "post-commit", NULL);
1719 if (amend && !no_post_rewrite) {
1720 commit_post_rewrite(the_repository, current_head, &oid);
1722 if (!quiet) {
1723 unsigned int flags = 0;
1725 if (!current_head)
1726 flags |= SUMMARY_INITIAL_COMMIT;
1727 if (author_date_is_interesting())
1728 flags |= SUMMARY_SHOW_AUTHOR_DATE;
1729 print_commit_summary(the_repository, prefix,
1730 &oid, flags);
1733 UNLEAK(err);
1734 UNLEAK(sb);
1735 return 0;