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