commit.c 42.7 KB
Newer Older
Kristian Høgsberg's avatar
Kristian Høgsberg committed
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"
Kristian Høgsberg's avatar
Kristian Høgsberg committed
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"
Kristian Høgsberg's avatar
Kristian Høgsberg committed
29 30

static const char * const builtin_commit_usage[] = {
Stephan Beyer's avatar
Stephan Beyer committed
31
	"git commit [options] [--] <filepattern>...",
Kristian Høgsberg's avatar
Kristian Høgsberg committed
32 33 34
	NULL
};

35
static const char * const builtin_status_usage[] = {
Stephan Beyer's avatar
Stephan Beyer committed
36
	"git status [options] [--] <filepattern>...",
37 38 39
	NULL
};

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

52
static const char empty_amend_advice[] =
53
N_("You asked to amend the most recent commit, but doing so would make\n"
54
"it empty. You can repeat your command with --allow-empty, or you can\n"
55
"remove the commit entirely with \"git reset HEAD^\".\n");
56

57
static const char empty_cherry_pick_advice[] =
Junio C Hamano's avatar
Junio C Hamano committed
58
N_("The previous cherry-pick is now empty, possibly due to conflict resolution.\n"
59 60 61 62
"If you wish to commit it anyway, use:\n"
"\n"
"    git commit --allow-empty\n"
"\n"
Junio C Hamano's avatar
Junio C Hamano committed
63
"Otherwise, please use 'git reset'\n");
64

65
static unsigned char head_sha1[20];
66

67
static const char *use_message_buffer;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
68
static const char commit_editmsg[] = "COMMIT_EDITMSG";
69 70 71 72 73
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,
74
	COMMIT_PARTIAL
75
} commit_style;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
76

77
static const char *logfile, *force_author;
78
static const char *template_file;
79 80 81 82 83
/*
 * The _message variables are commit names from which to take
 * the commit message and/or authorship.
 */
static const char *author_message, *author_message_buffer;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
84
static char *edit_message, *use_message;
85
static char *fixup_message, *squash_message;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
86
static int all, edit_flag, also, interactive, only, amend, signoff;
87
static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
88
static int no_post_rewrite, allow_empty_message;
89
static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
90 91 92 93 94 95 96 97 98 99
/*
 * 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,
100
	CLEANUP_ALL
101 102
} cleanup_mode;
static char *cleanup_arg;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
103

104 105
static enum commit_whence whence;
static int use_editor = 1, initial_commit, include_status = 1;
106
static int show_ignored_in_status;
107 108
static const char *only_include_assumed;
static struct strbuf message;
109

110 111 112 113
static int null_termination;
static enum {
	STATUS_FORMAT_LONG,
	STATUS_FORMAT_SHORT,
114
	STATUS_FORMAT_PORCELAIN
115
} status_format = STATUS_FORMAT_LONG;
116
static int status_show_branch;
117

118 119 120 121 122 123 124
static int opt_parse_m(const struct option *opt, const char *arg, int unset)
{
	struct strbuf *buf = opt->value;
	if (unset)
		strbuf_setlen(buf, 0);
	else {
		strbuf_addstr(buf, arg);
125
		strbuf_addstr(buf, "\n\n");
126 127 128
	}
	return 0;
}
Kristian Høgsberg's avatar
Kristian Høgsberg committed
129 130

static struct option builtin_commit_options[] = {
131 132
	OPT__QUIET(&quiet, "suppress summary after successful commit"),
	OPT__VERBOSE(&verbose, "show diff in commit message template"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
133

134
	OPT_GROUP("Commit message options"),
135
	OPT_FILENAME('F', "file", &logfile, "read message from file"),
136 137 138 139 140 141 142
	OPT_STRING(0, "author", &force_author, "author", "override author for commit"),
	OPT_STRING(0, "date", &force_date, "date", "override date for commit"),
	OPT_CALLBACK('m', "message", &message, "message", "commit message", opt_parse_m),
	OPT_STRING('c', "reedit-message", &edit_message, "commit", "reuse and edit message from specified commit"),
	OPT_STRING('C', "reuse-message", &use_message, "commit", "reuse message from specified commit"),
	OPT_STRING(0, "fixup", &fixup_message, "commit", "use autosquash formatted message to fixup specified commit"),
	OPT_STRING(0, "squash", &squash_message, "commit", "use autosquash formatted message to squash specified commit"),
143
	OPT_BOOLEAN(0, "reset-author", &renew_authorship, "the commit is authored by me now (used with -C-c/--amend)"),
144
	OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
145
	OPT_FILENAME('t', "template", &template_file, "use specified template file"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
146
	OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
147
	OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
148
	OPT_BOOLEAN(0, "status", &include_status, "include status in commit message template"),
149
	/* end commit message options */
