commit.c 47.6 KB
Newer Older
K
Kristian Høgsberg 已提交
1 2 3 4 5 6 7 8 9
/*
 * Builtin "git commit"
 *
 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
 */

#include "cache.h"
#include "cache-tree.h"
10
#include "color.h"
11
#include "dir.h"
K
Kristian Høgsberg 已提交
12 13 14 15 16 17 18 19 20 21 22 23
#include "builtin.h"
#include "diff.h"
#include "diffcore.h"
#include "commit.h"
#include "revision.h"
#include "wt-status.h"
#include "run-command.h"
#include "refs.h"
#include "log-tree.h"
#include "strbuf.h"
#include "utf8.h"
#include "parse-options.h"
24
#include "string-list.h"
25
#include "rerere.h"
26
#include "unpack-trees.h"
27
#include "quote.h"
28
#include "submodule.h"
J
Junio C Hamano 已提交
29
#include "gpg-interface.h"
N
Nguyễn Thái Ngọc Duy 已提交
30
#include "column.h"
31
#include "sequencer.h"
32
#include "notes-utils.h"
K
Kristian Høgsberg 已提交
33 34

static const char * const builtin_commit_usage[] = {
35
	N_("git commit [options] [--] <pathspec>..."),
K
Kristian Høgsberg 已提交
36 37 38
	NULL
};

39
static const char * const builtin_status_usage[] = {
40
	N_("git status [options] [--] <pathspec>..."),
41 42 43
	NULL
};

44
static const char implicit_ident_advice[] =
45
N_("Your name and email address were configured automatically based\n"
46 47 48
"on your username and hostname. Please check that they are accurate.\n"
"You can suppress this message by setting them explicitly:\n"
"\n"
49
"    git config --global user.name \"Your Name\"\n"
50 51
"    git config --global user.email you@example.com\n"
"\n"
52
"After doing this, you may fix the identity used for this commit with:\n"
53
"\n"
54
"    git commit --amend --reset-author\n");
55

J
Jeff King 已提交
56
static const char empty_amend_advice[] =
57
N_("You asked to amend the most recent commit, but doing so would make\n"
J
Jeff King 已提交
58
"it empty. You can repeat your command with --allow-empty, or you can\n"
59
"remove the commit entirely with \"git reset HEAD^\".\n");
J
Jeff King 已提交
60

61
static const char empty_cherry_pick_advice[] =
J
Junio C Hamano 已提交
62
N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
63 64 65
"If you wish to commit it anyway, use:\n"
"\n"
"    git commit --allow-empty\n"
66 67 68 69 70 71 72
"\n");

static const char empty_cherry_pick_advice_single[] =
N_("Otherwise, please use 'git reset'\n");

static const char empty_cherry_pick_advice_multi[] =
N_("If you wish to skip this commit, use:\n"
73
"\n"
74 75 76 77
"    git reset\n"
"\n"
"Then \"git cherry-pick --continue\" will resume cherry-picking\n"
"the remaining commits.\n");
78 79

static const char *use_message_buffer;
K
Kristian Høgsberg 已提交
80
static const char commit_editmsg[] = "COMMIT_EDITMSG";
81 82 83 84 85
static struct lock_file index_lock; /* real index */
static struct lock_file false_lock; /* used only for partial commits */
static enum {
	COMMIT_AS_IS = 1,
	COMMIT_NORMAL,
86
	COMMIT_PARTIAL
87
} commit_style;
K
Kristian Høgsberg 已提交
88

89
static const char *logfile, *force_author;
90
static const char *template_file;
91 92 93 94 95
/*
 * The _message variables are commit names from which to take
 * the commit message and/or authorship.
 */
static const char *author_message, *author_message_buffer;
K
Kristian Høgsberg 已提交
96
static char *edit_message, *use_message;
97
static char *fixup_message, *squash_message;
J
Junio C Hamano 已提交
98 99
static int all, also, interactive, patch_interactive, only, amend, signoff;
static int edit_flag = -1; /* unspecified */
100
static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
101
static int no_post_rewrite, allow_empty_message;
102
static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
J
Junio C Hamano 已提交
103 104
static char *sign_commit;

105 106 107 108 109 110 111 112 113 114
/*
 * The default commit message cleanup mode will remove the lines
 * beginning with # (shell comments) and leading and trailing
 * whitespaces (empty lines or containing only whitespaces)
 * if editor is used, and only the whitespaces if the message
 * is specified explicitly.
 */
static enum {
	CLEANUP_SPACE,
	CLEANUP_NONE,
115
	CLEANUP_ALL
116
} cleanup_mode;
117
static const char *cleanup_arg;
K
Kristian Høgsberg 已提交
118

119
static enum commit_whence whence;
120
static int sequencer_in_use;
121
static int use_editor = 1, include_status = 1;
122
static int show_ignored_in_status, have_option_m;
123
static const char *only_include_assumed;
124
static struct strbuf message = STRBUF_INIT;
125

126
static enum status_format {
127
	STATUS_FORMAT_NONE = 0,
128 129
	STATUS_FORMAT_LONG,
	STATUS_FORMAT_SHORT,
130 131 132 133
	STATUS_FORMAT_PORCELAIN,

	STATUS_FORMAT_UNSPECIFIED
} status_format = STATUS_FORMAT_UNSPECIFIED;
134

135 136 137
static int opt_parse_m(const struct option *opt, const char *arg, int unset)
{
	struct strbuf *buf = opt->value;
138 139
	if (unset) {
		have_option_m = 0;
140
		strbuf_setlen(buf, 0);
141 142
	} else {
		have_option_m = 1;
143 144
		if (buf->len)
			strbuf_addch(buf, '\n');
145
		strbuf_addstr(buf, arg);
146
		strbuf_complete_line(buf);
147 148 149
	}
	return 0;
}
K
Kristian Høgsberg 已提交
150

151 152 153 154
static void determine_whence(struct wt_status *s)
{
	if (file_exists(git_path("MERGE_HEAD")))
		whence = FROM_MERGE;
155
	else if (file_exists(git_path("CHERRY_PICK_HEAD"))) {
156
		whence = FROM_CHERRY_PICK;
157 158 159
		if (file_exists(git_path("sequencer")))
			sequencer_in_use = 1;
	}
160 161 162 163 164 165
	else
		whence = FROM_COMMIT;
	if (s)
		s->whence = whence;
}

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
static void rollback_index_files(void)
{
	switch (commit_style) {
	case COMMIT_AS_IS:
		break; /* nothing to do */
	case COMMIT_NORMAL:
		rollback_lock_file(&index_lock);
		break;
	case COMMIT_PARTIAL:
		rollback_lock_file(&index_lock);
		rollback_lock_file(&false_lock);
		break;
	}
}

181
static int commit_index_files(void)
182
{
183 184
	int err = 0;

185 186 187 188
	switch (commit_style) {
	case COMMIT_AS_IS:
		break; /* nothing to do */
	case COMMIT_NORMAL:
189
		err = commit_lock_file(&index_lock);
190 191
		break;
	case COMMIT_PARTIAL:
192
		err = commit_lock_file(&index_lock);
193 194 195
		rollback_lock_file(&false_lock);
		break;
	}
196 197

	return err;
198 199 200 201 202 203
}

/*
 * Take a union of paths in the index and the named tree (typically, "HEAD"),
 * and return the paths that match the given pattern in list.
 */
204
static int list_paths(struct string_list *list, const char *with_tree,
205 206 207 208 209
		      const char *prefix, const char **pattern)
{
	int i;
	char *m;

210 211 212
	if (!pattern)
		return 0;

213 214 215 216
	for (i = 0; pattern[i]; i++)
		;
	m = xcalloc(1, i);

217
	if (with_tree) {
218
		char *max_prefix = common_prefix(pattern);
219 220
		overlay_tree_on_cache(with_tree, max_prefix ? max_prefix : prefix);
		free(max_prefix);
221
	}
222 223

	for (i = 0; i < active_nr; i++) {
224
		const struct cache_entry *ce = active_cache[i];
225 226
		struct string_list_item *item;

227
		if (ce->ce_flags & CE_UPDATE)
228
			continue;
229
		if (!match_pathspec(pattern, ce->name, ce_namelen(ce), 0, m))
230
			continue;
231
		item = string_list_insert(list, ce->name);
232 233
		if (ce_skip_worktree(ce))
			item->util = item; /* better a valid pointer than a fake one */
234 235
	}

236
	return report_path_error(m, pattern, prefix);
237 238
}

