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

75
static const char *logfile, *force_author;
76
static const char *template_file;
77 78 79 80 81
/*
 * 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
82
static char *edit_message, *use_message;
83
static char *fixup_message, *squash_message;
84
static int all, edit_flag, also, interactive, patch_interactive, only, amend, signoff;
85
static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
86
static int no_post_rewrite, allow_empty_message;
87
static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
88 89 90 91 92 93 94 95 96 97
/*
 * 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,
98
	CLEANUP_ALL
99 100
} cleanup_mode;
static char *cleanup_arg;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
101

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

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

116 117 118 119 120 121 122
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);
123
		strbuf_addstr(buf, "\n\n");
124 125 126
	}
	return 0;
}
Kristian Høgsberg's avatar
Kristian Høgsberg committed
127 128

static struct option builtin_commit_options[] = {
129 130
	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
131

132
	OPT_GROUP("Commit message options"),
133
	OPT_FILENAME('F', "file", &logfile, "read message from file"),
134 135 136 137 138 139 140
	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"),
141
	OPT_BOOLEAN(0, "reset-author", &renew_authorship, "the commit is authored by me now (used with -C-c/--amend)"),
142
	OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
143
	OPT_FILENAME('t', "template", &template_file, "use specified template file"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
144
	OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
145
	OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
146
	OPT_BOOLEAN(0, "status", &include_status, "include status in commit message template"),
147
	/* end commit message options */
Kristian Høgsberg's avatar
Kristian Høgsberg committed
148 149 150 151 152

	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"),
153
	OPT_BOOLEAN('p', "patch", &patch_interactive, "interactively add changes"),
154
	OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
155
	OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
Junio C Hamano's avatar
Junio C Hamano committed
156
	OPT_BOOLEAN(0, "dry-run", &dry_run, "show what would be committed"),
157 158
	OPT_SET_INT(0, "short", &status_format, "show status concisely",
		    STATUS_FORMAT_SHORT),
159
	OPT_BOOLEAN(0, "branch", &status_show_branch, "show branch information"),
160
	OPT_SET_INT(0, "porcelain", &status_format,
161
		    "machine-readable output", STATUS_FORMAT_PORCELAIN),
162 163
	OPT_BOOLEAN('z', "null", &null_termination,
		    "terminate entries with NUL"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
164
	OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
165
	OPT_BOOLEAN(0, "no-post-rewrite", &no_post_rewrite, "bypass post-rewrite hook"),
166
	{ 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" },
167
	/* end commit contents options */
Kristian Høgsberg's avatar
Kristian Høgsberg committed
168

169 170 171 172 173 174 175
	{ 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
176 177 178
	OPT_END()
};

179 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
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;
}

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

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

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

	return err;
241 242 243 244 245 246
}

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

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

257
	if (with_tree) {
258
		char *max_prefix = common_prefix(pattern);
259 260
		overlay_tree_on_cache(with_tree, max_prefix ? max_prefix : prefix);
		free(max_prefix);
261
	}
262 263 264

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

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

276
	return report_path_error(m, pattern, prefix);
277 278
}

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

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

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

298
static void create_base_index(const struct commit *current_head)
299 300 301 302 303
{
	struct tree *tree;
	struct unpack_trees_options opts;
	struct tree_desc t;

304
	if (!current_head) {
305 306 307 308 309 310 311 312
		discard_cache();
		return;
	}

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

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

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

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

345 346
	if (is_status)
		refresh_flags |= REFRESH_UNMERGED;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
347

348 349
	if (*argv)
		pathspec = get_pathspec(prefix, argv);
350

Linus Torvalds's avatar
Linus Torvalds committed
351
	if (read_cache_preload(pathspec) < 0)
352
		die(_("index file corrupt"));
Linus Torvalds's avatar
Linus Torvalds committed
353

354 355 356 357 358 359 360 361 362 363 364 365
	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);

366
		if (interactive_add(argc, argv, prefix, patch_interactive) != 0)
367 368 369 370 371 372 373 374 375 376 377 378 379 380
			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;
	}

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

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

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

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

	memset(&partial, 0, sizeof(partial));
452
	partial.strdup_strings = 1;
453
	if (list_paths(&partial, !current_head ? NULL : "HEAD", prefix, pathspec))