Kristian Høgsberg's avatar
Kristian Høgsberg committed
150 151 152 153 154

	OPT_GROUP("Commit contents options"),
	OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
	OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
	OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
155
	OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
156
	OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
Junio C Hamano's avatar
Junio C Hamano committed
157
	OPT_BOOLEAN(0, "dry-run", &dry_run, "show what would be committed"),
158 159
	OPT_SET_INT(0, "short", &status_format, "show status concisely",
		    STATUS_FORMAT_SHORT),
160
	OPT_BOOLEAN(0, "branch", &status_show_branch, "show branch information"),
161
	OPT_SET_INT(0, "porcelain", &status_format,
162
		    "machine-readable output", STATUS_FORMAT_PORCELAIN),
163 164
	OPT_BOOLEAN('z', "null", &null_termination,
		    "terminate entries with NUL"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
165
	OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
166
	OPT_BOOLEAN(0, "no-post-rewrite", &no_post_rewrite, "bypass post-rewrite hook"),
167
	{ OPTION_STRING, 'u', "untracked-files", &untracked_files_arg, "mode", "show untracked files, optional modes: all, normal, no. (Default: all)", PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
168
	/* end commit contents options */
Kristian Høgsberg's avatar
Kristian Høgsberg committed
169

170 171 172 173 174 175 176
	{ OPTION_BOOLEAN, 0, "allow-empty", &allow_empty, NULL,
	  "ok to record an empty change",
	  PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
	{ OPTION_BOOLEAN, 0, "allow-empty-message", &allow_empty_message, NULL,
	  "ok to record a change with an empty message",
	  PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },

Kristian Høgsberg's avatar
Kristian Høgsberg committed
177 178 179
	OPT_END()
};

180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
static void determine_whence(struct wt_status *s)
{
	if (file_exists(git_path("MERGE_HEAD")))
		whence = FROM_MERGE;
	else if (file_exists(git_path("CHERRY_PICK_HEAD")))
		whence = FROM_CHERRY_PICK;
	else
		whence = FROM_COMMIT;
	if (s)
		s->whence = whence;
}

static const char *whence_s(void)
{
	char *s = "";

	switch (whence) {
	case FROM_COMMIT:
		break;
	case FROM_MERGE:
		s = "merge";
		break;
	case FROM_CHERRY_PICK:
		s = "cherry-pick";
		break;
	}

	return s;
}

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
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;
	}
}

225
static int commit_index_files(void)
226
{
227 228
	int err = 0;

229 230 231 232
	switch (commit_style) {
	case COMMIT_AS_IS:
		break; /* nothing to do */
	case COMMIT_NORMAL:
233
		err = commit_lock_file(&index_lock);
234 235
		break;
	case COMMIT_PARTIAL:
236
		err = commit_lock_file(&index_lock);
237 238 239
		rollback_lock_file(&false_lock);
		break;
	}
240 241

	return err;
242 243 244 245 246 247
}

/*
 * 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.
 */
