commit.c 38.8 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
"    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 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 72
static char *edit_message, *use_message;
static int all, edit_flag, also, interactive, only, amend, signoff;
73
static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
74
static int no_post_rewrite, allow_empty_message;
75
static char *untracked_files_arg, *force_date, *ignore_submodule_arg;
76 77 78 79 80 81 82 83 84 85
/*
 * 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,
86
	CLEANUP_ALL
87 88
} cleanup_mode;
static char *cleanup_arg;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
89

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

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

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

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

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

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

153 154 155 156 157 158 159
	{ 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
160 161 162
	OPT_END()
};

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
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;
	}
}

178
static int commit_index_files(void)
179
{
180 181
	int err = 0;

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

	return err;
195 196 197 198 199 200
}

/*
 * 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.
 */
201
static int list_paths(struct string_list *list, const char *with_tree,
202 203 204 205 206 207 208 209 210 211 212 213 214 215
		      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];
216 217
		struct string_list_item *item;

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

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

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

237 238
		/* p->util is skip-worktree */
		if (p->util)
239
			continue;
240

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

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

	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);
273 274
	if (unpack_trees(1, &t, &opts))
		exit(128); /* We've already reported the error, finish dying */
275 276
}

277 278 279 280 281 282 283 284 285 286
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");
}

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

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

305 306
	if (*argv)
		pathspec = get_pathspec(prefix, argv);
307

Linus Torvalds's avatar
Linus Torvalds committed
308 309 310
	if (read_cache_preload(pathspec) < 0)
		die("index file corrupt");

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

334 335 336 337 338
	/*
	 * As-is commit.
	 *
	 * (1) return the name of the real index file.
	 *
339 340
	 * The caller should run hooks on the real index,
	 * and create commit from the_index.
341 342 343 344
	 * We still need to refresh the index here.
	 */
	if (!pathspec || !*pathspec) {
		fd = hold_locked_index(&index_lock, 1);
345
		refresh_cache_or_die(refresh_flags);
346 347 348 349 350 351 352
		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);
		}
353
		commit_style = COMMIT_AS_IS;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
354 355 356
		return get_index_file();
	}

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

378
	if (in_merge)
379 380 381
		die("cannot do a partial commit during a merge.");

	memset(&partial, 0, sizeof(partial));
382
	partial.strdup_strings = 1;
383 384 385 386 387 388 389 390 391
	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);
392
	refresh_cache(REFRESH_QUIET);
Brandon Casey's avatar
Brandon Casey committed
393 394
	if (write_cache(fd, active_cache, active_nr) ||
	    close_lock_file(&index_lock))
Kristian Høgsberg's avatar
Kristian Høgsberg committed
395 396
		die("unable to write new_index file");

397
	fd = hold_lock_file_for_update(&false_lock,
398 399
				       git_path("next-index-%"PRIuMAX,
						(uintmax_t) getpid()),
400
				       LOCK_DIE_ON_ERROR);
401 402

	create_base_index();
403
	add_remove_files(&partial);
404
	refresh_cache(REFRESH_QUIET);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
405

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

	discard_cache();
	read_cache_from(false_lock.filename);

413
	return false_lock.filename;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
414 415
}

416 417
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
418
{
419 420
	unsigned char sha1[20];

421 422
	if (s->relative_paths)
		s->prefix = prefix;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
423 424

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

434
	wt_status_collect(s);
435 436 437

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

448
	return s->commitable;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
449 450
}

451 452 453 454 455 456 457 458
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
459 460
static const char sign_off_header[] = "Signed-off-by: ";

461
static void determine_author_info(struct strbuf *author_ident)
462 463 464 465 466 467 468
{
	char *name, *email, *date;

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

469
	if (use_message && !renew_authorship) {
470 471 472 473 474 475
		const char *a, *lb, *rb, *eol;

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

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

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

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

503 504
	if (force_date)
		date = force_date;
505 506
	strbuf_addstr(author_ident, fmt_ident(name, email, date,
					      IDENT_ERROR_ON_NO_NAME));
507 508
}

509 510 511 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
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;
}