239
static void add_remove_files(struct string_list *list)
240 241 242
{
	int i;
	for (i = 0; i < list->nr; i++) {
243
		struct stat st;
244
		struct string_list_item *p = &(list->items[i]);
245

246 247
		/* p->util is skip-worktree */
		if (p->util)
248
			continue;
249

250 251
		if (!lstat(p->string, &st)) {
			if (add_to_cache(p->string, &st, 0))
252
				die(_("updating files failed"));
253
		} else
254
			remove_file_from_cache(p->string);
255 256 257
	}
}

258
static void create_base_index(const struct commit *current_head)
259 260 261 262 263
{
	struct tree *tree;
	struct unpack_trees_options opts;
	struct tree_desc t;

264
	if (!current_head) {
265 266 267 268 269 270 271 272
		discard_cache();
		return;
	}

	memset(&opts, 0, sizeof(opts));
	opts.head_idx = 1;
	opts.index_only = 1;
	opts.merge = 1;
273 274
	opts.src_index = &the_index;
	opts.dst_index = &the_index;
275 276

	opts.fn = oneway_merge;
277
	tree = parse_tree_indirect(current_head->object.sha1);
278
	if (!tree)
279
		die(_("failed to unpack HEAD tree object"));
280 281
	parse_tree(tree);
	init_tree_desc(&t, tree->buffer, tree->size);
282 283
	if (unpack_trees(1, &t, &opts))
		exit(128); /* We've already reported the error, finish dying */
284 285
}

286 287 288 289 290 291 292 293 294 295
static void refresh_cache_or_die(int refresh_flags)
{
	/*
	 * refresh_flags contains REFRESH_QUIET, so the only errors
	 * are for unmerged entries.
	 */
	if (refresh_cache(refresh_flags | REFRESH_IN_PORCELAIN))
		die_resolve_conflict("commit");
}

296 297
static char *prepare_index(int argc, const char **argv, const char *prefix,
			   const struct commit *current_head, int is_status)
K
Kristian Høgsberg 已提交
298 299
{
	int fd;
300
	struct string_list partial;
301
	const char **pathspec = NULL;
302
	char *old_index_env = NULL;
303
	int refresh_flags = REFRESH_QUIET;
K
Kristian Høgsberg 已提交
304

305 306
	if (is_status)
		refresh_flags |= REFRESH_UNMERGED;
K
Kristian Høgsberg 已提交
307

308 309
	if (*argv)
		pathspec = get_pathspec(prefix, argv);
310

L
Linus Torvalds 已提交
311
	if (read_cache_preload(pathspec) < 0)
312
		die(_("index file corrupt"));
L
Linus Torvalds 已提交
313

314 315 316 317 318 319 320 321 322 323 324 325
	if (interactive) {
		fd = hold_locked_index(&index_lock, 1);

		refresh_cache_or_die(refresh_flags);

		if (write_cache(fd, active_cache, active_nr) ||
		    close_lock_file(&index_lock))
			die(_("unable to create temporary index"));

		old_index_env = getenv(INDEX_ENVIRONMENT);
		setenv(INDEX_ENVIRONMENT, index_lock.filename, 1);

326
		if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
327 328 329 330 331 332 333 334 335 336 337 338 339 340
			die(_("interactive add failed"));

		if (old_index_env && *old_index_env)
			setenv(INDEX_ENVIRONMENT, old_index_env, 1);
		else
			unsetenv(INDEX_ENVIRONMENT);

		discard_cache();
		read_cache_from(index_lock.filename);

		commit_style = COMMIT_NORMAL;
		return index_lock.filename;
	}

341 342 343 344 345 346 347 348 349 350 351 352 353
	/*
	 * Non partial, non as-is commit.
	 *
	 * (1) get the real index;
	 * (2) update the_index as necessary;
	 * (3) write the_index out to the real index (still locked);
	 * (4) return the name of the locked index file.
	 *
	 * The caller should run hooks on the locked real index, and
	 * (A) if all goes well, commit the real index;
	 * (B) on failure, rollback the real index.
	 */
	if (all || (also && pathspec && *pathspec)) {
354
		fd = hold_locked_index(&index_lock, 1);
355
		add_files_to_cache(also ? prefix : NULL, pathspec, 0);
356
		refresh_cache_or_die(refresh_flags);
357
		update_main_cache_tree(WRITE_TREE_SILENT);
B
Brandon Casey 已提交
358 359
		if (write_cache(fd, active_cache, active_nr) ||
		    close_lock_file(&index_lock))
360
			die(_("unable to write new_index file"));
361 362
		commit_style = COMMIT_NORMAL;
		return index_lock.filename;
K
Kristian Høgsberg 已提交
363 364
	}

365 366 367 368 369
	/*
	 * As-is commit.
	 *
	 * (1) return the name of the real index file.
	 *
370 371
	 * The caller should run hooks on the real index,
	 * and create commit from the_index.
372 373
	 * We still need to refresh the index here.
	 */
374
	if (!only && (!pathspec || !*pathspec)) {
375
		fd = hold_locked_index(&index_lock, 1);
376
		refresh_cache_or_die(refresh_flags);
377
		if (active_cache_changed) {
378
			update_main_cache_tree(WRITE_TREE_SILENT);
379 380
			if (write_cache(fd, active_cache, active_nr) ||
			    commit_locked_index(&index_lock))
381
				die(_("unable to write new_index file"));
382 383 384
		} else {
			rollback_lock_file(&index_lock);
		}
385
		commit_style = COMMIT_AS_IS;
K
Kristian Høgsberg 已提交
386 387 388
		return get_index_file();
	}

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
	/*
	 * A partial commit.
	 *
	 * (0) find the set of affected paths;
	 * (1) get lock on the real index file;
	 * (2) update the_index with the given paths;
	 * (3) write the_index out to the real index (still locked);
	 * (4) get lock on the false index file;
	 * (5) reset the_index from HEAD;
	 * (6) update the_index the same way as (2);
	 * (7) write the_index out to the false index file;
	 * (8) return the name of the false index file (still locked);
	 *
	 * The caller should run hooks on the locked false index, and
	 * create commit from it.  Then
	 * (A) if all goes well, commit the real index;
	 * (B) on failure, rollback the real index;
	 * In either case, rollback the false index.
	 */
	commit_style = COMMIT_PARTIAL;

410 411 412 413 414 415
	if (whence != FROM_COMMIT) {
		if (whence == FROM_MERGE)
			die(_("cannot do a partial commit during a merge."));
		else if (whence == FROM_CHERRY_PICK)
			die(_("cannot do a partial commit during a cherry-pick."));
	}
416 417

	memset(&partial, 0, sizeof(partial));
418
	partial.strdup_strings = 1;
419
	if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, pathspec))
420 421 422 423
		exit(1);

	discard_cache();
	if (read_cache() < 0)
424
		die(_("cannot read the index"));
425 426 427

	fd = hold_locked_index(&index_lock, 1);
	add_remove_files(&partial);
428
	refresh_cache(REFRESH_QUIET);
B
Brandon Casey 已提交
429 430
	if (write_cache(fd, active_cache, active_nr) ||
	    close_lock_file(&index_lock))
431
		die(_("unable to write new_index file"));
K
Kristian Høgsberg 已提交
432

433
	fd = hold_lock_file_for_update(&false_lock,
J
Junio C Hamano 已提交
434 435
				       git_path("next-index-%"PRIuMAX,
						(uintmax_t) getpid()),
436
				       LOCK_DIE_ON_ERROR);
437

438
	create_base_index(current_head);
439
	add_remove_files(&partial);
440
	refresh_cache(REFRESH_QUIET);
K
Kristian Høgsberg 已提交
441

B
Brandon Casey 已提交
442 443
	if (write_cache(fd, active_cache, active_nr) ||
	    close_lock_file(&false_lock))
444
		die(_("unable to write temporary index file"));
445 446 447 448

	discard_cache();
	read_cache_from(false_lock.filename);

449
	return false_lock.filename;
K
Kristian Høgsberg 已提交
450 451
}

452 453
static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
		      struct wt_status *s)