248
static int list_paths(struct string_list *list, const char *with_tree,
249 250 251 252 253 254 255 256 257 258 259 260 261 262
		      const char *prefix, const char **pattern)
{
	int i;
	char *m;

	for (i = 0; pattern[i]; i++)
		;
	m = xcalloc(1, i);

	if (with_tree)
		overlay_tree_on_cache(with_tree, prefix);

	for (i = 0; i < active_nr; i++) {
		struct cache_entry *ce = active_cache[i];
263 264
		struct string_list_item *item;

265
		if (ce->ce_flags & CE_UPDATE)
266
			continue;
267
		if (!match_pathspec(pattern, ce->name, ce_namelen(ce), 0, m))
268
			continue;
269
		item = string_list_insert(list, ce->name);
270 271
		if (ce_skip_worktree(ce))
			item->util = item; /* better a valid pointer than a fake one */
272 273 274 275 276
	}

	return report_path_error(m, pattern, prefix ? strlen(prefix) : 0);
}

277
static void add_remove_files(struct string_list *list)
278 279 280
{
	int i;
	for (i = 0; i < list->nr; i++) {
281
		struct stat st;
282
		struct string_list_item *p = &(list->items[i]);
283

284 285
		/* p->util is skip-worktree */
		if (p->util)
286
			continue;
287

288 289
		if (!lstat(p->string, &st)) {
			if (add_to_cache(p->string, &st, 0))
290
				die(_("updating files failed"));
291
		} else
292
			remove_file_from_cache(p->string);
293 294 295
	}
}

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
static void create_base_index(void)
{
	struct tree *tree;
	struct unpack_trees_options opts;
	struct tree_desc t;

	if (initial_commit) {
		discard_cache();
		return;
	}

	memset(&opts, 0, sizeof(opts));
	opts.head_idx = 1;
	opts.index_only = 1;
	opts.merge = 1;
311 312
	opts.src_index = &the_index;
	opts.dst_index = &the_index;
313 314 315 316

	opts.fn = oneway_merge;
	tree = parse_tree_indirect(head_sha1);
	if (!tree)
317
		die(_("failed to unpack HEAD tree object"));
318 319
	parse_tree(tree);
	init_tree_desc(&t, tree->buffer, tree->size);
320 321
	if (unpack_trees(1, &t, &opts))
		exit(128); /* We've already reported the error, finish dying */
322 323
}

324 325 326 327 328 329 330 331 332 333
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");
}

334
static char *prepare_index(int argc, const char **argv, const char *prefix, int is_status)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
335 336
{
	int fd;
337
	struct string_list partial;
338
	const char **pathspec = NULL;
339
	char *old_index_env = NULL;
340
	int refresh_flags = REFRESH_QUIET;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
341

342 343
	if (is_status)
		refresh_flags |= REFRESH_UNMERGED;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
344

345 346
	if (*argv)
		pathspec = get_pathspec(prefix, argv);
347

Linus Torvalds's avatar
Linus Torvalds committed
348
	if (read_cache_preload(pathspec) < 0)
349
		die(_("index file corrupt"));
Linus Torvalds's avatar
Linus Torvalds committed
350

351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
	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);

		if (interactive_add(argc, argv, prefix) != 0)
			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;
	}

378 379 380 381 382 383 384 385 386 387 388 389 390
	/*
	 * 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)) {
391
		fd = hold_locked_index(&index_lock, 1);
392
		add_files_to_cache(also ? prefix : NULL, pathspec, 0);
393
		refresh_cache_or_die(refresh_flags);
Brandon Casey's avatar
Brandon Casey committed
394 395
		if (write_cache(fd, active_cache, active_nr) ||
		    close_lock_file(&index_lock))
396
			die(_("unable to write new_index file"));
397 398
		commit_style = COMMIT_NORMAL;
		return index_lock.filename;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
399 400
	}

401 402 403 404 405
	/*
	 * As-is commit.
	 *
	 * (1) return the name of the real index file.
	 *
406 407
	 * The caller should run hooks on the real index,
	 * and create commit from the_index.
408 409 410 411
	 * We still need to refresh the index here.
	 */
	if (!pathspec || !*pathspec) {
		fd = hold_locked_index(&index_lock, 1);
412
		refresh_cache_or_die(refresh_flags);
413 414 415
		if (active_cache_changed) {
			if (write_cache(fd, active_cache, active_nr) ||
			    commit_locked_index(&index_lock))
416
				die(_("unable to write new_index file"));
417 418 419
		} else {
			rollback_lock_file(&index_lock);
		}
420
		commit_style = COMMIT_AS_IS;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
421 422 423
		return get_index_file();
	}

