object: add object_array initializer helper function
[git/gitster.git] / builtin / commit.c
blobe67c4be2211eed8f6c8d61f510adc2fc87d9b007
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_VARIABLE
9 #include "cache.h"
10 #include "advice.h"
11 #include "config.h"
12 #include "lockfile.h"
13 #include "cache-tree.h"
14 #include "color.h"
15 #include "dir.h"
16 #include "editor.h"
17 #include "environment.h"
18 #include "builtin.h"
19 #include "diff.h"
20 #include "diffcore.h"
21 #include "commit.h"
22 #include "gettext.h"
23 #include "revision.h"
24 #include "wt-status.h"
25 #include "run-command.h"
26 #include "hook.h"
27 #include "refs.h"
28 #include "log-tree.h"
29 #include "strbuf.h"
30 #include "utf8.h"
31 #include "object-name.h"
32 #include "parse-options.h"
33 #include "string-list.h"
34 #include "rerere.h"
35 #include "unpack-trees.h"
36 #include "quote.h"
37 #include "submodule.h"
38 #include "gpg-interface.h"
39 #include "column.h"
40 #include "sequencer.h"
41 #include "mailmap.h"
42 #include "help.h"
43 #include "commit-reach.h"
44 #include "commit-graph.h"
45 #include "pretty.h"
47 static const char * const builtin_commit_usage[] = {
48 N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n"
49 " [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]\n"
50 " [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n"
51 " [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n"
52 " [--date=<date>] [--cleanup=<mode>] [--[no-]status]\n"
53 " [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]\n"
54 " [(--trailer <token>[(=|:)<value>])...] [-S[<keyid>]]\n"
55 " [--] [<pathspec>...]"),
56 NULL
59 static const char * const builtin_status_usage[] = {
60 N_("git status [<options>] [--] [<pathspec>...]"),
61 NULL
64 static const char empty_amend_advice[] =
65 N_("You asked to amend the most recent commit, but doing so would make\n"
66 "it empty. You can repeat your command with --allow-empty, or you can\n"
67 "remove the commit entirely with \"git reset HEAD^\".\n");
69 static const char empty_cherry_pick_advice[] =
70 N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
71 "If you wish to commit it anyway, use:\n"
72 "\n"
73 " git commit --allow-empty\n"
74 "\n");
76 static const char empty_rebase_pick_advice[] =
77 N_("Otherwise, please use 'git rebase --skip'\n");
79 static const char empty_cherry_pick_advice_single[] =
80 N_("Otherwise, please use 'git cherry-pick --skip'\n");
82 static const char empty_cherry_pick_advice_multi[] =
83 N_("and then use:\n"
84 "\n"
85 " git cherry-pick --continue\n"
86 "\n"
87 "to resume cherry-picking the remaining commits.\n"
88 "If you wish to skip this commit, use:\n"
89 "\n"
90 " git cherry-pick --skip\n"
91 "\n");
93 static const char *color_status_slots[] = {
94 [WT_STATUS_HEADER] = "header",
95 [WT_STATUS_UPDATED] = "updated",
96 [WT_STATUS_CHANGED] = "changed",
97 [WT_STATUS_UNTRACKED] = "untracked",
98 [WT_STATUS_NOBRANCH] = "noBranch",
99 [WT_STATUS_UNMERGED] = "unmerged",
100 [WT_STATUS_LOCAL_BRANCH] = "localBranch",
101 [WT_STATUS_REMOTE_BRANCH] = "remoteBranch",
102 [WT_STATUS_ONBRANCH] = "branch",
105 static const char *use_message_buffer;
106 static struct lock_file index_lock; /* real index */
107 static struct lock_file false_lock; /* used only for partial commits */
108 static enum {
109 COMMIT_AS_IS = 1,
110 COMMIT_NORMAL,
111 COMMIT_PARTIAL
112 } commit_style;
114 static const char *logfile, *force_author;
115 static const char *template_file;
117 * The _message variables are commit names from which to take
118 * the commit message and/or authorship.
120 static const char *author_message, *author_message_buffer;
121 static char *edit_message, *use_message;
122 static char *fixup_message, *fixup_commit, *squash_message;
123 static const char *fixup_prefix;
124 static int all, also, interactive, patch_interactive, only, amend, signoff;
125 static int edit_flag = -1; /* unspecified */
126 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
127 static int config_commit_verbose = -1; /* unspecified */
128 static int no_post_rewrite, allow_empty_message, pathspec_file_nul;
129 static char *untracked_files_arg, *force_date, *ignore_submodule_arg, *ignored_arg;
130 static char *sign_commit, *pathspec_from_file;
131 static struct strvec trailer_args = STRVEC_INIT;
134 * The default commit message cleanup mode will remove the lines
135 * beginning with # (shell comments) and leading and trailing
136 * whitespaces (empty lines or containing only whitespaces)
137 * if editor is used, and only the whitespaces if the message
138 * is specified explicitly.
140 static enum commit_msg_cleanup_mode cleanup_mode;
141 static const char *cleanup_arg;
143 static enum commit_whence whence;
144 static int use_editor = 1, include_status = 1;
145 static int have_option_m;
146 static struct strbuf message = STRBUF_INIT;
148 static enum wt_status_format status_format = STATUS_FORMAT_UNSPECIFIED;
150 static int opt_pass_trailer(const struct option *opt, const char *arg, int unset)
152 BUG_ON_OPT_NEG(unset);
154 strvec_pushl(opt->value, "--trailer", arg, NULL);
155 return 0;
158 static int opt_parse_porcelain(const struct option *opt, const char *arg, int unset)
160 enum wt_status_format *value = (enum wt_status_format *)opt->value;
161 if (unset)
162 *value = STATUS_FORMAT_NONE;
163 else if (!arg)
164 *value = STATUS_FORMAT_PORCELAIN;
165 else if (!strcmp(arg, "v1") || !strcmp(arg, "1"))
166 *value = STATUS_FORMAT_PORCELAIN;
167 else if (!strcmp(arg, "v2") || !strcmp(arg, "2"))
168 *value = STATUS_FORMAT_PORCELAIN_V2;
169 else
170 die("unsupported porcelain version '%s'", arg);
172 return 0;
175 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
177 struct strbuf *buf = opt->value;
178 if (unset) {
179 have_option_m = 0;
180 strbuf_setlen(buf, 0);
181 } else {
182 have_option_m = 1;
183 if (buf->len)
184 strbuf_addch(buf, '\n');
185 strbuf_addstr(buf, arg);
186 strbuf_complete_line(buf);
188 return 0;
191 static int opt_parse_rename_score(const struct option *opt, const char *arg, int unset)
193 const char **value = opt->value;
195 BUG_ON_OPT_NEG(unset);
197 if (arg != NULL && *arg == '=')
198 arg = arg + 1;
200 *value = arg;
201 return 0;
204 static void determine_whence(struct wt_status *s)
206 if (file_exists(git_path_merge_head(the_repository)))
207 whence = FROM_MERGE;
208 else if (!sequencer_determine_whence(the_repository, &whence))
209 whence = FROM_COMMIT;
210 if (s)
211 s->whence = whence;
214 static void status_init_config(struct wt_status *s, config_fn_t fn)
216 wt_status_prepare(the_repository, s);
217 init_diff_ui_defaults();
218 git_config(fn, s);
219 determine_whence(s);
220 s->hints = advice_enabled(ADVICE_STATUS_HINTS); /* must come after git_config() */
223 static void rollback_index_files(void)
225 switch (commit_style) {
226 case COMMIT_AS_IS:
227 break; /* nothing to do */
228 case COMMIT_NORMAL:
229 rollback_lock_file(&index_lock);
230 break;
231 case COMMIT_PARTIAL:
232 rollback_lock_file(&index_lock);
233 rollback_lock_file(&false_lock);
234 break;
238 static int commit_index_files(void)
240 int err = 0;
242 switch (commit_style) {
243 case COMMIT_AS_IS:
244 break; /* nothing to do */
245 case COMMIT_NORMAL:
246 err = commit_lock_file(&index_lock);
247 break;
248 case COMMIT_PARTIAL:
249 err = commit_lock_file(&index_lock);
250 rollback_lock_file(&false_lock);
251 break;
254 return err;
258 * Take a union of paths in the index and the named tree (typically, "HEAD"),
259 * and return the paths that match the given pattern in list.
261 static int list_paths(struct string_list *list, const char *with_tree,
262 const struct pathspec *pattern)
264 int i, ret;
265 char *m;
267 if (!pattern->nr)
268 return 0;
270 m = xcalloc(1, pattern->nr);
272 if (with_tree) {
273 char *max_prefix = common_prefix(pattern);
274 overlay_tree_on_index(&the_index, with_tree, max_prefix);
275 free(max_prefix);
278 /* TODO: audit for interaction with sparse-index. */
279 ensure_full_index(&the_index);
280 for (i = 0; i < the_index.cache_nr; i++) {
281 const struct cache_entry *ce = the_index.cache[i];
282 struct string_list_item *item;
284 if (ce->ce_flags & CE_UPDATE)
285 continue;
286 if (!ce_path_match(&the_index, ce, pattern, m))
287 continue;
288 item = string_list_insert(list, ce->name);
289 if (ce_skip_worktree(ce))
290 item->util = item; /* better a valid pointer than a fake one */
293 ret = report_path_error(m, pattern);
294 free(m);
295 return ret;
298 static void add_remove_files(struct string_list *list)
300 int i;
301 for (i = 0; i < list->nr; i++) {
302 struct stat st;
303 struct string_list_item *p = &(list->items[i]);
305 /* p->util is skip-worktree */
306 if (p->util)
307 continue;
309 if (!lstat(p->string, &st)) {
310 if (add_to_index(&the_index, p->string, &st, 0))
311 die(_("updating files failed"));
312 } else
313 remove_file_from_index(&the_index, p->string);
317 static void create_base_index(const struct commit *current_head)
319 struct tree *tree;
320 struct unpack_trees_options opts;
321 struct tree_desc t;
323 if (!current_head) {
324 discard_index(&the_index);
325 return;
328 memset(&opts, 0, sizeof(opts));
329 opts.head_idx = 1;
330 opts.index_only = 1;
331 opts.merge = 1;
332 opts.src_index = &the_index;
333 opts.dst_index = &the_index;
335 opts.fn = oneway_merge;
336 tree = parse_tree_indirect(&current_head->object.oid);
337 if (!tree)
338 die(_("failed to unpack HEAD tree object"));
339 parse_tree(tree);
340 init_tree_desc(&t, tree->buffer, tree->size);
341 if (unpack_trees(1, &t, &opts))
342 exit(128); /* We've already reported the error, finish dying */
345 static void refresh_cache_or_die(int refresh_flags)
348 * refresh_flags contains REFRESH_QUIET, so the only errors
349 * are for unmerged entries.
351 if (refresh_index(&the_index, refresh_flags | REFRESH_IN_PORCELAIN, NULL, NULL, NULL))
352 die_resolve_conflict("commit");
355 static const char *prepare_index(const char **argv, const char *prefix,
356 const struct commit *current_head, int is_status)
358 struct string_list partial = STRING_LIST_INIT_DUP;
359 struct pathspec pathspec;
360 int refresh_flags = REFRESH_QUIET;
361 const char *ret;
363 if (is_status)
364 refresh_flags |= REFRESH_UNMERGED;
365 parse_pathspec(&pathspec, 0,
366 PATHSPEC_PREFER_FULL,
367 prefix, argv);
369 if (pathspec_from_file) {
370 if (interactive)
371 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--interactive/--patch");
373 if (all)
374 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "-a");
376 if (pathspec.nr)
377 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
379 parse_pathspec_file(&pathspec, 0,
380 PATHSPEC_PREFER_FULL,
381 prefix, pathspec_from_file, pathspec_file_nul);
382 } else if (pathspec_file_nul) {
383 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
386 if (!pathspec.nr && (also || (only && !allow_empty &&
387 (!amend || (fixup_message && strcmp(fixup_prefix, "amend"))))))
388 die(_("No paths with --include/--only does not make sense."));
390 if (repo_read_index_preload(the_repository, &pathspec, 0) < 0)
391 die(_("index file corrupt"));
393 if (interactive) {
394 char *old_index_env = NULL, *old_repo_index_file;
395 repo_hold_locked_index(the_repository, &index_lock,
396 LOCK_DIE_ON_ERROR);
398 refresh_cache_or_die(refresh_flags);
400 if (write_locked_index(&the_index, &index_lock, 0))
401 die(_("unable to create temporary index"));
403 old_repo_index_file = the_repository->index_file;
404 the_repository->index_file =
405 (char *)get_lock_file_path(&index_lock);
406 old_index_env = xstrdup_or_null(getenv(INDEX_ENVIRONMENT));
407 setenv(INDEX_ENVIRONMENT, the_repository->index_file, 1);
409 if (interactive_add(argv, prefix, patch_interactive) != 0)
410 die(_("interactive add failed"));
412 the_repository->index_file = old_repo_index_file;
413 if (old_index_env && *old_index_env)
414 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
415 else
416 unsetenv(INDEX_ENVIRONMENT);
417 FREE_AND_NULL(old_index_env);
419 discard_index(&the_index);
420 read_index_from(&the_index, get_lock_file_path(&index_lock),
421 get_git_dir());
422 if (cache_tree_update(&the_index, WRITE_TREE_SILENT) == 0) {
423 if (reopen_lock_file(&index_lock) < 0)
424 die(_("unable to write index file"));
425 if (write_locked_index(&the_index, &index_lock, 0))
426 die(_("unable to update temporary index"));
427 } else
428 warning(_("Failed to update main cache tree"));
430 commit_style = COMMIT_NORMAL;
431 ret = get_lock_file_path(&index_lock);
432 goto out;
436 * Non partial, non as-is commit.
438 * (1) get the real index;
439 * (2) update the_index as necessary;
440 * (3) write the_index out to the real index (still locked);
441 * (4) return the name of the locked index file.
443 * The caller should run hooks on the locked real index, and
444 * (A) if all goes well, commit the real index;
445 * (B) on failure, rollback the real index.
447 if (all || (also && pathspec.nr)) {
448 repo_hold_locked_index(the_repository, &index_lock,
449 LOCK_DIE_ON_ERROR);
450 add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
451 refresh_cache_or_die(refresh_flags);
452 cache_tree_update(&the_index, WRITE_TREE_SILENT);
453 if (write_locked_index(&the_index, &index_lock, 0))
454 die(_("unable to write new_index file"));
455 commit_style = COMMIT_NORMAL;
456 ret = get_lock_file_path(&index_lock);
457 goto out;
461 * As-is commit.
463 * (1) return the name of the real index file.
465 * The caller should run hooks on the real index,
466 * and create commit from the_index.
467 * We still need to refresh the index here.
469 if (!only && !pathspec.nr) {
470 repo_hold_locked_index(the_repository, &index_lock,
471 LOCK_DIE_ON_ERROR);
472 refresh_cache_or_die(refresh_flags);
473 if (the_index.cache_changed
474 || !cache_tree_fully_valid(the_index.cache_tree))
475 cache_tree_update(&the_index, WRITE_TREE_SILENT);
476 if (write_locked_index(&the_index, &index_lock,
477 COMMIT_LOCK | SKIP_IF_UNCHANGED))
478 die(_("unable to write new_index file"));
479 commit_style = COMMIT_AS_IS;
480 ret = get_index_file();
481 goto out;
485 * A partial commit.
487 * (0) find the set of affected paths;
488 * (1) get lock on the real index file;
489 * (2) update the_index with the given paths;
490 * (3) write the_index out to the real index (still locked);
491 * (4) get lock on the false index file;
492 * (5) reset the_index from HEAD;
493 * (6) update the_index the same way as (2);
494 * (7) write the_index out to the false index file;
495 * (8) return the name of the false index file (still locked);
497 * The caller should run hooks on the locked false index, and
498 * create commit from it. Then
499 * (A) if all goes well, commit the real index;
500 * (B) on failure, rollback the real index;
501 * In either case, rollback the false index.
503 commit_style = COMMIT_PARTIAL;
505 if (whence != FROM_COMMIT) {
506 if (whence == FROM_MERGE)
507 die(_("cannot do a partial commit during a merge."));
508 else if (is_from_cherry_pick(whence))
509 die(_("cannot do a partial commit during a cherry-pick."));
510 else if (is_from_rebase(whence))
511 die(_("cannot do a partial commit during a rebase."));
514 if (list_paths(&partial, !current_head ? NULL : "HEAD", &pathspec))
515 exit(1);
517 discard_index(&the_index);
518 if (repo_read_index(the_repository) < 0)
519 die(_("cannot read the index"));
521 repo_hold_locked_index(the_repository, &index_lock, LOCK_DIE_ON_ERROR);
522 add_remove_files(&partial);
523 refresh_index(&the_index, REFRESH_QUIET, NULL, NULL, NULL);
524 cache_tree_update(&the_index, WRITE_TREE_SILENT);
525 if (write_locked_index(&the_index, &index_lock, 0))
526 die(_("unable to write new_index file"));
528 hold_lock_file_for_update(&false_lock,
529 git_path("next-index-%"PRIuMAX,
530 (uintmax_t) getpid()),
531 LOCK_DIE_ON_ERROR);
533 create_base_index(current_head);
534 add_remove_files(&partial);
535 refresh_index(&the_index, REFRESH_QUIET, NULL, NULL, NULL);
537 if (write_locked_index(&the_index, &false_lock, 0))
538 die(_("unable to write temporary index file"));
540 discard_index(&the_index);
541 ret = get_lock_file_path(&false_lock);
542 read_index_from(&the_index, ret, get_git_dir());
543 out:
544 string_list_clear(&partial, 0);
545 clear_pathspec(&pathspec);
546 return ret;
549 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
550 struct wt_status *s)
552 struct object_id oid;
554 if (s->relative_paths)
555 s->prefix = prefix;
557 if (amend) {
558 s->amend = 1;
559 s->reference = "HEAD^1";
561 s->verbose = verbose;
562 s->index_file = index_file;
563 s->fp = fp;
564 s->nowarn = nowarn;
565 s->is_initial = repo_get_oid(the_repository, s->reference, &oid) ? 1 : 0;
566 if (!s->is_initial)
567 oidcpy(&s->oid_commit, &oid);
568 s->status_format = status_format;
569 s->ignore_submodule_arg = ignore_submodule_arg;
571 wt_status_collect(s);
572 wt_status_print(s);
573 wt_status_collect_free_buffers(s);
575 return s->committable;
578 static int is_a_merge(const struct commit *current_head)
580 return !!(current_head->parents && current_head->parents->next);
583 static void assert_split_ident(struct ident_split *id, const struct strbuf *buf)
585 if (split_ident_line(id, buf->buf, buf->len) || !id->date_begin)
586 BUG("unable to parse our own ident: %s", buf->buf);
589 static void export_one(const char *var, const char *s, const char *e, int hack)
591 struct strbuf buf = STRBUF_INIT;
592 if (hack)
593 strbuf_addch(&buf, hack);
594 strbuf_add(&buf, s, e - s);
595 setenv(var, buf.buf, 1);
596 strbuf_release(&buf);
599 static int parse_force_date(const char *in, struct strbuf *out)
601 strbuf_addch(out, '@');
603 if (parse_date(in, out) < 0) {
604 int errors = 0;
605 unsigned long t = approxidate_careful(in, &errors);
606 if (errors)
607 return -1;
608 strbuf_addf(out, "%lu", t);
611 return 0;
614 static void set_ident_var(char **buf, char *val)
616 free(*buf);
617 *buf = val;
620 static void determine_author_info(struct strbuf *author_ident)
622 char *name, *email, *date;
623 struct ident_split author;
625 name = xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
626 email = xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
627 date = xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
629 if (author_message) {
630 struct ident_split ident;
631 size_t len;
632 const char *a;
634 a = find_commit_header(author_message_buffer, "author", &len);
635 if (!a)
636 die(_("commit '%s' lacks author header"), author_message);
637 if (split_ident_line(&ident, a, len) < 0)
638 die(_("commit '%s' has malformed author line"), author_message);
640 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
641 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
643 if (ident.date_begin) {
644 struct strbuf date_buf = STRBUF_INIT;
645 strbuf_addch(&date_buf, '@');
646 strbuf_add(&date_buf, ident.date_begin, ident.date_end - ident.date_begin);
647 strbuf_addch(&date_buf, ' ');
648 strbuf_add(&date_buf, ident.tz_begin, ident.tz_end - ident.tz_begin);
649 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
653 if (force_author) {
654 struct ident_split ident;
656 if (split_ident_line(&ident, force_author, strlen(force_author)) < 0)
657 die(_("malformed --author parameter"));
658 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
659 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
662 if (force_date) {
663 struct strbuf date_buf = STRBUF_INIT;
664 if (parse_force_date(force_date, &date_buf))
665 die(_("invalid date format: %s"), force_date);
666 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
669 strbuf_addstr(author_ident, fmt_ident(name, email, WANT_AUTHOR_IDENT, date,
670 IDENT_STRICT));
671 assert_split_ident(&author, author_ident);
672 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
673 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
674 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
675 free(name);
676 free(email);
677 free(date);
680 static int author_date_is_interesting(void)
682 return author_message || force_date;
685 static void adjust_comment_line_char(const struct strbuf *sb)
687 char candidates[] = "#;@!$%^&|:";
688 char *candidate;
689 const char *p;
691 comment_line_char = candidates[0];
692 if (!memchr(sb->buf, comment_line_char, sb->len))
693 return;
695 p = sb->buf;
696 candidate = strchr(candidates, *p);
697 if (candidate)
698 *candidate = ' ';
699 for (p = sb->buf; *p; p++) {
700 if ((p[0] == '\n' || p[0] == '\r') && p[1]) {
701 candidate = strchr(candidates, p[1]);
702 if (candidate)
703 *candidate = ' ';
707 for (p = candidates; *p == ' '; p++)
709 if (!*p)
710 die(_("unable to select a comment character that is not used\n"
711 "in the current commit message"));
712 comment_line_char = *p;
715 static void prepare_amend_commit(struct commit *commit, struct strbuf *sb,
716 struct pretty_print_context *ctx)
718 const char *buffer, *subject, *fmt;
720 buffer = repo_get_commit_buffer(the_repository, commit, NULL);
721 find_commit_subject(buffer, &subject);
723 * If we amend the 'amend!' commit then we don't want to
724 * duplicate the subject line.
726 fmt = starts_with(subject, "amend!") ? "%b" : "%B";
727 repo_format_commit_message(the_repository, commit, fmt, sb, ctx);
728 repo_unuse_commit_buffer(the_repository, commit, buffer);
731 static int prepare_to_commit(const char *index_file, const char *prefix,
732 struct commit *current_head,
733 struct wt_status *s,
734 struct strbuf *author_ident)
736 struct stat statbuf;
737 struct strbuf committer_ident = STRBUF_INIT;
738 int committable;
739 struct strbuf sb = STRBUF_INIT;
740 const char *hook_arg1 = NULL;
741 const char *hook_arg2 = NULL;
742 int clean_message_contents = (cleanup_mode != COMMIT_MSG_CLEANUP_NONE);
743 int old_display_comment_prefix;
744 int merge_contains_scissors = 0;
745 int invoked_hook;
747 /* This checks and barfs if author is badly specified */
748 determine_author_info(author_ident);
750 if (!no_verify && run_commit_hook(use_editor, index_file, &invoked_hook,
751 "pre-commit", NULL))
752 return 0;
754 if (squash_message) {
756 * Insert the proper subject line before other commit
757 * message options add their content.
759 if (use_message && !strcmp(use_message, squash_message))
760 strbuf_addstr(&sb, "squash! ");
761 else {
762 struct pretty_print_context ctx = {0};
763 struct commit *c;
764 c = lookup_commit_reference_by_name(squash_message);
765 if (!c)
766 die(_("could not lookup commit %s"), squash_message);
767 ctx.output_encoding = get_commit_output_encoding();
768 repo_format_commit_message(the_repository, c,
769 "squash! %s\n\n", &sb,
770 &ctx);
774 if (have_option_m && !fixup_message) {
775 strbuf_addbuf(&sb, &message);
776 hook_arg1 = "message";
777 } else if (logfile && !strcmp(logfile, "-")) {
778 if (isatty(0))
779 fprintf(stderr, _("(reading log message from standard input)\n"));
780 if (strbuf_read(&sb, 0, 0) < 0)
781 die_errno(_("could not read log from standard input"));
782 hook_arg1 = "message";
783 } else if (logfile) {
784 if (strbuf_read_file(&sb, logfile, 0) < 0)
785 die_errno(_("could not read log file '%s'"),
786 logfile);
787 hook_arg1 = "message";
788 } else if (use_message) {
789 char *buffer;
790 buffer = strstr(use_message_buffer, "\n\n");
791 if (buffer)
792 strbuf_addstr(&sb, skip_blank_lines(buffer + 2));
793 hook_arg1 = "commit";
794 hook_arg2 = use_message;
795 } else if (fixup_message) {
796 struct pretty_print_context ctx = {0};
797 struct commit *commit;
798 char *fmt;
799 commit = lookup_commit_reference_by_name(fixup_commit);
800 if (!commit)
801 die(_("could not lookup commit %s"), fixup_commit);
802 ctx.output_encoding = get_commit_output_encoding();
803 fmt = xstrfmt("%s! %%s\n\n", fixup_prefix);
804 repo_format_commit_message(the_repository, commit, fmt, &sb,
805 &ctx);
806 free(fmt);
807 hook_arg1 = "message";
810 * Only `-m` commit message option is checked here, as
811 * it supports `--fixup` to append the commit message.
813 * The other commit message options `-c`/`-C`/`-F` are
814 * incompatible with all the forms of `--fixup` and
815 * have already errored out while parsing the `git commit`
816 * options.
818 if (have_option_m && !strcmp(fixup_prefix, "fixup"))
819 strbuf_addbuf(&sb, &message);
821 if (!strcmp(fixup_prefix, "amend")) {
822 if (have_option_m)
823 die(_("options '%s' and '%s:%s' cannot be used together"), "-m", "--fixup", fixup_message);
824 prepare_amend_commit(commit, &sb, &ctx);
826 } else if (!stat(git_path_merge_msg(the_repository), &statbuf)) {
827 size_t merge_msg_start;
830 * prepend SQUASH_MSG here if it exists and a
831 * "merge --squash" was originally performed
833 if (!stat(git_path_squash_msg(the_repository), &statbuf)) {
834 if (strbuf_read_file(&sb, git_path_squash_msg(the_repository), 0) < 0)
835 die_errno(_("could not read SQUASH_MSG"));
836 hook_arg1 = "squash";
837 } else
838 hook_arg1 = "merge";
840 merge_msg_start = sb.len;
841 if (strbuf_read_file(&sb, git_path_merge_msg(the_repository), 0) < 0)
842 die_errno(_("could not read MERGE_MSG"));
844 if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS &&
845 wt_status_locate_end(sb.buf + merge_msg_start,
846 sb.len - merge_msg_start) <
847 sb.len - merge_msg_start)
848 merge_contains_scissors = 1;
849 } else if (!stat(git_path_squash_msg(the_repository), &statbuf)) {
850 if (strbuf_read_file(&sb, git_path_squash_msg(the_repository), 0) < 0)
851 die_errno(_("could not read SQUASH_MSG"));
852 hook_arg1 = "squash";
853 } else if (template_file) {
854 if (strbuf_read_file(&sb, template_file, 0) < 0)
855 die_errno(_("could not read '%s'"), template_file);
856 hook_arg1 = "template";
857 clean_message_contents = 0;
861 * The remaining cases don't modify the template message, but
862 * just set the argument(s) to the prepare-commit-msg hook.
864 else if (whence == FROM_MERGE)
865 hook_arg1 = "merge";
866 else if (is_from_cherry_pick(whence) || whence == FROM_REBASE_PICK) {
867 hook_arg1 = "commit";
868 hook_arg2 = "CHERRY_PICK_HEAD";
871 if (squash_message) {
873 * If squash_commit was used for the commit subject,
874 * then we're possibly hijacking other commit log options.
875 * Reset the hook args to tell the real story.
877 hook_arg1 = "message";
878 hook_arg2 = "";
881 s->fp = fopen_for_writing(git_path_commit_editmsg());
882 if (!s->fp)
883 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
885 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
886 old_display_comment_prefix = s->display_comment_prefix;
887 s->display_comment_prefix = 1;
890 * Most hints are counter-productive when the commit has
891 * already started.
893 s->hints = 0;
895 if (clean_message_contents)
896 strbuf_stripspace(&sb, 0);
898 if (signoff)
899 append_signoff(&sb, ignore_non_trailer(sb.buf, sb.len), 0);
901 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
902 die_errno(_("could not write commit template"));
904 if (auto_comment_line_char)
905 adjust_comment_line_char(&sb);
906 strbuf_release(&sb);
908 /* This checks if committer ident is explicitly given */
909 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
910 if (use_editor && include_status) {
911 int ident_shown = 0;
912 int saved_color_setting;
913 struct ident_split ci, ai;
914 const char *hint_cleanup_all = allow_empty_message ?
915 _("Please enter the commit message for your changes."
916 " Lines starting\nwith '%c' will be ignored.\n") :
917 _("Please enter the commit message for your changes."
918 " Lines starting\nwith '%c' will be ignored, and an empty"
919 " message aborts the commit.\n");
920 const char *hint_cleanup_space = allow_empty_message ?
921 _("Please enter the commit message for your changes."
922 " Lines starting\n"
923 "with '%c' will be kept; you may remove them"
924 " yourself if you want to.\n") :
925 _("Please enter the commit message for your changes."
926 " Lines starting\n"
927 "with '%c' will be kept; you may remove them"
928 " yourself if you want to.\n"
929 "An empty message aborts the commit.\n");
930 if (whence != FROM_COMMIT) {
931 if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS &&
932 !merge_contains_scissors)
933 wt_status_add_cut_line(s->fp);
934 status_printf_ln(
935 s, GIT_COLOR_NORMAL,
936 whence == FROM_MERGE ?
937 _("\n"
938 "It looks like you may be committing a merge.\n"
939 "If this is not correct, please run\n"
940 " git update-ref -d MERGE_HEAD\n"
941 "and try again.\n") :
942 _("\n"
943 "It looks like you may be committing a cherry-pick.\n"
944 "If this is not correct, please run\n"
945 " git update-ref -d CHERRY_PICK_HEAD\n"
946 "and try again.\n"));
949 fprintf(s->fp, "\n");
950 if (cleanup_mode == COMMIT_MSG_CLEANUP_ALL)
951 status_printf(s, GIT_COLOR_NORMAL, hint_cleanup_all, comment_line_char);
952 else if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS) {
953 if (whence == FROM_COMMIT && !merge_contains_scissors)
954 wt_status_add_cut_line(s->fp);
955 } else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
956 status_printf(s, GIT_COLOR_NORMAL, hint_cleanup_space, comment_line_char);
959 * These should never fail because they come from our own
960 * fmt_ident. They may fail the sane_ident test, but we know
961 * that the name and mail pointers will at least be valid,
962 * which is enough for our tests and printing here.
964 assert_split_ident(&ai, author_ident);
965 assert_split_ident(&ci, &committer_ident);
967 if (ident_cmp(&ai, &ci))
968 status_printf_ln(s, GIT_COLOR_NORMAL,
969 _("%s"
970 "Author: %.*s <%.*s>"),
971 ident_shown++ ? "" : "\n",
972 (int)(ai.name_end - ai.name_begin), ai.name_begin,
973 (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);
975 if (author_date_is_interesting())
976 status_printf_ln(s, GIT_COLOR_NORMAL,
977 _("%s"
978 "Date: %s"),
979 ident_shown++ ? "" : "\n",
980 show_ident_date(&ai, DATE_MODE(NORMAL)));
982 if (!committer_ident_sufficiently_given())
983 status_printf_ln(s, GIT_COLOR_NORMAL,
984 _("%s"
985 "Committer: %.*s <%.*s>"),
986 ident_shown++ ? "" : "\n",
987 (int)(ci.name_end - ci.name_begin), ci.name_begin,
988 (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
990 status_printf_ln(s, GIT_COLOR_NORMAL, "%s", ""); /* Add new line for clarity */
992 saved_color_setting = s->use_color;
993 s->use_color = 0;
994 committable = run_status(s->fp, index_file, prefix, 1, s);
995 s->use_color = saved_color_setting;
996 string_list_clear(&s->change, 1);
997 } else {
998 struct object_id oid;
999 const char *parent = "HEAD";
1001 if (!the_index.cache_nr) {
1002 discard_index(&the_index);
1003 if (repo_read_index(the_repository) < 0)
1004 die(_("Cannot read index"));
1007 if (amend)
1008 parent = "HEAD^1";
1010 if (repo_get_oid(the_repository, parent, &oid)) {
1011 int i, ita_nr = 0;
1013 /* TODO: audit for interaction with sparse-index. */
1014 ensure_full_index(&the_index);
1015 for (i = 0; i < the_index.cache_nr; i++)
1016 if (ce_intent_to_add(the_index.cache[i]))
1017 ita_nr++;
1018 committable = the_index.cache_nr - ita_nr > 0;
1019 } else {
1021 * Unless the user did explicitly request a submodule
1022 * ignore mode by passing a command line option we do
1023 * not ignore any changed submodule SHA-1s when
1024 * comparing index and parent, no matter what is
1025 * configured. Otherwise we won't commit any
1026 * submodules which were manually staged, which would
1027 * be really confusing.
1029 struct diff_flags flags = DIFF_FLAGS_INIT;
1030 flags.override_submodule_config = 1;
1031 if (ignore_submodule_arg &&
1032 !strcmp(ignore_submodule_arg, "all"))
1033 flags.ignore_submodules = 1;
1034 committable = index_differs_from(the_repository,
1035 parent, &flags, 1);
1038 strbuf_release(&committer_ident);
1040 fclose(s->fp);
1042 if (trailer_args.nr) {
1043 struct child_process run_trailer = CHILD_PROCESS_INIT;
1045 strvec_pushl(&run_trailer.args, "interpret-trailers",
1046 "--in-place", git_path_commit_editmsg(), NULL);
1047 strvec_pushv(&run_trailer.args, trailer_args.v);
1048 run_trailer.git_cmd = 1;
1049 if (run_command(&run_trailer))
1050 die(_("unable to pass trailers to --trailers"));
1051 strvec_clear(&trailer_args);
1055 * Reject an attempt to record a non-merge empty commit without
1056 * explicit --allow-empty. In the cherry-pick case, it may be
1057 * empty due to conflict resolution, which the user should okay.
1059 if (!committable && whence != FROM_MERGE && !allow_empty &&
1060 !(amend && is_a_merge(current_head))) {
1061 s->hints = advice_enabled(ADVICE_STATUS_HINTS);
1062 s->display_comment_prefix = old_display_comment_prefix;
1063 run_status(stdout, index_file, prefix, 0, s);
1064 if (amend)
1065 fputs(_(empty_amend_advice), stderr);
1066 else if (is_from_cherry_pick(whence) ||
1067 whence == FROM_REBASE_PICK) {
1068 fputs(_(empty_cherry_pick_advice), stderr);
1069 if (whence == FROM_CHERRY_PICK_SINGLE)
1070 fputs(_(empty_cherry_pick_advice_single), stderr);
1071 else if (whence == FROM_CHERRY_PICK_MULTI)
1072 fputs(_(empty_cherry_pick_advice_multi), stderr);
1073 else
1074 fputs(_(empty_rebase_pick_advice), stderr);
1076 return 0;
1079 if (!no_verify && invoked_hook) {
1081 * Re-read the index as the pre-commit-commit hook was invoked
1082 * and could have updated it. We must do this before we invoke
1083 * the editor and after we invoke run_status above.
1085 discard_index(&the_index);
1087 read_index_from(&the_index, index_file, get_git_dir());
1089 if (cache_tree_update(&the_index, 0)) {
1090 error(_("Error building trees"));
1091 return 0;
1094 if (run_commit_hook(use_editor, index_file, NULL, "prepare-commit-msg",
1095 git_path_commit_editmsg(), hook_arg1, hook_arg2, NULL))
1096 return 0;
1098 if (use_editor) {
1099 struct strvec env = STRVEC_INIT;
1101 strvec_pushf(&env, "GIT_INDEX_FILE=%s", index_file);
1102 if (launch_editor(git_path_commit_editmsg(), NULL, env.v)) {
1103 fprintf(stderr,
1104 _("Please supply the message using either -m or -F option.\n"));
1105 exit(1);
1107 strvec_clear(&env);
1110 if (!no_verify &&
1111 run_commit_hook(use_editor, index_file, NULL, "commit-msg",
1112 git_path_commit_editmsg(), NULL)) {
1113 return 0;
1116 return 1;
1119 static const char *find_author_by_nickname(const char *name)
1121 struct rev_info revs;
1122 struct commit *commit;
1123 struct strbuf buf = STRBUF_INIT;
1124 const char *av[20];
1125 int ac = 0;
1127 repo_init_revisions(the_repository, &revs, NULL);
1128 strbuf_addf(&buf, "--author=%s", name);
1129 av[++ac] = "--all";
1130 av[++ac] = "-i";
1131 av[++ac] = buf.buf;
1132 av[++ac] = NULL;
1133 setup_revisions(ac, av, &revs, NULL);
1134 revs.mailmap = xmalloc(sizeof(struct string_list));
1135 string_list_init_nodup(revs.mailmap);
1136 read_mailmap(revs.mailmap);
1138 if (prepare_revision_walk(&revs))
1139 die(_("revision walk setup failed"));
1140 commit = get_revision(&revs);
1141 if (commit) {
1142 struct pretty_print_context ctx = {0};
1143 ctx.date_mode.type = DATE_NORMAL;
1144 strbuf_release(&buf);
1145 repo_format_commit_message(the_repository, commit,
1146 "%aN <%aE>", &buf, &ctx);
1147 release_revisions(&revs);
1148 return strbuf_detach(&buf, NULL);
1150 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name);
1153 static void handle_ignored_arg(struct wt_status *s)
1155 if (!ignored_arg)
1156 ; /* default already initialized */
1157 else if (!strcmp(ignored_arg, "traditional"))
1158 s->show_ignored_mode = SHOW_TRADITIONAL_IGNORED;
1159 else if (!strcmp(ignored_arg, "no"))
1160 s->show_ignored_mode = SHOW_NO_IGNORED;
1161 else if (!strcmp(ignored_arg, "matching"))
1162 s->show_ignored_mode = SHOW_MATCHING_IGNORED;
1163 else
1164 die(_("Invalid ignored mode '%s'"), ignored_arg);
1167 static void handle_untracked_files_arg(struct wt_status *s)
1169 if (!untracked_files_arg)
1170 ; /* default already initialized */
1171 else if (!strcmp(untracked_files_arg, "no"))
1172 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1173 else if (!strcmp(untracked_files_arg, "normal"))
1174 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1175 else if (!strcmp(untracked_files_arg, "all"))
1176 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1178 * Please update $__git_untracked_file_modes in
1179 * git-completion.bash when you add new options
1181 else
1182 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
1185 static const char *read_commit_message(const char *name)
1187 const char *out_enc;
1188 struct commit *commit;
1190 commit = lookup_commit_reference_by_name(name);
1191 if (!commit)
1192 die(_("could not lookup commit %s"), name);
1193 out_enc = get_commit_output_encoding();
1194 return repo_logmsg_reencode(the_repository, commit, NULL, out_enc);
1198 * Enumerate what needs to be propagated when --porcelain
1199 * is not in effect here.
1201 static struct status_deferred_config {
1202 enum wt_status_format status_format;
1203 int show_branch;
1204 enum ahead_behind_flags ahead_behind;
1205 } status_deferred_config = {
1206 STATUS_FORMAT_UNSPECIFIED,
1207 -1, /* unspecified */
1208 AHEAD_BEHIND_UNSPECIFIED,
1211 static void finalize_deferred_config(struct wt_status *s)
1213 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1214 status_format != STATUS_FORMAT_PORCELAIN_V2 &&
1215 !s->null_termination);
1217 if (s->null_termination) {
1218 if (status_format == STATUS_FORMAT_NONE ||
1219 status_format == STATUS_FORMAT_UNSPECIFIED)
1220 status_format = STATUS_FORMAT_PORCELAIN;
1221 else if (status_format == STATUS_FORMAT_LONG)
1222 die(_("options '%s' and '%s' cannot be used together"), "--long", "-z");
1225 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1226 status_format = status_deferred_config.status_format;
1227 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1228 status_format = STATUS_FORMAT_NONE;
1230 if (use_deferred_config && s->show_branch < 0)
1231 s->show_branch = status_deferred_config.show_branch;
1232 if (s->show_branch < 0)
1233 s->show_branch = 0;
1236 * If the user did not give a "--[no]-ahead-behind" command
1237 * line argument *AND* we will print in a human-readable format
1238 * (short, long etc.) then we inherit from the status.aheadbehind
1239 * config setting. In all other cases (and porcelain V[12] formats
1240 * in particular), we inherit _FULL for backwards compatibility.
1242 if (use_deferred_config &&
1243 s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
1244 s->ahead_behind_flags = status_deferred_config.ahead_behind;
1246 if (s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
1247 s->ahead_behind_flags = AHEAD_BEHIND_FULL;
1250 static void check_fixup_reword_options(int argc, const char *argv[]) {
1251 if (whence != FROM_COMMIT) {
1252 if (whence == FROM_MERGE)
1253 die(_("You are in the middle of a merge -- cannot reword."));
1254 else if (is_from_cherry_pick(whence))
1255 die(_("You are in the middle of a cherry-pick -- cannot reword."));
1257 if (argc)
1258 die(_("reword option of '%s' and path '%s' cannot be used together"), "--fixup", *argv);
1259 if (patch_interactive || interactive || all || also || only)
1260 die(_("reword option of '%s' and '%s' cannot be used together"),
1261 "--fixup", "--patch/--interactive/--all/--include/--only");
1264 static int parse_and_validate_options(int argc, const char *argv[],
1265 const struct option *options,
1266 const char * const usage[],
1267 const char *prefix,
1268 struct commit *current_head,
1269 struct wt_status *s)
1271 argc = parse_options(argc, argv, prefix, options, usage, 0);
1272 finalize_deferred_config(s);
1274 if (force_author && !strchr(force_author, '>'))
1275 force_author = find_author_by_nickname(force_author);
1277 if (force_author && renew_authorship)
1278 die(_("options '%s' and '%s' cannot be used together"), "--reset-author", "--author");
1280 if (logfile || have_option_m || use_message)
1281 use_editor = 0;
1283 /* Sanity check options */
1284 if (amend && !current_head)
1285 die(_("You have nothing to amend."));
1286 if (amend && whence != FROM_COMMIT) {
1287 if (whence == FROM_MERGE)
1288 die(_("You are in the middle of a merge -- cannot amend."));
1289 else if (is_from_cherry_pick(whence))
1290 die(_("You are in the middle of a cherry-pick -- cannot amend."));
1291 else if (whence == FROM_REBASE_PICK)
1292 die(_("You are in the middle of a rebase -- cannot amend."));
1294 if (fixup_message && squash_message)
1295 die(_("options '%s' and '%s' cannot be used together"), "--squash", "--fixup");
1296 die_for_incompatible_opt4(!!use_message, "-C",
1297 !!edit_message, "-c",
1298 !!logfile, "-F",
1299 !!fixup_message, "--fixup");
1300 die_for_incompatible_opt4(have_option_m, "-m",
1301 !!edit_message, "-c",
1302 !!use_message, "-C",
1303 !!logfile, "-F");
1304 if (use_message || edit_message || logfile ||fixup_message || have_option_m)
1305 template_file = NULL;
1306 if (edit_message)
1307 use_message = edit_message;
1308 if (amend && !use_message && !fixup_message)
1309 use_message = "HEAD";
1310 if (!use_message && !is_from_cherry_pick(whence) &&
1311 !is_from_rebase(whence) && renew_authorship)
1312 die(_("--reset-author can be used only with -C, -c or --amend."));
1313 if (use_message) {
1314 use_message_buffer = read_commit_message(use_message);
1315 if (!renew_authorship) {
1316 author_message = use_message;
1317 author_message_buffer = use_message_buffer;
1320 if ((is_from_cherry_pick(whence) || whence == FROM_REBASE_PICK) &&
1321 !renew_authorship) {
1322 author_message = "CHERRY_PICK_HEAD";
1323 author_message_buffer = read_commit_message(author_message);
1326 if (patch_interactive)
1327 interactive = 1;
1329 die_for_incompatible_opt4(also, "-i/--include",
1330 only, "-o/--only",
1331 all, "-a/--all",
1332 interactive, "--interactive/-p/--patch");
1333 if (fixup_message) {
1335 * We limit --fixup's suboptions to only alpha characters.
1336 * If the first character after a run of alpha is colon,
1337 * then the part before the colon may be a known suboption
1338 * name like `amend` or `reword`, or a misspelt suboption
1339 * name. In either case, we treat it as
1340 * --fixup=<suboption>:<arg>.
1342 * Otherwise, we are dealing with --fixup=<commit>.
1344 char *p = fixup_message;
1345 while (isalpha(*p))
1346 p++;
1347 if (p > fixup_message && *p == ':') {
1348 *p = '\0';
1349 fixup_commit = p + 1;
1350 if (!strcmp("amend", fixup_message) ||
1351 !strcmp("reword", fixup_message)) {
1352 fixup_prefix = "amend";
1353 allow_empty = 1;
1354 if (*fixup_message == 'r') {
1355 check_fixup_reword_options(argc, argv);
1356 only = 1;
1358 } else {
1359 die(_("unknown option: --fixup=%s:%s"), fixup_message, fixup_commit);
1361 } else {
1362 fixup_commit = fixup_message;
1363 fixup_prefix = "fixup";
1364 use_editor = 0;
1368 if (0 <= edit_flag)
1369 use_editor = edit_flag;
1371 cleanup_mode = get_cleanup_mode(cleanup_arg, use_editor);
1373 handle_untracked_files_arg(s);
1375 if (all && argc > 0)
1376 die(_("paths '%s ...' with -a does not make sense"),
1377 argv[0]);
1379 if (status_format != STATUS_FORMAT_NONE)
1380 dry_run = 1;
1382 return argc;
1385 static int dry_run_commit(const char **argv, const char *prefix,
1386 const struct commit *current_head, struct wt_status *s)
1388 int committable;
1389 const char *index_file;
1391 index_file = prepare_index(argv, prefix, current_head, 1);
1392 committable = run_status(stdout, index_file, prefix, 0, s);
1393 rollback_index_files();
1395 return committable ? 0 : 1;
1398 define_list_config_array_extra(color_status_slots, {"added"});
1400 static int parse_status_slot(const char *slot)
1402 if (!strcasecmp(slot, "added"))
1403 return WT_STATUS_UPDATED;
1405 return LOOKUP_CONFIG(color_status_slots, slot);
1408 static int git_status_config(const char *k, const char *v, void *cb)
1410 struct wt_status *s = cb;
1411 const char *slot_name;
1413 if (starts_with(k, "column."))
1414 return git_column_config(k, v, "status", &s->colopts);
1415 if (!strcmp(k, "status.submodulesummary")) {
1416 int is_bool;
1417 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
1418 if (is_bool && s->submodule_summary)
1419 s->submodule_summary = -1;
1420 return 0;
1422 if (!strcmp(k, "status.short")) {
1423 if (git_config_bool(k, v))
1424 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1425 else
1426 status_deferred_config.status_format = STATUS_FORMAT_NONE;
1427 return 0;
1429 if (!strcmp(k, "status.branch")) {
1430 status_deferred_config.show_branch = git_config_bool(k, v);
1431 return 0;
1433 if (!strcmp(k, "status.aheadbehind")) {
1434 status_deferred_config.ahead_behind = git_config_bool(k, v);
1435 return 0;
1437 if (!strcmp(k, "status.showstash")) {
1438 s->show_stash = git_config_bool(k, v);
1439 return 0;
1441 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1442 s->use_color = git_config_colorbool(k, v);
1443 return 0;
1445 if (!strcmp(k, "status.displaycommentprefix")) {
1446 s->display_comment_prefix = git_config_bool(k, v);
1447 return 0;
1449 if (skip_prefix(k, "status.color.", &slot_name) ||
1450 skip_prefix(k, "color.status.", &slot_name)) {
1451 int slot = parse_status_slot(slot_name);
1452 if (slot < 0)
1453 return 0;
1454 if (!v)
1455 return config_error_nonbool(k);
1456 return color_parse(v, s->color_palette[slot]);
1458 if (!strcmp(k, "status.relativepaths")) {
1459 s->relative_paths = git_config_bool(k, v);
1460 return 0;
1462 if (!strcmp(k, "status.showuntrackedfiles")) {
1463 if (!v)
1464 return config_error_nonbool(k);
1465 else if (!strcmp(v, "no"))
1466 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1467 else if (!strcmp(v, "normal"))
1468 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1469 else if (!strcmp(v, "all"))
1470 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1471 else
1472 return error(_("Invalid untracked files mode '%s'"), v);
1473 return 0;
1475 if (!strcmp(k, "diff.renamelimit")) {
1476 if (s->rename_limit == -1)
1477 s->rename_limit = git_config_int(k, v);
1478 return 0;
1480 if (!strcmp(k, "status.renamelimit")) {
1481 s->rename_limit = git_config_int(k, v);
1482 return 0;
1484 if (!strcmp(k, "diff.renames")) {
1485 if (s->detect_rename == -1)
1486 s->detect_rename = git_config_rename(k, v);
1487 return 0;
1489 if (!strcmp(k, "status.renames")) {
1490 s->detect_rename = git_config_rename(k, v);
1491 return 0;
1493 return git_diff_ui_config(k, v, NULL);
1496 int cmd_status(int argc, const char **argv, const char *prefix)
1498 static int no_renames = -1;
1499 static const char *rename_score_arg = (const char *)-1;
1500 static struct wt_status s;
1501 unsigned int progress_flag = 0;
1502 int fd;
1503 struct object_id oid;
1504 static struct option builtin_status_options[] = {
1505 OPT__VERBOSE(&verbose, N_("be verbose")),
1506 OPT_SET_INT('s', "short", &status_format,
1507 N_("show status concisely"), STATUS_FORMAT_SHORT),
1508 OPT_BOOL('b', "branch", &s.show_branch,
1509 N_("show branch information")),
1510 OPT_BOOL(0, "show-stash", &s.show_stash,
1511 N_("show stash information")),
1512 OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
1513 N_("compute full ahead/behind values")),
1514 OPT_CALLBACK_F(0, "porcelain", &status_format,
1515 N_("version"), N_("machine-readable output"),
1516 PARSE_OPT_OPTARG, opt_parse_porcelain),
1517 OPT_SET_INT(0, "long", &status_format,
1518 N_("show status in long format (default)"),
1519 STATUS_FORMAT_LONG),
1520 OPT_BOOL('z', "null", &s.null_termination,
1521 N_("terminate entries with NUL")),
1522 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1523 N_("mode"),
1524 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1525 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1526 { OPTION_STRING, 0, "ignored", &ignored_arg,
1527 N_("mode"),
1528 N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1529 PARSE_OPT_OPTARG, NULL, (intptr_t)"traditional" },
1530 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1531 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1532 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1533 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1534 OPT_BOOL(0, "no-renames", &no_renames, N_("do not detect renames")),
1535 OPT_CALLBACK_F('M', "find-renames", &rename_score_arg,
1536 N_("n"), N_("detect renames, optionally set similarity index"),
1537 PARSE_OPT_OPTARG | PARSE_OPT_NONEG, opt_parse_rename_score),
1538 OPT_END(),
1541 if (argc == 2 && !strcmp(argv[1], "-h"))
1542 usage_with_options(builtin_status_usage, builtin_status_options);
1544 prepare_repo_settings(the_repository);
1545 the_repository->settings.command_requires_full_index = 0;
1547 status_init_config(&s, git_status_config);
1548 argc = parse_options(argc, argv, prefix,
1549 builtin_status_options,
1550 builtin_status_usage, 0);
1551 finalize_colopts(&s.colopts, -1);
1552 finalize_deferred_config(&s);
1554 handle_untracked_files_arg(&s);
1555 handle_ignored_arg(&s);
1557 if (s.show_ignored_mode == SHOW_MATCHING_IGNORED &&
1558 s.show_untracked_files == SHOW_NO_UNTRACKED_FILES)
1559 die(_("Unsupported combination of ignored and untracked-files arguments"));
1561 parse_pathspec(&s.pathspec, 0,
1562 PATHSPEC_PREFER_FULL,
1563 prefix, argv);
1565 if (status_format != STATUS_FORMAT_PORCELAIN &&
1566 status_format != STATUS_FORMAT_PORCELAIN_V2)
1567 progress_flag = REFRESH_PROGRESS;
1568 repo_read_index(the_repository);
1569 refresh_index(&the_index,
1570 REFRESH_QUIET|REFRESH_UNMERGED|progress_flag,
1571 &s.pathspec, NULL, NULL);
1573 if (use_optional_locks())
1574 fd = repo_hold_locked_index(the_repository, &index_lock, 0);
1575 else
1576 fd = -1;
1578 s.is_initial = repo_get_oid(the_repository, s.reference, &oid) ? 1 : 0;
1579 if (!s.is_initial)
1580 oidcpy(&s.oid_commit, &oid);
1582 s.ignore_submodule_arg = ignore_submodule_arg;
1583 s.status_format = status_format;
1584 s.verbose = verbose;
1585 if (no_renames != -1)
1586 s.detect_rename = !no_renames;
1587 if ((intptr_t)rename_score_arg != -1) {
1588 if (s.detect_rename < DIFF_DETECT_RENAME)
1589 s.detect_rename = DIFF_DETECT_RENAME;
1590 if (rename_score_arg)
1591 s.rename_score = parse_rename_score(&rename_score_arg);
1594 wt_status_collect(&s);
1596 if (0 <= fd)
1597 repo_update_index_if_able(the_repository, &index_lock);
1599 if (s.relative_paths)
1600 s.prefix = prefix;
1602 wt_status_print(&s);
1603 wt_status_collect_free_buffers(&s);
1605 return 0;
1608 static int git_commit_config(const char *k, const char *v, void *cb)
1610 struct wt_status *s = cb;
1612 if (!strcmp(k, "commit.template"))
1613 return git_config_pathname(&template_file, k, v);
1614 if (!strcmp(k, "commit.status")) {
1615 include_status = git_config_bool(k, v);
1616 return 0;
1618 if (!strcmp(k, "commit.cleanup"))
1619 return git_config_string(&cleanup_arg, k, v);
1620 if (!strcmp(k, "commit.gpgsign")) {
1621 sign_commit = git_config_bool(k, v) ? "" : NULL;
1622 return 0;
1624 if (!strcmp(k, "commit.verbose")) {
1625 int is_bool;
1626 config_commit_verbose = git_config_bool_or_int(k, v, &is_bool);
1627 return 0;
1630 return git_status_config(k, v, s);
1633 int cmd_commit(int argc, const char **argv, const char *prefix)
1635 static struct wt_status s;
1636 static struct option builtin_commit_options[] = {
1637 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1638 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1640 OPT_GROUP(N_("Commit message options")),
1641 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1642 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1643 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1644 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1645 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1646 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
1648 * TRANSLATORS: Leave "[(amend|reword):]" as-is,
1649 * and only translate <commit>.
1651 OPT_STRING(0, "fixup", &fixup_message, N_("[(amend|reword):]commit"), N_("use autosquash formatted message to fixup or amend/reword specified commit")),
1652 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
1653 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
1654 OPT_CALLBACK_F(0, "trailer", &trailer_args, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG, opt_pass_trailer),
1655 OPT_BOOL('s', "signoff", &signoff, N_("add a Signed-off-by trailer")),
1656 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1657 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
1658 OPT_CLEANUP(&cleanup_arg),
1659 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
1660 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
1661 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1662 /* end commit message options */
1664 OPT_GROUP(N_("Commit contents options")),
1665 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1666 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1667 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1668 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1669 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
1670 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit and commit-msg hooks")),
1671 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
1672 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
1673 STATUS_FORMAT_SHORT),
1674 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
1675 OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
1676 N_("compute full ahead/behind values")),
1677 OPT_SET_INT(0, "porcelain", &status_format,
1678 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1679 OPT_SET_INT(0, "long", &status_format,
1680 N_("show status in long format (default)"),
1681 STATUS_FORMAT_LONG),
1682 OPT_BOOL('z', "null", &s.null_termination,
1683 N_("terminate entries with NUL")),
1684 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1685 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
1686 { 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" },
1687 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
1688 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
1689 /* end commit contents options */
1691 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1692 N_("ok to record an empty change")),
1693 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1694 N_("ok to record a change with an empty message")),
1696 OPT_END()
1699 struct strbuf sb = STRBUF_INIT;
1700 struct strbuf author_ident = STRBUF_INIT;
1701 const char *index_file, *reflog_msg;
1702 struct object_id oid;
1703 struct commit_list *parents = NULL;
1704 struct stat statbuf;
1705 struct commit *current_head = NULL;
1706 struct commit_extra_header *extra = NULL;
1707 struct strbuf err = STRBUF_INIT;
1708 int ret = 0;
1710 if (argc == 2 && !strcmp(argv[1], "-h"))
1711 usage_with_options(builtin_commit_usage, builtin_commit_options);
1713 prepare_repo_settings(the_repository);
1714 the_repository->settings.command_requires_full_index = 0;
1716 status_init_config(&s, git_commit_config);
1717 s.commit_template = 1;
1718 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1719 s.colopts = 0;
1721 if (repo_get_oid(the_repository, "HEAD", &oid))
1722 current_head = NULL;
1723 else {
1724 current_head = lookup_commit_or_die(&oid, "HEAD");
1725 if (repo_parse_commit(the_repository, current_head))
1726 die(_("could not parse HEAD commit"));
1728 verbose = -1; /* unspecified */
1729 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1730 builtin_commit_usage,
1731 prefix, current_head, &s);
1732 if (verbose == -1)
1733 verbose = (config_commit_verbose < 0) ? 0 : config_commit_verbose;
1735 if (dry_run)
1736 return dry_run_commit(argv, prefix, current_head, &s);
1737 index_file = prepare_index(argv, prefix, current_head, 0);
1739 /* Set up everything for writing the commit object. This includes
1740 running hooks, writing the trees, and interacting with the user. */
1741 if (!prepare_to_commit(index_file, prefix,
1742 current_head, &s, &author_ident)) {
1743 ret = 1;
1744 rollback_index_files();
1745 goto cleanup;
1748 /* Determine parents */
1749 reflog_msg = getenv("GIT_REFLOG_ACTION");
1750 if (!current_head) {
1751 if (!reflog_msg)
1752 reflog_msg = "commit (initial)";
1753 } else if (amend) {
1754 if (!reflog_msg)
1755 reflog_msg = "commit (amend)";
1756 parents = copy_commit_list(current_head->parents);
1757 } else if (whence == FROM_MERGE) {
1758 struct strbuf m = STRBUF_INIT;
1759 FILE *fp;
1760 int allow_fast_forward = 1;
1761 struct commit_list **pptr = &parents;
1763 if (!reflog_msg)
1764 reflog_msg = "commit (merge)";
1765 pptr = commit_list_append(current_head, pptr);
1766 fp = xfopen(git_path_merge_head(the_repository), "r");
1767 while (strbuf_getline_lf(&m, fp) != EOF) {
1768 struct commit *parent;
1770 parent = get_merge_parent(m.buf);
1771 if (!parent)
1772 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1773 pptr = commit_list_append(parent, pptr);
1775 fclose(fp);
1776 strbuf_release(&m);
1777 if (!stat(git_path_merge_mode(the_repository), &statbuf)) {
1778 if (strbuf_read_file(&sb, git_path_merge_mode(the_repository), 0) < 0)
1779 die_errno(_("could not read MERGE_MODE"));
1780 if (!strcmp(sb.buf, "no-ff"))
1781 allow_fast_forward = 0;
1783 if (allow_fast_forward)
1784 reduce_heads_replace(&parents);
1785 } else {
1786 if (!reflog_msg)
1787 reflog_msg = is_from_cherry_pick(whence)
1788 ? "commit (cherry-pick)"
1789 : is_from_rebase(whence)
1790 ? "commit (rebase)"
1791 : "commit";
1792 commit_list_insert(current_head, &parents);
1795 /* Finally, get the commit message */
1796 strbuf_reset(&sb);
1797 if (strbuf_read_file(&sb, git_path_commit_editmsg(), 0) < 0) {
1798 int saved_errno = errno;
1799 rollback_index_files();
1800 die(_("could not read commit message: %s"), strerror(saved_errno));
1803 cleanup_message(&sb, cleanup_mode, verbose);
1805 if (message_is_empty(&sb, cleanup_mode) && !allow_empty_message) {
1806 rollback_index_files();
1807 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
1808 exit(1);
1810 if (template_untouched(&sb, template_file, cleanup_mode) && !allow_empty_message) {
1811 rollback_index_files();
1812 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
1813 exit(1);
1816 if (fixup_message && starts_with(sb.buf, "amend! ") &&
1817 !allow_empty_message) {
1818 struct strbuf body = STRBUF_INIT;
1819 size_t len = commit_subject_length(sb.buf);
1820 strbuf_addstr(&body, sb.buf + len);
1821 if (message_is_empty(&body, cleanup_mode)) {
1822 rollback_index_files();
1823 fprintf(stderr, _("Aborting commit due to empty commit message body.\n"));
1824 exit(1);
1826 strbuf_release(&body);
1829 if (amend) {
1830 const char *exclude_gpgsig[3] = { "gpgsig", "gpgsig-sha256", NULL };
1831 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1832 } else {
1833 struct commit_extra_header **tail = &extra;
1834 append_merge_tag_headers(parents, &tail);
1837 if (commit_tree_extended(sb.buf, sb.len, &the_index.cache_tree->oid,
1838 parents, &oid, author_ident.buf, NULL,
1839 sign_commit, extra)) {
1840 rollback_index_files();
1841 die(_("failed to write commit object"));
1843 free_commit_extra_headers(extra);
1845 if (update_head_with_reflog(current_head, &oid, reflog_msg, &sb,
1846 &err)) {
1847 rollback_index_files();
1848 die("%s", err.buf);
1851 sequencer_post_commit_cleanup(the_repository, 0);
1852 unlink(git_path_merge_head(the_repository));
1853 unlink(git_path_merge_msg(the_repository));
1854 unlink(git_path_merge_mode(the_repository));
1855 unlink(git_path_squash_msg(the_repository));
1857 if (commit_index_files())
1858 die(_("repository has been updated, but unable to write\n"
1859 "new_index file. Check that disk is not full and quota is\n"
1860 "not exceeded, and then \"git restore --staged :/\" to recover."));
1862 git_test_write_commit_graph_or_die();
1864 repo_rerere(the_repository, 0);
1865 run_auto_maintenance(quiet);
1866 run_commit_hook(use_editor, get_index_file(), NULL, "post-commit",
1867 NULL);
1868 if (amend && !no_post_rewrite) {
1869 commit_post_rewrite(the_repository, current_head, &oid);
1871 if (!quiet) {
1872 unsigned int flags = 0;
1874 if (!current_head)
1875 flags |= SUMMARY_INITIAL_COMMIT;
1876 if (author_date_is_interesting())
1877 flags |= SUMMARY_SHOW_AUTHOR_DATE;
1878 print_commit_summary(the_repository, prefix,
1879 &oid, flags);
1882 apply_autostash(git_path_merge_autostash(the_repository));
1884 cleanup:
1885 strbuf_release(&author_ident);
1886 strbuf_release(&err);
1887 strbuf_release(&sb);
1888 return ret;