550 551 552 553 554 555 556 557 558
static char *cut_ident_timestamp_part(char *string)
{
	char *ket = strrchr(string, '>');
	if (!ket || ket[1] != ' ')
		die("Malformed ident string: '%s'", string);
	*++ket = '\0';
	return ket;
}

559
static int prepare_to_commit(const char *index_file, const char *prefix,
560 561
			     struct wt_status *s,
			     struct strbuf *author_ident)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
562 563
{
	struct stat statbuf;
564
	struct strbuf committer_ident = STRBUF_INIT;
565
	int commitable, saved_color_setting;
566
	struct strbuf sb = STRBUF_INIT;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
567 568
	char *buffer;
	FILE *fp;
569 570
	const char *hook_arg1 = NULL;
	const char *hook_arg2 = NULL;
571
	int ident_shown = 0;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
572

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

576 577
	if (message.len) {
		strbuf_addbuf(&sb, &message);
578
		hook_arg1 = "message";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
579 580 581 582
	} else if (logfile && !strcmp(logfile, "-")) {
		if (isatty(0))
			fprintf(stderr, "(reading log message from standard input)\n");
		if (strbuf_read(&sb, 0, 0) < 0)
583
			die_errno("could not read log from standard input");
584
		hook_arg1 = "message";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
585 586
	} else if (logfile) {
		if (strbuf_read_file(&sb, logfile, 0) < 0)
587 588
			die_errno("could not read log file '%s'",
				  logfile);
589
		hook_arg1 = "message";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
590 591 592 593 594
	} 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));
595 596
		hook_arg1 = "commit";
		hook_arg2 = use_message;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
597 598
	} else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
		if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
599
			die_errno("could not read MERGE_MSG");
600
		hook_arg1 = "merge";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
601 602
	} else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
		if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
603
			die_errno("could not read SQUASH_MSG");
604
		hook_arg1 = "squash";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
605 606
	} else if (template_file && !stat(template_file, &statbuf)) {
		if (strbuf_read_file(&sb, template_file, 0) < 0)
607
			die_errno("could not read '%s'", template_file);
608
		hook_arg1 = "template";
Kristian Høgsberg's avatar
Kristian Høgsberg committed
609 610
	}

611 612 613 614 615 616 617
	/*
	 * 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
618 619
	fp = fopen(git_path(commit_editmsg), "w");
	if (fp == NULL)
620
		die_errno("could not open '%s'", git_path(commit_editmsg));
Kristian Høgsberg's avatar
Kristian Høgsberg committed
621

622 623
	if (cleanup_mode != CLEANUP_NONE)
		stripspace(&sb, 0);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
624 625

	if (signoff) {
626
		struct strbuf sob = STRBUF_INIT;
627 628 629
		int i;

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

643
	if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
644
		die_errno("could not write commit template");
645

Kristian Høgsberg's avatar
Kristian Høgsberg committed
646 647
	strbuf_release(&sb);

648 649
	/* This checks and barfs if author is badly specified */
	determine_author_info(author_ident);
650

651
	/* This checks if committer ident is explicitly given */
652
	strbuf_addstr(&committer_ident, git_committer_info(0));
653
	if (use_editor && include_status) {
654
		char *ai_tmp, *ci_tmp;
655 656 657 658 659 660 661 662 663 664 665 666
		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
667
			"# Please enter the commit message for your changes.");
668
		if (cleanup_mode == CLEANUP_ALL)
Jeff King's avatar
Jeff King committed
669 670 671 672
			fprintf(fp,
				" Lines starting\n"
				"# with '#' will be ignored, and an empty"
				" message aborts the commit.\n");
673
		else /* CLEANUP_SPACE, that is. */
Jeff King's avatar
Jeff King committed
674 675 676 677 678
			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");
679 680 681
		if (only_include_assumed)
			fprintf(fp, "# %s\n", only_include_assumed);