424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
	/*
	 * 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;

445
	if (whence != FROM_COMMIT)
Junio C Hamano's avatar
Junio C Hamano committed
446
		die(_("cannot do a partial commit during a %s."), whence_s());
447 448

	memset(&partial, 0, sizeof(partial));
449
	partial.strdup_strings = 1;
450 451 452 453 454
	if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
		exit(1);

	discard_cache();
	if (read_cache() < 0)
455
		die(_("cannot read the index"));
456 457 458

	fd = hold_locked_index(&index_lock, 1);
	add_remove_files(&partial);
459
	refresh_cache(REFRESH_QUIET);
Brandon Casey's avatar
Brandon Casey committed
460 461
	if (write_cache(fd, active_cache, active_nr) ||
	    close_lock_file(&index_lock))
462
		die(_("unable to write new_index file"));
Kristian Høgsberg's avatar
Kristian Høgsberg committed
463

464
	fd = hold_lock_file_for_update(&false_lock,
465 466
				       git_path("next-index-%"PRIuMAX,
						(uintmax_t) getpid()),
467
				       LOCK_DIE_ON_ERROR);
468 469

	create_base_index();
470
	add_remove_files(&partial);
471
	refresh_cache(REFRESH_QUIET);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
472

Brandon Casey's avatar
Brandon Casey committed
473 474
	if (write_cache(fd, active_cache, active_nr) ||
	    close_lock_file(&false_lock))
475
		die(_("unable to write temporary index file"));
476 477 478 479

	discard_cache();
	read_cache_from(false_lock.filename);

480
	return false_lock.filename;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
481 482
}

483 484
static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
		      struct wt_status *s)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
485
{
486 487
	unsigned char sha1[20];

488 489
	if (s->relative_paths)
		s->prefix = prefix;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
490 491

	if (amend) {
492 493
		s->amend = 1;
		s->reference = "HEAD^1";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
494
	}
495 496 497 498
	s->verbose = verbose;
	s->index_file = index_file;
	s->fp = fp;
	s->nowarn = nowarn;
499
	s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
500

501
	wt_status_collect(s);
502 503 504

	switch (status_format) {
	case STATUS_FORMAT_SHORT:
505
		wt_shortstatus_print(s, null_termination, status_show_branch);
506 507
		break;
	case STATUS_FORMAT_PORCELAIN:
508
		wt_porcelain_print(s, null_termination);
509 510 511 512 513
		break;
	case STATUS_FORMAT_LONG:
		wt_status_print(s);
		break;
	}
Kristian Høgsberg's avatar
Kristian Høgsberg committed
514

515
	return s->commitable;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
516 517
}

518 519 520 521
static int is_a_merge(const unsigned char *sha1)
{
	struct commit *commit = lookup_commit(sha1);
	if (!commit || parse_commit(commit))
522
		die(_("could not parse HEAD commit"));
523 524 525
	return !!(commit->parents && commit->parents->next);
}

Kristian Høgsberg's avatar
Kristian Høgsberg committed
526 527
static const char sign_off_header[] = "Signed-off-by: ";

528
static void determine_author_info(struct strbuf *author_ident)
529 530 531 532 533 534 535
{
	char *name, *email, *date;

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

536
	if (author_message) {
537 538
		const char *a, *lb, *rb, *eol;

539
		a = strstr(author_message_buffer, "\nauthor ");
540
		if (!a)
Junio C Hamano's avatar
Junio C Hamano committed
541
			die(_("invalid commit: %s"), author_message);
542

543 544 545 546
		lb = strchrnul(a + strlen("\nauthor "), '<');
		rb = strchrnul(lb, '>');
		eol = strchrnul(rb, '\n');
		if (!*lb || !*rb || !*eol)
Junio C Hamano's avatar
Junio C Hamano committed
547
			die(_("invalid commit: %s"), author_message);
548

549 550 551 552 553 554 555 556 557
		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("<")));
		date = xmemdupz(rb + strlen("> "), eol - (rb + strlen("> ")));
558 559 560 561 562 563 564
	}

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

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

570 571
	if (force_date)
		date = force_date;
572 573
	strbuf_addstr(author_ident, fmt_ident(name, email, date,
					      IDENT_ERROR_ON_NO_NAME));
574 575
}

576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
static int ends_rfc2822_footer(struct strbuf *sb)
{
	int ch;
	int hit = 0;
	int i, j, k;
	int len = sb->len;
	int first = 1;
	const char *buf = sb->buf;

	for (i = len - 1; i > 0; i--) {
		if (hit && buf[i] == '\n')
			break;
		hit = (buf[i] == '\n');
	}

	while (i < len - 1 && buf[i] == '\n')
		i++;

	for (; i < len; i = k) {
		for (k = i; k < len && buf[k] != '\n'; k++)
			; /* do nothing */
		k++;

		if ((buf[k] == ' ' || buf[k] == '\t') && !first)
			continue;

		first = 0;

		for (j = 0; i + j < len; j++) {
			ch = buf[i + j];
			if (ch == ':')
				break;
			if (isalnum(ch) ||
			    (ch == '-'))
				continue;
			return 0;
		}
	}
	return 1;
}

