commit.c 38.6 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 41 42 43 44
static const char implicit_ident_advice[] =
"Your name and email address were configured automatically based\n"
"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 48 49 50 51
"    git config --global user.email you@example.com\n"
"\n"
"If the identity used for this commit is wrong, you can fix it with:\n"
"\n"
"    git commit --amend --author='Your Name <you@example.com>'\n";

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

57
static unsigned char head_sha1[20];
58

Kristian Høgsberg's avatar
Kristian Høgsberg committed
59 60
static char *use_message_buffer;
static const char commit_editmsg[] = "COMMIT_EDITMSG";
61 62 63 64 65
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,
66
	COMMIT_PARTIAL
67
} commit_style;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
68

69
static const char *logfile, *force_author;
70
static const char *template_file;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
71
static char *edit_message, *use_message;
72
static char *fixup_message;
73
static char *author_name, *author_email, *author_date;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
74
static int all, edit_flag, also, interactive, only, amend, signoff;
75
static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
76
static int no_post_rewrite, allow_empty_message;
77
static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
78 79 80 81 82 83 84 85 86 87
/*
 * 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,
88
	CLEANUP_ALL
89 90
} cleanup_mode;
static char *cleanup_arg;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
91

92
static int use_editor = 1, initial_commit, in_merge, include_status = 1;
93
static int show_ignored_in_status;
94 95
static const char *only_include_assumed;
static struct strbuf message;
96

97 98 99 100
static int null_termination;
static enum {
	STATUS_FORMAT_LONG,
	STATUS_FORMAT_SHORT,
101
	STATUS_FORMAT_PORCELAIN
102
} status_format = STATUS_FORMAT_LONG;
103
static int status_show_branch;
104

105 106 107 108 109 110 111
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);
112
		strbuf_addstr(buf, "\n\n");
113 114 115
	}
	return 0;
}
Kristian Høgsberg's avatar
Kristian Høgsberg committed
116 117 118 119 120

static struct option builtin_commit_options[] = {
	OPT__QUIET(&quiet),
	OPT__VERBOSE(&verbose),

121
	OPT_GROUP("Commit message options"),
122
	OPT_FILENAME('F', "file", &logfile, "read log from file"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
123
	OPT_STRING(0, "author", &force_author, "AUTHOR", "override author for commit"),
124
	OPT_STRING(0, "date", &force_date, "DATE", "override date for commit"),
125
	OPT_CALLBACK('m', "message", &message, "MESSAGE", "specify commit message", opt_parse_m),
126
	OPT_STRING('c', "reedit-message", &edit_message, "COMMIT", "reuse and edit message from specified commit"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
127
	OPT_STRING('C', "reuse-message", &use_message, "COMMIT", "reuse message from specified commit"),
128
	OPT_STRING(0, "fixup", &fixup_message, "COMMIT", "use autosquash formatted message to fixup specified commit"),
129
	OPT_BOOLEAN(0, "reset-author", &renew_authorship, "the commit is authored by me now (used with -C-c/--amend)"),
130
	OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
131
	OPT_FILENAME('t', "template", &template_file, "use specified template file"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
132
	OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
133
	OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
134
	OPT_BOOLEAN(0, "status", &include_status, "include status in commit message template"),
135
	/* end commit message options */
Kristian Høgsberg's avatar
Kristian Høgsberg committed
136 137 138 139 140

	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"),
141
	OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
142
	OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
Junio C Hamano's avatar
Junio C Hamano committed
143
	OPT_BOOLEAN(0, "dry-run", &dry_run, "show what would be committed"),
144 145
	OPT_SET_INT(0, "short", &status_format, "show status concisely",
		    STATUS_FORMAT_SHORT),
146
	OPT_BOOLEAN(0, "branch", &status_show_branch, "show branch information"),
147 148 149 150
	OPT_SET_INT(0, "porcelain", &status_format,
		    "show porcelain output format", STATUS_FORMAT_PORCELAIN),
	OPT_BOOLEAN('z', "null", &null_termination,
		    "terminate entries with NUL"),