K
Kristian Høgsberg 已提交
454
{
455 456
	unsigned char sha1[20];

457 458
	if (s->relative_paths)
		s->prefix = prefix;
K
Kristian Høgsberg 已提交
459 460

	if (amend) {
461 462
		s->amend = 1;
		s->reference = "HEAD^1";
K
Kristian Høgsberg 已提交
463
	}
464 465 466 467
	s->verbose = verbose;
	s->index_file = index_file;
	s->fp = fp;
	s->nowarn = nowarn;
468
	s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
K
Kristian Høgsberg 已提交
469

470
	wt_status_collect(s);
471 472 473

	switch (status_format) {
	case STATUS_FORMAT_SHORT:
474
		wt_shortstatus_print(s);
475 476
		break;
	case STATUS_FORMAT_PORCELAIN:
477
		wt_porcelain_print(s);
478
		break;
479 480 481
	case STATUS_FORMAT_UNSPECIFIED:
		die("BUG: finalize_deferred_config() should have been called");
		break;
482
	case STATUS_FORMAT_NONE:
483 484 485 486
	case STATUS_FORMAT_LONG:
		wt_status_print(s);
		break;
	}
K
Kristian Høgsberg 已提交
487

488
	return s->commitable;
K
Kristian Høgsberg 已提交
489 490
}

491
static int is_a_merge(const struct commit *current_head)
492
{
493
	return !!(current_head->parents && current_head->parents->next);
494 495
}

496 497 498 499 500 501 502 503 504 505
static void export_one(const char *var, const char *s, const char *e, int hack)
{
	struct strbuf buf = STRBUF_INIT;
	if (hack)
		strbuf_addch(&buf, hack);
	strbuf_addf(&buf, "%.*s", (int)(e - s), s);
	setenv(var, buf.buf, 1);
	strbuf_release(&buf);
}

506 507 508 509 510 511 512 513 514 515 516 517 518 519
static int sane_ident_split(struct ident_split *person)
{
	if (!person->name_begin || !person->name_end ||
	    person->name_begin == person->name_end)
		return 0; /* no human readable name */
	if (!person->mail_begin || !person->mail_end ||
	    person->mail_begin == person->mail_end)
		return 0; /* no usable mail */
	if (!person->date_begin || !person->date_end ||
	    !person->tz_begin || !person->tz_end)
		return 0;
	return 1;
}

520
static void determine_author_info(struct strbuf *author_ident)
521 522
{
	char *name, *email, *date;
523
	struct ident_split author;
524 525 526 527 528

	name = getenv("GIT_AUTHOR_NAME");
	email = getenv("GIT_AUTHOR_EMAIL");
	date = getenv("GIT_AUTHOR_DATE");

529
	if (author_message) {
530
		const char *a, *lb, *rb, *eol;
531
		size_t len;
532

533
		a = strstr(author_message_buffer, "\nauthor ");
534
		if (!a)
J
Junio C Hamano 已提交
535
			die(_("invalid commit: %s"), author_message);
536

537 538 539 540
		lb = strchrnul(a + strlen("\nauthor "), '<');
		rb = strchrnul(lb, '>');
		eol = strchrnul(rb, '\n');
		if (!*lb || !*rb || !*eol)
J
Junio C Hamano 已提交
541
			die(_("invalid commit: %s"), author_message);
542

543 544 545 546 547 548 549 550
		if (lb == a + strlen("\nauthor "))
			/* \nauthor <foo@example.com> */
			name = xcalloc(1, 1);
		else
			name = xmemdupz(a + strlen("\nauthor "),
					(lb - strlen(" ") -
					 (a + strlen("\nauthor "))));
		email = xmemdupz(lb + strlen("<"), rb - (lb + strlen("<")));
551 552 553 554 555
		len = eol - (rb + strlen("> "));
		date = xmalloc(len + 2);
		*date = '@';
		memcpy(date + 1, rb + strlen("> "), len);
		date[len + 1] = '\0';
556 557 558 559 560 561 562
	}

	if (force_author) {
		const char *lb = strstr(force_author, " <");
		const char *rb = strchr(force_author, '>');

		if (!lb || !rb)
563
			die(_("malformed --author parameter"));
564 565 566 567
		name = xstrndup(force_author, lb - force_author);
		email = xstrndup(lb + 2, rb - (lb + 2));
	}

M
Miklos Vajna 已提交
568 569
	if (force_date)
		date = force_date;
570
	strbuf_addstr(author_ident, fmt_ident(name, email, date, IDENT_STRICT));
571 572
	if (!split_ident_line(&author, author_ident->buf, author_ident->len) &&
	    sane_ident_split(&author)) {
573 574 575 576
		export_one("GIT_AUTHOR_NAME", author.name_begin, author.name_end, 0);
		export_one("GIT_AUTHOR_EMAIL", author.mail_begin, author.mail_end, 0);
		export_one("GIT_AUTHOR_DATE", author.date_begin, author.tz_end, '@');
	}
577 578
}

579 580 581 582
static char *cut_ident_timestamp_part(char *string)
{
	char *ket = strrchr(string, '>');
	if (!ket || ket[1] != ' ')
583
		die(_("Malformed ident string: '%s'"), string);
584 585 586 587
	*++ket = '\0';
	return ket;
}

588
static int prepare_to_commit(const char *index_file, const char *prefix,
589
			     struct commit *current_head,
590 591
			     struct wt_status *s,
			     struct strbuf *author_ident)
K
Kristian Høgsberg 已提交
592 593
{
	struct stat statbuf;
594
	struct strbuf committer_ident = STRBUF_INIT;
595
	int commitable, saved_color_setting;
596
	struct strbuf sb = STRBUF_INIT;
K
Kristian Høgsberg 已提交
597
	char *buffer;
598 599
	const char *hook_arg1 = NULL;
	const char *hook_arg2 = NULL;
600
	int ident_shown = 0;
601
	int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
K
Kristian Høgsberg 已提交
602

603 604 605
	/* This checks and barfs if author is badly specified */
	determine_author_info(author_ident);

606 607
	if (!no_verify && run_hook(index_file, "pre-commit", NULL))
		return 0;
K
Kristian Høgsberg 已提交
608

609 610 611 612 613 614 615 616 617 618 619 620
	if (squash_message) {
		/*
		 * Insert the proper subject line before other commit
		 * message options add their content.
		 */
		if (use_message && !strcmp(use_message, squash_message))
			strbuf_addstr(&sb, "squash! ");
		else {
			struct pretty_print_context ctx = {0};
			struct commit *c;
			c = lookup_commit_reference_by_name(squash_message);
			if (!c)
621
				die(_("could not lookup commit %s"), squash_message);
622 623 624 625 626 627
			ctx.output_encoding = get_commit_output_encoding();
			format_commit_message(c, "squash! %s\n\n", &sb,
					      &ctx);
		}
	}

628 629
	if (message.len) {
		strbuf_addbuf(&sb, &message);
630
		hook_arg1 = "message";
K
Kristian Høgsberg 已提交
631 632
	} else if (logfile && !strcmp(logfile, "-")) {
		if (isatty(0))
633
			fprintf(stderr, _("(reading log message from standard input)\n"));
K
Kristian Høgsberg 已提交
634
		if (strbuf_read(&sb, 0, 0) < 0)
635
			die_errno(_("could not read log from standard input"));
636
		hook_arg1 = "message";
K
Kristian Høgsberg 已提交
637 638
	} else if (logfile) {
		if (strbuf_read_file(&sb, logfile, 0) < 0)
639
			die_errno(_("could not read log file '%s'"),
640
				  logfile);
641
		hook_arg1 = "message";
K
Kristian Høgsberg 已提交
642 643
	} else if (use_message) {
		buffer = strstr(use_message_buffer, "\n\n");
644
		if (!use_editor && (!buffer || buffer[2] == '\0'))
645
			die(_("commit has empty message"));
K
Kristian Høgsberg 已提交
646
		strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
647 648
		hook_arg1 = "commit";
		hook_arg2 = use_message;
649 650 651 652 653
	} else if (fixup_message) {
		struct pretty_print_context ctx = {0};
		struct commit *commit;
		commit = lookup_commit_reference_by_name(fixup_message);
		if (!commit)
654
			die(_("could not lookup commit %s"), fixup_message);
655 656 657 658
		ctx.output_encoding = get_commit_output_encoding();
		format_commit_message(commit, "fixup! %s\n\n",
				      &sb, &ctx);
		hook_arg1 = "message";
K
Kristian Høgsberg 已提交
659 660
	} else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
		if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
661
			die_errno(_("could not read MERGE_MSG"));
662
		hook_arg1 = "merge";
K
Kristian Høgsberg 已提交
663 664
	} else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
		if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
665
			die_errno(_("could not read SQUASH_MSG"));
666
		hook_arg1 = "squash";
667
	} else if (template_file) {
K
Kristian Høgsberg 已提交
668
		if (strbuf_read_file(&sb, template_file, 0) < 0)
669
			die_errno(_("could not read '%s'"), template_file);
670
		hook_arg1 = "template";
671
		clean_message_contents = 0;
K
Kristian Høgsberg 已提交
672 673
	}

674
	/*
675 676
	 * The remaining cases don't modify the template message, but
	 * just set the argument(s) to the prepare-commit-msg hook.
677
	 */