617 618 619 620
static char *cut_ident_timestamp_part(char *string)
{
	char *ket = strrchr(string, '>');
	if (!ket || ket[1] != ' ')
621
		die(_("Malformed ident string: '%s'"), string);
622 623 624 625
	*++ket = '\0';
	return ket;
}

626
static int prepare_to_commit(const char *index_file, const char *prefix,
627 628
			     struct wt_status *s,
			     struct strbuf *author_ident)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
629 630
{
	struct stat statbuf;
631
	struct strbuf committer_ident = STRBUF_INIT;
632
	int commitable, saved_color_setting;
633
	struct strbuf sb = STRBUF_INIT;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
634
	char *buffer;
635 636
	const char *hook_arg1 = NULL;
	const char *hook_arg2 = NULL;
637
	int ident_shown = 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
638

639 640
	if (!no_verify && run_hook(index_file, "pre-commit", NULL))
		return 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
641

642 643 644 645 646 647 648 649 650 651 652 653
	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)
654
				die(_("could not lookup commit %s"), squash_message);
655 656 657 658 659 660
			ctx.output_encoding = get_commit_output_encoding();
			format_commit_message(c, "squash! %s\n\n", &sb,
					      &ctx);
		}
	}

661 662
	if (message.len) {
		strbuf_addbuf(&sb, &message);
663
		hook_arg1 = "message";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
664 665
	} else if (logfile && !strcmp(logfile, "-")) {
		if (isatty(0))
666
			fprintf(stderr, _("(reading log message from standard input)\n"));
Kristian Høgsberg's avatar
Kristian Høgsberg committed
667
		if (strbuf_read(&sb, 0, 0) < 0)
668
			die_errno(_("could not read log from standard input"));
669
		hook_arg1 = "message";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
670 671
	} else if (logfile) {
		if (strbuf_read_file(&sb, logfile, 0) < 0)
672
			die_errno(_("could not read log file '%s'"),
673
				  logfile);
674
		hook_arg1 = "message";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
675 676 677
	} else if (use_message) {
		buffer = strstr(use_message_buffer, "\n\n");
		if (!buffer || buffer[2] == '\0')
678
			die(_("commit has empty message"));
Kristian Høgsberg's avatar
Kristian Høgsberg committed
679
		strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
680 681
		hook_arg1 = "commit";
		hook_arg2 = use_message;
682 683 684 685 686
	} else if (fixup_message) {
		struct pretty_print_context ctx = {0};
		struct commit *commit;
		commit = lookup_commit_reference_by_name(fixup_message);
		if (!commit)
687
			die(_("could not lookup commit %s"), fixup_message);
688 689 690 691
		ctx.output_encoding = get_commit_output_encoding();
		format_commit_message(commit, "fixup! %s\n\n",
				      &sb, &ctx);
		hook_arg1 = "message";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
692 693
	} else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
		if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
