]> git.ipfire.org Git - thirdparty/git.git/blame - builtin/commit.c
Merge branch 'vd/fsck-submodule-url-test'
[thirdparty/git.git] / builtin / commit.c
CommitLineData
f5bbc322
KH
1/*
2 * Builtin "git commit"
3 *
4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
6 */
7
dfd0a893 8#define USE_THE_INDEX_VARIABLE
bc5c5ec0 9#include "builtin.h"
6c6ddf92 10#include "advice.h"
b2141fc1 11#include "config.h"
697cc8ef 12#include "lockfile.h"
f5bbc322 13#include "cache-tree.h"
6b2f2d98 14#include "color.h"
2888605c 15#include "dir.h"
4e120823 16#include "editor.h"
7ee24e18 17#include "environment.h"
f5bbc322 18#include "diff.h"
f5bbc322 19#include "commit.h"
f394e093 20#include "gettext.h"
f5bbc322
KH
21#include "revision.h"
22#include "wt-status.h"
23#include "run-command.h"
f5bbc322 24#include "strbuf.h"
dabab1d6 25#include "object-name.h"
f5bbc322 26#include "parse-options.h"
c339932b 27#include "path.h"
fbffdfb1 28#include "preload-index.h"
08c46a49 29#include "read-cache.h"
c455c87c 30#include "string-list.h"
5b2fd956 31#include "rerere.h"
fa9dcf80 32#include "unpack-trees.h"
323d0530 33#include "column.h"
5ed75e2a 34#include "sequencer.h"
baf889c2 35#include "sparse-index.h"
ea16794e 36#include "mailmap.h"
3ac68a93 37#include "help.h"
64043556 38#include "commit-reach.h"
859fdc0c 39#include "commit-graph.h"
88c7b4c3 40#include "pretty.h"
f5bbc322
KH
41
42static const char * const builtin_commit_usage[] = {
423be1f8
ÆAB
43 N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n"
44 " [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]\n"
45 " [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n"
46 " [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n"
47 " [--date=<date>] [--cleanup=<mode>] [--[no-]status]\n"
48 " [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]\n"
49 " [(--trailer <token>[(=|:)<value>])...] [-S[<keyid>]]\n"
50 " [--] [<pathspec>...]"),
f5bbc322
KH
51 NULL
52};
53
2f02b25f 54static const char * const builtin_status_usage[] = {
463ea0cf 55 N_("git status [<options>] [--] [<pathspec>...]"),
2f02b25f
SB
56 NULL
57};
58
f197ed2f 59static const char empty_amend_advice[] =
fc88e316 60N_("You asked to amend the most recent commit, but doing so would make\n"
f197ed2f 61"it empty. You can repeat your command with --allow-empty, or you can\n"
fc88e316 62"remove the commit entirely with \"git reset HEAD^\".\n");
f197ed2f 63
37f7a857 64static const char empty_cherry_pick_advice[] =
6c80cd29 65N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
37f7a857
JS
66"If you wish to commit it anyway, use:\n"
67"\n"
68" git commit --allow-empty\n"
c17592a7
JK
69"\n");
70
430b75f7
PW
71static const char empty_rebase_pick_advice[] =
72N_("Otherwise, please use 'git rebase --skip'\n");
73
c17592a7 74static const char empty_cherry_pick_advice_single[] =
dcb500dc 75N_("Otherwise, please use 'git cherry-pick --skip'\n");
c17592a7
JK
76
77static const char empty_cherry_pick_advice_multi[] =
dcb500dc 78N_("and then use:\n"
37f7a857 79"\n"
dcb500dc 80" git cherry-pick --continue\n"
c17592a7 81"\n"
dcb500dc
RA
82"to resume cherry-picking the remaining commits.\n"
83"If you wish to skip this commit, use:\n"
84"\n"
85" git cherry-pick --skip\n"
86"\n");
37f7a857 87
a73b3680
NTND
88static const char *color_status_slots[] = {
89 [WT_STATUS_HEADER] = "header",
90 [WT_STATUS_UPDATED] = "updated",
91 [WT_STATUS_CHANGED] = "changed",
92 [WT_STATUS_UNTRACKED] = "untracked",
93 [WT_STATUS_NOBRANCH] = "noBranch",
94 [WT_STATUS_UNMERGED] = "unmerged",
95 [WT_STATUS_LOCAL_BRANCH] = "localBranch",
96 [WT_STATUS_REMOTE_BRANCH] = "remoteBranch",
97 [WT_STATUS_ONBRANCH] = "branch",
98};
99
37f7a857 100static const char *use_message_buffer;
2888605c
JH
101static struct lock_file index_lock; /* real index */
102static struct lock_file false_lock; /* used only for partial commits */
103static enum {
104 COMMIT_AS_IS = 1,
105 COMMIT_NORMAL,
4b05548f 106 COMMIT_PARTIAL
2888605c 107} commit_style;
f5bbc322 108
dbd0f5c7 109static const char *logfile, *force_author;
984c6e7e 110static const char *template_file;
37f7a857
JS
111/*
112 * The _message variables are commit names from which to take
113 * the commit message and/or authorship.
114 */
115static const char *author_message, *author_message_buffer;
f5bbc322 116static char *edit_message, *use_message;
494d314a
CM
117static char *fixup_message, *fixup_commit, *squash_message;
118static const char *fixup_prefix;
ca1ba201
JH
119static int all, also, interactive, patch_interactive, only, amend, signoff;
120static int edit_flag = -1; /* unspecified */
c51f6cee 121static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
aaab8420 122static int config_commit_verbose = -1; /* unspecified */
e440fc58 123static int no_post_rewrite, allow_empty_message, pathspec_file_nul;
eec0f7f2 124static char *untracked_files_arg, *force_date, *ignore_submodule_arg, *ignored_arg;
e440fc58 125static char *sign_commit, *pathspec_from_file;
2daae3d1 126static struct strvec trailer_args = STRVEC_INIT;
ba3c69a9 127
5f065737
AR
128/*
129 * The default commit message cleanup mode will remove the lines
130 * beginning with # (shell comments) and leading and trailing
131 * whitespaces (empty lines or containing only whitespaces)
132 * if editor is used, and only the whitespaces if the message
133 * is specified explicitly.
134 */
d0aaa46f 135static enum commit_msg_cleanup_mode cleanup_mode;
51fb3a3d 136static const char *cleanup_arg;
f5bbc322 137
37f7a857 138static enum commit_whence whence;
06bb643b 139static int use_editor = 1, include_status = 1;
eec0f7f2 140static int have_option_m;
2c47789d 141static struct strbuf message = STRBUF_INIT;
f9568530 142
be7e795e 143static enum wt_status_format status_format = STATUS_FORMAT_UNSPECIFIED;
84b4202d 144
2daae3d1
ZH
145static int opt_pass_trailer(const struct option *opt, const char *arg, int unset)
146{
147 BUG_ON_OPT_NEG(unset);
148
116761ba 149 strvec_pushl(opt->value, "--trailer", arg, NULL);
2daae3d1
ZH
150 return 0;
151}
152
c4f596b9
JH
153static int opt_parse_porcelain(const struct option *opt, const char *arg, int unset)
154{
155 enum wt_status_format *value = (enum wt_status_format *)opt->value;
156 if (unset)
157 *value = STATUS_FORMAT_NONE;
158 else if (!arg)
159 *value = STATUS_FORMAT_PORCELAIN;
160 else if (!strcmp(arg, "v1") || !strcmp(arg, "1"))
161 *value = STATUS_FORMAT_PORCELAIN;
1ecdecce
JH
162 else if (!strcmp(arg, "v2") || !strcmp(arg, "2"))
163 *value = STATUS_FORMAT_PORCELAIN_V2;
c4f596b9
JH
164 else
165 die("unsupported porcelain version '%s'", arg);
166
167 return 0;
168}
7c9f7038 169
f9568530
JS
170static int opt_parse_m(const struct option *opt, const char *arg, int unset)
171{
172 struct strbuf *buf = opt->value;
25206778
RS
173 if (unset) {
174 have_option_m = 0;
f9568530 175 strbuf_setlen(buf, 0);
25206778
RS
176 } else {
177 have_option_m = 1;
a24a41ea
BC
178 if (buf->len)
179 strbuf_addch(buf, '\n');
f9568530 180 strbuf_addstr(buf, arg);
a24a41ea 181 strbuf_complete_line(buf);
f9568530
JS
182 }
183 return 0;
184}
f5bbc322 185
e8b2dc2c
BP
186static int opt_parse_rename_score(const struct option *opt, const char *arg, int unset)
187{
188 const char **value = opt->value;
517fe807
JK
189
190 BUG_ON_OPT_NEG(unset);
191
e8b2dc2c
BP
192 if (arg != NULL && *arg == '=')
193 arg = arg + 1;
194
195 *value = arg;
196 return 0;
197}
198
37f7a857
JS
199static void determine_whence(struct wt_status *s)
200{
102de880 201 if (file_exists(git_path_merge_head(the_repository)))
37f7a857 202 whence = FROM_MERGE;
901ba7b1 203 else if (!sequencer_determine_whence(the_repository, &whence))
37f7a857
JS
204 whence = FROM_COMMIT;
205 if (s)
206 s->whence = whence;
207}
208
5c25dfaa
MM
209static void status_init_config(struct wt_status *s, config_fn_t fn)
210{
5b02ca38 211 wt_status_prepare(the_repository, s);
dc6b1d92 212 init_diff_ui_defaults();
5c25dfaa
MM
213 git_config(fn, s);
214 determine_whence(s);
ed9bff08 215 s->hints = advice_enabled(ADVICE_STATUS_HINTS); /* must come after git_config() */
5c25dfaa
MM
216}
217
2888605c
JH
218static void rollback_index_files(void)
219{
220 switch (commit_style) {
221 case COMMIT_AS_IS:
222 break; /* nothing to do */
223 case COMMIT_NORMAL:
224 rollback_lock_file(&index_lock);
225 break;
226 case COMMIT_PARTIAL:
227 rollback_lock_file(&index_lock);
228 rollback_lock_file(&false_lock);
229 break;
230 }
231}
232
5a9dd399 233static int commit_index_files(void)
2888605c 234{
5a9dd399
BC
235 int err = 0;
236
2888605c
JH
237 switch (commit_style) {
238 case COMMIT_AS_IS:
239 break; /* nothing to do */
240 case COMMIT_NORMAL:
5a9dd399 241 err = commit_lock_file(&index_lock);
2888605c
JH
242 break;
243 case COMMIT_PARTIAL:
5a9dd399 244 err = commit_lock_file(&index_lock);
2888605c
JH
245 rollback_lock_file(&false_lock);
246 break;
247 }
5a9dd399
BC
248
249 return err;
2888605c
JH
250}
251
252/*
253 * Take a union of paths in the index and the named tree (typically, "HEAD"),
254 * and return the paths that match the given pattern in list.
255 */
c455c87c 256static int list_paths(struct string_list *list, const char *with_tree,
c5c33504 257 const struct pathspec *pattern)
2888605c 258{
5d0b9bf8 259 int i, ret;
2888605c
JH
260 char *m;
261
17ddc66e 262 if (!pattern->nr)
ea2d4ed3
JK
263 return 0;
264
17ddc66e 265 m = xcalloc(1, pattern->nr);
2888605c 266
8894d535 267 if (with_tree) {
f950eb95 268 char *max_prefix = common_prefix(pattern);
86238e07 269 overlay_tree_on_index(&the_index, with_tree, max_prefix);
5879f568 270 free(max_prefix);
8894d535 271 }
2888605c 272
cb8388df
DS
273 /* TODO: audit for interaction with sparse-index. */
274 ensure_full_index(&the_index);
dc594180
ÆAB
275 for (i = 0; i < the_index.cache_nr; i++) {
276 const struct cache_entry *ce = the_index.cache[i];
7fce6e3c
NTND
277 struct string_list_item *item;
278
7a51ed66 279 if (ce->ce_flags & CE_UPDATE)
e87e22d0 280 continue;
6d2df284 281 if (!ce_path_match(&the_index, ce, pattern, m))
2888605c 282 continue;
78a395d3 283 item = string_list_insert(list, ce->name);
7fce6e3c
NTND
284 if (ce_skip_worktree(ce))
285 item->util = item; /* better a valid pointer than a fake one */
2888605c
JH
286 }
287
c5c33504 288 ret = report_path_error(m, pattern);
5d0b9bf8
SB
289 free(m);
290 return ret;
2888605c
JH
291}
292
c455c87c 293static void add_remove_files(struct string_list *list)
2888605c
JH
294{
295 int i;
296 for (i = 0; i < list->nr; i++) {
d177cab0 297 struct stat st;
c455c87c 298 struct string_list_item *p = &(list->items[i]);
d177cab0 299
7fce6e3c
NTND
300 /* p->util is skip-worktree */
301 if (p->util)
b4d1690d 302 continue;
d177cab0 303
c455c87c 304 if (!lstat(p->string, &st)) {
fbc1ed62 305 if (add_to_index(&the_index, p->string, &st, 0))
8a6179bc 306 die(_("updating files failed"));
960b8ad1 307 } else
031b2033 308 remove_file_from_index(&the_index, p->string);
2888605c
JH
309 }
310}
311
06bb643b 312static void create_base_index(const struct commit *current_head)
fa9dcf80
LT
313{
314 struct tree *tree;
315 struct unpack_trees_options opts;
316 struct tree_desc t;
317
06bb643b 318 if (!current_head) {
07047d68 319 discard_index(&the_index);
fa9dcf80
LT
320 return;
321 }
322
323 memset(&opts, 0, sizeof(opts));
324 opts.head_idx = 1;
325 opts.index_only = 1;
326 opts.merge = 1;
34110cd4
LT
327 opts.src_index = &the_index;
328 opts.dst_index = &the_index;
fa9dcf80
LT
329
330 opts.fn = oneway_merge;
a9dbc179 331 tree = parse_tree_indirect(&current_head->object.oid);
fa9dcf80 332 if (!tree)
8a6179bc 333 die(_("failed to unpack HEAD tree object"));
fa9dcf80
LT
334 parse_tree(tree);
335 init_tree_desc(&t, tree->buffer, tree->size);
203a2fe1
DB
336 if (unpack_trees(1, &t, &opts))
337 exit(128); /* We've already reported the error, finish dying */
fa9dcf80
LT
338}
339
d38a30df
MM
340static void refresh_cache_or_die(int refresh_flags)
341{
342 /*
343 * refresh_flags contains REFRESH_QUIET, so the only errors
344 * are for unmerged entries.
345 */
07047d68 346 if (refresh_index(&the_index, refresh_flags | REFRESH_IN_PORCELAIN, NULL, NULL, NULL))
d38a30df
MM
347 die_resolve_conflict("commit");
348}
349
e885a84f 350static const char *prepare_index(const char **argv, const char *prefix,
35ff08be 351 const struct commit *current_head, int is_status)
f5bbc322 352{
dd1055ed 353 struct string_list partial = STRING_LIST_INIT_DUP;
6654c889 354 struct pathspec pathspec;
50b7e70f 355 int refresh_flags = REFRESH_QUIET;
b4fb09e4 356 const char *ret;
f5bbc322 357
50b7e70f
JH
358 if (is_status)
359 refresh_flags |= REFRESH_UNMERGED;
6654c889
NTND
360 parse_pathspec(&pathspec, 0,
361 PATHSPEC_PREFER_FULL,
362 prefix, argv);
f5bbc322 363
e440fc58
AM
364 if (pathspec_from_file) {
365 if (interactive)
12909b6b 366 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "--interactive/--patch");
e440fc58 367
509efef7 368 if (all)
12909b6b 369 die(_("options '%s' and '%s' cannot be used together"), "--pathspec-from-file", "-a");
509efef7 370
e440fc58 371 if (pathspec.nr)
246cac85 372 die(_("'%s' and pathspec arguments cannot be used together"), "--pathspec-from-file");
e440fc58
AM
373
374 parse_pathspec_file(&pathspec, 0,
375 PATHSPEC_PREFER_FULL,
376 prefix, pathspec_from_file, pathspec_file_nul);
377 } else if (pathspec_file_nul) {
6fa00ee8 378 die(_("the option '%s' requires '%s'"), "--pathspec-file-nul", "--pathspec-from-file");
e440fc58
AM
379 }
380
494d314a
CM
381 if (!pathspec.nr && (also || (only && !allow_empty &&
382 (!amend || (fixup_message && strcmp(fixup_prefix, "amend"))))))
e440fc58
AM
383 die(_("No paths with --include/--only does not make sense."));
384
07047d68 385 if (repo_read_index_preload(the_repository, &pathspec, 0) < 0)
8a6179bc 386 die(_("index file corrupt"));
671c9b7e 387
1020d087 388 if (interactive) {
c480eeb5 389 char *old_index_env = NULL, *old_repo_index_file;
07047d68
ÆAB
390 repo_hold_locked_index(the_repository, &index_lock,
391 LOCK_DIE_ON_ERROR);
1020d087
CI
392
393 refresh_cache_or_die(refresh_flags);
394
812d6b00 395 if (write_locked_index(&the_index, &index_lock, 0))
1020d087
CI
396 die(_("unable to create temporary index"));
397
c480eeb5
JS
398 old_repo_index_file = the_repository->index_file;
399 the_repository->index_file =
400 (char *)get_lock_file_path(&index_lock);
406bab38 401 old_index_env = xstrdup_or_null(getenv(INDEX_ENVIRONMENT));
c480eeb5 402 setenv(INDEX_ENVIRONMENT, the_repository->index_file, 1);
1020d087 403
e885a84f 404 if (interactive_add(argv, prefix, patch_interactive) != 0)
1020d087
CI
405 die(_("interactive add failed"));
406
c480eeb5 407 the_repository->index_file = old_repo_index_file;
1020d087
CI
408 if (old_index_env && *old_index_env)
409 setenv(INDEX_ENVIRONMENT, old_index_env, 1);
410 else
411 unsetenv(INDEX_ENVIRONMENT);
406bab38 412 FREE_AND_NULL(old_index_env);
1020d087 413
07047d68
ÆAB
414 discard_index(&the_index);
415 read_index_from(&the_index, get_lock_file_path(&index_lock),
416 get_git_dir());
fcb864bc 417 if (cache_tree_update(&the_index, WRITE_TREE_SILENT) == 0) {
3fd13cbc 418 if (reopen_lock_file(&index_lock) < 0)
9c4d6c02 419 die(_("unable to write index file"));
812d6b00 420 if (write_locked_index(&the_index, &index_lock, 0))
3fd13cbc 421 die(_("unable to update temporary index"));
9c4d6c02
DT
422 } else
423 warning(_("Failed to update main cache tree"));
1020d087
CI
424
425 commit_style = COMMIT_NORMAL;
dd1055ed
426 ret = get_lock_file_path(&index_lock);
427 goto out;
1020d087
CI
428 }
429
2888605c
JH
430 /*
431 * Non partial, non as-is commit.
432 *
433 * (1) get the real index;
434 * (2) update the_index as necessary;
435 * (3) write the_index out to the real index (still locked);
436 * (4) return the name of the locked index file.
437 *
438 * The caller should run hooks on the locked real index, and
439 * (A) if all goes well, commit the real index;
440 * (B) on failure, rollback the real index.
441 */
6654c889 442 if (all || (also && pathspec.nr)) {
07047d68
ÆAB
443 repo_hold_locked_index(the_repository, &index_lock,
444 LOCK_DIE_ON_ERROR);
50c37ee8
EN
445 add_files_to_cache(the_repository, also ? prefix : NULL,
446 &pathspec, 0, 0);
d38a30df 447 refresh_cache_or_die(refresh_flags);
fcb864bc 448 cache_tree_update(&the_index, WRITE_TREE_SILENT);
812d6b00 449 if (write_locked_index(&the_index, &index_lock, 0))
a060705d 450 die(_("unable to write new index file"));
2888605c 451 commit_style = COMMIT_NORMAL;
dd1055ed
452 ret = get_lock_file_path(&index_lock);
453 goto out;
f5bbc322
KH
454 }
455
2888605c
JH
456 /*
457 * As-is commit.
458 *
459 * (1) return the name of the real index file.
460 *
73276235
MH
461 * The caller should run hooks on the real index,
462 * and create commit from the_index.
2888605c
JH
463 * We still need to refresh the index here.
464 */
6654c889 465 if (!only && !pathspec.nr) {
07047d68
ÆAB
466 repo_hold_locked_index(the_repository, &index_lock,
467 LOCK_DIE_ON_ERROR);
d38a30df 468 refresh_cache_or_die(refresh_flags);
dc594180
ÆAB
469 if (the_index.cache_changed
470 || !cache_tree_fully_valid(the_index.cache_tree))
fcb864bc 471 cache_tree_update(&the_index, WRITE_TREE_SILENT);
61000814
472 if (write_locked_index(&the_index, &index_lock,
473 COMMIT_LOCK | SKIP_IF_UNCHANGED))
a060705d 474 die(_("unable to write new index file"));
2888605c 475 commit_style = COMMIT_AS_IS;
dd1055ed
476 ret = get_index_file();
477 goto out;
f5bbc322
KH
478 }
479
2888605c
JH
480 /*
481 * A partial commit.
482 *
483 * (0) find the set of affected paths;
484 * (1) get lock on the real index file;
485 * (2) update the_index with the given paths;
486 * (3) write the_index out to the real index (still locked);
487 * (4) get lock on the false index file;
488 * (5) reset the_index from HEAD;
489 * (6) update the_index the same way as (2);
490 * (7) write the_index out to the false index file;
491 * (8) return the name of the false index file (still locked);
492 *
493 * The caller should run hooks on the locked false index, and
494 * create commit from it. Then
495 * (A) if all goes well, commit the real index;
496 * (B) on failure, rollback the real index;
497 * In either case, rollback the false index.
498 */
499 commit_style = COMMIT_PARTIAL;
500
b0cea47e
ÆAB
501 if (whence != FROM_COMMIT) {
502 if (whence == FROM_MERGE)
503 die(_("cannot do a partial commit during a merge."));
8d57f757 504 else if (is_from_cherry_pick(whence))
b0cea47e 505 die(_("cannot do a partial commit during a cherry-pick."));
430b75f7
PW
506 else if (is_from_rebase(whence))
507 die(_("cannot do a partial commit during a rebase."));
b0cea47e 508 }
2888605c 509
c5c33504 510 if (list_paths(&partial, !current_head ? NULL : "HEAD", &pathspec))
2888605c
JH
511 exit(1);
512
07047d68
ÆAB
513 discard_index(&the_index);
514 if (repo_read_index(the_repository) < 0)
8a6179bc 515 die(_("cannot read the index"));
2888605c 516
07047d68 517 repo_hold_locked_index(the_repository, &index_lock, LOCK_DIE_ON_ERROR);
2888605c 518 add_remove_files(&partial);
07047d68 519 refresh_index(&the_index, REFRESH_QUIET, NULL, NULL, NULL);
fcb864bc 520 cache_tree_update(&the_index, WRITE_TREE_SILENT);
812d6b00 521 if (write_locked_index(&the_index, &index_lock, 0))
a060705d 522 die(_("unable to write new index file"));
f5bbc322 523
03b86647
NTND
524 hold_lock_file_for_update(&false_lock,
525 git_path("next-index-%"PRIuMAX,
526 (uintmax_t) getpid()),
527 LOCK_DIE_ON_ERROR);
fa9dcf80 528
06bb643b 529 create_base_index(current_head);
2888605c 530 add_remove_files(&partial);
07047d68 531 refresh_index(&the_index, REFRESH_QUIET, NULL, NULL, NULL);
f5bbc322 532
812d6b00 533 if (write_locked_index(&the_index, &false_lock, 0))
8a6179bc 534 die(_("unable to write temporary index file"));
959ba670 535
07047d68 536 discard_index(&the_index);
b4fb09e4 537 ret = get_lock_file_path(&false_lock);
07047d68 538 read_index_from(&the_index, ret, get_git_dir());
dd1055ed
539out:
540 string_list_clear(&partial, 0);
541 clear_pathspec(&pathspec);
b4fb09e4 542 return ret;
f5bbc322
KH
543}
544
d249b098
JH
545static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
546 struct wt_status *s)
f5bbc322 547{
8066df41 548 struct object_id oid;
76e2f7ce 549
d249b098
JH
550 if (s->relative_paths)
551 s->prefix = prefix;
f5bbc322
KH
552
553 if (amend) {
d249b098
JH
554 s->amend = 1;
555 s->reference = "HEAD^1";
f5bbc322 556 }
d249b098
JH
557 s->verbose = verbose;
558 s->index_file = index_file;
559 s->fp = fp;
560 s->nowarn = nowarn;
d850b7a5 561 s->is_initial = repo_get_oid(the_repository, s->reference, &oid) ? 1 : 0;
d9fc746c 562 if (!s->is_initial)
e0cb7cdb 563 oidcpy(&s->oid_commit, &oid);
be7e795e
JH
564 s->status_format = status_format;
565 s->ignore_submodule_arg = ignore_submodule_arg;
f5bbc322 566
76e2f7ce 567 wt_status_collect(s);
be7e795e 568 wt_status_print(s);
73ba5d78 569 wt_status_collect_free_buffers(s);
f5bbc322 570
6fa90194 571 return s->committable;
f5bbc322
KH
572}
573
06bb643b 574static int is_a_merge(const struct commit *current_head)
ec84bd00 575{
06bb643b 576 return !!(current_head->parents && current_head->parents->next);
ec84bd00
PB
577}
578
fac90838
JK
579static void assert_split_ident(struct ident_split *id, const struct strbuf *buf)
580{
c83a5099 581 if (split_ident_line(id, buf->buf, buf->len) || !id->date_begin)
033abf97 582 BUG("unable to parse our own ident: %s", buf->buf);
fac90838
JK
583}
584
7dfe8ad6
JH
585static void export_one(const char *var, const char *s, const char *e, int hack)
586{
587 struct strbuf buf = STRBUF_INIT;
588 if (hack)
589 strbuf_addch(&buf, hack);
147ee355 590 strbuf_add(&buf, s, e - s);
7dfe8ad6
JH
591 setenv(var, buf.buf, 1);
592 strbuf_release(&buf);
593}
594
c33ddc2e 595static int parse_force_date(const char *in, struct strbuf *out)
14ac2864 596{
c33ddc2e 597 strbuf_addch(out, '@');
14ac2864 598
c33ddc2e 599 if (parse_date(in, out) < 0) {
14ac2864
JK
600 int errors = 0;
601 unsigned long t = approxidate_careful(in, &errors);
602 if (errors)
603 return -1;
c33ddc2e 604 strbuf_addf(out, "%lu", t);
14ac2864
JK
605 }
606
607 return 0;
608}
609
f4ef5173
JK
610static void set_ident_var(char **buf, char *val)
611{
612 free(*buf);
613 *buf = val;
614}
615
4c28e4ad 616static void determine_author_info(struct strbuf *author_ident)
a45d46ba
SB
617{
618 char *name, *email, *date;
7dfe8ad6 619 struct ident_split author;
a45d46ba 620
eaa541eb
JK
621 name = xstrdup_or_null(getenv("GIT_AUTHOR_NAME"));
622 email = xstrdup_or_null(getenv("GIT_AUTHOR_EMAIL"));
623 date = xstrdup_or_null(getenv("GIT_AUTHOR_DATE"));
a45d46ba 624
37f7a857 625 if (author_message) {
f0f9662a 626 struct ident_split ident;
2c733fb2 627 size_t len;
f0f9662a 628 const char *a;
a45d46ba 629
f0f9662a 630 a = find_commit_header(author_message_buffer, "author", &len);
a45d46ba 631 if (!a)
f0f9662a
JK
632 die(_("commit '%s' lacks author header"), author_message);
633 if (split_ident_line(&ident, a, len) < 0)
634 die(_("commit '%s' has malformed author line"), author_message);
635
f4ef5173
JK
636 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
637 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
638
f0f9662a 639 if (ident.date_begin) {
f4ef5173 640 struct strbuf date_buf = STRBUF_INIT;
f0f9662a
JK
641 strbuf_addch(&date_buf, '@');
642 strbuf_add(&date_buf, ident.date_begin, ident.date_end - ident.date_begin);
643 strbuf_addch(&date_buf, ' ');
644 strbuf_add(&date_buf, ident.tz_begin, ident.tz_end - ident.tz_begin);
f4ef5173 645 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
f0f9662a 646 }
a45d46ba
SB
647 }
648
649 if (force_author) {
f0f9662a 650 struct ident_split ident;
a45d46ba 651
f0f9662a 652 if (split_ident_line(&ident, force_author, strlen(force_author)) < 0)
8a6179bc 653 die(_("malformed --author parameter"));
f4ef5173
JK
654 set_ident_var(&name, xmemdupz(ident.name_begin, ident.name_end - ident.name_begin));
655 set_ident_var(&email, xmemdupz(ident.mail_begin, ident.mail_end - ident.mail_begin));
a45d46ba
SB
656 }
657
14ac2864 658 if (force_date) {
f4ef5173 659 struct strbuf date_buf = STRBUF_INIT;
c33ddc2e 660 if (parse_force_date(force_date, &date_buf))
14ac2864 661 die(_("invalid date format: %s"), force_date);
f4ef5173 662 set_ident_var(&date, strbuf_detach(&date_buf, NULL));
14ac2864
JK
663 }
664
39ab4d09
WH
665 strbuf_addstr(author_ident, fmt_ident(name, email, WANT_AUTHOR_IDENT, date,
666 IDENT_STRICT));
c83a5099
JK
667 assert_split_ident(&author, author_ident);
668 export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
669 export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
670 export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
f4ef5173
JK
671 free(name);
672 free(email);
673 free(date);
a45d46ba
SB
674}
675
b7242b8c
JK
676static int author_date_is_interesting(void)
677{
678 return author_message || force_date;
4c28e4ad
JH
679}
680
84c9dc2c
NTND
681static void adjust_comment_line_char(const struct strbuf *sb)
682{
683 char candidates[] = "#;@!$%^&|:";
684 char *candidate;
685 const char *p;
686
687 comment_line_char = candidates[0];
688 if (!memchr(sb->buf, comment_line_char, sb->len))
689 return;
690
691 p = sb->buf;
692 candidate = strchr(candidates, *p);
693 if (candidate)
694 *candidate = ' ';
695 for (p = sb->buf; *p; p++) {
696 if ((p[0] == '\n' || p[0] == '\r') && p[1]) {
697 candidate = strchr(candidates, p[1]);
698 if (candidate)
699 *candidate = ' ';
700 }
701 }
702
703 for (p = candidates; *p == ' '; p++)
704 ;
705 if (!*p)
706 die(_("unable to select a comment character that is not used\n"
707 "in the current commit message"));
708 comment_line_char = *p;
709}
710
494d314a
CM
711static void prepare_amend_commit(struct commit *commit, struct strbuf *sb,
712 struct pretty_print_context *ctx)
713{
714 const char *buffer, *subject, *fmt;
715
ecb5091f 716 buffer = repo_get_commit_buffer(the_repository, commit, NULL);
494d314a
CM
717 find_commit_subject(buffer, &subject);
718 /*
719 * If we amend the 'amend!' commit then we don't want to
720 * duplicate the subject line.
721 */
722 fmt = starts_with(subject, "amend!") ? "%b" : "%B";
bab82164 723 repo_format_commit_message(the_repository, commit, fmt, sb, ctx);
ecb5091f 724 repo_unuse_commit_buffer(the_repository, commit, buffer);
494d314a
CM
725}
726
d249b098 727static int prepare_to_commit(const char *index_file, const char *prefix,
06bb643b 728 struct commit *current_head,
4c28e4ad
JH
729 struct wt_status *s,
730 struct strbuf *author_ident)
f5bbc322
KH
731{
732 struct stat statbuf;
4c28e4ad 733 struct strbuf committer_ident = STRBUF_INIT;
6fa90194 734 int committable;
f285a2d7 735 struct strbuf sb = STRBUF_INIT;
8089c85b
PB
736 const char *hook_arg1 = NULL;
737 const char *hook_arg2 = NULL;
d0aaa46f 738 int clean_message_contents = (cleanup_mode != COMMIT_MSG_CLEANUP_NONE);
2556b996 739 int old_display_comment_prefix;
1055997e 740 int merge_contains_scissors = 0;
a8cc5943 741 int invoked_hook;
f5bbc322 742
7dfe8ad6
JH
743 /* This checks and barfs if author is badly specified */
744 determine_author_info(author_ident);
745
a8cc5943
ÆAB
746 if (!no_verify && run_commit_hook(use_editor, index_file, &invoked_hook,
747 "pre-commit", NULL))
ec84bd00 748 return 0;
f5bbc322 749
89ac1223
PN
750 if (squash_message) {
751 /*
752 * Insert the proper subject line before other commit
753 * message options add their content.
754 */
755 if (use_message && !strcmp(use_message, squash_message))
756 strbuf_addstr(&sb, "squash! ");
757 else {
758 struct pretty_print_context ctx = {0};
759 struct commit *c;
760 c = lookup_commit_reference_by_name(squash_message);
761 if (!c)
e4cf0134 762 die(_("could not lookup commit '%s'"), squash_message);
89ac1223 763 ctx.output_encoding = get_commit_output_encoding();
bab82164
ÆAB
764 repo_format_commit_message(the_repository, c,
765 "squash! %s\n\n", &sb,
766 &ctx);
89ac1223
PN
767 }
768 }
769
30884c9a 770 if (have_option_m && !fixup_message) {
f9568530 771 strbuf_addbuf(&sb, &message);
8089c85b 772 hook_arg1 = "message";
f5bbc322
KH
773 } else if (logfile && !strcmp(logfile, "-")) {
774 if (isatty(0))
8a6179bc 775 fprintf(stderr, _("(reading log message from standard input)\n"));
f5bbc322 776 if (strbuf_read(&sb, 0, 0) < 0)
8a6179bc 777 die_errno(_("could not read log from standard input"));
8089c85b 778 hook_arg1 = "message";
f5bbc322
KH
779 } else if (logfile) {
780 if (strbuf_read_file(&sb, logfile, 0) < 0)
8a6179bc 781 die_errno(_("could not read log file '%s'"),
d824cbba 782 logfile);
8089c85b 783 hook_arg1 = "message";
f5bbc322 784 } else if (use_message) {
e23fd15a 785 char *buffer;
f5bbc322 786 buffer = strstr(use_message_buffer, "\n\n");
076cbd63 787 if (buffer)
84e213a3 788 strbuf_addstr(&sb, skip_blank_lines(buffer + 2));
8089c85b
PB
789 hook_arg1 = "commit";
790 hook_arg2 = use_message;
d71b8ba7
PN
791 } else if (fixup_message) {
792 struct pretty_print_context ctx = {0};
793 struct commit *commit;
494d314a
CM
794 char *fmt;
795 commit = lookup_commit_reference_by_name(fixup_commit);
d71b8ba7 796 if (!commit)
e4cf0134 797 die(_("could not lookup commit '%s'"), fixup_commit);
d71b8ba7 798 ctx.output_encoding = get_commit_output_encoding();
494d314a 799 fmt = xstrfmt("%s! %%s\n\n", fixup_prefix);
bab82164
ÆAB
800 repo_format_commit_message(the_repository, commit, fmt, &sb,
801 &ctx);
494d314a 802 free(fmt);
d71b8ba7 803 hook_arg1 = "message";
494d314a
CM
804
805 /*
806 * Only `-m` commit message option is checked here, as
807 * it supports `--fixup` to append the commit message.
808 *
809 * The other commit message options `-c`/`-C`/`-F` are
810 * incompatible with all the forms of `--fixup` and
811 * have already errored out while parsing the `git commit`
812 * options.
813 */
814 if (have_option_m && !strcmp(fixup_prefix, "fixup"))
815 strbuf_addbuf(&sb, &message);
816
817 if (!strcmp(fixup_prefix, "amend")) {
818 if (have_option_m)
246cac85 819 die(_("options '%s' and '%s:%s' cannot be used together"), "-m", "--fixup", fixup_message);
494d314a
CM
820 prepare_amend_commit(commit, &sb, &ctx);
821 }
102de880 822 } else if (!stat(git_path_merge_msg(the_repository), &statbuf)) {
1055997e
DL
823 size_t merge_msg_start;
824
b64c1e07
SS
825 /*
826 * prepend SQUASH_MSG here if it exists and a
827 * "merge --squash" was originally performed
828 */
102de880
SB
829 if (!stat(git_path_squash_msg(the_repository), &statbuf)) {
830 if (strbuf_read_file(&sb, git_path_squash_msg(the_repository), 0) < 0)
b64c1e07
SS
831 die_errno(_("could not read SQUASH_MSG"));
832 hook_arg1 = "squash";
833 } else
834 hook_arg1 = "merge";
1055997e
DL
835
836 merge_msg_start = sb.len;
102de880 837 if (strbuf_read_file(&sb, git_path_merge_msg(the_repository), 0) < 0)
8a6179bc 838 die_errno(_("could not read MERGE_MSG"));
1055997e
DL
839
840 if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS &&
841 wt_status_locate_end(sb.buf + merge_msg_start,
842 sb.len - merge_msg_start) <
843 sb.len - merge_msg_start)
844 merge_contains_scissors = 1;
102de880
SB
845 } else if (!stat(git_path_squash_msg(the_repository), &statbuf)) {
846 if (strbuf_read_file(&sb, git_path_squash_msg(the_repository), 0) < 0)
8a6179bc 847 die_errno(_("could not read SQUASH_MSG"));
8089c85b 848 hook_arg1 = "squash";
2140b140 849 } else if (template_file) {
f5bbc322 850 if (strbuf_read_file(&sb, template_file, 0) < 0)
8a6179bc 851 die_errno(_("could not read '%s'"), template_file);
8089c85b 852 hook_arg1 = "template";
8b1ae678 853 clean_message_contents = 0;
f5bbc322
KH
854 }
855
8089c85b 856 /*
37f7a857
JS
857 * The remaining cases don't modify the template message, but
858 * just set the argument(s) to the prepare-commit-msg hook.
8089c85b 859 */
37f7a857 860 else if (whence == FROM_MERGE)
8089c85b 861 hook_arg1 = "merge";
430b75f7 862 else if (is_from_cherry_pick(whence) || whence == FROM_REBASE_PICK) {
37f7a857
JS
863 hook_arg1 = "commit";
864 hook_arg2 = "CHERRY_PICK_HEAD";
865 }
8089c85b 866
89ac1223
PN
867 if (squash_message) {
868 /*
869 * If squash_commit was used for the commit subject,
870 * then we're possibly hijacking other commit log options.
871 * Reset the hook args to tell the real story.
872 */
873 hook_arg1 = "message";
874 hook_arg2 = "";
875 }
876
e51b0dfc 877 s->fp = fopen_for_writing(git_path_commit_editmsg());
afe8a907 878 if (!s->fp)
e51b0dfc 879 die_errno(_("could not open '%s'"), git_path_commit_editmsg());
f5bbc322 880
2556b996
MM
881 /* Ignore status.displayCommentPrefix: we do need comments in COMMIT_EDITMSG. */
882 old_display_comment_prefix = s->display_comment_prefix;
883 s->display_comment_prefix = 1;
884
ea9882bf
MM
885 /*
886 * Most hints are counter-productive when the commit has
887 * already started.
888 */
889 s->hints = 0;
890
8b1ae678 891 if (clean_message_contents)
787cb8a4 892 strbuf_stripspace(&sb, '\0');
f5bbc322 893
073bd75e 894 if (signoff)
7cb26a17 895 append_signoff(&sb, ignored_log_message_bytes(sb.buf, sb.len), 0);
f5bbc322 896
37f3012f 897 if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
8a6179bc 898 die_errno(_("could not write commit template"));
13208572 899
84c9dc2c
NTND
900 if (auto_comment_line_char)
901 adjust_comment_line_char(&sb);
f5bbc322
KH
902 strbuf_release(&sb);
903
bb1ae3f6 904 /* This checks if committer ident is explicitly given */
f20f3878 905 strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
bed575e4 906 if (use_editor && include_status) {
e23fd15a
EP
907 int ident_shown = 0;
908 int saved_color_setting;
47010263 909 struct ident_split ci, ai;
6f70f00b
HJ
910 const char *hint_cleanup_all = allow_empty_message ?
911 _("Please enter the commit message for your changes."
912 " Lines starting\nwith '%c' will be ignored.\n") :
913 _("Please enter the commit message for your changes."
914 " Lines starting\nwith '%c' will be ignored, and an empty"
915 " message aborts the commit.\n");
916 const char *hint_cleanup_space = allow_empty_message ?
917 _("Please enter the commit message for your changes."
918 " Lines starting\n"
919 "with '%c' will be kept; you may remove them"
920 " yourself if you want to.\n") :
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 "An empty message aborts the commit.\n");
75df1f43 926 if (whence != FROM_COMMIT) {
1055997e
DL
927 if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS &&
928 !merge_contains_scissors)
75df1f43 929 wt_status_add_cut_line(s->fp);
b6d2558c
HWN
930 status_printf_ln(
931 s, GIT_COLOR_NORMAL,
ca03e067 932 whence == FROM_MERGE ?
b6d2558c
HWN
933 _("\n"
934 "It looks like you may be committing a merge.\n"
935 "If this is not correct, please run\n"
936 " git update-ref -d MERGE_HEAD\n"
937 "and try again.\n") :
938 _("\n"
939 "It looks like you may be committing a cherry-pick.\n"
940 "If this is not correct, please run\n"
941 " git update-ref -d CHERRY_PICK_HEAD\n"
942 "and try again.\n"));
75df1f43 943 }
ec84bd00 944
b926c0d1 945 fprintf(s->fp, "\n");
d0aaa46f 946 if (cleanup_mode == COMMIT_MSG_CLEANUP_ALL)
54ba2f18 947 status_printf(s, GIT_COLOR_NORMAL, hint_cleanup_all, comment_line_char);
1055997e
DL
948 else if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS) {
949 if (whence == FROM_COMMIT && !merge_contains_scissors)
950 wt_status_add_cut_line(s->fp);
951 } else /* COMMIT_MSG_CLEANUP_SPACE, that is. */
54ba2f18 952 status_printf(s, GIT_COLOR_NORMAL, hint_cleanup_space, comment_line_char);
ec84bd00 953
fac90838
JK
954 /*
955 * These should never fail because they come from our own
956 * fmt_ident. They may fail the sane_ident test, but we know
957 * that the name and mail pointers will at least be valid,
958 * which is enough for our tests and printing here.
959 */
960 assert_split_ident(&ai, author_ident);
961 assert_split_ident(&ci, &committer_ident);
47010263
JK
962
963 if (ident_cmp(&ai, &ci))
b926c0d1 964 status_printf_ln(s, GIT_COLOR_NORMAL,
fe8165cd 965 _("%s"
47010263 966 "Author: %.*s <%.*s>"),
b926c0d1 967 ident_shown++ ? "" : "\n",
47010263
JK
968 (int)(ai.name_end - ai.name_begin), ai.name_begin,
969 (int)(ai.mail_end - ai.mail_begin), ai.mail_begin);
e83dbe80 970
b7242b8c
JK
971 if (author_date_is_interesting())
972 status_printf_ln(s, GIT_COLOR_NORMAL,
973 _("%s"
974 "Date: %s"),
975 ident_shown++ ? "" : "\n",
a5481a6c 976 show_ident_date(&ai, DATE_MODE(NORMAL)));
e83dbe80 977
d6991cee 978 if (!committer_ident_sufficiently_given())
b926c0d1 979 status_printf_ln(s, GIT_COLOR_NORMAL,
fe8165cd 980 _("%s"
47010263 981 "Committer: %.*s <%.*s>"),
b926c0d1 982 ident_shown++ ? "" : "\n",
47010263
JK
983 (int)(ci.name_end - ci.name_begin), ci.name_begin,
984 (int)(ci.mail_end - ci.mail_begin), ci.mail_begin);
bb1ae3f6 985
b3cf1b77 986 status_printf_ln(s, GIT_COLOR_NORMAL, "%s", ""); /* Add new line for clarity */
bb1ae3f6 987
d249b098
JH
988 saved_color_setting = s->use_color;
989 s->use_color = 0;
6fa90194 990 committable = run_status(s->fp, index_file, prefix, 1, s);
d249b098 991 s->use_color = saved_color_setting;
3e73cc62 992 string_list_clear(&s->change, 1);
ec84bd00 993 } else {
8066df41 994 struct object_id oid;
fbcf1184 995 const char *parent = "HEAD";
7168624c 996
2ee045ee
JS
997 if (!the_index.initialized && repo_read_index(the_repository) < 0)
998 die(_("Cannot read index"));
7168624c 999
fbcf1184
JH
1000 if (amend)
1001 parent = "HEAD^1";
1002
d850b7a5 1003 if (repo_get_oid(the_repository, parent, &oid)) {
2c49f7ff
NTND
1004 int i, ita_nr = 0;
1005
cb8388df
DS
1006 /* TODO: audit for interaction with sparse-index. */
1007 ensure_full_index(&the_index);
dc594180
ÆAB
1008 for (i = 0; i < the_index.cache_nr; i++)
1009 if (ce_intent_to_add(the_index.cache[i]))
2c49f7ff 1010 ita_nr++;
dc594180 1011 committable = the_index.cache_nr - ita_nr > 0;
2c49f7ff 1012 } else {
c215d3d2
JL
1013 /*
1014 * Unless the user did explicitly request a submodule
1015 * ignore mode by passing a command line option we do
1016 * not ignore any changed submodule SHA-1s when
1017 * comparing index and parent, no matter what is
1018 * configured. Otherwise we won't commit any
1019 * submodules which were manually staged, which would
1020 * be really confusing.
1021 */
02f2f56b 1022 struct diff_flags flags = DIFF_FLAGS_INIT;
0d1e0e78 1023 flags.override_submodule_config = 1;
c215d3d2
JL
1024 if (ignore_submodule_arg &&
1025 !strcmp(ignore_submodule_arg, "all"))
0d1e0e78 1026 flags.ignore_submodules = 1;
ffc00a48
NTND
1027 committable = index_differs_from(the_repository,
1028 parent, &flags, 1);
c215d3d2 1029 }
ec84bd00 1030 }
4c28e4ad 1031 strbuf_release(&committer_ident);
d616a239 1032
37f3012f 1033 fclose(s->fp);
7168624c 1034
2daae3d1
ZH
1035 if (trailer_args.nr) {
1036 struct child_process run_trailer = CHILD_PROCESS_INIT;
1037
1038 strvec_pushl(&run_trailer.args, "interpret-trailers",
be3d6543
JK
1039 "--in-place", "--no-divider",
1040 git_path_commit_editmsg(), NULL);
2daae3d1
ZH
1041 strvec_pushv(&run_trailer.args, trailer_args.v);
1042 run_trailer.git_cmd = 1;
1043 if (run_command(&run_trailer))
1044 die(_("unable to pass trailers to --trailers"));
1045 strvec_clear(&trailer_args);
1046 }
1047
37f7a857
JS
1048 /*
1049 * Reject an attempt to record a non-merge empty commit without
1050 * explicit --allow-empty. In the cherry-pick case, it may be
1051 * empty due to conflict resolution, which the user should okay.
1052 */
6fa90194 1053 if (!committable && whence != FROM_MERGE && !allow_empty &&
06bb643b 1054 !(amend && is_a_merge(current_head))) {
ed9bff08 1055 s->hints = advice_enabled(ADVICE_STATUS_HINTS);
2556b996 1056 s->display_comment_prefix = old_display_comment_prefix;
d249b098 1057 run_status(stdout, index_file, prefix, 0, s);
f197ed2f 1058 if (amend)
fc88e316 1059 fputs(_(empty_amend_advice), stderr);
430b75f7
PW
1060 else if (is_from_cherry_pick(whence) ||
1061 whence == FROM_REBASE_PICK) {
6c80cd29 1062 fputs(_(empty_cherry_pick_advice), stderr);
8d57f757 1063 if (whence == FROM_CHERRY_PICK_SINGLE)
c17592a7 1064 fputs(_(empty_cherry_pick_advice_single), stderr);
430b75f7 1065 else if (whence == FROM_CHERRY_PICK_MULTI)
c17592a7 1066 fputs(_(empty_cherry_pick_advice_multi), stderr);
430b75f7
PW
1067 else
1068 fputs(_(empty_rebase_pick_advice), stderr);
c17592a7 1069 }
ec84bd00 1070 return 0;
7168624c
AR
1071 }
1072
a8cc5943 1073 if (!no_verify && invoked_hook) {
680ee550 1074 /*
a8cc5943
ÆAB
1075 * Re-read the index as the pre-commit-commit hook was invoked
1076 * and could have updated it. We must do this before we invoke
680ee550
KW
1077 * the editor and after we invoke run_status above.
1078 */
07047d68 1079 discard_index(&the_index);
680ee550 1080 }
07047d68 1081 read_index_from(&the_index, index_file, get_git_dir());
680ee550 1082
fcb864bc 1083 if (cache_tree_update(&the_index, 0)) {
8a6179bc 1084 error(_("Error building trees"));
ec84bd00 1085 return 0;
7168624c 1086 }
f5bbc322 1087
a8cc5943 1088 if (run_commit_hook(use_editor, index_file, NULL, "prepare-commit-msg",
e51b0dfc 1089 git_path_commit_editmsg(), hook_arg1, hook_arg2, NULL))
8089c85b 1090 return 0;
f5bbc322 1091
ec84bd00 1092 if (use_editor) {
22f9b7f3 1093 struct strvec env = STRVEC_INIT;
8d7aa4ba 1094
22f9b7f3 1095 strvec_pushf(&env, "GIT_INDEX_FILE=%s", index_file);
d70a9eb6 1096 if (launch_editor(git_path_commit_editmsg(), NULL, env.v)) {
7198203a 1097 fprintf(stderr,
8a6179bc 1098 _("Please supply the message using either -m or -F option.\n"));
7198203a
SB
1099 exit(1);
1100 }
22f9b7f3 1101 strvec_clear(&env);
ec84bd00 1102 }
f5bbc322 1103
ec84bd00 1104 if (!no_verify &&
a8cc5943
ÆAB
1105 run_commit_hook(use_editor, index_file, NULL, "commit-msg",
1106 git_path_commit_editmsg(), NULL)) {
ec84bd00
PB
1107 return 0;
1108 }
f5bbc322 1109
ec84bd00 1110 return 1;
f5bbc322
KH
1111}
1112
146ea068
JH
1113static const char *find_author_by_nickname(const char *name)
1114{
1115 struct rev_info revs;
1116 struct commit *commit;
1117 struct strbuf buf = STRBUF_INIT;
1118 const char *av[20];
1119 int ac = 0;
1120
2abf3503 1121 repo_init_revisions(the_repository, &revs, NULL);
146ea068
JH
1122 strbuf_addf(&buf, "--author=%s", name);
1123 av[++ac] = "--all";
1124 av[++ac] = "-i";
1125 av[++ac] = buf.buf;
1126 av[++ac] = NULL;
1127 setup_revisions(ac, av, &revs, NULL);
a52f07af
ÆAB
1128 revs.mailmap = xmalloc(sizeof(struct string_list));
1129 string_list_init_nodup(revs.mailmap);
4e168333 1130 read_mailmap(revs.mailmap);
ea16794e 1131
81c3ce3c
SB
1132 if (prepare_revision_walk(&revs))
1133 die(_("revision walk setup failed"));
146ea068
JH
1134 commit = get_revision(&revs);
1135 if (commit) {
dd2e794a 1136 struct pretty_print_context ctx = {0};
a5481a6c 1137 ctx.date_mode.type = DATE_NORMAL;
146ea068 1138 strbuf_release(&buf);
bab82164
ÆAB
1139 repo_format_commit_message(the_repository, commit,
1140 "%aN <%aE>", &buf, &ctx);
2108fe4a 1141 release_revisions(&revs);
146ea068
JH
1142 return strbuf_detach(&buf, NULL);
1143 }
1044b1f6 1144 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name);
146ea068
JH
1145}
1146
eec0f7f2
JM
1147static void handle_ignored_arg(struct wt_status *s)
1148{
1149 if (!ignored_arg)
1150 ; /* default already initialized */
1151 else if (!strcmp(ignored_arg, "traditional"))
1152 s->show_ignored_mode = SHOW_TRADITIONAL_IGNORED;
1153 else if (!strcmp(ignored_arg, "no"))
1154 s->show_ignored_mode = SHOW_NO_IGNORED;
1155 else if (!strcmp(ignored_arg, "matching"))
1156 s->show_ignored_mode = SHOW_MATCHING_IGNORED;
1157 else
1158 die(_("Invalid ignored mode '%s'"), ignored_arg);
1159}
76e2f7ce
JH
1160
1161static void handle_untracked_files_arg(struct wt_status *s)
1162{
1163 if (!untracked_files_arg)
1164 ; /* default already initialized */
1165 else if (!strcmp(untracked_files_arg, "no"))
1166 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1167 else if (!strcmp(untracked_files_arg, "normal"))
1168 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1169 else if (!strcmp(untracked_files_arg, "all"))
1170 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
5a59a230
NTND
1171 /*
1172 * Please update $__git_untracked_file_modes in
1173 * git-completion.bash when you add new options
1174 */
76e2f7ce 1175 else
8a6179bc 1176 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
76e2f7ce
JH
1177}
1178
37f7a857
JS
1179static const char *read_commit_message(const char *name)
1180{
dd0d388c 1181 const char *out_enc;
37f7a857
JS
1182 struct commit *commit;
1183
1184 commit = lookup_commit_reference_by_name(name);
1185 if (!commit)
e4cf0134 1186 die(_("could not lookup commit '%s'"), name);
37f7a857 1187 out_enc = get_commit_output_encoding();
ecb5091f 1188 return repo_logmsg_reencode(the_repository, commit, NULL, out_enc);
37f7a857
JS
1189}
1190
84b4202d
JH
1191/*
1192 * Enumerate what needs to be propagated when --porcelain
1193 * is not in effect here.
1194 */
1195static struct status_deferred_config {
be7e795e 1196 enum wt_status_format status_format;
84b4202d 1197 int show_branch;
06b324c1 1198 enum ahead_behind_flags ahead_behind;
84b4202d
JH
1199} status_deferred_config = {
1200 STATUS_FORMAT_UNSPECIFIED,
06b324c1
JH
1201 -1, /* unspecified */
1202 AHEAD_BEHIND_UNSPECIFIED,
84b4202d
JH
1203};
1204
1205static void finalize_deferred_config(struct wt_status *s)
1206{
1207 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1ecdecce 1208 status_format != STATUS_FORMAT_PORCELAIN_V2 &&
84b4202d
JH
1209 !s->null_termination);
1210
1211 if (s->null_termination) {
1212 if (status_format == STATUS_FORMAT_NONE ||
1213 status_format == STATUS_FORMAT_UNSPECIFIED)
1214 status_format = STATUS_FORMAT_PORCELAIN;
1215 else if (status_format == STATUS_FORMAT_LONG)
12909b6b 1216 die(_("options '%s' and '%s' cannot be used together"), "--long", "-z");
84b4202d
JH
1217 }
1218
1219 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1220 status_format = status_deferred_config.status_format;
1221 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1222 status_format = STATUS_FORMAT_NONE;
1223
1224 if (use_deferred_config && s->show_branch < 0)
1225 s->show_branch = status_deferred_config.show_branch;
1226 if (s->show_branch < 0)
1227 s->show_branch = 0;
fd9b544a 1228
06b324c1
JH
1229 /*
1230 * If the user did not give a "--[no]-ahead-behind" command
fb4db1a2
JH
1231 * line argument *AND* we will print in a human-readable format
1232 * (short, long etc.) then we inherit from the status.aheadbehind
1233 * config setting. In all other cases (and porcelain V[12] formats
1234 * in particular), we inherit _FULL for backwards compatibility.
06b324c1 1235 */
fb4db1a2
JH
1236 if (use_deferred_config &&
1237 s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
06b324c1
JH
1238 s->ahead_behind_flags = status_deferred_config.ahead_behind;
1239
fd9b544a
JH
1240 if (s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
1241 s->ahead_behind_flags = AHEAD_BEHIND_FULL;
84b4202d
JH
1242}
1243
3270ae82
CM
1244static void check_fixup_reword_options(int argc, const char *argv[]) {
1245 if (whence != FROM_COMMIT) {
1246 if (whence == FROM_MERGE)
1247 die(_("You are in the middle of a merge -- cannot reword."));
1248 else if (is_from_cherry_pick(whence))
1249 die(_("You are in the middle of a cherry-pick -- cannot reword."));
1250 }
1251 if (argc)
246cac85 1252 die(_("reword option of '%s' and path '%s' cannot be used together"), "--fixup", *argv);
3270ae82 1253 if (patch_interactive || interactive || all || also || only)
246cac85
JNA
1254 die(_("reword option of '%s' and '%s' cannot be used together"),
1255 "--fixup", "--patch/--interactive/--all/--include/--only");
3270ae82
CM
1256}
1257
2f02b25f 1258static int parse_and_validate_options(int argc, const char *argv[],
036dbbfb 1259 const struct option *options,
dbd0f5c7 1260 const char * const usage[],
d249b098 1261 const char *prefix,
06bb643b 1262 struct commit *current_head,
d249b098 1263 struct wt_status *s)
f5bbc322 1264{
036dbbfb 1265 argc = parse_options(argc, argv, prefix, options, usage, 0);
84b4202d 1266 finalize_deferred_config(s);
f5bbc322 1267
146ea068
JH
1268 if (force_author && !strchr(force_author, '>'))
1269 force_author = find_author_by_nickname(force_author);
1270
c51f6cee 1271 if (force_author && renew_authorship)
a699367b 1272 die(_("options '%s' and '%s' cannot be used together"), "--reset-author", "--author");
c51f6cee 1273
494d314a 1274 if (logfile || have_option_m || use_message)
4803466f 1275 use_editor = 0;
f5bbc322 1276
f5bbc322 1277 /* Sanity check options */
06bb643b 1278 if (amend && !current_head)
8a6179bc 1279 die(_("You have nothing to amend."));
b0cea47e
ÆAB
1280 if (amend && whence != FROM_COMMIT) {
1281 if (whence == FROM_MERGE)
1282 die(_("You are in the middle of a merge -- cannot amend."));
8d57f757 1283 else if (is_from_cherry_pick(whence))
b0cea47e 1284 die(_("You are in the middle of a cherry-pick -- cannot amend."));
430b75f7
PW
1285 else if (whence == FROM_REBASE_PICK)
1286 die(_("You are in the middle of a rebase -- cannot amend."));
b0cea47e 1287 }
89ac1223 1288 if (fixup_message && squash_message)
a699367b
JNA
1289 die(_("options '%s' and '%s' cannot be used together"), "--squash", "--fixup");
1290 die_for_incompatible_opt4(!!use_message, "-C",
1291 !!edit_message, "-c",
1292 !!logfile, "-F",
1293 !!fixup_message, "--fixup");
1294 die_for_incompatible_opt4(have_option_m, "-m",
1295 !!edit_message, "-c",
1296 !!use_message, "-C",
1297 !!logfile, "-F");
1298 if (use_message || edit_message || logfile ||fixup_message || have_option_m)
010c7dbc 1299 template_file = NULL;
f5bbc322
KH
1300 if (edit_message)
1301 use_message = edit_message;
d71b8ba7 1302 if (amend && !use_message && !fixup_message)
f5bbc322 1303 use_message = "HEAD";
430b75f7
PW
1304 if (!use_message && !is_from_cherry_pick(whence) &&
1305 !is_from_rebase(whence) && renew_authorship)
8a6179bc 1306 die(_("--reset-author can be used only with -C, -c or --amend."));
f5bbc322 1307 if (use_message) {
37f7a857
JS
1308 use_message_buffer = read_commit_message(use_message);
1309 if (!renew_authorship) {
1310 author_message = use_message;
1311 author_message_buffer = use_message_buffer;
1312 }
1313 }
430b75f7
PW
1314 if ((is_from_cherry_pick(whence) || whence == FROM_REBASE_PICK) &&
1315 !renew_authorship) {
37f7a857
JS
1316 author_message = "CHERRY_PICK_HEAD";
1317 author_message_buffer = read_commit_message(author_message);
f5bbc322
KH
1318 }
1319
b4bd4668
CI
1320 if (patch_interactive)
1321 interactive = 1;
1322
a699367b
JNA
1323 die_for_incompatible_opt4(also, "-i/--include",
1324 only, "-o/--only",
1325 all, "-a/--all",
1326 interactive, "--interactive/-p/--patch");
494d314a
CM
1327 if (fixup_message) {
1328 /*
1329 * We limit --fixup's suboptions to only alpha characters.
1330 * If the first character after a run of alpha is colon,
1331 * then the part before the colon may be a known suboption
3270ae82
CM
1332 * name like `amend` or `reword`, or a misspelt suboption
1333 * name. In either case, we treat it as
1334 * --fixup=<suboption>:<arg>.
494d314a
CM
1335 *
1336 * Otherwise, we are dealing with --fixup=<commit>.
1337 */
1338 char *p = fixup_message;
1339 while (isalpha(*p))
1340 p++;
1341 if (p > fixup_message && *p == ':') {
1342 *p = '\0';
1343 fixup_commit = p + 1;
3270ae82
CM
1344 if (!strcmp("amend", fixup_message) ||
1345 !strcmp("reword", fixup_message)) {
494d314a
CM
1346 fixup_prefix = "amend";
1347 allow_empty = 1;
3270ae82
CM
1348 if (*fixup_message == 'r') {
1349 check_fixup_reword_options(argc, argv);
1350 only = 1;
1351 }
494d314a
CM
1352 } else {
1353 die(_("unknown option: --fixup=%s:%s"), fixup_message, fixup_commit);
1354 }
1355 } else {
1356 fixup_commit = fixup_message;
1357 fixup_prefix = "fixup";
1358 use_editor = 0;
1359 }
1360 }
1361
8ef6aad6
JK
1362 if (0 <= edit_flag)
1363 use_editor = edit_flag;
1364
f29cd862 1365 cleanup_mode = get_cleanup_mode(cleanup_arg, use_editor);
f5bbc322 1366
76e2f7ce 1367 handle_untracked_files_arg(s);
4bfee30a 1368
f5bbc322 1369 if (all && argc > 0)
5a1dbd48
NTND
1370 die(_("paths '%s ...' with -a does not make sense"),
1371 argv[0]);
f5bbc322 1372
f3f47a1e 1373 if (status_format != STATUS_FORMAT_NONE)
7c9f7038
JK
1374 dry_run = 1;
1375
f5bbc322
KH
1376 return argc;
1377}
1378
e885a84f 1379static int dry_run_commit(const char **argv, const char *prefix,
06bb643b 1380 const struct commit *current_head, struct wt_status *s)
f5bbc322 1381{
6fa90194 1382 int committable;
3a5d13a3 1383 const char *index_file;
f5bbc322 1384
e885a84f 1385 index_file = prepare_index(argv, prefix, current_head, 1);
6fa90194 1386 committable = run_status(stdout, index_file, prefix, 0, s);
3a5d13a3 1387 rollback_index_files();
f5bbc322 1388
6fa90194 1389 return committable ? 0 : 1;
3a5d13a3
JH
1390}
1391
3ac68a93
NTND
1392define_list_config_array_extra(color_status_slots, {"added"});
1393
8852117a 1394static int parse_status_slot(const char *slot)
f766b367 1395{
a73b3680 1396 if (!strcasecmp(slot, "added"))
f766b367 1397 return WT_STATUS_UPDATED;
a73b3680
NTND
1398
1399 return LOOKUP_CONFIG(color_status_slots, slot);
f766b367
JH
1400}
1401
a4e7e317
GC
1402static int git_status_config(const char *k, const char *v,
1403 const struct config_context *ctx, void *cb)
f766b367
JH
1404{
1405 struct wt_status *s = cb;
e3f1da98 1406 const char *slot_name;
f766b367 1407
59556548 1408 if (starts_with(k, "column."))
4d2292e9 1409 return git_column_config(k, v, "status", &s->colopts);
f766b367
JH
1410 if (!strcmp(k, "status.submodulesummary")) {
1411 int is_bool;
8868b1eb
GC
1412 s->submodule_summary = git_config_bool_or_int(k, v, ctx->kvi,
1413 &is_bool);
f766b367
JH
1414 if (is_bool && s->submodule_summary)
1415 s->submodule_summary = -1;
1416 return 0;
1417 }
4fb5166a
JJGG
1418 if (!strcmp(k, "status.short")) {
1419 if (git_config_bool(k, v))
84b4202d 1420 status_deferred_config.status_format = STATUS_FORMAT_SHORT;
4fb5166a 1421 else
84b4202d 1422 status_deferred_config.status_format = STATUS_FORMAT_NONE;
4fb5166a
JJGG
1423 return 0;
1424 }
ec85d070 1425 if (!strcmp(k, "status.branch")) {
84b4202d 1426 status_deferred_config.show_branch = git_config_bool(k, v);
ec85d070
JJGG
1427 return 0;
1428 }
06b324c1
JH
1429 if (!strcmp(k, "status.aheadbehind")) {
1430 status_deferred_config.ahead_behind = git_config_bool(k, v);
1431 return 0;
1432 }
c1b5d019
LB
1433 if (!strcmp(k, "status.showstash")) {
1434 s->show_stash = git_config_bool(k, v);
1435 return 0;
1436 }
f766b367 1437 if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
e269eb79 1438 s->use_color = git_config_colorbool(k, v);
f766b367
JH
1439 return 0;
1440 }
2556b996
MM
1441 if (!strcmp(k, "status.displaycommentprefix")) {
1442 s->display_comment_prefix = git_config_bool(k, v);
1443 return 0;
1444 }
e3f1da98
RS
1445 if (skip_prefix(k, "status.color.", &slot_name) ||
1446 skip_prefix(k, "color.status.", &slot_name)) {
b9465768 1447 int slot = parse_status_slot(slot_name);
8b8e8624
JK
1448 if (slot < 0)
1449 return 0;
f766b367
JH
1450 if (!v)
1451 return config_error_nonbool(k);
f6c5a296 1452 return color_parse(v, s->color_palette[slot]);
f766b367
JH
1453 }
1454 if (!strcmp(k, "status.relativepaths")) {
1455 s->relative_paths = git_config_bool(k, v);
1456 return 0;
1457 }
1458 if (!strcmp(k, "status.showuntrackedfiles")) {
1459 if (!v)
1460 return config_error_nonbool(k);
1461 else if (!strcmp(v, "no"))
1462 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1463 else if (!strcmp(v, "normal"))
1464 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1465 else if (!strcmp(v, "all"))
1466 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
1467 else
8a6179bc 1468 return error(_("Invalid untracked files mode '%s'"), v);
f766b367
JH
1469 return 0;
1470 }
e8b2dc2c
BP
1471 if (!strcmp(k, "diff.renamelimit")) {
1472 if (s->rename_limit == -1)
8868b1eb 1473 s->rename_limit = git_config_int(k, v, ctx->kvi);
e8b2dc2c
BP
1474 return 0;
1475 }
1476 if (!strcmp(k, "status.renamelimit")) {
8868b1eb 1477 s->rename_limit = git_config_int(k, v, ctx->kvi);
e8b2dc2c
BP
1478 return 0;
1479 }
1480 if (!strcmp(k, "diff.renames")) {
1481 if (s->detect_rename == -1)
1482 s->detect_rename = git_config_rename(k, v);
1483 return 0;
1484 }
1485 if (!strcmp(k, "status.renames")) {
1486 s->detect_rename = git_config_rename(k, v);
1487 return 0;
1488 }
a4e7e317 1489 return git_diff_ui_config(k, v, ctx, NULL);
f766b367
JH
1490}
1491
3a5d13a3
JH
1492int cmd_status(int argc, const char **argv, const char *prefix)
1493{
e8b2dc2c
BP
1494 static int no_renames = -1;
1495 static const char *rename_score_arg = (const char *)-1;
036dbbfb 1496 static struct wt_status s;
ae9af122 1497 unsigned int progress_flag = 0;
4bb6644d 1498 int fd;
8066df41 1499 struct object_id oid;
9e4b7ab6 1500 static struct option builtin_status_options[] = {
f2276316 1501 OPT__VERBOSE(&verbose, N_("be verbose")),
dd2be243 1502 OPT_SET_INT('s', "short", &status_format,
f2276316 1503 N_("show status concisely"), STATUS_FORMAT_SHORT),
84b4202d
JH
1504 OPT_BOOL('b', "branch", &s.show_branch,
1505 N_("show branch information")),
c1b5d019
LB
1506 OPT_BOOL(0, "show-stash", &s.show_stash,
1507 N_("show stash information")),
fd9b544a
JH
1508 OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
1509 N_("compute full ahead/behind values")),
203c8533 1510 OPT_CALLBACK_F(0, "porcelain", &status_format,
c4f596b9 1511 N_("version"), N_("machine-readable output"),
203c8533 1512 PARSE_OPT_OPTARG, opt_parse_porcelain),
f3f47a1e
JK
1513 OPT_SET_INT(0, "long", &status_format,
1514 N_("show status in long format (default)"),
1515 STATUS_FORMAT_LONG),
d5d09d47
SB
1516 OPT_BOOL('z', "null", &s.null_termination,
1517 N_("terminate entries with NUL")),
76e2f7ce 1518 { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
f2276316
NTND
1519 N_("mode"),
1520 N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
76e2f7ce 1521 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
eec0f7f2
JM
1522 { OPTION_STRING, 0, "ignored", &ignored_arg,
1523 N_("mode"),
1524 N_("show ignored files, optional modes: traditional, matching, no. (Default: traditional)"),
1525 PARSE_OPT_OPTARG, NULL, (intptr_t)"traditional" },
f2276316
NTND
1526 { OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
1527 N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
46a958b3 1528 PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
9c23f4c5 1529 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
e8b2dc2c 1530 OPT_BOOL(0, "no-renames", &no_renames, N_("do not detect renames")),
203c8533 1531 OPT_CALLBACK_F('M', "find-renames", &rename_score_arg,
e8b2dc2c 1532 N_("n"), N_("detect renames, optionally set similarity index"),
203c8533 1533 PARSE_OPT_OPTARG | PARSE_OPT_NONEG, opt_parse_rename_score),
76e2f7ce
JH
1534 OPT_END(),
1535 };
1536
5d3dd915
NTND
1537 if (argc == 2 && !strcmp(argv[1], "-h"))
1538 usage_with_options(builtin_status_usage, builtin_status_options);
1539
d76723ee
DS
1540 prepare_repo_settings(the_repository);
1541 the_repository->settings.command_requires_full_index = 0;
1542
5c25dfaa 1543 status_init_config(&s, git_status_config);
76e2f7ce 1544 argc = parse_options(argc, argv, prefix,
9e4b7ab6
JH
1545 builtin_status_options,
1546 builtin_status_usage, 0);
4d2292e9 1547 finalize_colopts(&s.colopts, -1);
84b4202d 1548 finalize_deferred_config(&s);
000f97bd 1549
76e2f7ce 1550 handle_untracked_files_arg(&s);
eec0f7f2
JM
1551 handle_ignored_arg(&s);
1552
1553 if (s.show_ignored_mode == SHOW_MATCHING_IGNORED &&
1554 s.show_untracked_files == SHOW_NO_UNTRACKED_FILES)
1555 die(_("Unsupported combination of ignored and untracked-files arguments"));
1556
15b55ae0
NTND
1557 parse_pathspec(&s.pathspec, 0,
1558 PATHSPEC_PREFER_FULL,
1559 prefix, argv);
76e2f7ce 1560
ae9af122
NTND
1561 if (status_format != STATUS_FORMAT_PORCELAIN &&
1562 status_format != STATUS_FORMAT_PORCELAIN_V2)
1563 progress_flag = REFRESH_PROGRESS;
e1ff0a32 1564 repo_read_index(the_repository);
ae9af122
NTND
1565 refresh_index(&the_index,
1566 REFRESH_QUIET|REFRESH_UNMERGED|progress_flag,
1567 &s.pathspec, NULL, NULL);
4bb6644d 1568
27344d6a 1569 if (use_optional_locks())
07047d68 1570 fd = repo_hold_locked_index(the_repository, &index_lock, 0);
27344d6a
JK
1571 else
1572 fd = -1;
4bb6644d 1573
d850b7a5 1574 s.is_initial = repo_get_oid(the_repository, s.reference, &oid) ? 1 : 0;
d9fc746c 1575 if (!s.is_initial)
e0cb7cdb 1576 oidcpy(&s.oid_commit, &oid);
d9fc746c 1577
46a958b3 1578 s.ignore_submodule_arg = ignore_submodule_arg;
be7e795e
JH
1579 s.status_format = status_format;
1580 s.verbose = verbose;
e8b2dc2c
BP
1581 if (no_renames != -1)
1582 s.detect_rename = !no_renames;
1583 if ((intptr_t)rename_score_arg != -1) {
1584 if (s.detect_rename < DIFF_DETECT_RENAME)
1585 s.detect_rename = DIFF_DETECT_RENAME;
1586 if (rename_score_arg)
1587 s.rename_score = parse_rename_score(&rename_score_arg);
1588 }
be7e795e 1589
76e2f7ce
JH
1590 wt_status_collect(&s);
1591
226c051a 1592 if (0 <= fd)
1b0d968b 1593 repo_update_index_if_able(the_repository, &index_lock);
226c051a 1594
8661768f
JK
1595 if (s.relative_paths)
1596 s.prefix = prefix;
38920dd6 1597
be7e795e 1598 wt_status_print(&s);
73ba5d78
SS
1599 wt_status_collect_free_buffers(&s);
1600
76e2f7ce 1601 return 0;
f5bbc322
KH
1602}
1603
a4e7e317
GC
1604static int git_commit_config(const char *k, const char *v,
1605 const struct config_context *ctx, void *cb)
f5bbc322 1606{
d249b098
JH
1607 struct wt_status *s = cb;
1608
984c6e7e 1609 if (!strcmp(k, "commit.template"))
395de250 1610 return git_config_pathname(&template_file, k, v);
bed575e4
JHI
1611 if (!strcmp(k, "commit.status")) {
1612 include_status = git_config_bool(k, v);
1613 return 0;
1614 }
51fb3a3d
RT
1615 if (!strcmp(k, "commit.cleanup"))
1616 return git_config_string(&cleanup_arg, k, v);
d95bfb12
NV
1617 if (!strcmp(k, "commit.gpgsign")) {
1618 sign_commit = git_config_bool(k, v) ? "" : NULL;
1619 return 0;
1620 }
aaab8420
PB
1621 if (!strcmp(k, "commit.verbose")) {
1622 int is_bool;
8868b1eb
GC
1623 config_commit_verbose = git_config_bool_or_int(k, v, ctx->kvi,
1624 &is_bool);
aaab8420
PB
1625 return 0;
1626 }
f5bbc322 1627
a4e7e317 1628 return git_status_config(k, v, ctx, s);
f5bbc322
KH
1629}
1630
f5bbc322
KH
1631int cmd_commit(int argc, const char **argv, const char *prefix)
1632{
036dbbfb
JK
1633 static struct wt_status s;
1634 static struct option builtin_commit_options[] = {
9c23f4c5
NTND
1635 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1636 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1637
1638 OPT_GROUP(N_("Commit message options")),
1639 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1640 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1641 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1642 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1643 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1644 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
494d314a 1645 /*
3270ae82
CM
1646 * TRANSLATORS: Leave "[(amend|reword):]" as-is,
1647 * and only translate <commit>.
494d314a 1648 */
3270ae82 1649 OPT_STRING(0, "fixup", &fixup_message, N_("[(amend|reword):]commit"), N_("use autosquash formatted message to fixup or amend/reword specified commit")),
9c23f4c5 1650 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
d5d09d47 1651 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
116761ba 1652 OPT_CALLBACK_F(0, "trailer", &trailer_args, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG, opt_pass_trailer),
3abd4a67 1653 OPT_BOOL('s', "signoff", &signoff, N_("add a Signed-off-by trailer")),
9c23f4c5
NTND
1654 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1655 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
ca04dc96 1656 OPT_CLEANUP(&cleanup_arg),
d5d09d47 1657 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
e703d711 1658 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
9c23f4c5 1659 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
036dbbfb
JK
1660 /* end commit message options */
1661
9c23f4c5 1662 OPT_GROUP(N_("Commit contents options")),
d5d09d47
SB
1663 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1664 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1665 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1666 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1667 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
def480fe 1668 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit and commit-msg hooks")),
d5d09d47 1669 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
9c23f4c5 1670 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
036dbbfb 1671 STATUS_FORMAT_SHORT),
84b4202d 1672 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
fd9b544a
JH
1673 OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
1674 N_("compute full ahead/behind values")),
036dbbfb 1675 OPT_SET_INT(0, "porcelain", &status_format,
9c23f4c5 1676 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
f3f47a1e
JK
1677 OPT_SET_INT(0, "long", &status_format,
1678 N_("show status in long format (default)"),
1679 STATUS_FORMAT_LONG),
d5d09d47
SB
1680 OPT_BOOL('z', "null", &s.null_termination,
1681 N_("terminate entries with NUL")),
1682 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1683 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
9c23f4c5 1684 { 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" },
e440fc58
AM
1685 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
1686 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
036dbbfb
JK
1687 /* end commit contents options */
1688
4741edd5
SB
1689 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1690 N_("ok to record an empty change")),
1691 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1692 N_("ok to record a change with an empty message")),
036dbbfb
JK
1693
1694 OPT_END()
1695 };
1696
f285a2d7 1697 struct strbuf sb = STRBUF_INIT;
4c28e4ad 1698 struct strbuf author_ident = STRBUF_INIT;
f5bbc322 1699 const char *index_file, *reflog_msg;
8066df41 1700 struct object_id oid;
de9f7fa3 1701 struct commit_list *parents = NULL;
cf10f9fd 1702 struct stat statbuf;
06bb643b 1703 struct commit *current_head = NULL;
ed7a42a0 1704 struct commit_extra_header *extra = NULL;
c0fe1ed0 1705 struct strbuf err = STRBUF_INIT;
00d8c311 1706 int ret = 0;
f5bbc322 1707
5d3dd915
NTND
1708 if (argc == 2 && !strcmp(argv[1], "-h"))
1709 usage_with_options(builtin_commit_usage, builtin_commit_options);
1710
daa1acef
DS
1711 prepare_repo_settings(the_repository);
1712 the_repository->settings.command_requires_full_index = 0;
1713
5c25dfaa 1714 status_init_config(&s, git_commit_config);
4ddb1354 1715 s.commit_template = 1;
f0915cba 1716 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
4d2292e9 1717 s.colopts = 0;
f5bbc322 1718
d850b7a5 1719 if (repo_get_oid(the_repository, "HEAD", &oid))
06bb643b
JH
1720 current_head = NULL;
1721 else {
bc83266a 1722 current_head = lookup_commit_or_die(&oid, "HEAD");
ecb5091f 1723 if (repo_parse_commit(the_repository, current_head))
06bb643b
JH
1724 die(_("could not parse HEAD commit"));
1725 }
aaab8420 1726 verbose = -1; /* unspecified */
036dbbfb
JK
1727 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1728 builtin_commit_usage,
06bb643b 1729 prefix, current_head, &s);
aaab8420
PB
1730 if (verbose == -1)
1731 verbose = (config_commit_verbose < 0) ? 0 : config_commit_verbose;
1732
c9bfb953 1733 if (dry_run)
e885a84f
JK
1734 return dry_run_commit(argv, prefix, current_head, &s);
1735 index_file = prepare_index(argv, prefix, current_head, 0);
f5bbc322 1736
ec84bd00
PB
1737 /* Set up everything for writing the commit object. This includes
1738 running hooks, writing the trees, and interacting with the user. */
06bb643b
JH
1739 if (!prepare_to_commit(index_file, prefix,
1740 current_head, &s, &author_ident)) {
00d8c311 1741 ret = 1;
2888605c 1742 rollback_index_files();
00d8c311 1743 goto cleanup;
f5bbc322
KH
1744 }
1745
f5bbc322 1746 /* Determine parents */
643cb5f7 1747 reflog_msg = getenv("GIT_REFLOG_ACTION");
06bb643b 1748 if (!current_head) {
643cb5f7
CC
1749 if (!reflog_msg)
1750 reflog_msg = "commit (initial)";
f5bbc322 1751 } else if (amend) {
643cb5f7
CC
1752 if (!reflog_msg)
1753 reflog_msg = "commit (amend)";
de9f7fa3 1754 parents = copy_commit_list(current_head->parents);
37f7a857 1755 } else if (whence == FROM_MERGE) {
f285a2d7 1756 struct strbuf m = STRBUF_INIT;
f5bbc322 1757 FILE *fp;
e23fd15a 1758 int allow_fast_forward = 1;
de9f7fa3 1759 struct commit_list **pptr = &parents;
f5bbc322 1760
643cb5f7
CC
1761 if (!reflog_msg)
1762 reflog_msg = "commit (merge)";
de9f7fa3 1763 pptr = commit_list_append(current_head, pptr);
102de880 1764 fp = xfopen(git_path_merge_head(the_repository), "r");
8f309aeb 1765 while (strbuf_getline_lf(&m, fp) != EOF) {
5231c633
JH
1766 struct commit *parent;
1767
1768 parent = get_merge_parent(m.buf);
1769 if (!parent)
8a6179bc 1770 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
de9f7fa3 1771 pptr = commit_list_append(parent, pptr);
7c3fd25d 1772 }
f5bbc322
KH
1773 fclose(fp);
1774 strbuf_release(&m);
102de880
SB
1775 if (!stat(git_path_merge_mode(the_repository), &statbuf)) {
1776 if (strbuf_read_file(&sb, git_path_merge_mode(the_repository), 0) < 0)
8a6179bc 1777 die_errno(_("could not read MERGE_MODE"));
cf10f9fd
MV
1778 if (!strcmp(sb.buf, "no-ff"))
1779 allow_fast_forward = 0;
1780 }
1781 if (allow_fast_forward)
4da72644 1782 reduce_heads_replace(&parents);
f5bbc322 1783 } else {
643cb5f7 1784 if (!reflog_msg)
8d57f757 1785 reflog_msg = is_from_cherry_pick(whence)
37f7a857 1786 ? "commit (cherry-pick)"
430b75f7
PW
1787 : is_from_rebase(whence)
1788 ? "commit (rebase)"
37f7a857 1789 : "commit";
de9f7fa3 1790 commit_list_insert(current_head, &parents);
f5bbc322 1791 }
f5bbc322 1792
ec84bd00 1793 /* Finally, get the commit message */
cf10f9fd 1794 strbuf_reset(&sb);
e51b0dfc 1795 if (strbuf_read_file(&sb, git_path_commit_editmsg(), 0) < 0) {
0721c314 1796 int saved_errno = errno;
740001a5 1797 rollback_index_files();
8a6179bc 1798 die(_("could not read commit message: %s"), strerror(saved_errno));
740001a5 1799 }
99a12694 1800
f29cd862 1801 cleanup_message(&sb, cleanup_mode, verbose);
bc17f35f 1802
d0aaa46f 1803 if (message_is_empty(&sb, cleanup_mode) && !allow_empty_message) {
b2eda9bd 1804 rollback_index_files();
bc17f35f 1805 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
b2eda9bd
JH
1806 exit(1);
1807 }
d0aaa46f 1808 if (template_untouched(&sb, template_file, cleanup_mode) && !allow_empty_message) {
2888605c 1809 rollback_index_files();
bc17f35f 1810 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
fdc7c811 1811 exit(1);
2888605c 1812 }
f5bbc322 1813
494d314a
CM
1814 if (fixup_message && starts_with(sb.buf, "amend! ") &&
1815 !allow_empty_message) {
1816 struct strbuf body = STRBUF_INIT;
1817 size_t len = commit_subject_length(sb.buf);
1818 strbuf_addstr(&body, sb.buf + len);
1819 if (message_is_empty(&body, cleanup_mode)) {
1820 rollback_index_files();
1821 fprintf(stderr, _("Aborting commit due to empty commit message body.\n"));
1822 exit(1);
1823 }
1824 strbuf_release(&body);
1825 }
1826
0074d18d 1827 if (amend) {
42d4e1d1 1828 const char *exclude_gpgsig[3] = { "gpgsig", "gpgsig-sha256", NULL };
c871a1d1 1829 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
0074d18d
JH
1830 } else {
1831 struct commit_extra_header **tail = &extra;
1832 append_merge_tag_headers(parents, &tail);
1833 }
ed7a42a0 1834
dc594180 1835 if (commit_tree_extended(sb.buf, sb.len, &the_index.cache_tree->oid,
e8cbe211
PW
1836 parents, &oid, author_ident.buf, NULL,
1837 sign_commit, extra)) {
2888605c 1838 rollback_index_files();
8a6179bc 1839 die(_("failed to write commit object"));
2888605c 1840 }
ed7a42a0 1841 free_commit_extra_headers(extra);
f5bbc322 1842
0505d604
PW
1843 if (update_head_with_reflog(current_head, &oid, reflog_msg, &sb,
1844 &err)) {
2888605c 1845 rollback_index_files();
c0fe1ed0 1846 die("%s", err.buf);
2888605c 1847 }
f5bbc322 1848
f496b064 1849 sequencer_post_commit_cleanup(the_repository, 0);
102de880
SB
1850 unlink(git_path_merge_head(the_repository));
1851 unlink(git_path_merge_msg(the_repository));
1852 unlink(git_path_merge_mode(the_repository));
1853 unlink(git_path_squash_msg(the_repository));
f5bbc322 1854
5a9dd399 1855 if (commit_index_files())
1a07e59c 1856 die(_("repository has been updated, but unable to write\n"
a060705d 1857 "new index file. Check that disk is not full and quota is\n"
80f537f7 1858 "not exceeded, and then \"git restore --staged :/\" to recover."));
f5bbc322 1859
b23ea979 1860 git_test_write_commit_graph_or_die();
859fdc0c 1861
35843b11 1862 repo_rerere(the_repository, 0);
a95ce124 1863 run_auto_maintenance(quiet);
a8cc5943
ÆAB
1864 run_commit_hook(use_editor, get_index_file(), NULL, "post-commit",
1865 NULL);
6f6bee3b 1866 if (amend && !no_post_rewrite) {
1d18d758 1867 commit_post_rewrite(the_repository, current_head, &oid);
6f6bee3b 1868 }
e47c6caf
PW
1869 if (!quiet) {
1870 unsigned int flags = 0;
1871
1872 if (!current_head)
1873 flags |= SUMMARY_INITIAL_COMMIT;
1874 if (author_date_is_interesting())
1875 flags |= SUMMARY_SHOW_AUTHOR_DATE;
f11c9580
NTND
1876 print_commit_summary(the_repository, prefix,
1877 &oid, flags);
6f6bee3b 1878 }
f5bbc322 1879
a03b5553
DL
1880 apply_autostash(git_path_merge_autostash(the_repository));
1881
00d8c311 1882cleanup:
ac95f5d3
ÆAB
1883 strbuf_release(&author_ident);
1884 strbuf_release(&err);
1885 strbuf_release(&sb);
00d8c311 1886 return ret;
f5bbc322 1887}