678
	else if (whence == FROM_MERGE)
679
		hook_arg1 = "merge";
680 681 682 683
	else if (whence == FROM_CHERRY_PICK) {
		hook_arg1 = "commit";
		hook_arg2 = "CHERRY_PICK_HEAD";
	}
684

685 686 687 688 689 690 691 692 693 694
	if (squash_message) {
		/*
		 * If squash_commit was used for the commit subject,
		 * then we're possibly hijacking other commit log options.
		 * Reset the hook args to tell the real story.
		 */
		hook_arg1 = "message";
		hook_arg2 = "";
	}

695 696
	s->fp = fopen(git_path(commit_editmsg), "w");
	if (s->fp == NULL)
697
		die_errno(_("could not open '%s'"), git_path(commit_editmsg));
K
Kristian Høgsberg 已提交
698

699
	if (clean_message_contents)
700
		stripspace(&sb, 0);
K
Kristian Høgsberg 已提交
701 702

	if (signoff) {
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
		/*
		 * See if we have a Conflicts: block at the end. If yes, count
		 * its size, so we can ignore it.
		 */
		int ignore_footer = 0;
		int i, eol, previous = 0;
		const char *nl;

		for (i = 0; i < sb.len; i++) {
			nl = memchr(sb.buf + i, '\n', sb.len - i);
			if (nl)
				eol = nl - sb.buf;
			else
				eol = sb.len;
			if (!prefixcmp(sb.buf + previous, "\nConflicts:\n")) {
				ignore_footer = sb.len - previous;
				break;
			}
			while (i < eol)
				i++;
			previous = eol;
724
		}
725

726
		append_signoff(&sb, ignore_footer, 0);
K
Kristian Høgsberg 已提交
727 728
	}

729
	if (fwrite(sb.buf, 1, sb.len, s->fp) < sb.len)
730
		die_errno(_("could not write commit template"));
731

K
Kristian Høgsberg 已提交
732 733
	strbuf_release(&sb);

734
	/* This checks if committer ident is explicitly given */
735
	strbuf_addstr(&committer_ident, git_committer_info(IDENT_STRICT));
736
	if (use_editor && include_status) {
737
		char *ai_tmp, *ci_tmp;
738
		if (whence != FROM_COMMIT)
739
			status_printf_ln(s, GIT_COLOR_NORMAL,
740 741 742 743 744 745 746 747 748 749 750
			    whence == FROM_MERGE
				? _("\n"
					"It looks like you may be committing a merge.\n"
					"If this is not correct, please remove the file\n"
					"	%s\n"
					"and try again.\n")
				: _("\n"
					"It looks like you may be committing a cherry-pick.\n"
					"If this is not correct, please remove the file\n"
					"	%s\n"
					"and try again.\n"),
751 752 753
				git_path(whence == FROM_MERGE
					 ? "MERGE_HEAD"
					 : "CHERRY_PICK_HEAD"));
754

755
		fprintf(s->fp, "\n");
756
		if (cleanup_mode == CLEANUP_ALL)
757 758
			status_printf(s, GIT_COLOR_NORMAL,
				_("Please enter the commit message for your changes."
J
Junio C Hamano 已提交
759 760
				  " Lines starting\nwith '%c' will be ignored, and an empty"
				  " message aborts the commit.\n"), comment_line_char);
761
		else /* CLEANUP_SPACE, that is. */
762 763
			status_printf(s, GIT_COLOR_NORMAL,
				_("Please enter the commit message for your changes."
J
Junio C Hamano 已提交
764 765 766 767
				  " Lines starting\n"
				  "with '%c' will be kept; you may remove them"
				  " yourself if you want to.\n"
				  "An empty message aborts the commit.\n"), comment_line_char);
768
		if (only_include_assumed)
769 770
			status_printf_ln(s, GIT_COLOR_NORMAL,
					"%s", only_include_assumed);
771

772 773 774
		ai_tmp = cut_ident_timestamp_part(author_ident->buf);
		ci_tmp = cut_ident_timestamp_part(committer_ident.buf);
		if (strcmp(author_ident->buf, committer_ident.buf))
775
			status_printf_ln(s, GIT_COLOR_NORMAL,
776 777
				_("%s"
				"Author:    %s"),
778
				ident_shown++ ? "" : "\n",
779
				author_ident->buf);
780

781
		if (!committer_ident_sufficiently_given())
782
			status_printf_ln(s, GIT_COLOR_NORMAL,
783 784
				_("%s"
				"Committer: %s"),
785
				ident_shown++ ? "" : "\n",
786
				committer_ident.buf);
787 788

		if (ident_shown)
789
			status_printf_ln(s, GIT_COLOR_NORMAL, "");
790

791 792
		saved_color_setting = s->use_color;
		s->use_color = 0;
793
		commitable = run_status(s->fp, index_file, prefix, 1, s);
794
		s->use_color = saved_color_setting;
795 796 797

		*ai_tmp = ' ';
		*ci_tmp = ' ';
798
	} else {
799
		unsigned char sha1[20];
800
		const char *parent = "HEAD";
801 802

		if (!active_nr && read_cache() < 0)
803
			die(_("Cannot read index"));
804

805 806 807
		if (amend)
			parent = "HEAD^1";

808
		if (get_sha1(parent, sha1))
809
			commitable = !!active_nr;
810 811
		else
			commitable = index_differs_from(parent, 0);
812
	}
813
	strbuf_release(&committer_ident);
814

815
	fclose(s->fp);
816

817 818 819 820 821 822
	/*
	 * Reject an attempt to record a non-merge empty commit without
	 * explicit --allow-empty. In the cherry-pick case, it may be
	 * empty due to conflict resolution, which the user should okay.
	 */
	if (!commitable && whence != FROM_MERGE && !allow_empty &&
823
	    !(amend && is_a_merge(current_head))) {
824
		run_status(stdout, index_file, prefix, 0, s);
J
Jeff King 已提交
825
		if (amend)
826
			fputs(_(empty_amend_advice), stderr);
827
		else if (whence == FROM_CHERRY_PICK) {
J
Junio C Hamano 已提交
828
			fputs(_(empty_cherry_pick_advice), stderr);
829 830 831 832 833
			if (!sequencer_in_use)
				fputs(_(empty_cherry_pick_advice_single), stderr);
			else
				fputs(_(empty_cherry_pick_advice_multi), stderr);
		}
834
		return 0;
835 836
	}

837 838 839 840 841 842 843
	/*
	 * Re-read the index as pre-commit hook could have updated it,
	 * and write it out as a tree.  We must do this before we invoke
	 * the editor and after we invoke run_status above.
	 */
	discard_cache();
	read_cache_from(index_file);
844
	if (update_main_cache_tree(0)) {
845
		error(_("Error building trees"));
846
		return 0;
847
	}
K
Kristian Høgsberg 已提交
848