694
			die_errno(_("could not read MERGE_MSG"));
695
		hook_arg1 = "merge";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
696 697
	} else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
		if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
698
			die_errno(_("could not read SQUASH_MSG"));
699
		hook_arg1 = "squash";
700
	} else if (template_file) {
Kristian Høgsberg's avatar
Kristian Høgsberg committed
701
		if (strbuf_read_file(&sb, template_file, 0) < 0)
702
			die_errno(_("could not read '%s'"), template_file);
703
		hook_arg1 = "template";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
704 705
	}

706
	/*
707 708
	 * The remaining cases don't modify the template message, but
	 * just set the argument(s) to the prepare-commit-msg hook.
709
	 */
710
	else if (whence == FROM_MERGE)
711
		hook_arg1 = "merge";
712 713 714 715
	else if (whence == FROM_CHERRY_PICK) {
		hook_arg1 = "commit";
		hook_arg2 = "CHERRY_PICK_HEAD";
	}
716

717 718 719 720 721 722 723 724 725 726
	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 = "";
	}

727 728
	s->fp = fopen(git_path(commit_editmsg), "w");
	if (s->fp == NULL)
729
		die_errno(_("could not open '%s'"), git_path(commit_editmsg));
Kristian Høgsberg's avatar
Kristian Høgsberg committed
730

731 732
	if (cleanup_mode != CLEANUP_NONE)
		stripspace(&sb, 0);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
733 734

	if (signoff) {
735
		struct strbuf sob = STRBUF_INIT;
736 737 738
		int i;

		strbuf_addstr(&sob, sign_off_header);
739 740
		strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
					     getenv("GIT_COMMITTER_EMAIL")));
741 742 743
		strbuf_addch(&sob, '\n');
		for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
			; /* do nothing */
744
		if (prefixcmp(sb.buf + i, sob.buf)) {
745
			if (!i || !ends_rfc2822_footer(&sb))
746
				strbuf_addch(&sb, '\n');
747
			strbuf_addbuf(&sb, &sob);
748
		}
749
		strbuf_release(&sob);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
750 751
	}

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

Kristian Høgsberg's avatar
Kristian Høgsberg committed
755 756
	strbuf_release(&sb);

757 758
	/* This checks and barfs if author is badly specified */
	determine_author_info(author_ident);
759

760
	/* This checks if committer ident is explicitly given */
761
	strbuf_addstr(&committer_ident, git_committer_info(0));