682 683 684
		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))
685
			fprintf(fp,
686 687 688
				"%s"
				"# Author:    %s\n",
				ident_shown++ ? "" : "#\n",
689
				author_ident->buf);
690

691
		if (!user_ident_sufficiently_given())
692 693 694 695
			fprintf(fp,
				"%s"
				"# Committer: %s\n",
				ident_shown++ ? "" : "#\n",
696
				committer_ident.buf);
697 698 699 700

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

701 702 703 704
		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;
705 706 707

		*ai_tmp = ' ';
		*ci_tmp = ' ';
708
	} else {
709
		unsigned char sha1[20];
710
		const char *parent = "HEAD";
711 712 713 714

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

715 716 717
		if (amend)
			parent = "HEAD^1";

718
		if (get_sha1(parent, sha1))
719
			commitable = !!active_nr;
720 721
		else
			commitable = index_differs_from(parent, 0);
722
	}
723
	strbuf_release(&committer_ident);
724

725
	fclose(fp);
726

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

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

750 751 752
	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
753

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

766 767 768 769
	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
770

771
	return 1;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
772 773 774
}

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

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

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

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

844 845 846 847 848 849 850 851 852 853 854 855 856 857 858

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

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

866 867
	argc = parse_options(argc, argv, prefix, builtin_commit_options, usage,
			     0);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
868

869 870 871
	if (force_author && !strchr(force_author, '>'))
		force_author = find_author_by_nickname(force_author);

872 873 874
	if (force_author && renew_authorship)
		die("Using both --reset-author and --author does not make sense");

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

	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)
889
		die("You are in the middle of a merge -- cannot amend.");
Kristian Høgsberg's avatar
Kristian Høgsberg committed
890 891 892 893 894 895 896 897 898

	if (use_message)
		f++;
	if (edit_message)
		f++;
	if (logfile)
		f++;
	if (f > 1)
		die("Only one of -c/-C/-F can be used.");
899
	if (message.len && f > 0)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
900 901 902
		die("Option -m cannot be combined with -c/-C/-F.");
	if (edit_message)
		use_message = edit_message;
903
	if (amend && !use_message)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
904
		use_message = "HEAD";
905 906
	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
907 908 909 910 911 912 913 914 915
	if (use_message) {
		unsigned char sha1[20];
		static char utf8[] = "UTF-8";
		const char *out_enc;
		char *enc, *end;
		struct commit *commit;

		if (get_sha1(use_message, sha1))
			die("could not lookup commit %s", use_message);
Junio C Hamano's avatar
Junio C Hamano committed
916
		commit = lookup_commit_reference(sha1);
Kristian Høgsberg's avatar
Kristian Høgsberg committed
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
		if (!commit || parse_commit(commit))
			die("could not parse commit %s", use_message);

		enc = strstr(commit->buffer, "\nencoding");
		if (enc) {
			end = strchr(enc + 10, '\n');
			enc = xstrndup(enc + 10, end - (enc + 10));
		} else {
			enc = utf8;
		}
		out_enc = git_commit_encoding ? git_commit_encoding : utf8;

		if (strcmp(out_enc, enc))
			use_message_buffer =
				reencode_string(commit->buffer, out_enc, 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 (use_message_buffer == NULL)
			use_message_buffer = xstrdup(commit->buffer);
		if (enc != utf8)
			free(enc);
	}

	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.";
951
	if (argc > 0 && !also && !only)
Kristian Høgsberg's avatar
Kristian Høgsberg committed
952
		only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
953 954 955 956 957 958 959 960 961 962
	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
963

964
	handle_untracked_files_arg(s);
965

Kristian Høgsberg's avatar
Kristian Høgsberg committed
966 967 968 969 970
	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.");

971 972 973 974 975
	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
976 977 978
	return argc;
}