Kristian Høgsberg's avatar
Kristian Høgsberg committed
151
	OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
152
	OPT_BOOLEAN(0, "no-post-rewrite", &no_post_rewrite, "bypass post-rewrite hook"),
153
	{ 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" },
154
	/* end commit contents options */
Kristian Høgsberg's avatar
Kristian Høgsberg committed
155

156 157 158 159 160 161 162
	{ 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
163 164 165
	OPT_END()
};

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 210 211 212 213 214 215 216 217 218
		      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];
219 220
		struct string_list_item *item;

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

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

233
static void add_remove_files(struct string_list *list)
234 235 236
{
	int i;
	for (i = 0; i < list->nr; i++) {
237
		struct stat st;
238
		struct string_list_item *p = &(list->items[i]);
239

240 241
		/* p->util is skip-worktree */
		if (p->util)
242
			continue;
243

244 245
		if (!lstat(p->string, &st)) {
			if (add_to_cache(p->string, &st, 0))
246 247
				die("updating files failed");
		} else
248
			remove_file_from_cache(p->string);
249 250 251
	}
}

252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
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;
267 268
	opts.src_index = &the_index;
	opts.dst_index = &the_index;
269 270 271 272 273 274 275

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

280 281 282 283 284 285 286 287 288 289
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");
}