454 455 456 457
		exit(1);

	discard_cache();
	if (read_cache() < 0)
458
		die(_("cannot read the index"));
459 460 461

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

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

472
	create_base_index(current_head);
473
	add_remove_files(&partial);
474
	refresh_cache(REFRESH_QUIET);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
475

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

	discard_cache();
	read_cache_from(false_lock.filename);

483
	return false_lock.filename;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
484 485
}

486 487
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
488
{
489 490
	unsigned char sha1[20];

491 492
	if (s->relative_paths)
		s->prefix = prefix;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
493 494

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

504
	wt_status_collect(s);
505 506 507

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

518
	return s->commitable;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
519 520
}

521
static int is_a_merge(const struct commit *current_head)
522
{
523
	return !!(current_head->parents && current_head->parents->next);
524 525
}

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
			     struct commit *current_head,
628 629
			     struct wt_status *s,
			     struct strbuf *author_ident)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
630 631
{
	struct stat statbuf;
632
	struct strbuf committer_ident = STRBUF_INIT;
633
	int commitable, saved_color_setting;
634
	struct strbuf sb = STRBUF_INIT;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
635
	char *buffer;
636 637
	const char *hook_arg1 = NULL;
	const char *hook_arg2 = NULL;
638
	int ident_shown = 0;
639
	int clean_message_contents = (cleanup_mode != CLEANUP_NONE);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
640

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

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

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

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

720 721 722 723 724 725 726 727 728 729
	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 = "";
	}

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

734
	if (clean_message_contents)
735
		stripspace(&sb, 0);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
736 737

	if (signoff) {
738
		struct strbuf sob = STRBUF_INIT;
739 740 741
		int i;

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

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

Kristian Høgsberg's avatar
Kristian Høgsberg committed
758 759
	strbuf_release(&sb);

760 761
	/* This checks and barfs if author is badly specified */
	determine_author_info(author_ident);
762

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

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

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

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

		if (ident_shown)
815
			status_printf_ln(s, GIT_COLOR_NORMAL, "");
816

817 818
		saved_color_setting = s->use_color;
		s->use_color = 0;
819
		commitable = run_status(s->fp, index_file, prefix, 1, s);
820
		s->use_color = saved_color_setting;
821 822 823

		*ai_tmp = ' ';
		*ci_tmp = ' ';
824
	} else {
825
		unsigned char sha1[20];
826
		const char *parent = "HEAD";
827 828

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

831 832 833
		if (amend)
			parent = "HEAD^1";

834
		if (get_sha1(parent, sha1))
835
			commitable = !!active_nr;
836 837
		else
			commitable = index_differs_from(parent, 0);
838
	}
839
	strbuf_release(&committer_ident);
840

841
	fclose(s->fp);
842

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

858 859 860 861 862 863 864 865 866 867 868
	/*
	 * 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) {
869
		error(_("Error building trees"));
870
		return 0;
871
	}
Kristian Høgsberg's avatar
Kristian Høgsberg committed
872

873 874 875
	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
876

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

889 890 891 892
	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
893

894
	return 1;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
895 896 897
}

/*
898 899
 * 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
900
 */
901
static int message_is_empty(struct strbuf *sb)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
902
{
903
	struct strbuf tmpl = STRBUF_INIT;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
904
	const char *nl;
905
	int eol, i, start = 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
906

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

Kristian Høgsberg's avatar
Kristian Høgsberg committed
910 911
	/* See if the template is just a prefix of the message. */
	if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
912
		stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
		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;
}

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

967 968 969 970 971 972 973 974 975 976 977 978

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

982 983 984 985 986 987 988
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
989
		die(_("could not lookup commit %s"), name);
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
	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;
}

1004
static int parse_and_validate_options(int argc, const char *argv[],
1005
				      const char * const usage[],
1006
				      const char *prefix,
1007
				      struct commit *current_head,
1008
				      struct wt_status *s)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
1009 1010 1011
{
	int f = 0;

1012 1013
	argc = parse_options(argc, argv, prefix, builtin_commit_options, usage,
			     0);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
1014

1015 1016 1017
	if (force_author && !strchr(force_author, '>'))
		force_author = find_author_by_nickname(force_author);

1018
	if (force_author && renew_authorship)
1019
		die(_("Using both --reset-author and --author does not make sense"));
1020