]> git.ipfire.org Git - thirdparty/git.git/blame - builtin/commit.c
environment: store comment_line_char as a string
[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
1751e581 687 if (!memchr(sb->buf, candidates[0], sb->len)) {
72a7d5d9 688 comment_line_str = xstrfmt("%c", candidates[0]);
84c9dc2c 689 return;
1751e581 690 }
84c9dc2c
NTND
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"));
72a7d5d9 709 comment_line_str = xstrfmt("%c", *p);
84c9dc2c
NTND
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)
e4cf0134 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)
e4cf0134 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)
787cb8a4 893 strbuf_stripspace(&sb, '\0');
f5bbc322 894
073bd75e 895 if (signoff)
7cb26a17 896 append_signoff(&sb, ignored_log_message_bytes(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
2ee045ee
JS
998 if (!the_index.initialized && repo_read_index(the_repository) < 0)
999 die(_("Cannot read index"));
7168624c 1000
fbcf1184
JH
1001 if (amend)
1002 parent = "HEAD^1";
1003
d850b7a5 1004 if (repo_get_oid(the_repository, parent, &oid)) {
2c49f7ff
NTND
1005 int i, ita_nr = 0;
1006
cb8388df
DS
1007 /* TODO: audit for interaction with sparse-index. */
1008 ensure_full_index(&the_index);
dc594180
ÆAB
1009 for (i = 0; i < the_index.cache_nr; i++)
1010 if (ce_intent_to_add(the_index.cache[i]))
2c49f7ff 1011 ita_nr++;
dc594180 1012 committable = the_index.cache_nr - ita_nr > 0;
2c49f7ff 1013 } else {
c215d3d2
JL
1014 /*
1015 * Unless the user did explicitly request a submodule
1016 * ignore mode by passing a command line option we do
1017 * not ignore any changed submodule SHA-1s when
1018 * comparing index and parent, no matter what is
1019 * configured. Otherwise we won't commit any
1020 * submodules which were manually staged, which would
1021 * be really confusing.
1022 */
02f2f56b 1023 struct diff_flags flags = DIFF_FLAGS_INIT;
0d1e0e78 1024 flags.override_submodule_config = 1;
c215d3d2
JL
1025 if (ignore_submodule_arg &&
1026 !strcmp(ignore_submodule_arg, "all"))
0d1e0e78 1027 flags.ignore_submodules = 1;
ffc00a48
NTND
1028 committable = index_differs_from(the_repository,
1029 parent, &flags, 1);
c215d3d2 1030 }
ec84bd00 1031 }
4c28e4ad 1032 strbuf_release(&committer_ident);
d616a239 1033
37f3012f 1034 fclose(s->fp);
7168624c 1035
2daae3d1
ZH
1036 if (trailer_args.nr) {
1037 struct child_process run_trailer = CHILD_PROCESS_INIT;
1038
1039 strvec_pushl(&run_trailer.args, "interpret-trailers",
be3d6543
JK
1040 "--in-place", "--no-divider",
1041 git_path_commit_editmsg(), NULL);
2daae3d1
ZH
1042 strvec_pushv(&run_trailer.args, trailer_args.v);
1043 run_trailer.git_cmd = 1;
1044 if (run_command(&run_trailer))
1045 die(_("unable to pass trailers to --trailers"));
1046 strvec_clear(&trailer_args);
1047 }
1048
37f7a857
JS
1049 /*
1050 * Reject an attempt to record a non-merge empty commit without
1051 * explicit --allow-empty. In the cherry-pick case, it may be
1052 * empty due to conflict resolution, which the user should okay.
1053 */
6fa90194 1054 if (!committable && whence != FROM_MERGE && !allow_empty &&
06bb643b 1055 !(amend && is_a_merge(current_head))) {
ed9bff08 1056 s->hints = advice_enabled(ADVICE_STATUS_HINTS);
2556b996 1057 s->display_comment_prefix = old_display_comment_prefix;
d249b098 1058 run_status(stdout, index_file, prefix, 0, s);
f197ed2f 1059 if (amend)
fc88e316 1060 fputs(_(empty_amend_advice), stderr);
430b75f7
PW
1061 else if (is_from_cherry_pick(whence) ||
1062 whence == FROM_REBASE_PICK) {
6c80cd29 1063 fputs(_(empty_cherry_pick_advice), stderr);
8d57f757 1064 if (whence == FROM_CHERRY_PICK_SINGLE)
c17592a7 1065 fputs(_(empty_cherry_pick_advice_single), stderr);
430b75f7 1066 else if (whence == FROM_CHERRY_PICK_MULTI)
c17592a7 1067 fputs(_(empty_cherry_pick_advice_multi), stderr);
430b75f7
PW
1068 else
1069 fputs(_(empty_rebase_pick_advice), stderr);
c17592a7 1070 }
ec84bd00 1071 return 0;
7168624c
AR
1072 }
1073
a8cc5943 1074 if (!no_verify && invoked_hook) {
680ee550 1075 /*
a8cc5943
ÆAB
1076 * Re-read the index as the pre-commit-commit hook was invoked
1077 * and could have updated it. We must do this before we invoke
680ee550
KW
1078 * the editor and after we invoke run_status above.
1079 */
07047d68 1080 discard_index(&the_index);
680ee550 1081 }
07047d68 1082 read_index_from(&the_index, index_file, get_git_dir());
680ee550 1083
fcb864bc 1084 if (cache_tree_update(&the_index, 0)) {
8a6179bc 1085 error(_("Error building trees"));
ec84bd00 1086 return 0;
7168624c 1087 }
f5bbc322 1088
a8cc5943 1089 if (run_commit_hook(use_editor, index_file, NULL, "prepare-commit-msg",
e51b0dfc 1090 git_path_commit_editmsg(), hook_arg1, hook_arg2, NULL))
8089c85b 1091 return 0;
f5bbc322 1092
ec84bd00 1093 if (use_editor) {
22f9b7f3 1094 struct strvec env = STRVEC_INIT;
8d7aa4ba 1095
22f9b7f3 1096 strvec_pushf(&env, "GIT_INDEX_FILE=%s", index_file);
d70a9eb6 1097 if (launch_editor(git_path_commit_editmsg(), NULL, env.v)) {
7198203a 1098 fprintf(stderr,
8a6179bc 1099 _("Please supply the message using either -m or -F option.\n"));
7198203a
SB
1100 exit(1);
1101 }
22f9b7f3 1102 strvec_clear(&env);
ec84bd00 1103 }
f5bbc322 1104
ec84bd00 1105 if (!no_verify &&
a8cc5943
ÆAB
1106 run_commit_hook(use_editor, index_file, NULL, "commit-msg",
1107 git_path_commit_editmsg(), NULL)) {
ec84bd00
PB
1108 return 0;
1109 }
f5bbc322 1110
ec84bd00 1111 return 1;
f5bbc322
KH
1112}
1113
146ea068
JH
1114static const char *find_author_by_nickname(const char *name)
1115{
1116 struct rev_info revs;
1117 struct commit *commit;
1118 struct strbuf buf = STRBUF_INIT;
1119 const char *av[20];
1120 int ac = 0;
1121
2abf3503 1122 repo_init_revisions(the_repository, &revs, NULL);
146ea068
JH
1123 strbuf_addf(&buf, "--author=%s", name);
1124 av[++ac] = "--all";
1125 av[++ac] = "-i";
1126 av[++ac] = buf.buf;
1127 av[++ac] = NULL;
1128 setup_revisions(ac, av, &revs, NULL);
a52f07af
ÆAB
1129 revs.mailmap = xmalloc(sizeof(struct string_list));
1130 string_list_init_nodup(revs.mailmap);
4e168333 1131 read_mailmap(revs.mailmap);
ea16794e 1132
81c3ce3c
SB
1133 if (prepare_revision_walk(&revs))
1134 die(_("revision walk setup failed"));
146ea068
JH
1135 commit = get_revision(&revs);
1136 if (commit) {
dd2e794a 1137 struct pretty_print_context ctx = {0};
a5481a6c 1138 ctx.date_mode.type = DATE_NORMAL;
146ea068 1139 strbuf_release(&buf);
bab82164
ÆAB
1140 repo_format_commit_message(the_repository, commit,
1141 "%aN <%aE>", &buf, &ctx);
2108fe4a 1142 release_revisions(&revs);
146ea068
JH
1143 return strbuf_detach(&buf, NULL);
1144 }
1044b1f6 1145 die(_("--author '%s' is not 'Name <email>' and matches no existing author"), name);
146ea068
JH
1146}
1147
eec0f7f2
JM
1148static void handle_ignored_arg(struct wt_status *s)
1149{
1150 if (!ignored_arg)
1151 ; /* default already initialized */
1152 else if (!strcmp(ignored_arg, "traditional"))
1153 s->show_ignored_mode = SHOW_TRADITIONAL_IGNORED;
1154 else if (!strcmp(ignored_arg, "no"))
1155 s->show_ignored_mode = SHOW_NO_IGNORED;
1156 else if (!strcmp(ignored_arg, "matching"))
1157 s->show_ignored_mode = SHOW_MATCHING_IGNORED;
1158 else
1159 die(_("Invalid ignored mode '%s'"), ignored_arg);
1160}
76e2f7ce
JH
1161
1162static void handle_untracked_files_arg(struct wt_status *s)
1163{
1164 if (!untracked_files_arg)
1165 ; /* default already initialized */
1166 else if (!strcmp(untracked_files_arg, "no"))
1167 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
1168 else if (!strcmp(untracked_files_arg, "normal"))
1169 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
1170 else if (!strcmp(untracked_files_arg, "all"))
1171 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
5a59a230
NTND
1172 /*
1173 * Please update $__git_untracked_file_modes in
1174 * git-completion.bash when you add new options
1175 */
76e2f7ce 1176 else
8a6179bc 1177 die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
76e2f7ce
JH
1178}
1179
37f7a857
JS
1180static const char *read_commit_message(const char *name)
1181{
dd0d388c 1182 const char *out_enc;
37f7a857
JS
1183 struct commit *commit;
1184
1185 commit = lookup_commit_reference_by_name(name);
1186 if (!commit)
e4cf0134 1187 die(_("could not lookup commit '%s'"), name);
37f7a857 1188 out_enc = get_commit_output_encoding();
ecb5091f 1189 return repo_logmsg_reencode(the_repository, commit, NULL, out_enc);
37f7a857
JS
1190}
1191
84b4202d
JH
1192/*
1193 * Enumerate what needs to be propagated when --porcelain
1194 * is not in effect here.
1195 */
1196static struct status_deferred_config {
be7e795e 1197 enum wt_status_format status_format;
84b4202d 1198 int show_branch;
06b324c1 1199 enum ahead_behind_flags ahead_behind;
84b4202d
JH
1200} status_deferred_config = {
1201 STATUS_FORMAT_UNSPECIFIED,
06b324c1
JH
1202 -1, /* unspecified */
1203 AHEAD_BEHIND_UNSPECIFIED,
84b4202d
JH
1204};
1205
1206static void finalize_deferred_config(struct wt_status *s)
1207{
1208 int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
1ecdecce 1209 status_format != STATUS_FORMAT_PORCELAIN_V2 &&
84b4202d
JH
1210 !s->null_termination);
1211
1212 if (s->null_termination) {
1213 if (status_format == STATUS_FORMAT_NONE ||
1214 status_format == STATUS_FORMAT_UNSPECIFIED)
1215 status_format = STATUS_FORMAT_PORCELAIN;
1216 else if (status_format == STATUS_FORMAT_LONG)
12909b6b 1217 die(_("options '%s' and '%s' cannot be used together"), "--long", "-z");
84b4202d
JH
1218 }
1219
1220 if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
1221 status_format = status_deferred_config.status_format;
1222 if (status_format == STATUS_FORMAT_UNSPECIFIED)
1223 status_format = STATUS_FORMAT_NONE;
1224
1225 if (use_deferred_config && s->show_branch < 0)
1226 s->show_branch = status_deferred_config.show_branch;
1227 if (s->show_branch < 0)
1228 s->show_branch = 0;
fd9b544a 1229
06b324c1
JH
1230 /*
1231 * If the user did not give a "--[no]-ahead-behind" command
fb4db1a2
JH
1232 * line argument *AND* we will print in a human-readable format
1233 * (short, long etc.) then we inherit from the status.aheadbehind
1234 * config setting. In all other cases (and porcelain V[12] formats
1235 * in particular), we inherit _FULL for backwards compatibility.
06b324c1 1236 */
fb4db1a2
JH
1237 if (use_deferred_config &&
1238 s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
06b324c1
JH
1239 s->ahead_behind_flags = status_deferred_config.ahead_behind;
1240
fd9b544a
JH
1241 if (s->ahead_behind_flags == AHEAD_BEHIND_UNSPECIFIED)
1242 s->ahead_behind_flags = AHEAD_BEHIND_FULL;
84b4202d
JH
1243}
1244
3270ae82
CM
1245static void check_fixup_reword_options(int argc, const char *argv[]) {
1246 if (whence != FROM_COMMIT) {
1247 if (whence == FROM_MERGE)
1248 die(_("You are in the middle of a merge -- cannot reword."));
1249 else if (is_from_cherry_pick(whence))
1250 die(_("You are in the middle of a cherry-pick -- cannot reword."));
1251 }
1252 if (argc)
246cac85 1253 die(_("reword option of '%s' and path '%s' cannot be used together"), "--fixup", *argv);
3270ae82 1254 if (patch_interactive || interactive || all || also || only)
246cac85
JNA
1255 die(_("reword option of '%s' and '%s' cannot be used together"),
1256 "--fixup", "--patch/--interactive/--all/--include/--only");
3270ae82
CM
1257}
1258
2f02b25f 1259static int parse_and_validate_options(int argc, const char *argv[],
036dbbfb 1260 const struct option *options,
dbd0f5c7 1261 const char * const usage[],
d249b098 1262 const char *prefix,
06bb643b 1263 struct commit *current_head,
d249b098 1264 struct wt_status *s)
f5bbc322 1265{
036dbbfb 1266 argc = parse_options(argc, argv, prefix, options, usage, 0);
84b4202d 1267 finalize_deferred_config(s);
f5bbc322 1268
146ea068
JH
1269 if (force_author && !strchr(force_author, '>'))
1270 force_author = find_author_by_nickname(force_author);
1271
c51f6cee 1272 if (force_author && renew_authorship)
a699367b 1273 die(_("options '%s' and '%s' cannot be used together"), "--reset-author", "--author");
c51f6cee 1274
494d314a 1275 if (logfile || have_option_m || use_message)
4803466f 1276 use_editor = 0;
f5bbc322 1277
f5bbc322 1278 /* Sanity check options */
06bb643b 1279 if (amend && !current_head)
8a6179bc 1280 die(_("You have nothing to amend."));
b0cea47e
ÆAB
1281 if (amend && whence != FROM_COMMIT) {
1282 if (whence == FROM_MERGE)
1283 die(_("You are in the middle of a merge -- cannot amend."));
8d57f757 1284 else if (is_from_cherry_pick(whence))
b0cea47e 1285 die(_("You are in the middle of a cherry-pick -- cannot amend."));
430b75f7
PW
1286 else if (whence == FROM_REBASE_PICK)
1287 die(_("You are in the middle of a rebase -- cannot amend."));
b0cea47e 1288 }
89ac1223 1289 if (fixup_message && squash_message)
a699367b
JNA
1290 die(_("options '%s' and '%s' cannot be used together"), "--squash", "--fixup");
1291 die_for_incompatible_opt4(!!use_message, "-C",
1292 !!edit_message, "-c",
1293 !!logfile, "-F",
1294 !!fixup_message, "--fixup");
1295 die_for_incompatible_opt4(have_option_m, "-m",
1296 !!edit_message, "-c",
1297 !!use_message, "-C",
1298 !!logfile, "-F");
1299 if (use_message || edit_message || logfile ||fixup_message || have_option_m)
010c7dbc 1300 template_file = NULL;
f5bbc322
KH
1301 if (edit_message)
1302 use_message = edit_message;
d71b8ba7 1303 if (amend && !use_message && !fixup_message)
f5bbc322 1304 use_message = "HEAD";
430b75f7
PW
1305 if (!use_message && !is_from_cherry_pick(whence) &&
1306 !is_from_rebase(whence) && renew_authorship)
8a6179bc 1307 die(_("--reset-author can be used only with -C, -c or --amend."));
f5bbc322 1308 if (use_message) {
37f7a857
JS
1309 use_message_buffer = read_commit_message(use_message);
1310 if (!renew_authorship) {
1311 author_message = use_message;
1312 author_message_buffer = use_message_buffer;
1313 }
1314 }
430b75f7
PW
1315 if ((is_from_cherry_pick(whence) || whence == FROM_REBASE_PICK) &&
1316 !renew_authorship) {
37f7a857
JS
1317 author_message = "CHERRY_PICK_HEAD";
1318 author_message_buffer = read_commit_message(author_message);
f5bbc322
KH
1319 }
1320
b4bd4668
CI
1321 if (patch_interactive)
1322 interactive = 1;
1323
a699367b
JNA
1324 die_for_incompatible_opt4(also, "-i/--include",
1325 only, "-o/--only",
1326 all, "-a/--all",
1327 interactive, "--interactive/-p/--patch");
494d314a
CM
1328 if (fixup_message) {
1329 /*
1330 * We limit --fixup's suboptions to only alpha characters.
1331 * If the first character after a run of alpha is colon,
1332 * then the part before the colon may be a known suboption
3270ae82
CM
1333 * name like `amend` or `reword`, or a misspelt suboption
1334 * name. In either case, we treat it as
1335 * --fixup=<suboption>:<arg>.
494d314a
CM
1336 *
1337 * Otherwise, we are dealing with --fixup=<commit>.
1338 */
1339 char *p = fixup_message;
1340 while (isalpha(*p))
1341 p++;
1342 if (p > fixup_message && *p == ':') {
1343 *p = '\0';
1344 fixup_commit = p + 1;
3270ae82
CM
1345 if (!strcmp("amend", fixup_message) ||
1346 !strcmp("reword", fixup_message)) {
494d314a
CM
1347 fixup_prefix = "amend";
1348 allow_empty = 1;
3270ae82
CM
1349 if (*fixup_message == 'r') {
1350 check_fixup_reword_options(argc, argv);
1351 only = 1;
1352 }
494d314a
CM
1353 } else {
1354 die(_("unknown option: --fixup=%s:%s"), fixup_message, fixup_commit);
1355 }
1356 } else {
1357 fixup_commit = fixup_message;
1358 fixup_prefix = "fixup";
1359 use_editor = 0;
1360 }
1361 }
1362
8ef6aad6
JK
1363 if (0 <= edit_flag)
1364 use_editor = edit_flag;
1365
f29cd862 1366 cleanup_mode = get_cleanup_mode(cleanup_arg, use_editor);
f5bbc322 1367
76e2f7ce 1368 handle_untracked_files_arg(s);
4bfee30a 1369
f5bbc322 1370 if (all && argc > 0)
5a1dbd48
NTND
1371 die(_("paths '%s ...' with -a does not make sense"),
1372 argv[0]);
f5bbc322 1373
f3f47a1e 1374 if (status_format != STATUS_FORMAT_NONE)
7c9f7038
JK
1375 dry_run = 1;
1376
f5bbc322
KH
1377 return argc;
1378}
1379
e885a84f 1380static int dry_run_commit(const char **argv, const char *prefix,
06bb643b 1381 const struct commit *current_head, struct wt_status *s)
f5bbc322 1382{
6fa90194 1383 int committable;
3a5d13a3 1384 const char *index_file;
f5bbc322 1385
e885a84f 1386 index_file = prepare_index(argv, prefix, current_head, 1);
6fa90194 1387 committable = run_status(stdout, index_file, prefix, 0, s);
3a5d13a3 1388 rollback_index_files();
f5bbc322 1389
6fa90194 1390 return committable ? 0 : 1;
3a5d13a3
JH
1391}
1392
3ac68a93
NTND
1393define_list_config_array_extra(color_status_slots, {"added"});
1394
8852117a 1395static int parse_status_slot(const char *slot)
f766b367 1396{
a73b3680 1397 if (!strcasecmp(slot, "added"))
f766b367 1398 return WT_STATUS_UPDATED;
a73b3680
NTND
1399
1400 return LOOKUP_CONFIG(color_status_slots, slot);
f766b367
JH
1401}
1402
a4e7e317
GC
1403static int git_status_config(const char *k, const char *v,
1404 const struct config_context *ctx, void *cb)
f766b367
JH
1405{
1406 struct wt_status *s = cb;
e3f1da98 1407 const char *slot_name;
f766b367 1408
59556548 1409 if (starts_with(k, "column."))
4d2292e9 1410 return git_column_config(k, v, "status", &s->colopts);
f766b367
JH
1411 if (!strcmp(k, "status.submodulesummary")) {
1412 int is_bool;
8868b1eb
GC
1413 s->submodule_summary = git_config_bool_or_int(k, v, ctx->kvi,
1414 &is_bool);
f766b367
JH
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)
8868b1eb 1474 s->rename_limit = git_config_int(k, v, ctx->kvi);
e8b2dc2c
BP
1475 return 0;
1476 }
1477 if (!strcmp(k, "status.renamelimit")) {
8868b1eb 1478 s->rename_limit = git_config_int(k, v, ctx->kvi);
e8b2dc2c
BP
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 }
a4e7e317 1490 return git_diff_ui_config(k, v, ctx, NULL);
f766b367
JH
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
a4e7e317
GC
1605static int git_commit_config(const char *k, const char *v,
1606 const struct config_context *ctx, void *cb)
f5bbc322 1607{
d249b098
JH
1608 struct wt_status *s = cb;
1609
984c6e7e 1610 if (!strcmp(k, "commit.template"))
395de250 1611 return git_config_pathname(&template_file, k, v);
bed575e4
JHI
1612 if (!strcmp(k, "commit.status")) {
1613 include_status = git_config_bool(k, v);
1614 return 0;
1615 }
51fb3a3d
RT
1616 if (!strcmp(k, "commit.cleanup"))
1617 return git_config_string(&cleanup_arg, k, v);
d95bfb12
NV
1618 if (!strcmp(k, "commit.gpgsign")) {
1619 sign_commit = git_config_bool(k, v) ? "" : NULL;
1620 return 0;
1621 }
aaab8420
PB
1622 if (!strcmp(k, "commit.verbose")) {
1623 int is_bool;
8868b1eb
GC
1624 config_commit_verbose = git_config_bool_or_int(k, v, ctx->kvi,
1625 &is_bool);
aaab8420
PB
1626 return 0;
1627 }
f5bbc322 1628
a4e7e317 1629 return git_status_config(k, v, ctx, s);
f5bbc322
KH
1630}
1631
f5bbc322
KH
1632int cmd_commit(int argc, const char **argv, const char *prefix)
1633{
036dbbfb
JK
1634 static struct wt_status s;
1635 static struct option builtin_commit_options[] = {
9c23f4c5
NTND
1636 OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
1637 OPT__VERBOSE(&verbose, N_("show diff in commit message template")),
1638
1639 OPT_GROUP(N_("Commit message options")),
1640 OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
1641 OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
1642 OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
1643 OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
1644 OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
1645 OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
494d314a 1646 /*
3270ae82
CM
1647 * TRANSLATORS: Leave "[(amend|reword):]" as-is,
1648 * and only translate <commit>.
494d314a 1649 */
3270ae82 1650 OPT_STRING(0, "fixup", &fixup_message, N_("[(amend|reword):]commit"), N_("use autosquash formatted message to fixup or amend/reword specified commit")),
9c23f4c5 1651 OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
d5d09d47 1652 OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
116761ba 1653 OPT_CALLBACK_F(0, "trailer", &trailer_args, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG, opt_pass_trailer),
3abd4a67 1654 OPT_BOOL('s', "signoff", &signoff, N_("add a Signed-off-by trailer")),
9c23f4c5
NTND
1655 OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
1656 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
ca04dc96 1657 OPT_CLEANUP(&cleanup_arg),
d5d09d47 1658 OPT_BOOL(0, "status", &include_status, N_("include status in commit message template")),
e703d711 1659 { OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key-id"),
9c23f4c5 1660 N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
036dbbfb
JK
1661 /* end commit message options */
1662
9c23f4c5 1663 OPT_GROUP(N_("Commit contents options")),
d5d09d47
SB
1664 OPT_BOOL('a', "all", &all, N_("commit all changed files")),
1665 OPT_BOOL('i', "include", &also, N_("add specified files to index for commit")),
1666 OPT_BOOL(0, "interactive", &interactive, N_("interactively add files")),
1667 OPT_BOOL('p', "patch", &patch_interactive, N_("interactively add changes")),
1668 OPT_BOOL('o', "only", &only, N_("commit only specified files")),
def480fe 1669 OPT_BOOL('n', "no-verify", &no_verify, N_("bypass pre-commit and commit-msg hooks")),
d5d09d47 1670 OPT_BOOL(0, "dry-run", &dry_run, N_("show what would be committed")),
9c23f4c5 1671 OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
036dbbfb 1672 STATUS_FORMAT_SHORT),
84b4202d 1673 OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
fd9b544a
JH
1674 OPT_BOOL(0, "ahead-behind", &s.ahead_behind_flags,
1675 N_("compute full ahead/behind values")),
036dbbfb 1676 OPT_SET_INT(0, "porcelain", &status_format,
9c23f4c5 1677 N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
f3f47a1e
JK
1678 OPT_SET_INT(0, "long", &status_format,
1679 N_("show status in long format (default)"),
1680 STATUS_FORMAT_LONG),
d5d09d47
SB
1681 OPT_BOOL('z', "null", &s.null_termination,
1682 N_("terminate entries with NUL")),
1683 OPT_BOOL(0, "amend", &amend, N_("amend previous commit")),
1684 OPT_BOOL(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
9c23f4c5 1685 { 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
1686 OPT_PATHSPEC_FROM_FILE(&pathspec_from_file),
1687 OPT_PATHSPEC_FILE_NUL(&pathspec_file_nul),
036dbbfb
JK
1688 /* end commit contents options */
1689
4741edd5
SB
1690 OPT_HIDDEN_BOOL(0, "allow-empty", &allow_empty,
1691 N_("ok to record an empty change")),
1692 OPT_HIDDEN_BOOL(0, "allow-empty-message", &allow_empty_message,
1693 N_("ok to record a change with an empty message")),
036dbbfb
JK
1694
1695 OPT_END()
1696 };
1697
f285a2d7 1698 struct strbuf sb = STRBUF_INIT;
4c28e4ad 1699 struct strbuf author_ident = STRBUF_INIT;
f5bbc322 1700 const char *index_file, *reflog_msg;
8066df41 1701 struct object_id oid;
de9f7fa3 1702 struct commit_list *parents = NULL;
cf10f9fd 1703 struct stat statbuf;
06bb643b 1704 struct commit *current_head = NULL;
ed7a42a0 1705 struct commit_extra_header *extra = NULL;
c0fe1ed0 1706 struct strbuf err = STRBUF_INIT;
00d8c311 1707 int ret = 0;
f5bbc322 1708
5d3dd915
NTND
1709 if (argc == 2 && !strcmp(argv[1], "-h"))
1710 usage_with_options(builtin_commit_usage, builtin_commit_options);
1711
daa1acef
DS
1712 prepare_repo_settings(the_repository);
1713 the_repository->settings.command_requires_full_index = 0;
1714
5c25dfaa 1715 status_init_config(&s, git_commit_config);
4ddb1354 1716 s.commit_template = 1;
f0915cba 1717 status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
4d2292e9 1718 s.colopts = 0;
f5bbc322 1719
d850b7a5 1720 if (repo_get_oid(the_repository, "HEAD", &oid))
06bb643b
JH
1721 current_head = NULL;
1722 else {
bc83266a 1723 current_head = lookup_commit_or_die(&oid, "HEAD");
ecb5091f 1724 if (repo_parse_commit(the_repository, current_head))
06bb643b
JH
1725 die(_("could not parse HEAD commit"));
1726 }
aaab8420 1727 verbose = -1; /* unspecified */
036dbbfb
JK
1728 argc = parse_and_validate_options(argc, argv, builtin_commit_options,
1729 builtin_commit_usage,
06bb643b 1730 prefix, current_head, &s);
aaab8420
PB
1731 if (verbose == -1)
1732 verbose = (config_commit_verbose < 0) ? 0 : config_commit_verbose;
1733
c9bfb953 1734 if (dry_run)
e885a84f
JK
1735 return dry_run_commit(argv, prefix, current_head, &s);
1736 index_file = prepare_index(argv, prefix, current_head, 0);
f5bbc322 1737
ec84bd00
PB
1738 /* Set up everything for writing the commit object. This includes
1739 running hooks, writing the trees, and interacting with the user. */
06bb643b
JH
1740 if (!prepare_to_commit(index_file, prefix,
1741 current_head, &s, &author_ident)) {
00d8c311 1742 ret = 1;
2888605c 1743 rollback_index_files();
00d8c311 1744 goto cleanup;
f5bbc322
KH
1745 }
1746
f5bbc322 1747 /* Determine parents */
643cb5f7 1748 reflog_msg = getenv("GIT_REFLOG_ACTION");
06bb643b 1749 if (!current_head) {
643cb5f7
CC
1750 if (!reflog_msg)
1751 reflog_msg = "commit (initial)";
f5bbc322 1752 } else if (amend) {
643cb5f7
CC
1753 if (!reflog_msg)
1754 reflog_msg = "commit (amend)";
de9f7fa3 1755 parents = copy_commit_list(current_head->parents);
37f7a857 1756 } else if (whence == FROM_MERGE) {
f285a2d7 1757 struct strbuf m = STRBUF_INIT;
f5bbc322 1758 FILE *fp;
e23fd15a 1759 int allow_fast_forward = 1;
de9f7fa3 1760 struct commit_list **pptr = &parents;
f5bbc322 1761
643cb5f7
CC
1762 if (!reflog_msg)
1763 reflog_msg = "commit (merge)";
de9f7fa3 1764 pptr = commit_list_append(current_head, pptr);
102de880 1765 fp = xfopen(git_path_merge_head(the_repository), "r");
8f309aeb 1766 while (strbuf_getline_lf(&m, fp) != EOF) {
5231c633
JH
1767 struct commit *parent;
1768
1769 parent = get_merge_parent(m.buf);
1770 if (!parent)
8a6179bc 1771 die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
de9f7fa3 1772 pptr = commit_list_append(parent, pptr);
7c3fd25d 1773 }
f5bbc322
KH
1774 fclose(fp);
1775 strbuf_release(&m);
102de880
SB
1776 if (!stat(git_path_merge_mode(the_repository), &statbuf)) {
1777 if (strbuf_read_file(&sb, git_path_merge_mode(the_repository), 0) < 0)
8a6179bc 1778 die_errno(_("could not read MERGE_MODE"));
cf10f9fd
MV
1779 if (!strcmp(sb.buf, "no-ff"))
1780 allow_fast_forward = 0;
1781 }
1782 if (allow_fast_forward)
4da72644 1783 reduce_heads_replace(&parents);
f5bbc322 1784 } else {
643cb5f7 1785 if (!reflog_msg)
8d57f757 1786 reflog_msg = is_from_cherry_pick(whence)
37f7a857 1787 ? "commit (cherry-pick)"
430b75f7
PW
1788 : is_from_rebase(whence)
1789 ? "commit (rebase)"
37f7a857 1790 : "commit";
de9f7fa3 1791 commit_list_insert(current_head, &parents);
f5bbc322 1792 }
f5bbc322 1793
ec84bd00 1794 /* Finally, get the commit message */
cf10f9fd 1795 strbuf_reset(&sb);
e51b0dfc 1796 if (strbuf_read_file(&sb, git_path_commit_editmsg(), 0) < 0) {
0721c314 1797 int saved_errno = errno;
740001a5 1798 rollback_index_files();
8a6179bc 1799 die(_("could not read commit message: %s"), strerror(saved_errno));
740001a5 1800 }
99a12694 1801
f29cd862 1802 cleanup_message(&sb, cleanup_mode, verbose);
bc17f35f 1803
d0aaa46f 1804 if (message_is_empty(&sb, cleanup_mode) && !allow_empty_message) {
b2eda9bd 1805 rollback_index_files();
bc17f35f 1806 fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
b2eda9bd
JH
1807 exit(1);
1808 }
d0aaa46f 1809 if (template_untouched(&sb, template_file, cleanup_mode) && !allow_empty_message) {
2888605c 1810 rollback_index_files();
bc17f35f 1811 fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
fdc7c811 1812 exit(1);
2888605c 1813 }
f5bbc322 1814
494d314a
CM
1815 if (fixup_message && starts_with(sb.buf, "amend! ") &&
1816 !allow_empty_message) {
1817 struct strbuf body = STRBUF_INIT;
1818 size_t len = commit_subject_length(sb.buf);
1819 strbuf_addstr(&body, sb.buf + len);
1820 if (message_is_empty(&body, cleanup_mode)) {
1821 rollback_index_files();
1822 fprintf(stderr, _("Aborting commit due to empty commit message body.\n"));
1823 exit(1);
1824 }
1825 strbuf_release(&body);
1826 }
1827
0074d18d 1828 if (amend) {
42d4e1d1 1829 const char *exclude_gpgsig[3] = { "gpgsig", "gpgsig-sha256", NULL };
c871a1d1 1830 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
0074d18d
JH
1831 } else {
1832 struct commit_extra_header **tail = &extra;
1833 append_merge_tag_headers(parents, &tail);
1834 }
ed7a42a0 1835
dc594180 1836 if (commit_tree_extended(sb.buf, sb.len, &the_index.cache_tree->oid,
e8cbe211
PW
1837 parents, &oid, author_ident.buf, NULL,
1838 sign_commit, extra)) {
2888605c 1839 rollback_index_files();
8a6179bc 1840 die(_("failed to write commit object"));
2888605c 1841 }
ed7a42a0 1842 free_commit_extra_headers(extra);
f5bbc322 1843
0505d604
PW
1844 if (update_head_with_reflog(current_head, &oid, reflog_msg, &sb,
1845 &err)) {
2888605c 1846 rollback_index_files();
c0fe1ed0 1847 die("%s", err.buf);
2888605c 1848 }
f5bbc322 1849
f496b064 1850 sequencer_post_commit_cleanup(the_repository, 0);
102de880
SB
1851 unlink(git_path_merge_head(the_repository));
1852 unlink(git_path_merge_msg(the_repository));
1853 unlink(git_path_merge_mode(the_repository));
1854 unlink(git_path_squash_msg(the_repository));
f5bbc322 1855
5a9dd399 1856 if (commit_index_files())
1a07e59c 1857 die(_("repository has been updated, but unable to write\n"
a060705d 1858 "new index file. Check that disk is not full and quota is\n"
80f537f7 1859 "not exceeded, and then \"git restore --staged :/\" to recover."));
f5bbc322 1860
b23ea979 1861 git_test_write_commit_graph_or_die();
859fdc0c 1862
35843b11 1863 repo_rerere(the_repository, 0);
a95ce124 1864 run_auto_maintenance(quiet);
a8cc5943
ÆAB
1865 run_commit_hook(use_editor, get_index_file(), NULL, "post-commit",
1866 NULL);
6f6bee3b 1867 if (amend && !no_post_rewrite) {
1d18d758 1868 commit_post_rewrite(the_repository, current_head, &oid);
6f6bee3b 1869 }
e47c6caf
PW
1870 if (!quiet) {
1871 unsigned int flags = 0;
1872
1873 if (!current_head)
1874 flags |= SUMMARY_INITIAL_COMMIT;
1875 if (author_date_is_interesting())
1876 flags |= SUMMARY_SHOW_AUTHOR_DATE;
f11c9580
NTND
1877 print_commit_summary(the_repository, prefix,
1878 &oid, flags);
6f6bee3b 1879 }
f5bbc322 1880
3f921c75 1881 apply_autostash_ref(the_repository, "MERGE_AUTOSTASH");
a03b5553 1882
00d8c311 1883cleanup:
ac95f5d3
ÆAB
1884 strbuf_release(&author_ident);
1885 strbuf_release(&err);
1886 strbuf_release(&sb);
00d8c311 1887 return ret;
f5bbc322 1888}