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