290
static char *prepare_index(int argc, const char **argv, const char *prefix, int is_status)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
291 292
{
	int fd;
293
	struct string_list partial;
294
	const char **pathspec = NULL;
295
	int refresh_flags = REFRESH_QUIET;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
296

297 298
	if (is_status)
		refresh_flags |= REFRESH_UNMERGED;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
299
	if (interactive) {
300 301
		if (interactive_add(argc, argv, prefix) != 0)
			die("interactive add failed");
Linus Torvalds's avatar
Linus Torvalds committed
302
		if (read_cache_preload(NULL) < 0)
303
			die("index file corrupt");
304
		commit_style = COMMIT_AS_IS;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
305 306 307
		return get_index_file();
	}

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

Linus Torvalds's avatar
Linus Torvalds committed
311 312 313
	if (read_cache_preload(pathspec) < 0)
		die("index file corrupt");

314 315 316 317 318 319 320 321 322 323 324 325 326
	/*
	 * 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)) {
327
		fd = hold_locked_index(&index_lock, 1);
328
		add_files_to_cache(also ? prefix : NULL, pathspec, 0);
329
		refresh_cache_or_die(refresh_flags);
Brandon Casey's avatar
Brandon Casey committed
330 331
		if (write_cache(fd, active_cache, active_nr) ||
		    close_lock_file(&index_lock))
Kristian Høgsberg's avatar
Kristian Høgsberg committed
332
			die("unable to write new_index file");
333 334
		commit_style = COMMIT_NORMAL;
		return index_lock.filename;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
335 336
	}

337 338 339 340 341
	/*
	 * As-is commit.
	 *
	 * (1) return the name of the real index file.
	 *
342 343
	 * The caller should run hooks on the real index,
	 * and create commit from the_index.
344 345 346 347
	 * We still need to refresh the index here.
	 */
	if (!pathspec || !*pathspec) {
		fd = hold_locked_index(&index_lock, 1);
348
		refresh_cache_or_die(refresh_flags);
349 350 351 352 353 354 355
		if (active_cache_changed) {
			if (write_cache(fd, active_cache, active_nr) ||
			    commit_locked_index(&index_lock))
				die("unable to write new_index file");
		} else {
			rollback_lock_file(&index_lock);
		}
356
		commit_style = COMMIT_AS_IS;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
357 358 359
		return get_index_file();
	}

360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
	/*
	 * 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;

381
	if (in_merge)
382 383 384
		die("cannot do a partial commit during a merge.");

	memset(&partial, 0, sizeof(partial));
385
	partial.strdup_strings = 1;
386 387 388 389 390 391 392 393 394
	if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
		exit(1);

	discard_cache();
	if (read_cache() < 0)
		die("cannot read the index");

	fd = hold_locked_index(&index_lock, 1);
	add_remove_files(&partial);
395
	refresh_cache(REFRESH_QUIET);
Brandon Casey's avatar
Brandon Casey committed
396 397
	if (write_cache(fd, active_cache, active_nr) ||
	    close_lock_file(&index_lock))
Kristian Høgsberg's avatar
Kristian Høgsberg committed
398 399
		die("unable to write new_index file");

400
	fd = hold_lock_file_for_update(&false_lock,
401 402
				       git_path("next-index-%"PRIuMAX,
						(uintmax_t) getpid()),
403
				       LOCK_DIE_ON_ERROR);
404 405

	create_base_index();
406
	add_remove_files(&partial);
407
	refresh_cache(REFRESH_QUIET);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
408

Brandon Casey's avatar
Brandon Casey committed
409 410
	if (write_cache(fd, active_cache, active_nr) ||
	    close_lock_file(&false_lock))
411
		die("unable to write temporary index file");
412 413 414 415

	discard_cache();
	read_cache_from(false_lock.filename);

416
	return false_lock.filename;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
417 418
}

419 420
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
421
{
422 423
	unsigned char sha1[20];

424 425
	if (s->relative_paths)
		s->prefix = prefix;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
426 427

	if (amend) {
428 429
		s->amend = 1;
		s->reference = "HEAD^1";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
430
	}
431 432 433 434
	s->verbose = verbose;
	s->index_file = index_file;
	s->fp = fp;
	s->nowarn = nowarn;
435
	s->is_initial = get_sha1(s->reference, sha1) ? 1 : 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
436

437
	wt_status_collect(s);
438 439 440

	switch (status_format) {
	case STATUS_FORMAT_SHORT:
441
		wt_shortstatus_print(s, null_termination, status_show_branch);
442 443
		break;
	case STATUS_FORMAT_PORCELAIN:
444
		wt_porcelain_print(s, null_termination);
445 446 447 448 449
		break;
	case STATUS_FORMAT_LONG:
		wt_status_print(s);
		break;
	}
Kristian Høgsberg's avatar
Kristian Høgsberg committed
450

451
	return s->commitable;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
452 453
}

454 455 456 457 458 459 460 461
static int is_a_merge(const unsigned char *sha1)
{
	struct commit *commit = lookup_commit(sha1);
	if (!commit || parse_commit(commit))
		die("could not parse HEAD commit");
	return !!(commit->parents && commit->parents->next);
}

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

464
static void determine_author_info(void)
465 466 467 468 469 470 471
{
	char *name, *email, *date;

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

472
	if (use_message && !renew_authorship) {
473 474 475 476 477 478
		const char *a, *lb, *rb, *eol;

		a = strstr(use_message_buffer, "\nauthor ");
		if (!a)
			die("invalid commit: %s", use_message);

479 480 481 482
		lb = strchrnul(a + strlen("\nauthor "), '<');
		rb = strchrnul(lb, '>');
		eol = strchrnul(rb, '\n');
		if (!*lb || !*rb || !*eol)
483 484
			die("invalid commit: %s", use_message);

485 486 487 488 489 490 491 492 493
		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("> ")));
494 495 496 497 498 499 500 501 502 503 504 505
	}

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

		if (!lb || !rb)
			die("malformed --author parameter");
		name = xstrndup(force_author, lb - force_author);
		email = xstrndup(lb + 2, rb - (lb + 2));
	}

506 507 508
	if (force_date)
		date = force_date;

509 510 511
	author_name = name;
	author_email = email;
	author_date = date;
512 513
}

514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
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;
}

555 556
static int prepare_to_commit(const char *index_file, const char *prefix,
			     struct wt_status *s)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
557 558
{
	struct stat statbuf;
559
	int commitable, saved_color_setting;
560
	struct strbuf sb = STRBUF_INIT;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
561 562
	char *buffer;
	FILE *fp;
563 564
	const char *hook_arg1 = NULL;
	const char *hook_arg2 = NULL;
565
	int ident_shown = 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
566

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

570 571
	if (message.len) {
		strbuf_addbuf(&sb, &message);
572
		hook_arg1 = "message";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
573 574 575 576
	} else if (logfile && !strcmp(logfile, "-")) {
		if (isatty(0))
			fprintf(stderr, "(reading log message from standard input)\n");
		if (strbuf_read(&sb, 0, 0) < 0)
577
			die_errno("could not read log from standard input");
578
		hook_arg1 = "message";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
579 580
	} else if (logfile) {
		if (strbuf_read_file(&sb, logfile, 0) < 0)
581 582
			die_errno("could not read log file '%s'",
				  logfile);
583
		hook_arg1 = "message";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
584 585 586 587 588
	} else if (use_message) {
		buffer = strstr(use_message_buffer, "\n\n");
		if (!buffer || buffer[2] == '\0')
			die("commit has empty message");
		strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
589 590
		hook_arg1 = "commit";
		hook_arg2 = use_message;
591 592 593 594 595 596 597 598 599 600
	} else if (fixup_message) {
		struct pretty_print_context ctx = {0};
		struct commit *commit;
		commit = lookup_commit_reference_by_name(fixup_message);
		if (!commit)
			die("could not lookup commit %s", fixup_message);
		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
601 602
	} else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
		if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
603
			die_errno("could not read MERGE_MSG");
604
		hook_arg1 = "merge";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
605 606
	} else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
		if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
607
			die_errno("could not read SQUASH_MSG");
608
		hook_arg1 = "squash";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
609 610
	} else if (template_file && !stat(template_file, &statbuf)) {
		if (strbuf_read_file(&sb, template_file, 0) < 0)
611
			die_errno("could not read '%s'", template_file);
612
		hook_arg1 = "template";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
613 614
	}

615 616 617 618 619 620 621
	/*
	 * This final case does not modify the template message,
	 * it just sets the argument to the prepare-commit-msg hook.
	 */
	else if (in_merge)
		hook_arg1 = "merge";

Kristian Høgsberg's avatar
Kristian Høgsberg committed
622 623
	fp = fopen(git_path(commit_editmsg), "w");
	if (fp == NULL)
624
		die_errno("could not open '%s'", git_path(commit_editmsg));
Kristian Høgsberg's avatar
Kristian Høgsberg committed
625

626 627
	if (cleanup_mode != CLEANUP_NONE)
		stripspace(&sb, 0);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
628 629

	if (signoff) {
630
		struct strbuf sob = STRBUF_INIT;
631 632 633
		int i;

		strbuf_addstr(&sob, sign_off_header);
634 635
		strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
					     getenv("GIT_COMMITTER_EMAIL")));