979 980
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
981 982
{
	int commitable;
Junio C Hamano's avatar
Junio C Hamano committed
983
	const char *index_file;
Kristian Høgsberg's avatar
Kristian Høgsberg committed
984

Junio C Hamano's avatar
Junio C Hamano committed
985
	index_file = prepare_index(argc, argv, prefix, 1);
986
	commitable = run_status(stdout, index_file, prefix, 0, s);
Junio C Hamano's avatar
Junio C Hamano committed
987
	rollback_index_files();
Kristian Høgsberg's avatar
Kristian Høgsberg committed
988

Junio C Hamano's avatar
Junio C Hamano committed
989 990 991
	return commitable ? 0 : 1;
}

992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
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;
1007
	return -1;
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
}

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);
1027 1028
		if (slot < 0)
			return 0;
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
		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
1054 1055
int cmd_status(int argc, const char **argv, const char *prefix)
{
1056
	struct wt_status s;
1057
	int fd;
1058
	unsigned char sha1[20];
1059
	static struct option builtin_status_options[] = {
1060
		OPT__VERBOSE(&verbose),
1061 1062
		OPT_SET_INT('s', "short", &status_format,
			    "show status concisely", STATUS_FORMAT_SHORT),
1063 1064
		OPT_BOOLEAN('b', "branch", &status_show_branch,
			    "show branch information"),
1065 1066 1067
		OPT_SET_INT(0, "porcelain", &status_format,
			    "show porcelain output format",
			    STATUS_FORMAT_PORCELAIN),
1068 1069
		OPT_BOOLEAN('z', "null", &null_termination,
			    "terminate entries with NUL"),
1070 1071 1072 1073
		{ 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" },
1074 1075
		OPT_BOOLEAN(0, "ignored", &show_ignored_in_status,
			    "show ignored files"),
1076 1077 1078
		{ 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" },
1079 1080 1081
		OPT_END(),
	};

1082
	if (null_termination && status_format == STATUS_FORMAT_LONG)
1083
		status_format = STATUS_FORMAT_PORCELAIN;
1084 1085

	wt_status_prepare(&s);
1086
	gitmodules_config();
1087
	git_config(git_status_config, &s);
1088
	in_merge = file_exists(git_path("MERGE_HEAD"));
1089
	argc = parse_options(argc, argv, prefix,
1090 1091
			     builtin_status_options,
			     builtin_status_usage, 0);
1092
	handle_untracked_files_arg(&s);
1093 1094
	if (show_ignored_in_status)
		s.show_ignored_files = 1;
1095 1096 1097
	if (*argv)
		s.pathspec = get_pathspec(prefix, argv);

1098
	read_cache_preload(s.pathspec);
1099
	refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, s.pathspec, NULL, NULL);
1100 1101 1102

	fd = hold_locked_index(&index_lock, 0);
	if (0 <= fd) {
1103 1104
		if (active_cache_changed &&
		    !write_cache(fd, active_cache, active_nr))
1105
			commit_locked_index(&index_lock);
1106 1107
		else
			rollback_lock_file(&index_lock);
1108 1109
	}

1110
	s.is_initial = get_sha1(s.reference, sha1) ? 1 : 0;
1111
	s.in_merge = in_merge;
1112
	s.ignore_submodule_arg = ignore_submodule_arg;
1113 1114
	wt_status_collect(&s);

1115 1116
	if (s.relative_paths)
		s.prefix = prefix;
1117 1118
	if (s.use_color == -1)
		s.use_color = git_use_color_default;
1119 1120 1121
	if (diff_use_color_default == -1)
		diff_use_color_default = git_use_color_default;

1122 1123
	switch (status_format) {
	case STATUS_FORMAT_SHORT:
1124
		wt_shortstatus_print(&s, null_termination, status_show_branch);
1125
		break;
1126
	case STATUS_FORMAT_PORCELAIN:
1127
		wt_porcelain_print(&s, null_termination);
1128
		break;
1129
	case STATUS_FORMAT_LONG:
1130
		s.verbose = verbose;
1131
		s.ignore_submodule_arg = ignore_submodule_arg;
1132
		wt_status_print(&s);
1133
		break;