762
	if (use_editor && include_status) {
763
		char *ai_tmp, *ci_tmp;
764
		if (whence != FROM_COMMIT)
765
			status_printf_ln(s, GIT_COLOR_NORMAL,
766
				_("\n"
767
				"It looks like you may be committing a %s.\n"
768 769 770
				"If this is not correct, please remove the file\n"
				"	%s\n"
				"and try again.\n"
771
				""),
772 773 774 775
				whence_s(),
				git_path(whence == FROM_MERGE
					 ? "MERGE_HEAD"
					 : "CHERRY_PICK_HEAD"));
776

777 778
		fprintf(s->fp, "\n");
		status_printf(s, GIT_COLOR_NORMAL,
779
			_("Please enter the commit message for your changes."));
780
		if (cleanup_mode == CLEANUP_ALL)
781
			status_printf_more(s, GIT_COLOR_NORMAL,
782
				_(" Lines starting\n"
783
				"with '#' will be ignored, and an empty"
784
				" message aborts the commit.\n"));
785
		else /* CLEANUP_SPACE, that is. */
786
			status_printf_more(s, GIT_COLOR_NORMAL,
787
				_(" Lines starting\n"
788
				"with '#' will be kept; you may remove them"
Jeff King's avatar
Jeff King committed
789
				" yourself if you want to.\n"
790
				"An empty message aborts the commit.\n"));
791
		if (only_include_assumed)
792 793
			status_printf_ln(s, GIT_COLOR_NORMAL,
					"%s", only_include_assumed);
794

795 796 797
		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))
798
			status_printf_ln(s, GIT_COLOR_NORMAL,
799 800
				_("%s"
				"Author:    %s"),
801
				ident_shown++ ? "" : "\n",
802
				author_ident->buf);
803

804
		if (!user_ident_sufficiently_given())
805
			status_printf_ln(s, GIT_COLOR_NORMAL,
806 807
				_("%s"
				"Committer: %s"),
808
				ident_shown++ ? "" : "\n",
809
				committer_ident.buf);
810 811

		if (ident_shown)
812
			status_printf_ln(s, GIT_COLOR_NORMAL, "");
813

814 815
		saved_color_setting = s->use_color;
		s->use_color = 0;
816
		commitable = run_status(s->fp, index_file, prefix, 1, s);
817
		s->use_color = saved_color_setting;
818 819 820

		*ai_tmp = ' ';
		*ci_tmp = ' ';
821
	} else {
822
		unsigned char sha1[20];
823
		const char *parent = "HEAD";
824 825

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

828 829 830
		if (amend)
			parent = "HEAD^1";

831
		if (get_sha1(parent, sha1))
832
			commitable = !!active_nr;
833 834
		else
			commitable = index_differs_from(parent, 0);
835
	}
836
	strbuf_release(&committer_ident);
837

838
	fclose(s->fp);
839

840 841 842 843 844 845
	/*
	 * 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 &&
846
	    !(amend && is_a_merge(head_sha1))) {
847
		run_status(stdout, index_file, prefix, 0, s);
848
		if (amend)
849
			fputs(_(empty_amend_advice), stderr);
850
		else if (whence == FROM_CHERRY_PICK)
Junio C Hamano's avatar
Junio C Hamano committed
851
			fputs(_(empty_cherry_pick_advice), stderr);
852
		return 0;
853 854
	}

855 856 857 858 859 860 861 862 863 864 865
	/*
	 * 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);
	if (!active_cache_tree)
		active_cache_tree = cache_tree();
	if (cache_tree_update(active_cache_tree,
			      active_cache, active_nr, 0, 0) < 0) {
866
		error(_("Error building trees"));
867
		return 0;
868
	}
Kristian Høgsberg's avatar
Kristian Høgsberg committed
869

870 871 872
	if (run_hook(index_file, "prepare-commit-msg",
		     git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
		return 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
873

874 875
	if (use_editor) {
		char index[PATH_MAX];
876 877
		const char *env[2] = { NULL };
		env[0] =  index;
878
		snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
879 880
		if (launch_editor(git_path(commit_editmsg), NULL, env)) {
			fprintf(stderr,
881
			_("Please supply the message using either -m or -F option.\n"));
882 883
			exit(1);
		}
884
	}
Kristian Høgsberg's avatar
Kristian Høgsberg committed
885

886 887 888 889
	if (!no_verify &&
	    run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
		return 0;
	}
Kristian Høgsberg's avatar
Kristian Høgsberg committed
890

891
	return 1;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
892 893 894
}

/*
895 896
 * Find out if the message in the strbuf contains only whitespace and
 * Signed-off-by lines.
Kristian Høgsberg's avatar
Kristian Høgsberg committed
897
 */