636 637 638
		strbuf_addch(&sob, '\n');
		for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
			; /* do nothing */
639
		if (prefixcmp(sb.buf + i, sob.buf)) {
640
			if (!i || !ends_rfc2822_footer(&sb))
641
				strbuf_addch(&sb, '\n');
642
			strbuf_addbuf(&sb, &sob);
643
		}
644
		strbuf_release(&sob);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
645 646
	}

647
	if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
648
		die_errno("could not write commit template");
649

Kristian Høgsberg's avatar
Kristian Høgsberg committed
650 651
	strbuf_release(&sb);

652 653
	determine_author_info();

654 655
	/* This checks if committer ident is explicitly given */
	git_committer_info(0);
656
	if (use_editor && include_status) {
657 658 659
		char *author_ident;
		const char *committer_ident;

660 661 662 663 664 665 666 667 668 669 670 671
		if (in_merge)
			fprintf(fp,
				"#\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",
				git_path("MERGE_HEAD"));

		fprintf(fp,
			"\n"
Jeff King's avatar
Jeff King committed
672
			"# Please enter the commit message for your changes.");
673
		if (cleanup_mode == CLEANUP_ALL)
Jeff King's avatar
Jeff King committed
674 675 676 677
			fprintf(fp,
				" Lines starting\n"
				"# with '#' will be ignored, and an empty"
				" message aborts the commit.\n");
678
		else /* CLEANUP_SPACE, that is. */
Jeff King's avatar
Jeff King committed
679 680 681 682 683
			fprintf(fp,
				" Lines starting\n"
				"# with '#' will be kept; you may remove them"
				" yourself if you want to.\n"
				"# An empty message aborts the commit.\n");
684 685 686
		if (only_include_assumed)
			fprintf(fp, "# %s\n", only_include_assumed);

687 688 689 690 691
		author_ident = xstrdup(fmt_name(author_name, author_email));
		committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
					   getenv("GIT_COMMITTER_EMAIL"));
		if (strcmp(author_ident, committer_ident))
			fprintf(fp,
692 693 694
				"%s"
				"# Author:    %s\n",
				ident_shown++ ? "" : "#\n",
695 696 697
				author_ident);
		free(author_ident);