849 850 851
	if (run_hook(index_file, "prepare-commit-msg",
		     git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
		return 0;
K
Kristian Høgsberg 已提交
852

853 854
	if (use_editor) {
		char index[PATH_MAX];
855 856
		const char *env[2] = { NULL };
		env[0] =  index;
857
		snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
S
Stephan Beyer 已提交
858 859
		if (launch_editor(git_path(commit_editmsg), NULL, env)) {
			fprintf(stderr,
860
			_("Please supply the message using either -m or -F option.\n"));
S
Stephan Beyer 已提交
861 862
			exit(1);
		}
863
	}
K
Kristian Høgsberg 已提交
864

865 866 867 868
	if (!no_verify &&
	    run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
		return 0;
	}
K
Kristian Høgsberg 已提交
869

870
	return 1;
K
Kristian Høgsberg 已提交
871 872
}

873
static int rest_is_empty(struct strbuf *sb, int start)
K
Kristian Høgsberg 已提交
874
{
875
	int i, eol;
K
Kristian Høgsberg 已提交
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
	const char *nl;

	/* Check if the rest is just whitespace and Signed-of-by's. */
	for (i = start; i < sb->len; i++) {
		nl = memchr(sb->buf + i, '\n', sb->len - i);
		if (nl)
			eol = nl - sb->buf;
		else
			eol = sb->len;

		if (strlen(sign_off_header) <= eol - i &&
		    !prefixcmp(sb->buf + i, sign_off_header)) {
			i = eol;
			continue;
		}
		while (i < eol)
			if (!isspace(sb->buf[i++]))
				return 0;
	}

	return 1;
}

899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
/*
 * Find out if the message in the strbuf contains only whitespace and
 * Signed-off-by lines.
 */
static int message_is_empty(struct strbuf *sb)
{
	if (cleanup_mode == CLEANUP_NONE && sb->len)
		return 0;
	return rest_is_empty(sb, 0);
}

/*
 * See if the user edited the message in the editor or left what
 * was in the template intact
 */
static int template_untouched(struct strbuf *sb)
{
	struct strbuf tmpl = STRBUF_INIT;
	char *start;

	if (cleanup_mode == CLEANUP_NONE && sb->len)
		return 0;

	if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
		return 0;

	stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
	start = (char *)skip_prefix(sb->buf, tmpl.buf);
	if (!start)
		start = sb->buf;
	strbuf_release(&tmpl);
	return rest_is_empty(sb, start - sb->buf);
}

933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
static const char *find_author_by_nickname(const char *name)
{
	struct rev_info revs;
	struct commit *commit;
	struct strbuf buf = STRBUF_INIT;
	const char *av[20];
	int ac = 0;

	init_revisions(&revs, NULL);
	strbuf_addf(&buf, "--author=%s", name);
	av[++ac] = "--all";
	av[++ac] = "-i";
	av[++ac] = buf.buf;
	av[++ac] = NULL;
	setup_revisions(ac, av, &revs, NULL);
	prepare_revision_walk(&revs);
	commit = get_revision(&revs);
	if (commit) {
951 952
		struct pretty_print_context ctx = {0};
		ctx.date_mode = DATE_NORMAL;
953
		strbuf_release(&buf);
954
		format_commit_message(commit, "%an <%ae>", &buf, &ctx);
955 956
		return strbuf_detach(&buf, NULL);
	}
957
	die(_("No existing author found with '%s'"), name);
958 959
}

960 961 962 963 964 965 966 967 968 969 970 971

static void handle_untracked_files_arg(struct wt_status *s)
{
	if (!untracked_files_arg)
		; /* default already initialized */
	else if (!strcmp(untracked_files_arg, "no"))
		s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
	else if (!strcmp(untracked_files_arg, "normal"))
		s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
	else if (!strcmp(untracked_files_arg, "all"))
		s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
	else
972
		die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
973 974
}

975 976
static const char *read_commit_message(const char *name)
{
J
Jeff King 已提交
977
	const char *out_enc;
978 979 980 981
	struct commit *commit;

	commit = lookup_commit_reference_by_name(name);
	if (!commit)
J
Junio C Hamano 已提交
982
		die(_("could not lookup commit %s"), name);
983
	out_enc = get_commit_output_encoding();
984
	return logmsg_reencode(commit, NULL, out_enc);
985 986
}

987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
/*
 * Enumerate what needs to be propagated when --porcelain
 * is not in effect here.
 */
static struct status_deferred_config {
	enum status_format status_format;
	int show_branch;
} status_deferred_config = {
	STATUS_FORMAT_UNSPECIFIED,
	-1 /* unspecified */
};

static void finalize_deferred_config(struct wt_status *s)
{
	int use_deferred_config = (status_format != STATUS_FORMAT_PORCELAIN &&
				   !s->null_termination);

	if (s->null_termination) {
		if (status_format == STATUS_FORMAT_NONE ||
		    status_format == STATUS_FORMAT_UNSPECIFIED)
			status_format = STATUS_FORMAT_PORCELAIN;
		else if (status_format == STATUS_FORMAT_LONG)
			die(_("--long and -z are incompatible"));
	}

	if (use_deferred_config && status_format == STATUS_FORMAT_UNSPECIFIED)
		status_format = status_deferred_config.status_format;
	if (status_format == STATUS_FORMAT_UNSPECIFIED)
		status_format = STATUS_FORMAT_NONE;

	if (use_deferred_config && s->show_branch < 0)
		s->show_branch = status_deferred_config.show_branch;
	if (s->show_branch < 0)
		s->show_branch = 0;
}

1023
static int parse_and_validate_options(int argc, const char *argv[],
J
Jeff King 已提交
1024
				      const struct option *options,
1025
				      const char * const usage[],
1026
				      const char *prefix,
1027
				      struct commit *current_head,
1028
				      struct wt_status *s)
K
Kristian Høgsberg 已提交
1029 1030 1031
{
	int f = 0;

J
Jeff King 已提交
1032
	argc = parse_options(argc, argv, prefix, options, usage, 0);
1033
	finalize_deferred_config(s);
K
Kristian Høgsberg 已提交
1034

1035 1036 1037
	if (force_author && !strchr(force_author, '>'))
		force_author = find_author_by_nickname(force_author);

1038
	if (force_author && renew_authorship)
1039
		die(_("Using both --reset-author and --author does not make sense"));
1040

1041
	if (logfile || have_option_m || use_message || fixup_message)
1042
		use_editor = 0;
J
Junio C Hamano 已提交
1043 1044
	if (0 <= edit_flag)
		use_editor = edit_flag;
1045 1046
	if (!use_editor)
		setenv("GIT_EDITOR", ":", 1);
K
Kristian Høgsberg 已提交
1047 1048

	/* Sanity check options */
1049
	if (amend && !current_head)
1050
		die(_("You have nothing to amend."));
1051 1052 1053 1054 1055 1056
	if (amend && whence != FROM_COMMIT) {
		if (whence == FROM_MERGE)
			die(_("You are in the middle of a merge -- cannot amend."));
		else if (whence == FROM_CHERRY_PICK)
			die(_("You are in the middle of a cherry-pick -- cannot amend."));
	}
1057
	if (fixup_message && squash_message)
1058
		die(_("Options --squash and --fixup cannot be used together"));
K
Kristian Høgsberg 已提交
1059 1060 1061 1062
	if (use_message)
		f++;
	if (edit_message)
		f++;
1063 1064
	if (fixup_message)
		f++;
K
Kristian Høgsberg 已提交
1065 1066 1067
	if (logfile)
		f++;
	if (f > 1)
1068
		die(_("Only one of -c/-C/-F/--fixup can be used."));
1069
	if (message.len && f > 0)
1070
		die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));
1071 1072
	if (f || message.len)
		template_file = NULL;
K
Kristian Høgsberg 已提交
1073 1074
	if (edit_message)
		use_message = edit_message;
1075
	if (amend && !use_message && !fixup_message)
K
Kristian Høgsberg 已提交
1076
		use_message = "HEAD";
1077
	if (!use_message && whence != FROM_CHERRY_PICK && renew_authorship)
1078
		die(_("--reset-author can be used only with -C, -c or --amend."));
K
Kristian Høgsberg 已提交
1079
	if (use_message) {
1080 1081 1082 1083 1084 1085 1086 1087 1088
		use_message_buffer = read_commit_message(use_message);
		if (!renew_authorship) {
			author_message = use_message;
			author_message_buffer = use_message_buffer;
		}
	}
	if (whence == FROM_CHERRY_PICK && !renew_authorship) {
		author_message = "CHERRY_PICK_HEAD";
		author_message_buffer = read_commit_message(author_message);
K
Kristian Høgsberg 已提交
1089 1090
	}

1091 1092 1093
	if (patch_interactive)
		interactive = 1;

K
Kristian Høgsberg 已提交
1094
	if (!!also + !!only + !!all + !!interactive > 1)
1095
		die(_("Only one of --include/--only/--all/--interactive/--patch can be used."));
K
Kristian Høgsberg 已提交
1096
	if (argc == 0 && (also || (only && !amend)))
1097
		die(_("No paths with --include/--only does not make sense."));
K
Kristian Høgsberg 已提交
1098
	if (argc == 0 && only && amend)
1099
		only_include_assumed = _("Clever... amending the last one with dirty index.");
1100
	if (argc > 0 && !also && !only)
1101
		only_include_assumed = _("Explicit paths specified without -i nor -o; assuming --only paths...");
1102 1103 1104 1105 1106 1107 1108 1109 1110
	if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
		cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
	else if (!strcmp(cleanup_arg, "verbatim"))
		cleanup_mode = CLEANUP_NONE;
	else if (!strcmp(cleanup_arg, "whitespace"))
		cleanup_mode = CLEANUP_SPACE;
	else if (!strcmp(cleanup_arg, "strip"))
		cleanup_mode = CLEANUP_ALL;
	else
1111
		die(_("Invalid cleanup mode %s"), cleanup_arg);
K
Kristian Høgsberg 已提交
1112

1113
	handle_untracked_files_arg(s);
1114

K
Kristian Høgsberg 已提交
1115
	if (all && argc > 0)
1116
		die(_("Paths with -a does not make sense."));
K
Kristian Høgsberg 已提交
1117

1118
	if (status_format != STATUS_FORMAT_NONE)