898
static int message_is_empty(struct strbuf *sb)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
899
{
900
	struct strbuf tmpl = STRBUF_INIT;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
901
	const char *nl;
902
	int eol, i, start = 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
903

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

Kristian Høgsberg's avatar
Kristian Høgsberg committed
907 908
	/* See if the template is just a prefix of the message. */
	if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
909
		stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936
		if (start + tmpl.len <= sb->len &&
		    memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
			start += tmpl.len;
	}
	strbuf_release(&tmpl);

	/* 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;
}

937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
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) {
955 956
		struct pretty_print_context ctx = {0};
		ctx.date_mode = DATE_NORMAL;
957
		strbuf_release(&buf);
958
		format_commit_message(commit, "%an <%ae>", &buf, &ctx);
959 960
		return strbuf_detach(&buf, NULL);
	}
961
	die(_("No existing author found with '%s'"), name);
962 963
}

964 965 966 967 968 969 970 971 972 973 974 975

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
976
		die(_("Invalid untracked files mode '%s'"), untracked_files_arg);
977 978
}

979 980 981 982 983 984 985
static const char *read_commit_message(const char *name)
{
	const char *out_enc, *out;
	struct commit *commit;

	commit = lookup_commit_reference_by_name(name);
	if (!commit)
Junio C Hamano's avatar
Junio C Hamano committed
986
		die(_("could not lookup commit %s"), name);
987 988 989 990 991 992 993 994 995 996 997 998 999 1000
	out_enc = get_commit_output_encoding();
	out = logmsg_reencode(commit, out_enc);

	/*
	 * If we failed to reencode the buffer, just copy it
	 * byte for byte so the user can try to fix it up.
	 * This also handles the case where input and output
	 * encodings are identical.
	 */
	if (out == NULL)
		out = xstrdup(commit->buffer);
	return out;
}

1001
static int parse_and_validate_options(int argc, const char *argv[],
1002
				      const char * const usage[],
1003 1004
				      const char *prefix,
				      struct wt_status *s)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
1005 1006 1007
{
	int f = 0;

1008 1009
	argc = parse_options(argc, argv, prefix, builtin_commit_options, usage,
			     0);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
1010

1011 1012 1013
	if (force_author && !strchr(force_author, '>'))
		force_author = find_author_by_nickname(force_author);

1014
	if (force_author && renew_authorship)
1015
		die(_("Using both --reset-author and --author does not make sense"));
1016

1017
	if (logfile || message.len || use_message || fixup_message)
1018
		use_editor = 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
1019
	if (edit_flag)
1020
		use_editor = 1;
1021 1022
	if (!use_editor)
		setenv("GIT_EDITOR", ":", 1);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
1023 1024 1025 1026 1027 1028

	if (get_sha1("HEAD", head_sha1))
		initial_commit = 1;

	/* Sanity check options */
	if (amend && initial_commit)
1029
		die(_("You have nothing to amend."));
1030
	if (amend && whence != FROM_COMMIT)
Junio C Hamano's avatar
Junio C Hamano committed
1031
		die(_("You are in the middle of a %s -- cannot amend."), whence_s());
1032
	if (fixup_message && squash_message)
1033
		die(_("Options --squash and --fixup cannot be used together"));
Kristian Høgsberg's avatar
Kristian Høgsberg committed
1034 1035 1036 1037
	if (use_message)
		f++;
	if (edit_message)
		f++;
1038 1039
	if (fixup_message)
		f++;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
1040 1041 1042
	if (logfile)
		f++;
	if (f > 1)
1043
		die(_("Only one of -c/-C/-F/--fixup can be used."));
1044
	if (message.len && f > 0)
1045
		die((_("Option -m cannot be combined with -c/-C/-F/--fixup.")));