698
		if (!user_ident_sufficiently_given())
699 700 701 702 703 704 705 706 707
			fprintf(fp,
				"%s"
				"# Committer: %s\n",
				ident_shown++ ? "" : "#\n",
				committer_ident);

		if (ident_shown)
			fprintf(fp, "#\n");

708 709 710 711
		saved_color_setting = s->use_color;
		s->use_color = 0;
		commitable = run_status(fp, index_file, prefix, 1, s);
		s->use_color = saved_color_setting;
712
	} else {
713
		unsigned char sha1[20];
714
		const char *parent = "HEAD";
715 716 717 718

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

719 720 721
		if (amend)
			parent = "HEAD^1";

722
		if (get_sha1(parent, sha1))
723
			commitable = !!active_nr;
724 725
		else
			commitable = index_differs_from(parent, 0);
726
	}
727

728
	fclose(fp);
729

730 731
	if (!commitable && !in_merge && !allow_empty &&
	    !(amend && is_a_merge(head_sha1))) {
732
		run_status(stdout, index_file, prefix, 0, s);
733 734
		if (amend)
			fputs(empty_amend_advice, stderr);
735
		return 0;
736 737
	}

738 739 740 741 742 743 744 745 746 747 748
	/*
	 * 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) {
749
		error("Error building trees");
750
		return 0;
751
	}
Kristian Høgsberg's avatar
Kristian Høgsberg committed
752

753 754 755
	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
756

757 758
	if (use_editor) {
		char index[PATH_MAX];
759 760
		const char *env[2] = { NULL };
		env[0] =  index;
761
		snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
762 763 764 765 766
		if (launch_editor(git_path(commit_editmsg), NULL, env)) {
			fprintf(stderr,
			"Please supply the message using either -m or -F option.\n");
			exit(1);
		}
767
	}
Kristian Høgsberg's avatar
Kristian Høgsberg committed
768

769 770 771 772
	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
773

774
	return 1;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
775 776 777
}

/*
778 779
 * 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
780
 */
781
static int message_is_empty(struct strbuf *sb)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
782
{
783
	struct strbuf tmpl = STRBUF_INIT;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
784
	const char *nl;
785
	int eol, i, start = 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
786

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

Kristian Høgsberg's avatar
Kristian Høgsberg committed
790 791
	/* See if the template is just a prefix of the message. */
	if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
792
		stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
		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;
}

820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
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) {
838 839
		struct pretty_print_context ctx = {0};
		ctx.date_mode = DATE_NORMAL;
840
		strbuf_release(&buf);
841
		format_commit_message(commit, "%an <%ae>", &buf, &ctx);
842 843 844 845 846
		return strbuf_detach(&buf, NULL);
	}
	die("No existing author found with '%s'", name);
}

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861

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

862
static int parse_and_validate_options(int argc, const char *argv[],
863
				      const char * const usage[],
864 865
				      const char *prefix,
				      struct wt_status *s)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