1119 1120
		dry_run = 1;

K
Kristian Høgsberg 已提交
1121 1122 1123
	return argc;
}

1124
static int dry_run_commit(int argc, const char **argv, const char *prefix,
1125
			  const struct commit *current_head, struct wt_status *s)
K
Kristian Høgsberg 已提交
1126 1127
{
	int commitable;
J
Junio C Hamano 已提交
1128
	const char *index_file;
K
Kristian Høgsberg 已提交
1129

1130
	index_file = prepare_index(argc, argv, prefix, current_head, 1);
1131
	commitable = run_status(stdout, index_file, prefix, 0, s);
J
Junio C Hamano 已提交
1132
	rollback_index_files();
K
Kristian Høgsberg 已提交
1133

J
Junio C Hamano 已提交
1134 1135 1136
	return commitable ? 0 : 1;
}

1137 1138 1139 1140
static int parse_status_slot(const char *var, int offset)
{
	if (!strcasecmp(var+offset, "header"))
		return WT_STATUS_HEADER;
1141 1142
	if (!strcasecmp(var+offset, "branch"))
		return WT_STATUS_ONBRANCH;
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
	if (!strcasecmp(var+offset, "updated")
		|| !strcasecmp(var+offset, "added"))
		return WT_STATUS_UPDATED;
	if (!strcasecmp(var+offset, "changed"))
		return WT_STATUS_CHANGED;
	if (!strcasecmp(var+offset, "untracked"))
		return WT_STATUS_UNTRACKED;
	if (!strcasecmp(var+offset, "nobranch"))
		return WT_STATUS_NOBRANCH;
	if (!strcasecmp(var+offset, "unmerged"))
		return WT_STATUS_UNMERGED;
J
Jeff King 已提交
1154
	return -1;
1155 1156 1157 1158 1159 1160
}

static int git_status_config(const char *k, const char *v, void *cb)
{
	struct wt_status *s = cb;

N
Nguyễn Thái Ngọc Duy 已提交
1161
	if (!prefixcmp(k, "column."))
J
Jeff King 已提交
1162
		return git_column_config(k, v, "status", &s->colopts);
1163 1164 1165 1166 1167 1168 1169
	if (!strcmp(k, "status.submodulesummary")) {
		int is_bool;
		s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
		if (is_bool && s->submodule_summary)
			s->submodule_summary = -1;
		return 0;
	}
1170 1171
	if (!strcmp(k, "status.short")) {
		if (git_config_bool(k, v))
1172
			status_deferred_config.status_format = STATUS_FORMAT_SHORT;
1173
		else
1174
			status_deferred_config.status_format = STATUS_FORMAT_NONE;
1175 1176
		return 0;
	}
1177
	if (!strcmp(k, "status.branch")) {
1178
		status_deferred_config.show_branch = git_config_bool(k, v);
1179 1180
		return 0;
	}
1181
	if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
1182
		s->use_color = git_config_colorbool(k, v);
1183 1184 1185 1186
		return 0;
	}
	if (!prefixcmp(k, "status.color.") || !prefixcmp(k, "color.status.")) {
		int slot = parse_status_slot(k, 13);
J
Jeff King 已提交
1187 1188
		if (slot < 0)
			return 0;
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
		if (!v)
			return config_error_nonbool(k);
		color_parse(v, k, s->color_palette[slot]);
		return 0;
	}
	if (!strcmp(k, "status.relativepaths")) {
		s->relative_paths = git_config_bool(k, v);
		return 0;
	}
	if (!strcmp(k, "status.showuntrackedfiles")) {
		if (!v)
			return config_error_nonbool(k);
		else if (!strcmp(v, "no"))
			s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
		else if (!strcmp(v, "normal"))
			s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
		else if (!strcmp(v, "all"))
			s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
		else
1208
			return error(_("Invalid untracked files mode '%s'"), v);
1209 1210 1211 1212 1213
		return 0;
	}
	return git_diff_ui_config(k, v, NULL);
}