866 867 868
{
	int f = 0;

869 870
	argc = parse_options(argc, argv, prefix, builtin_commit_options, usage,
			     0);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
871

872 873 874
	if (force_author && !strchr(force_author, '>'))
		force_author = find_author_by_nickname(force_author);

875 876 877
	if (force_author && renew_authorship)
		die("Using both --reset-author and --author does not make sense");

878
	if (logfile || message.len || use_message || fixup_message)
879
		use_editor = 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
880
	if (edit_flag)
881
		use_editor = 1;
882 883
	if (!use_editor)
		setenv("GIT_EDITOR", ":", 1);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
884 885 886 887 888 889 890 891

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

	/* Sanity check options */
	if (amend && initial_commit)
		die("You have nothing to amend.");
	if (amend && in_merge)
892
		die("You are in the middle of a merge -- cannot amend.");
Kristian Høgsberg's avatar
Kristian Høgsberg committed
893 894 895 896 897

	if (use_message)
		f++;
	if (edit_message)
		f++;
898 899
	if (fixup_message)
		f++;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
900 901 902
	if (logfile)
		f++;
	if (f > 1)
903
		die("Only one of -c/-C/-F/--fixup can be used.");
904
	if (message.len && f > 0)
905
		die("Option -m cannot be combined with -c/-C/-F/--fixup.");
Kristian Høgsberg's avatar
Kristian Høgsberg committed
906 907
	if (edit_message)
		use_message = edit_message;
908
	if (amend && !use_message && !fixup_message)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
909
		use_message = "HEAD";
910 911
	if (!use_message && renew_authorship)
		die("--reset-author can be used only with -C, -c or --amend.");
Kristian Høgsberg's avatar
Kristian Høgsberg committed
912 913 914 915
	if (use_message) {
		const char *out_enc;
		struct commit *commit;

916 917
		commit = lookup_commit_reference_by_name(use_message);
		if (!commit)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
918
			die("could not lookup commit %s", use_message);
919 920
		out_enc = get_commit_output_encoding();
		use_message_buffer = logmsg_reencode(commit, out_enc);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937

		/*
		 * 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 (use_message_buffer == NULL)
			use_message_buffer = xstrdup(commit->buffer);
	}

	if (!!also + !!only + !!all + !!interactive > 1)
		die("Only one of --include/--only/--all/--interactive can be used.");
	if (argc == 0 && (also || (only && !amend)))
		die("No paths with --include/--only does not make sense.");
	if (argc == 0 && only && amend)
		only_include_assumed = "Clever... amending the last one with dirty index.";
938
	if (argc > 0 && !also && !only)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
939
		only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
940 941 942 943 944 945 946 947 948 949
	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
		die("Invalid cleanup mode %s", cleanup_arg);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
950

951
	handle_untracked_files_arg(s);
952

Kristian Høgsberg's avatar
Kristian Høgsberg committed
953 954 955 956 957
	if (all && argc > 0)
		die("Paths with -a does not make sense.");
	else if (interactive && argc > 0)
		die("Paths with --interactive does not make sense.");

958 959 960 961 962
	if (null_termination && status_format == STATUS_FORMAT_LONG)
		status_format = STATUS_FORMAT_PORCELAIN;
	if (status_format != STATUS_FORMAT_LONG)
		dry_run = 1;

Kristian Høgsberg's avatar
Kristian Høgsberg committed
963 964 965
	return argc;
}

966 967
static int dry_run_commit(int argc, const char **argv, const char *prefix,
			  struct wt_status *s)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
968 969
{
	int commitable;
Junio C Hamano's avatar
Junio C Hamano committed
970
	const char *index_file;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
971

Junio C Hamano's avatar
Junio C Hamano committed
972
	index_file = prepare_index(argc, argv, prefix, 1);
973
	commitable = run_status(stdout, index_file, prefix, 0, s);
Junio C Hamano's avatar
Junio C Hamano committed
974
	rollback_index_files();
Kristian Høgsberg's avatar
Kristian Høgsberg committed
975

Junio C Hamano's avatar
Junio C Hamano committed
976 977 978
	return commitable ? 0 : 1;
}

979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
static int parse_status_slot(const char *var, int offset)
{
	if (!strcasecmp(var+offset, "header"))
		return WT_STATUS_HEADER;
	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;
994
	return -1;
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
}

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

	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;
	}
	if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
		s->use_color = git_config_colorbool(k, v, -1);
		return 0;
	}
	if (!prefixcmp(k, "status.color.") || !prefixcmp(k, "color.status.")) {
		int slot = parse_status_slot(k, 13);
1014 1015
		if (slot < 0)
			return 0;
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
		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
			return error("Invalid untracked files mode '%s'", v);
		return 0;
	}
	return git_diff_ui_config(k, v, NULL);
}

Junio C Hamano's avatar
Junio C Hamano committed
1041 1042
int cmd_status(int argc, const char **argv, const char *prefix)
{
1043
	struct wt_status s;
1044
	int fd;
1045
	unsigned char sha1[20];
1046
	static struct option builtin_status_options[] = {
1047
		OPT__VERBOSE(&verbose),
1048 1049
		OPT_SET_INT('s', "short", &status_format,
			    "show status concisely", STATUS_FORMAT_SHORT),
1050 1051
		OPT_BOOLEAN('b', "branch", &status_show_branch,
			    "show branch information"),
1052 1053 1054
		OPT_SET_INT(0, "porcelain", &status_format,
			    "show porcelain output format",
			    STATUS_FORMAT_PORCELAIN),
1055 1056
		OPT_BOOLEAN('z', "null", &null_termination,
			    "terminate entries with NUL"),
1057 1058 1059 1060
		{ 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" },
1061 1062
		OPT_BOOLEAN(0, "ignored", &show_ignored_in_status,
			    "show ignored files"),
1063 1064 1065
		{ OPTION_STRING, 0, "ignore-submodules", &ignore_submodule_arg, "when",
		  "ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)",
		  PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
1066 1067 1068
		OPT_END(),
	};

1069
	if (null_termination && status_format == STATUS_FORMAT_LONG)
1070
		status_format = STATUS_FORMAT_PORCELAIN;
1071 1072

	wt_status_prepare(&s);
1073
	gitmodules_config();
1074
	git_config(git_status_config, &s);
1075
	in_merge = file_exists(git_path("MERGE_HEAD"));
1076
	argc = parse_options(argc, argv, prefix,
1077 1078
			     builtin_status_options,
			     builtin_status_usage, 0);
1079
	handle_untracked_files_arg(&s);
1080 1081
	if (show_ignored_in_status)
		s.show_ignored_files = 1;
1082 1083 1084
	if (*argv)
		s.pathspec = get_pathspec(prefix, argv);

1085
	read_cache_preload(s.pathspec);
1086
	refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, s.pathspec, NULL, NULL);
1087 1088 1089

	fd = hold_locked_index(&index_lock, 0);
	if (0 <= fd) {
1090 1091
		if (active_cache_changed &&
		    !write_cache(fd, active_cache, active_nr))
1092
			commit_locked_index(&index_lock);
1093 1094
		else
			rollback_lock_file(&index_lock);
1095 1096
	}

1097
	s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1098
	s.in_merge = in_merge;
1099
	s.ignore_submodule_arg = ignore_submodule_arg;
1100 1101
	wt_status_collect(&s);

1102 1103
	if (s.relative_paths)
		s.prefix = prefix;
1104 1105
	if (s.use_color == -1)
		s.use_color = git_use_color_default;
1106 1107 1108
	if (diff_use_color_default == -1)
		diff_use_color_default = git_use_color_default;

1109 1110
	switch (status_format) {
	case STATUS_FORMAT_SHORT:
1111
		wt_shortstatus_print(&s, null_termination, status_show_branch);
1112
		break;
1113
	case STATUS_FORMAT_PORCELAIN:
1114
		wt_porcelain_print(&s, null_termination);
1115
		break;
1116
	case STATUS_FORMAT_LONG:
1117
		s.verbose = verbose;
1118
		s.ignore_submodule_arg = ignore_submodule_arg;
1119
		wt_status_print(&s);
1120
		break;
1121
	}
1122
	return 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
1123 1124 1125 1126 1127 1128
}

static void print_summary(const char *prefix, const unsigned char *sha1)
{
	struct rev_info rev;
	struct commit *commit;
1129
	struct strbuf format = STRBUF_INIT;
1130 1131
	unsigned char junk_sha1[20];
	const char *head = resolve_ref("HEAD", junk_sha1, 0, NULL);