J
Junio C Hamano 已提交
1214 1215
int cmd_status(int argc, const char **argv, const char *prefix)
{
J
Jeff King 已提交
1216
	static struct wt_status s;
1217
	int fd;
1218
	unsigned char sha1[20];
1219
	static struct option builtin_status_options[] = {
1220
		OPT__VERBOSE(&verbose, N_("be verbose")),
1221
		OPT_SET_INT('s', "short", &status_format,
1222
			    N_("show status concisely"), STATUS_FORMAT_SHORT),
1223 1224
		OPT_BOOL('b', "branch", &s.show_branch,
			 N_("show branch information")),
1225
		OPT_SET_INT(0, "porcelain", &status_format,
1226
			    N_("machine-readable output"),
1227
			    STATUS_FORMAT_PORCELAIN),
1228 1229 1230
		OPT_SET_INT(0, "long", &status_format,
			    N_("show status in long format (default)"),
			    STATUS_FORMAT_LONG),
1231
		OPT_BOOLEAN('z', "null", &s.null_termination,
1232
			    N_("terminate entries with NUL")),
1233
		{ OPTION_STRING, 'u', "untracked-files", &untracked_files_arg,
1234 1235
		  N_("mode"),
		  N_("show untracked files, optional modes: all, normal, no. (Default: all)"),
1236
		  PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1237
		OPT_BOOLEAN(0, "ignored", &show_ignored_in_status,
1238 1239 1240
			    N_("show ignored files")),
		{ OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, N_("when"),
		  N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
1241
		  PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1242
		OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
1243 1244 1245
		OPT_END(),
	};

1246 1247 1248
	if (argc == 2 && !strcmp(argv[1], "-h"))
		usage_with_options(builtin_status_usage, builtin_status_options);

1249
	wt_status_prepare(&s);
1250
	gitmodules_config();
1251
	git_config(git_status_config, &s);
1252
	determine_whence(&s);
1253
	argc = parse_options(argc, argv, prefix,
1254 1255
			     builtin_status_options,
			     builtin_status_usage, 0);
J
Jeff King 已提交
1256
	finalize_colopts(&s.colopts, -1);
1257
	finalize_deferred_config(&s);
1258

1259
	handle_untracked_files_arg(&s);
1260 1261
	if (show_ignored_in_status)
		s.show_ignored_files = 1;
1262 1263 1264
	if (*argv)
		s.pathspec = get_pathspec(prefix, argv);

1265
	read_cache_preload(s.pathspec);
1266
	refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, s.pathspec, NULL, NULL);
1267 1268

	fd = hold_locked_index(&index_lock, 0);
1269 1270
	if (0 <= fd)
		update_index_if_able(&the_index, &index_lock);
1271

1272
	s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1273
	s.ignore_submodule_arg = ignore_submodule_arg;
1274 1275
	wt_status_collect(&s);

J
Jeff King 已提交
1276 1277
	if (s.relative_paths)
		s.prefix = prefix;
1278

1279 1280
	switch (status_format) {
	case STATUS_FORMAT_SHORT:
1281
		wt_shortstatus_print(&s);
1282
		break;
1283
	case STATUS_FORMAT_PORCELAIN:
1284
		wt_porcelain_print(&s);
1285
		break;
1286 1287 1288
	case STATUS_FORMAT_UNSPECIFIED:
		die("BUG: finalize_deferred_config() should have been called");
		break;
1289
	case STATUS_FORMAT_NONE:
1290
	case STATUS_FORMAT_LONG:
1291
		s.verbose = verbose;
1292
		s.ignore_submodule_arg = ignore_submodule_arg;
1293
		wt_status_print(&s);
1294
		break;
1295
	}
1296
	return 0;
K
Kristian Høgsberg 已提交
1297 1298
}

1299 1300
static void print_summary(const char *prefix, const unsigned char *sha1,
			  int initial_commit)
K
Kristian Høgsberg 已提交
1301 1302 1303
{
	struct rev_info rev;
	struct commit *commit;
1304
	struct strbuf format = STRBUF_INIT;
J
Jeff King 已提交
1305
	unsigned char junk_sha1[20];
1306
	const char *head;
1307 1308 1309
	struct pretty_print_context pctx = {0};
	struct strbuf author_ident = STRBUF_INIT;
	struct strbuf committer_ident = STRBUF_INIT;
K
Kristian Høgsberg 已提交
1310 1311 1312

	commit = lookup_commit(sha1);
	if (!commit)
1313
		die(_("couldn't look up newly created commit"));
K
Kristian Høgsberg 已提交
1314
	if (!commit || parse_commit(commit))
1315
		die(_("could not parse newly created commit"));
K
Kristian Høgsberg 已提交
1316

1317 1318 1319 1320 1321 1322 1323 1324
	strbuf_addstr(&format, "format:%h] %s");

	format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
	format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
	if (strbuf_cmp(&author_ident, &committer_ident)) {
		strbuf_addstr(&format, "\n Author: ");
		strbuf_addbuf_percentquote(&format, &author_ident);
	}
1325
	if (!committer_ident_sufficiently_given()) {
1326 1327
		strbuf_addstr(&format, "\n Committer: ");
		strbuf_addbuf_percentquote(&format, &committer_ident);
1328 1329
		if (advice_implicit_identity) {
			strbuf_addch(&format, '\n');
1330
			strbuf_addstr(&format, _(implicit_ident_advice));
1331
		}
1332 1333 1334 1335
	}
	strbuf_release(&author_ident);
	strbuf_release(&committer_ident);

K
Kristian Høgsberg 已提交
1336 1337 1338 1339 1340 1341 1342 1343 1344
	init_revisions(&rev, prefix);
	setup_revisions(0, NULL, &rev, NULL);

	rev.diff = 1;
	rev.diffopt.output_format =
		DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;

	rev.verbose_header = 1;
	rev.show_root_diff = 1;
1345
	get_commit_format(format.buf, &rev);
1346
	rev.always_show_header = 0;
1347 1348
	rev.diffopt.detect_rename = 1;
	rev.diffopt.break_opt = 0;
1349
	diff_setup_done(&rev.diffopt);
K
Kristian Høgsberg 已提交
1350

1351
	head = resolve_ref_unsafe("HEAD", junk_sha1, 0, NULL);
1352
	printf("[%s%s ",
J
Jeff King 已提交
1353 1354 1355
		!prefixcmp(head, "refs/heads/") ?
			head + 11 :
			!strcmp(head, "HEAD") ?
1356
				_("detached HEAD") :
J
Jeff King 已提交
1357
				head,
1358
		initial_commit ? _(" (root-commit)") : "");
K
Kristian Høgsberg 已提交
1359

1360
	if (!log_tree_commit(&rev, commit)) {
1361 1362 1363
		rev.always_show_header = 1;
		rev.use_terminator = 1;
		log_tree_commit(&rev, commit);
1364
	}
1365

1366
	strbuf_release(&format);
K
Kristian Høgsberg 已提交
1367 1368
}

1369
static int git_commit_config(const char *k, const char *v, void *cb)
K
Kristian Høgsberg 已提交
1370
{
1371
	struct wt_status *s = cb;
J
Junio C Hamano 已提交
1372
	int status;
1373

1374
	if (!strcmp(k, "commit.template"))
1375
		return git_config_pathname(&template_file, k, v);
1376 1377 1378 1379
	if (!strcmp(k, "commit.status")) {
		include_status = git_config_bool(k, v);
		return 0;
	}
1380 1381
	if (!strcmp(k, "commit.cleanup"))
		return git_config_string(&cleanup_arg, k, v);
K
Kristian Høgsberg 已提交
1382

J
Junio C Hamano 已提交
1383 1384 1385
	status = git_gpg_config(k, v, NULL);
	if (status)
		return status;
1386
	return git_status_config(k, v, s);
K
Kristian Høgsberg 已提交
1387 1388
}

1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
static int run_rewrite_hook(const unsigned char *oldsha1,
			    const unsigned char *newsha1)
{
	/* oldsha1 SP newsha1 LF NUL */
	static char buf[2*40 + 3];
	struct child_process proc;
	const char *argv[3];
	int code;
	size_t n;

1399 1400
	argv[0] = find_hook("post-rewrite");
	if (!argv[0])
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
		return 0;

	argv[1] = "amend";
	argv[2] = NULL;

	memset(&proc, 0, sizeof(proc));
	proc.argv = argv;
	proc.in = -1;
	proc.stdout_to_stderr = 1;

	code = start_command(&proc);
	if (code)
		return code;
	n = snprintf(buf, sizeof(buf), "%s %s\n",
		     sha1_to_hex(oldsha1), sha1_to_hex(newsha1));
	write_in_full(proc.in, buf, n);
	close(proc.in);
	return finish_command(&proc);
}

K
Kristian Høgsberg 已提交
1421 1422
int cmd_commit(int argc, const char **argv, const char *prefix)
{
J
Jeff King 已提交
1423 1424
	static struct wt_status s;
	static struct option builtin_commit_options[] = {
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
		OPT__QUIET(&quiet, N_("suppress summary after successful commit")),
		OPT__VERBOSE(&verbose, N_("show diff in commit message template")),

		OPT_GROUP(N_("Commit message options")),
		OPT_FILENAME('F', "file", &logfile, N_("read message from file")),
		OPT_STRING(0, "author", &force_author, N_("author"), N_("override author for commit")),
		OPT_STRING(0, "date", &force_date, N_("date"), N_("override date for commit")),
		OPT_CALLBACK('m', "message", &message, N_("message"), N_("commit message"), opt_parse_m),
		OPT_STRING('c', "reedit-message", &edit_message, N_("commit"), N_("reuse and edit message from specified commit")),
		OPT_STRING('C', "reuse-message", &use_message, N_("commit"), N_("reuse message from specified commit")),
		OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
		OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
		OPT_BOOLEAN(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
		OPT_BOOLEAN('s', "signoff", &signoff, N_("add Signed-off-by:")),
		OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
		OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
		OPT_STRING(0, "cleanup", &cleanup_arg, N_("default"), N_("how to strip spaces and #comments from message")),
		OPT_BOOLEAN(0, "status", &include_status, N_("include status in commit message template")),
		{ OPTION_STRING, 'S', "gpg-sign", &sign_commit, N_("key id"),
		  N_("GPG sign commit"), PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
J
Jeff King 已提交
1445 1446
		/* end commit message options */

1447 1448 1449 1450 1451 1452 1453 1454 1455
		OPT_GROUP(N_("Commit contents options")),
		OPT_BOOLEAN('a', "all", &all, N_("commit all changed files")),
		OPT_BOOLEAN('i', "include", &also, N_("add specified files to index for commit")),
		OPT_BOOLEAN(0, "interactive", &interactive, N_("interactively add files")),
		OPT_BOOLEAN('p', "patch", &patch_interactive, N_("interactively add changes")),
		OPT_BOOLEAN('o', "only", &only, N_("commit only specified files")),
		OPT_BOOLEAN('n', "no-verify", &no_verify, N_("bypass pre-commit hook")),
		OPT_BOOLEAN(0, "dry-run", &dry_run, N_("show what would be committed")),
		OPT_SET_INT(0, "short", &status_format, N_("show status concisely"),
J
Jeff King 已提交
1456
			    STATUS_FORMAT_SHORT),
1457
		OPT_BOOL(0, "branch", &s.show_branch, N_("show branch information")),
J
Jeff King 已提交
1458
		OPT_SET_INT(0, "porcelain", &status_format,
1459
			    N_("machine-readable output"), STATUS_FORMAT_PORCELAIN),
1460 1461 1462
		OPT_SET_INT(0, "long", &status_format,
			    N_("show status in long format (default)"),
			    STATUS_FORMAT_LONG),
1463
		OPT_BOOLEAN('z', "null", &s.null_termination,
1464 1465 1466 1467
			    N_("terminate entries with NUL")),
		OPT_BOOLEAN(0, "amend", &amend, N_("amend previous commit")),
		OPT_BOOLEAN(0, "no-post-rewrite", &no_post_rewrite, N_("bypass post-rewrite hook")),
		{ 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" },
J
Jeff King 已提交
1468 1469 1470
		/* end commit contents options */

		{ OPTION_BOOLEAN, 0, "allow-empty", &allow_empty, NULL,
1471
		  N_("ok to record an empty change"),
J
Jeff King 已提交
1472 1473
		  PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
		{ OPTION_BOOLEAN, 0, "allow-empty-message", &allow_empty_message, NULL,
1474
		  N_("ok to record a change with an empty message"),
J
Jeff King 已提交
1475 1476 1477 1478 1479
		  PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },

		OPT_END()
	};

1480
	struct strbuf sb = STRBUF_INIT;
1481
	struct strbuf author_ident = STRBUF_INIT;
K
Kristian Høgsberg 已提交
1482
	const char *index_file, *reflog_msg;
1483
	char *nl, *p;
1484
	unsigned char sha1[20];
K
Kristian Høgsberg 已提交
1485
	struct ref_lock *ref_lock;
M
Miklos Vajna 已提交
1486
	struct commit_list *parents = NULL, **pptr = &parents;
1487 1488
	struct stat statbuf;
	int allow_fast_forward = 1;
1489
	struct commit *current_head = NULL;
1490
	struct commit_extra_header *extra = NULL;
K
Kristian Høgsberg 已提交
1491

1492 1493 1494
	if (argc == 2 && !strcmp(argv[1], "-h"))
		usage_with_options(builtin_commit_usage, builtin_commit_options);

1495
	wt_status_prepare(&s);
1496
	gitmodules_config();
1497
	git_config(git_commit_config, &s);
1498
	status_format = STATUS_FORMAT_NONE; /* Ignore status.short */
1499
	determine_whence(&s);
J
Jeff King 已提交
1500
	s.colopts = 0;
K
Kristian Høgsberg 已提交
1501

1502 1503 1504
	if (get_sha1("HEAD", sha1))
		current_head = NULL;
	else {
1505
		current_head = lookup_commit_or_die(sha1, "HEAD");
1506 1507 1508
		if (!current_head || parse_commit(current_head))
			die(_("could not parse HEAD commit"));
	}
J
Jeff King 已提交
1509 1510
	argc = parse_and_validate_options(argc, argv, builtin_commit_options,
					  builtin_commit_usage,
1511
					  prefix, current_head, &s);
1512
	if (dry_run)
1513 1514
		return dry_run_commit(argc, argv, prefix, current_head, &s);
	index_file = prepare_index(argc, argv, prefix, current_head, 0);
K
Kristian Høgsberg 已提交
1515

1516 1517
	/* Set up everything for writing the commit object.  This includes
	   running hooks, writing the trees, and interacting with the user.  */
1518 1519
	if (!prepare_to_commit(index_file, prefix,
			       current_head, &s, &author_ident)) {
1520
		rollback_index_files();
K
Kristian Høgsberg 已提交
1521 1522 1523 1524
		return 1;
	}

	/* Determine parents */
1525
	reflog_msg = getenv("GIT_REFLOG_ACTION");
1526
	if (!current_head) {
1527 1528
		if (!reflog_msg)
			reflog_msg = "commit (initial)";
K
Kristian Høgsberg 已提交
1529 1530 1531
	} else if (amend) {
		struct commit_list *c;

1532 1533
		if (!reflog_msg)
			reflog_msg = "commit (amend)";
1534
		for (c = current_head->parents; c; c = c->next)
M
Miklos Vajna 已提交
1535
			pptr = &commit_list_insert(c->item, pptr)->next;
1536
	} else if (whence == FROM_MERGE) {
1537
		struct strbuf m = STRBUF_INIT;
K
Kristian Høgsberg 已提交
1538 1539
		FILE *fp;

1540 1541
		if (!reflog_msg)
			reflog_msg = "commit (merge)";
1542
		pptr = &commit_list_insert(current_head, pptr)->next;
K
Kristian Høgsberg 已提交
1543 1544
		fp = fopen(git_path("MERGE_HEAD"), "r");
		if (fp == NULL)
1545
			die_errno(_("could not open '%s' for reading"),
1546
				  git_path("MERGE_HEAD"));
1547
		while (strbuf_getline(&m, fp, '\n') != EOF) {
1548 1549 1550 1551
			struct commit *parent;

			parent = get_merge_parent(m.buf);
			if (!parent)
1552
				die(_("Corrupt MERGE_HEAD file (%s)"), m.buf);
1553
			pptr = &commit_list_insert(parent, pptr)->next;
1554
		}
K
Kristian Høgsberg 已提交
1555 1556
		fclose(fp);
		strbuf_release(&m);
1557 1558
		if (!stat(git_path("MERGE_MODE"), &statbuf)) {
			if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1559
				die_errno(_("could not read MERGE_MODE"));
1560 1561 1562 1563 1564
			if (!strcmp(sb.buf, "no-ff"))
				allow_fast_forward = 0;
		}
		if (allow_fast_forward)
			parents = reduce_heads(parents);
K
Kristian Høgsberg 已提交
1565
	} else {
1566
		if (!reflog_msg)
1567 1568 1569
			reflog_msg = (whence == FROM_CHERRY_PICK)
					? "commit (cherry-pick)"
					: "commit";
1570
		pptr = &commit_list_insert(current_head, pptr)->next;
K
Kristian Høgsberg 已提交
1571 1572
	}

1573
	/* Finally, get the commit message */
1574
	strbuf_reset(&sb);
1575
	if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1576
		int saved_errno = errno;
1577
		rollback_index_files();
1578
		die(_("could not read commit message: %s"), strerror(saved_errno));
1579
	}
1580 1581

	/* Truncate the message just before the diff, if any. */
1582 1583 1584 1585 1586
	if (verbose) {
		p = strstr(sb.buf, "\ndiff --git ");
		if (p != NULL)
			strbuf_setlen(&sb, p - sb.buf + 1);
	}
1587

1588 1589
	if (cleanup_mode != CLEANUP_NONE)
		stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1590 1591 1592 1593 1594
	if (template_untouched(&sb) && !allow_empty_message) {
		rollback_index_files();
		fprintf(stderr, _("Aborting commit; you did not edit the message.\n"));
		exit(1);
	}
1595
	if (message_is_empty(&sb) && !allow_empty_message) {
1596
		rollback_index_files();
1597
		fprintf(stderr, _("Aborting commit due to empty commit message.\n"));
J
Jeff King 已提交
1598
		exit(1);
1599
	}
K
Kristian Høgsberg 已提交
1600

1601
	if (amend) {
1602 1603
		const char *exclude_gpgsig[2] = { "gpgsig", NULL };
		extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1604 1605 1606 1607
	} else {
		struct commit_extra_header **tail = &extra;
		append_merge_tag_headers(parents, &tail);
	}
1608

1609
	if (commit_tree_extended(&sb, active_cache_tree->sha1, parents, sha1,
J
Junio C Hamano 已提交
1610
				 author_ident.buf, sign_commit, extra)) {
1611
		rollback_index_files();
1612
		die(_("failed to write commit object"));
1613
	}
1614
	strbuf_release(&author_ident);
1615
	free_commit_extra_headers(extra);
K
Kristian Høgsberg 已提交
1616 1617

	ref_lock = lock_any_ref_for_update("HEAD",
1618 1619 1620
					   !current_head
					   ? NULL
					   : current_head->object.sha1,
K
Kristian Høgsberg 已提交
1621 1622
					   0);

M
Miklos Vajna 已提交
1623
	nl = strchr(sb.buf, '\n');
1624 1625 1626 1627 1628 1629
	if (nl)
		strbuf_setlen(&sb, nl + 1 - sb.buf);
	else
		strbuf_addch(&sb, '\n');
	strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
	strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
K
Kristian Høgsberg 已提交
1630

1631 1632
	if (!ref_lock) {
		rollback_index_files();
1633
		die(_("cannot lock HEAD ref"));
1634
	}
1635
	if (write_ref_sha1(ref_lock, sha1, sb.buf) < 0) {
1636
		rollback_index_files();
1637
		die(_("cannot update HEAD ref"));
1638
	}
K
Kristian Høgsberg 已提交
1639

J
Jay Soffian 已提交
1640
	unlink(git_path("CHERRY_PICK_HEAD"));
1641
	unlink(git_path("REVERT_HEAD"));
K
Kristian Høgsberg 已提交
1642 1643
	unlink(git_path("MERGE_HEAD"));
	unlink(git_path("MERGE_MSG"));
1644
	unlink(git_path("MERGE_MODE"));
1645
	unlink(git_path("SQUASH_MSG"));
K
Kristian Høgsberg 已提交
1646

1647
	if (commit_index_files())
1648
		die (_("Repository has been updated, but unable to write\n"
1649
		     "new_index file. Check that disk is not full or quota is\n"
1650
		     "not exceeded, and then \"git reset HEAD\" to recover."));
K
Kristian Høgsberg 已提交
1651

1652
	rerere(0);
1653
	run_hook(get_index_file(), "post-commit", NULL);
1654
	if (amend && !no_post_rewrite) {
1655 1656 1657
		struct notes_rewrite_cfg *cfg;
		cfg = init_copy_notes_for_rewrite("amend");
		if (cfg) {
1658 1659
			/* we are amending, so current_head is not NULL */
			copy_note_for_rewrite(cfg, current_head->object.sha1, sha1);
1660
			finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1661
		}
1662
		run_rewrite_hook(current_head->object.sha1, sha1);
1663
	}
K
Kristian Høgsberg 已提交
1664
	if (!quiet)
1665
		print_summary(prefix, sha1, !current_head);
K
Kristian Høgsberg 已提交
1666 1667 1668

	return 0;
}