builtin-log.c 29.3 KB
Newer Older
1 2 3 4 5 6 7
/*
 * Builtin "git log" and related commands (show, whatchanged)
 *
 * (C) Copyright 2006 Linus Torvalds
 *		 2006 Junio Hamano
 */
#include "cache.h"
8
#include "color.h"
9 10 11 12
#include "commit.h"
#include "diff.h"
#include "revision.h"
#include "log-tree.h"
13
#include "builtin.h"
14
#include "tag.h"
L
Linus Torvalds 已提交
15
#include "reflog-walk.h"
16
#include "patch-ids.h"
17
#include "refs.h"
18
#include "run-command.h"
19
#include "shortlog.h"
20

H
Heikki Orsila 已提交
21 22 23
/* Set a default date-time format for git log ("log.date" config variable) */
static const char *default_date_mode = NULL;

24
static int default_show_root = 1;
25
static const char *fmt_patch_subject_prefix = "PATCH";
26
static const char *fmt_pretty;
27

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
static void add_name_decoration(const char *prefix, const char *name, struct object *obj)
{
	int plen = strlen(prefix);
	int nlen = strlen(name);
	struct name_decoration *res = xmalloc(sizeof(struct name_decoration) + plen + nlen);
	memcpy(res->name, prefix, plen);
	memcpy(res->name + plen, name, nlen + 1);
	res->next = add_decoration(&name_decoration, obj, res);
}

static int add_ref_decoration(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
{
	struct object *obj = parse_object(sha1);
	if (!obj)
		return 0;
	add_name_decoration("", refname, obj);
	while (obj->type == OBJ_TAG) {
		obj = ((struct tag *)obj)->tagged;
		if (!obj)
			break;
		add_name_decoration("tag: ", refname, obj);
	}
	return 0;
}

53
static void cmd_log_init(int argc, const char **argv, const char *prefix,
54 55
		      struct rev_info *rev)
{
J
Junio C Hamano 已提交
56
	int i;
57
	int decorate = 0;
J
Junio C Hamano 已提交
58

59 60
	rev->abbrev = DEFAULT_ABBREV;
	rev->commit_format = CMIT_FMT_DEFAULT;
61
	if (fmt_pretty)
62
		get_commit_format(fmt_pretty, rev);
63
	rev->verbose_header = 1;
64
	DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
65
	rev->show_root_diff = default_show_root;
66
	rev->subject_prefix = fmt_patch_subject_prefix;
H
Heikki Orsila 已提交
67 68 69 70

	if (default_date_mode)
		rev->date_mode = parse_date_format(default_date_mode);

71
	argc = setup_revisions(argc, argv, rev, "HEAD");
H
Heikki Orsila 已提交
72

73 74
	if (rev->diffopt.pickaxe || rev->diffopt.filter)
		rev->always_show_header = 0;
75
	if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
76 77 78 79
		rev->always_show_header = 0;
		if (rev->diffopt.nr_paths != 1)
			usage("git logs can only follow renames on one pathname at a time");
	}
J
Junio C Hamano 已提交
80 81
	for (i = 1; i < argc; i++) {
		const char *arg = argv[i];
82
		if (!strcmp(arg, "--decorate")) {
83 84 85 86
			if (!decorate)
				for_each_ref(add_ref_decoration, NULL);
			decorate = 1;
		} else
J
Junio C Hamano 已提交
87 88
			die("unrecognized argument: %s", arg);
	}
89 90
}

L
Linus Torvalds 已提交
91 92 93 94 95 96 97 98 99 100 101 102
/*
 * This gives a rough estimate for how many commits we
 * will print out in the list.
 */
static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
{
	int n = 0;

	while (list) {
		struct commit *commit = list->item;
		unsigned int flags = commit->object.flags;
		list = list->next;
103
		if (!(flags & (TREESAME | UNINTERESTING)))
L
Linus Torvalds 已提交
104
			n++;
L
Linus Torvalds 已提交
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
	}
	return n;
}

static void show_early_header(struct rev_info *rev, const char *stage, int nr)
{
	if (rev->shown_one) {
		rev->shown_one = 0;
		if (rev->commit_format != CMIT_FMT_ONELINE)
			putchar(rev->diffopt.line_termination);
	}
	printf("Final output: %d %s\n", nr, stage);
}

struct itimerval early_output_timer;

121 122 123
static void log_show_early(struct rev_info *revs, struct commit_list *list)
{
	int i = revs->early_output;
L
Linus Torvalds 已提交
124
	int show_header = 1;
125 126 127 128

	sort_in_topological_order(&list, revs->lifo);
	while (list && i) {
		struct commit *commit = list->item;
L
Linus Torvalds 已提交
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
		switch (simplify_commit(revs, commit)) {
		case commit_show:
			if (show_header) {
				int n = estimate_commit_count(revs, list);
				show_early_header(revs, "incomplete", n);
				show_header = 0;
			}
			log_tree_commit(revs, commit);
			i--;
			break;
		case commit_ignore:
			break;
		case commit_error:
			return;
		}
144 145
		list = list->next;
	}
L
Linus Torvalds 已提交
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163

	/* Did we already get enough commits for the early output? */
	if (!i)
		return;

	/*
	 * ..if no, then repeat it twice a second until we
	 * do.
	 *
	 * NOTE! We don't use "it_interval", because if the
	 * reader isn't listening, we want our output to be
	 * throttled by the writing, and not have the timer
	 * trigger every second even if we're blocked on a
	 * reader!
	 */
	early_output_timer.it_value.tv_sec = 0;
	early_output_timer.it_value.tv_usec = 500000;
	setitimer(ITIMER_REAL, &early_output_timer, NULL);
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
}

static void early_output(int signal)
{
	show_early_output = log_show_early;
}

static void setup_early_output(struct rev_info *rev)
{
	struct sigaction sa;

	/*
	 * Set up the signal handler, minimally intrusively:
	 * we only set a single volatile integer word (not
	 * using sigatomic_t - trying to avoid unnecessary
	 * system dependencies and headers), and using
	 * SA_RESTART.
	 */
	memset(&sa, 0, sizeof(sa));
	sa.sa_handler = early_output;
	sigemptyset(&sa.sa_mask);
	sa.sa_flags = SA_RESTART;
	sigaction(SIGALRM, &sa, NULL);

	/*
	 * If we can get the whole output in less than a
	 * tenth of a second, don't even bother doing the
	 * early-output thing..
	 *
	 * This is a one-time-only trigger.
	 */
L
Linus Torvalds 已提交
195 196 197
	early_output_timer.it_value.tv_sec = 0;
	early_output_timer.it_value.tv_usec = 100000;
	setitimer(ITIMER_REAL, &early_output_timer, NULL);
198 199 200 201
}

static void finish_early_output(struct rev_info *rev)
{
L
Linus Torvalds 已提交
202
	int n = estimate_commit_count(rev, rev->commits);
203
	signal(SIGALRM, SIG_IGN);
L
Linus Torvalds 已提交
204
	show_early_header(rev, "done", n);
205 206
}

207 208 209
static int cmd_log_walk(struct rev_info *rev)
{
	struct commit *commit;
210

211 212 213
	if (rev->early_output)
		setup_early_output(rev);

214 215
	if (prepare_revision_walk(rev))
		die("revision walk setup failed");
216 217 218 219

	if (rev->early_output)
		finish_early_output(rev);

220 221
	while ((commit = get_revision(rev)) != NULL) {
		log_tree_commit(rev, commit);
222 223 224 225 226
		if (!rev->reflog_info) {
			/* we allow cycles in reflog ancestry */
			free(commit->buffer);
			commit->buffer = NULL;
		}
L
Linus Torvalds 已提交
227 228
		free_commit_list(commit->parents);
		commit->parents = NULL;
229 230 231 232
	}
	return 0;
}

233
static int git_log_config(const char *var, const char *value, void *cb)
234
{
235 236
	if (!strcmp(var, "format.pretty"))
		return git_config_string(&fmt_pretty, var, value);
237 238
	if (!strcmp(var, "format.subjectprefix")) {
		if (!value)
239
			config_error_nonbool(var);
240 241 242
		fmt_patch_subject_prefix = xstrdup(value);
		return 0;
	}
H
Heikki Orsila 已提交
243 244
	if (!strcmp(var, "log.date"))
		return git_config_string(&default_date_mode, var, value);
245 246 247 248
	if (!strcmp(var, "log.showroot")) {
		default_show_root = git_config_bool(var, value);
		return 0;
	}
249
	return git_diff_ui_config(var, value, cb);
250 251
}

252
int cmd_whatchanged(int argc, const char **argv, const char *prefix)
253 254 255
{
	struct rev_info rev;

256
	git_config(git_log_config, NULL);
257 258 259 260

	if (diff_use_color_default == -1)
		diff_use_color_default = git_use_color_default;

261
	init_revisions(&rev, prefix);
262
	rev.diff = 1;
L
Linus Torvalds 已提交
263
	rev.simplify_history = 0;
264
	cmd_log_init(argc, argv, prefix, &rev);
265 266 267
	if (!rev.diffopt.output_format)
		rev.diffopt.output_format = DIFF_FORMAT_RAW;
	return cmd_log_walk(&rev);
268 269
}

270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
static void show_tagger(char *buf, int len, struct rev_info *rev)
{
	char *email_end, *p;
	unsigned long date;
	int tz;

	email_end = memchr(buf, '>', len);
	if (!email_end)
		return;
	p = ++email_end;
	while (isspace(*p))
		p++;
	date = strtoul(p, &p, 10);
	while (isspace(*p))
		p++;
	tz = (int)strtol(p, NULL, 10);
	printf("Tagger: %.*s\nDate:   %s\n", (int)(email_end - buf), buf,
	       show_date(date, tz, rev->date_mode));
}

static int show_object(const unsigned char *sha1, int show_tag_object,
	struct rev_info *rev)
292 293
{
	unsigned long size;
294 295
	enum object_type type;
	char *buf = read_sha1_file(sha1, &type, &size);
296 297 298 299 300
	int offset = 0;

	if (!buf)
		return error("Could not read object %s", sha1_to_hex(sha1));

301 302 303
	if (show_tag_object)
		while (offset < size && buf[offset] != '\n') {
			int new_offset = offset + 1;
304 305
			while (new_offset < size && buf[new_offset++] != '\n')
				; /* do nothing */
306 307 308
			if (!prefixcmp(buf + offset, "tagger "))
				show_tagger(buf + offset + 7,
					    new_offset - offset - 7, rev);
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
			offset = new_offset;
		}

	if (offset < size)
		fwrite(buf + offset, size - offset, 1, stdout);
	free(buf);
	return 0;
}

static int show_tree_object(const unsigned char *sha1,
		const char *base, int baselen,
		const char *pathname, unsigned mode, int stage)
{
	printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
	return 0;
}

326
int cmd_show(int argc, const char **argv, const char *prefix)
327 328
{
	struct rev_info rev;
329 330
	struct object_array_entry *objects;
	int i, count, ret = 0;
331

332
	git_config(git_log_config, NULL);
333 334 335 336

	if (diff_use_color_default == -1)
		diff_use_color_default = git_use_color_default;

337
	init_revisions(&rev, prefix);
338 339 340 341 342 343
	rev.diff = 1;
	rev.combine_merges = 1;
	rev.dense_combined_merges = 1;
	rev.always_show_header = 1;
	rev.ignore_merges = 0;
	rev.no_walk = 1;
344
	cmd_log_init(argc, argv, prefix, &rev);
345 346 347 348 349 350 351 352

	count = rev.pending.nr;
	objects = rev.pending.objects;
	for (i = 0; i < count && !ret; i++) {
		struct object *o = objects[i].item;
		const char *name = objects[i].name;
		switch (o->type) {
		case OBJ_BLOB:
353
			ret = show_object(o->sha1, 0, NULL);
354 355 356 357
			break;
		case OBJ_TAG: {
			struct tag *t = (struct tag *)o;

358
			printf("%stag %s%s\n",
359
					diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
360
					t->tag,
361
					diff_get_color_opt(&rev.diffopt, DIFF_RESET));
362
			ret = show_object(o->sha1, 1, &rev);
363
			objects[i].item = parse_object(t->tagged->sha1);
364 365 366 367 368
			i--;
			break;
		}
		case OBJ_TREE:
			printf("%stree %s%s\n\n",
369
					diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
370
					name,
371
					diff_get_color_opt(&rev.diffopt, DIFF_RESET));
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
			read_tree_recursive((struct tree *)o, "", 0, 0, NULL,
					show_tree_object);
			break;
		case OBJ_COMMIT:
			rev.pending.nr = rev.pending.alloc = 0;
			rev.pending.objects = NULL;
			add_object_array(o, name, &rev.pending);
			ret = cmd_log_walk(&rev);
			break;
		default:
			ret = error("Unknown type: %d", o->type);
		}
	}
	free(objects);
	return ret;
387 388
}

L
Linus Torvalds 已提交
389 390 391 392 393 394 395
/*
 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
 */
int cmd_log_reflog(int argc, const char **argv, const char *prefix)
{
	struct rev_info rev;

396
	git_config(git_log_config, NULL);
397 398 399 400

	if (diff_use_color_default == -1)
		diff_use_color_default = git_use_color_default;

L
Linus Torvalds 已提交
401 402 403 404 405 406 407 408 409 410 411 412
	init_revisions(&rev, prefix);
	init_reflog_walk(&rev.reflog_info);
	rev.abbrev_commit = 1;
	rev.verbose_header = 1;
	cmd_log_init(argc, argv, prefix, &rev);

	/*
	 * This means that we override whatever commit format the user gave
	 * on the cmd line.  Sad, but cmd_log_init() currently doesn't
	 * allow us to set a different default.
	 */
	rev.commit_format = CMIT_FMT_ONELINE;
413
	rev.use_terminator = 1;
L
Linus Torvalds 已提交
414 415 416 417 418 419 420 421 422 423 424
	rev.always_show_header = 1;

	/*
	 * We get called through "git reflog", so unlike the other log
	 * routines, we need to set up our pager manually..
	 */
	setup_pager();

	return cmd_log_walk(&rev);
}

425
int cmd_log(int argc, const char **argv, const char *prefix)
426 427 428
{
	struct rev_info rev;

429
	git_config(git_log_config, NULL);
430 431 432 433

	if (diff_use_color_default == -1)
		diff_use_color_default = git_use_color_default;

434
	init_revisions(&rev, prefix);
435
	rev.always_show_header = 1;
436
	cmd_log_init(argc, argv, prefix, &rev);
437
	return cmd_log_walk(&rev);
438
}
439

440 441 442
/* format-patch */
#define FORMAT_PATCH_NAME_MAX 64

443 444 445 446 447 448
static int istitlechar(char c)
{
	return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
		(c >= '0' && c <= '9') || c == '.' || c == '_';
}

449
static const char *fmt_patch_suffix = ".patch";
450 451
static int numbered = 0;
static int auto_number = 0;
452

D
Daniel Barkalow 已提交
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
static char **extra_hdr;
static int extra_hdr_nr;
static int extra_hdr_alloc;

static char **extra_to;
static int extra_to_nr;
static int extra_to_alloc;

static char **extra_cc;
static int extra_cc_nr;
static int extra_cc_alloc;

static void add_header(const char *value)
{
	int len = strlen(value);
	while (value[len - 1] == '\n')
		len--;
	if (!strncasecmp(value, "to: ", 4)) {
		ALLOC_GROW(extra_to, extra_to_nr + 1, extra_to_alloc);
		extra_to[extra_to_nr++] = xstrndup(value + 4, len - 4);
		return;
	}
	if (!strncasecmp(value, "cc: ", 4)) {
		ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
		extra_cc[extra_cc_nr++] = xstrndup(value + 4, len - 4);
		return;
	}
	ALLOC_GROW(extra_hdr, extra_hdr_nr + 1, extra_hdr_alloc);
	extra_hdr[extra_hdr_nr++] = xstrndup(value, len);
}

484
static int git_format_config(const char *var, const char *value, void *cb)
485 486
{
	if (!strcmp(var, "format.headers")) {
487 488
		if (!value)
			die("format.headers without value");
D
Daniel Barkalow 已提交
489
		add_header(value);
490 491
		return 0;
	}
492 493
	if (!strcmp(var, "format.suffix")) {
		if (!value)
494
			return config_error_nonbool(var);
495 496 497
		fmt_patch_suffix = xstrdup(value);
		return 0;
	}
498 499 500 501 502 503 504
	if (!strcmp(var, "format.cc")) {
		if (!value)
			return config_error_nonbool(var);
		ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
		extra_cc[extra_cc_nr++] = xstrdup(value);
		return 0;
	}
505
	if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff")) {
506 507
		return 0;
	}
508
	if (!strcmp(var, "format.numbered")) {
509
		if (value && !strcasecmp(value, "auto")) {
510 511 512 513 514 515
			auto_number = 1;
			return 0;
		}
		numbered = git_config_bool(var, value);
		return 0;
	}
516

517
	return git_log_config(var, value, cb);
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 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
static const char *get_oneline_for_filename(struct commit *commit,
					    int keep_subject)
{
	static char filename[PATH_MAX];
	char *sol;
	int len = 0;
	int suffix_len = strlen(fmt_patch_suffix) + 1;

	sol = strstr(commit->buffer, "\n\n");
	if (!sol)
		filename[0] = '\0';
	else {
		int j, space = 0;

		sol += 2;
		/* strip [PATCH] or [PATCH blabla] */
		if (!keep_subject && !prefixcmp(sol, "[PATCH")) {
			char *eos = strchr(sol + 6, ']');
			if (eos) {
				while (isspace(*eos))
					eos++;
				sol = eos;
			}
		}

		for (j = 0;
		     j < FORMAT_PATCH_NAME_MAX - suffix_len - 5 &&
			     len < sizeof(filename) - suffix_len &&
			     sol[j] && sol[j] != '\n';
		     j++) {
			if (istitlechar(sol[j])) {
				if (space) {
					filename[len++] = '-';
					space = 0;
				}
				filename[len++] = sol[j];
				if (sol[j] == '.')
					while (sol[j + 1] == '.')
						j++;
			} else
				space = 1;
		}
		while (filename[len - 1] == '.'
		       || filename[len - 1] == '-')
			len--;
		filename[len] = '\0';
	}
	return filename;
}

571
static FILE *realstdout = NULL;
572
static const char *output_directory = NULL;
573

574
static int reopen_stdout(const char *oneline, int nr, int total)
575
{
576
	char filename[PATH_MAX];
577
	int len = 0;
578
	int suffix_len = strlen(fmt_patch_suffix) + 1;
579

580
	if (output_directory) {
581 582 583
		len = snprintf(filename, sizeof(filename), "%s",
				output_directory);
		if (len >=
584 585
		    sizeof(filename) - FORMAT_PATCH_NAME_MAX - suffix_len)
			return error("name of output directory is too long");
586 587 588
		if (filename[len - 1] != '/')
			filename[len++] = '/';
	}
589

590 591 592 593 594 595
	if (!oneline)
		len += sprintf(filename + len, "%d", nr);
	else {
		len += sprintf(filename + len, "%04d-", nr);
		len += snprintf(filename + len, sizeof(filename) - len - 1
				- suffix_len, "%s", oneline);
596
		strcpy(filename + len, fmt_patch_suffix);
597
	}
598

599
	fprintf(realstdout, "%s\n", filename);
600 601 602
	if (freopen(filename, "w", stdout) == NULL)
		return error("Cannot open patch file %s",filename);

603
	return 0;
604 605
}

606
static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids, const char *prefix)
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
{
	struct rev_info check_rev;
	struct commit *commit;
	struct object *o1, *o2;
	unsigned flags1, flags2;

	if (rev->pending.nr != 2)
		die("Need exactly one range.");

	o1 = rev->pending.objects[0].item;
	flags1 = o1->flags;
	o2 = rev->pending.objects[1].item;
	flags2 = o2->flags;

	if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
		die("Not a range.");

624
	init_patch_ids(ids);
625 626

	/* given a range a..b get all patch ids for b..a */
627
	init_revisions(&check_rev, prefix);
628 629 630 631
	o1->flags ^= UNINTERESTING;
	o2->flags ^= UNINTERESTING;
	add_pending_object(&check_rev, o1, "o1");
	add_pending_object(&check_rev, o2, "o2");
632 633
	if (prepare_revision_walk(&check_rev))
		die("revision walk setup failed");
634 635 636 637 638 639

	while ((commit = get_revision(&check_rev)) != NULL) {
		/* ignore merges */
		if (commit->parents && commit->parents->next)
			continue;

640
		add_commit_patch_id(commit, ids);
641 642 643
	}

	/* reset for next revision walk */
644 645 646 647
	clear_commit_marks((struct commit *)o1,
			SEEN | UNINTERESTING | SHOWN | ADDED);
	clear_commit_marks((struct commit *)o2,
			SEEN | UNINTERESTING | SHOWN | ADDED);
648 649 650 651
	o1->flags = flags1;
	o2->flags = flags2;
}

652
static void gen_message_id(struct rev_info *info, char *base)
653
{
654
	const char *committer = git_committer_info(IDENT_WARN_ON_NO_NAME);
655 656
	const char *email_start = strrchr(committer, '<');
	const char *email_end = strrchr(committer, '>');
657 658
	struct strbuf buf;
	if (!email_start || !email_end || email_start > email_end - 1)
659
		die("Could not extract email from committer identity.");
660 661 662 663 664
	strbuf_init(&buf, 0);
	strbuf_addf(&buf, "%s.%lu.git.%.*s", base,
		    (unsigned long) time(NULL),
		    (int)(email_end - email_start - 1), email_start + 1);
	info->message_id = strbuf_detach(&buf, NULL);
665 666
}

667 668 669 670
static void make_cover_letter(struct rev_info *rev, int use_stdout,
			      int numbered, int numbered_files,
			      struct commit *origin,
			      int nr, struct commit **list, struct commit *head)
671 672
{
	const char *committer;
673
	char *head_sha1;
674 675 676 677
	const char *subject_start = NULL;
	const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
	const char *msg;
	const char *extra_headers = rev->extra_headers;
678
	struct shortlog log;
679
	struct strbuf sb;
680
	int i;
681
	const char *encoding = "utf-8";
682
	struct diff_options opts;
J
Junio C Hamano 已提交
683
	int need_8bit_cte = 0;
684 685 686 687 688 689 690 691 692 693

	if (rev->commit_format != CMIT_FMT_EMAIL)
		die("Cover letter needs email format");

	if (!use_stdout && reopen_stdout(numbered_files ?
				NULL : "cover-letter", 0, rev->total))
		return;

	head_sha1 = sha1_to_hex(head->object.sha1);

J
Junio C Hamano 已提交
694 695
	log_write_email_headers(rev, head_sha1, &subject_start, &extra_headers,
				&need_8bit_cte);
696 697 698 699 700 701 702 703

	committer = git_committer_info(0);

	msg = body;
	strbuf_init(&sb, 0);
	pp_user_info(NULL, CMIT_FMT_EMAIL, &sb, committer, DATE_RFC2822,
		     encoding);
	pp_title_line(CMIT_FMT_EMAIL, &msg, &sb, subject_start, extra_headers,
J
Junio C Hamano 已提交
704
		      encoding, need_8bit_cte);
705 706 707 708 709
	pp_remainder(CMIT_FMT_EMAIL, &msg, &sb, 0);
	printf("%s\n", sb.buf);

	strbuf_release(&sb);

710
	shortlog_init(&log);
711 712 713 714
	log.wrap_lines = 1;
	log.wrap = 72;
	log.in1 = 2;
	log.in2 = 4;
715 716 717 718 719
	for (i = 0; i < nr; i++)
		shortlog_add_commit(&log, list[i]);

	shortlog_output(&log);

720
	/*
721
	 * We can only do diffstat with a unique reference point
722 723 724 725
	 */
	if (!origin)
		return;

726 727
	memcpy(&opts, &rev->diffopt, sizeof(opts));
	opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
728

729 730 731 732 733 734 735
	diff_setup_done(&opts);

	diff_tree_sha1(origin->tree->object.sha1,
		       head->tree->object.sha1,
		       "", &opts);
	diffcore_std(&opts);
	diff_flush(&opts);
736 737

	printf("\n");
738 739
}

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
static const char *clean_message_id(const char *msg_id)
{
	char ch;
	const char *a, *z, *m;

	m = msg_id;
	while ((ch = *m) && (isspace(ch) || (ch == '<')))
		m++;
	a = m;
	z = NULL;
	while ((ch = *m)) {
		if (!isspace(ch) && (ch != '>'))
			z = m;
		m++;
	}
	if (!z)
		die("insane in-reply-to: %s", msg_id);
	if (++z == m)
		return a;
P
Pierre Habouzit 已提交
759
	return xmemdupz(a, z - a);
760 761
}

762
int cmd_format_patch(int argc, const char **argv, const char *prefix)
763 764 765 766
{
	struct commit *commit;
	struct commit **list = NULL;
	struct rev_info rev;
767
	int nr = 0, total, i, j;
768
	int use_stdout = 0;
769
	int start_number = -1;
770
	int keep_subject = 0;
771
	int numbered_files = 0;		/* _just_ numbers */
772
	int subject_prefix = 0;
773
	int ignore_if_in_upstream = 0;
774
	int thread = 0;
775
	int cover_letter = 0;
776
	int boundary_count = 0;
777
	int no_binary_diff = 0;
778
	struct commit *origin = NULL, *head = NULL;
779
	const char *in_reply_to = NULL;
780
	struct patch_ids ids;
J
Junio C Hamano 已提交
781
	char *add_signoff = NULL;
D
Daniel Barkalow 已提交
782
	struct strbuf buf;
783

784
	git_config(git_format_config, NULL);
785
	init_revisions(&rev, prefix);
786 787 788 789 790
	rev.commit_format = CMIT_FMT_EMAIL;
	rev.verbose_header = 1;
	rev.diff = 1;
	rev.combine_merges = 0;
	rev.ignore_merges = 1;
791
	DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
792

793
	rev.subject_prefix = fmt_patch_subject_prefix;
794

795 796
	/*
	 * Parse the arguments before setup_revisions(), or something
797
	 * like "git format-patch -o a123 HEAD^.." may fail; a123 is
798 799 800 801
	 * possibly a valid SHA1.
	 */
	for (i = 1, j = 1; i < argc; i++) {
		if (!strcmp(argv[i], "--stdout"))
802
			use_stdout = 1;
803 804 805
		else if (!strcmp(argv[i], "-n") ||
				!strcmp(argv[i], "--numbered"))
			numbered = 1;
806 807 808 809 810
		else if (!strcmp(argv[i], "-N") ||
				!strcmp(argv[i], "--no-numbered")) {
			numbered = 0;
			auto_number = 0;
		}
811
		else if (!prefixcmp(argv[i], "--start-number="))
812
			start_number = strtol(argv[i] + 15, NULL, 10);
813 814
		else if (!strcmp(argv[i], "--numbered-files"))
			numbered_files = 1;
815 816 817 818 819
		else if (!strcmp(argv[i], "--start-number")) {
			i++;
			if (i == argc)
				die("Need a number for --start-number");
			start_number = strtol(argv[i], NULL, 10);
J
Junio C Hamano 已提交
820
		}
821 822 823 824
		else if (!prefixcmp(argv[i], "--cc=")) {
			ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
			extra_cc[extra_cc_nr++] = xstrdup(argv[i] + 5);
		}
J
Junio C Hamano 已提交
825
		else if (!strcmp(argv[i], "-k") ||
826 827 828
				!strcmp(argv[i], "--keep-subject")) {
			keep_subject = 1;
			rev.total = -1;
J
Junio C Hamano 已提交
829
		}
830 831
		else if (!strcmp(argv[i], "--output-directory") ||
			 !strcmp(argv[i], "-o")) {
832
			i++;
833 834 835 836 837
			if (argc <= i)
				die("Which directory?");
			if (output_directory)
				die("Two output directories?");
			output_directory = argv[i];
838
		}
J
Junio C Hamano 已提交
839 840
		else if (!strcmp(argv[i], "--signoff") ||
			 !strcmp(argv[i], "-s")) {
E
Eric W. Biederman 已提交
841 842
			const char *committer;
			const char *endpos;
843
			committer = git_committer_info(IDENT_ERROR_ON_NO_NAME);
E
Eric W. Biederman 已提交
844
			endpos = strchr(committer, '>');
J
Junio C Hamano 已提交
845 846
			if (!endpos)
				die("bogos committer info %s\n", committer);
P
Pierre Habouzit 已提交
847
			add_signoff = xmemdupz(committer, endpos - committer + 1);
J
Junio C Hamano 已提交
848
		}
849
		else if (!strcmp(argv[i], "--attach")) {
850
			rev.mime_boundary = git_version_string;
851 852 853 854 855 856 857 858 859 860 861
			rev.no_inline = 1;
		}
		else if (!prefixcmp(argv[i], "--attach=")) {
			rev.mime_boundary = argv[i] + 9;
			rev.no_inline = 1;
		}
		else if (!strcmp(argv[i], "--inline")) {
			rev.mime_boundary = git_version_string;
			rev.no_inline = 0;
		}
		else if (!prefixcmp(argv[i], "--inline=")) {
862
			rev.mime_boundary = argv[i] + 9;
863 864
			rev.no_inline = 0;
		}
865 866
		else if (!strcmp(argv[i], "--ignore-if-in-upstream"))
			ignore_if_in_upstream = 1;
867 868
		else if (!strcmp(argv[i], "--thread"))
			thread = 1;
869
		else if (!prefixcmp(argv[i], "--in-reply-to="))
870 871 872 873 874 875
			in_reply_to = argv[i] + 14;
		else if (!strcmp(argv[i], "--in-reply-to")) {
			i++;
			if (i == argc)
				die("Need a Message-Id for --in-reply-to");
			in_reply_to = argv[i];
876 877 878 879
		} else if (!prefixcmp(argv[i], "--subject-prefix=")) {
			subject_prefix = 1;
			rev.subject_prefix = argv[i] + 17;
		} else if (!prefixcmp(argv[i], "--suffix="))
880
			fmt_patch_suffix = argv[i] + 9;
881 882
		else if (!strcmp(argv[i], "--cover-letter"))
			cover_letter = 1;
883 884
		else if (!strcmp(argv[i], "--no-binary"))
			no_binary_diff = 1;
885
		else
886
			argv[j++] = argv[i];
887
	}
888 889
	argc = j;

D
Daniel Barkalow 已提交
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
	strbuf_init(&buf, 0);

	for (i = 0; i < extra_hdr_nr; i++) {
		strbuf_addstr(&buf, extra_hdr[i]);
		strbuf_addch(&buf, '\n');
	}

	if (extra_to_nr)
		strbuf_addstr(&buf, "To: ");
	for (i = 0; i < extra_to_nr; i++) {
		if (i)
			strbuf_addstr(&buf, "    ");
		strbuf_addstr(&buf, extra_to[i]);
		if (i + 1 < extra_to_nr)
			strbuf_addch(&buf, ',');
		strbuf_addch(&buf, '\n');
	}

	if (extra_cc_nr)
		strbuf_addstr(&buf, "Cc: ");
	for (i = 0; i < extra_cc_nr; i++) {
		if (i)
			strbuf_addstr(&buf, "    ");
		strbuf_addstr(&buf, extra_cc[i]);
		if (i + 1 < extra_cc_nr)
			strbuf_addch(&buf, ',');
		strbuf_addch(&buf, '\n');
	}

	rev.extra_headers = strbuf_detach(&buf, 0);

921
	if (start_number < 0)
922
		start_number = 1;
923
	if (numbered && keep_subject)
924
		die ("-n and -k are mutually exclusive.");
925 926
	if (keep_subject && subject_prefix)
		die ("--subject-prefix and -k are mutually exclusive.");
927 928
	if (numbered_files && use_stdout)
		die ("--numbered-files and --stdout are mutually exclusive.");
929

930 931 932
	argc = setup_revisions(argc, argv, &rev, "HEAD");
	if (argc > 1)
		die ("unrecognized argument: %s", argv[1]);
933

934
	if (!rev.diffopt.output_format)
935
		rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY | DIFF_FORMAT_PATCH;
936

937
	if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
938
		DIFF_OPT_SET(&rev.diffopt, BINARY);
939

940
	if (!output_directory && !use_stdout)
941 942
		output_directory = prefix;

943 944 945 946 947 948 949 950
	if (output_directory) {
		if (use_stdout)
			die("standard output, or directory, which one?");
		if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
			die("Could not create directory %s",
			    output_directory);
	}

951
	if (rev.pending.nr == 1) {
952 953 954 955 956 957
		if (rev.max_count < 0 && !rev.show_root_diff) {
			/*
			 * This is traditional behaviour of "git format-patch
			 * origin" that prepares what the origin side still
			 * does not have.
			 */
J
Junio C Hamano 已提交
958
			rev.pending.objects[0].item->flags |= UNINTERESTING;
959
			add_head_to_pending(&rev);
J
Junio C Hamano 已提交
960
		}
961 962 963 964
		/*
		 * Otherwise, it is "format-patch -22 HEAD", and/or
		 * "format-patch --root HEAD".  The user wants
		 * get_revision() to do the usual traversal.
J
Junio C Hamano 已提交
965
		 */
966
	}
967 968 969 970 971
	if (cover_letter) {
		/* remember the range */
		int i;
		for (i = 0; i < rev.pending.nr; i++) {
			struct object *o = rev.pending.objects[i].item;
972
			if (!(o->flags & UNINTERESTING))
973 974 975 976 977 978
				head = (struct commit *)o;
		}
		/* We can't generate a cover letter without any patches */
		if (!head)
			return 0;
	}
979

980
	if (ignore_if_in_upstream)
981
		get_patch_ids(&rev, &ids, prefix);
982

983
	if (!use_stdout)
984
		realstdout = xfdopen(xdup(1), "w");
985

986 987
	if (prepare_revision_walk(&rev))
		die("revision walk setup failed");
988
	rev.boundary = 1;
989
	while ((commit = get_revision(&rev)) != NULL) {
990 991 992 993 994 995
		if (commit->object.flags & BOUNDARY) {
			boundary_count++;
			origin = (boundary_count == 1) ? commit : NULL;
			continue;
		}

996 997 998
		/* ignore merges */
		if (commit->parents && commit->parents->next)
			continue;
999 1000

		if (ignore_if_in_upstream &&
1001
				has_commit_patch_id(commit, &ids))
1002 1003
			continue;

1004
		nr++;
J
Jonas Fonseca 已提交
1005
		list = xrealloc(list, nr * sizeof(list[0]));
1006 1007
		list[nr - 1] = commit;
	}
1008
	total = nr;
1009 1010
	if (!keep_subject && auto_number && total > 1)
		numbered = 1;
1011
	if (numbered)
1012
		rev.total = total + start_number - 1;
1013 1014
	if (in_reply_to)
		rev.ref_message_id = clean_message_id(in_reply_to);
1015 1016 1017 1018
	if (cover_letter) {
		if (thread)
			gen_message_id(&rev, "cover");
		make_cover_letter(&rev, use_stdout, numbered, numbered_files,
1019
				  origin, nr, list, head);
1020 1021 1022 1023
		total++;
		start_number--;
	}
	rev.add_signoff = add_signoff;
1024 1025 1026
	while (0 <= --nr) {
		int shown;
		commit = list[nr];
1027
		rev.nr = total - nr + (start_number - 1);
1028
		/* Make the second and subsequent mails replies to the first */
1029
		if (thread) {
1030
			/* Have we already had a message ID? */
1031
			if (rev.message_id) {
1032 1033 1034 1035 1036 1037
				/*
				 * If we've got the ID to be a reply
				 * to, discard the current ID;
				 * otherwise, make everything a reply
				 * to that.
				 */
1038 1039 1040 1041
				if (rev.ref_message_id)
					free(rev.message_id);
				else
					rev.ref_message_id = rev.message_id;
1042
			}
1043
			gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1044
		}
1045 1046 1047 1048
		if (!use_stdout && reopen_stdout(numbered_files ? NULL :
				get_oneline_for_filename(commit, keep_subject),
				rev.nr, rev.total))
			die("Failed to create output files");
1049 1050 1051
		shown = log_tree_commit(&rev, commit);
		free(commit->buffer);
		commit->buffer = NULL;
1052 1053 1054 1055 1056 1057 1058 1059 1060

		/* We put one extra blank line between formatted
		 * patches and this flag is used by log-tree code
		 * to see if it needs to emit a LF before showing
		 * the log; when using one file per patch, we do
		 * not want the extra blank line.
		 */
		if (!use_stdout)
			rev.shown_one = 0;
1061 1062 1063 1064 1065 1066 1067 1068
		if (shown) {
			if (rev.mime_boundary)
				printf("\n--%s%s--\n\n\n",
				       mime_boundary_leader,
				       rev.mime_boundary);
			else
				printf("-- \n%s\n\n", git_version_string);
		}
1069 1070
		if (!use_stdout)
			fclose(stdout);
1071 1072
	}
	free(list);
1073 1074
	if (ignore_if_in_upstream)
		free_patch_ids(&ids);
1075 1076 1077
	return 0;
}

R
Rene Scharfe 已提交
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
{
	unsigned char sha1[20];
	if (get_sha1(arg, sha1) == 0) {
		struct commit *commit = lookup_commit_reference(sha1);
		if (commit) {
			commit->object.flags |= flags;
			add_pending_object(revs, &commit->object, arg);
			return 0;
		}
	}
	return -1;
}

static const char cherry_usage[] =
"git-cherry [-v] <upstream> [<head>] [<limit>]";
int cmd_cherry(int argc, const char **argv, const char *prefix)
{
	struct rev_info revs;
1097
	struct patch_ids ids;
R
Rene Scharfe 已提交
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
	struct commit *commit;
	struct commit_list *list = NULL;
	const char *upstream;
	const char *head = "HEAD";
	const char *limit = NULL;
	int verbose = 0;

	if (argc > 1 && !strcmp(argv[1], "-v")) {
		verbose = 1;
		argc--;
		argv++;
	}

	switch (argc) {
	case 4:
		limit = argv[3];
		/* FALLTHROUGH */
	case 3:
		head = argv[2];
		/* FALLTHROUGH */
	case 2:
		upstream = argv[1];
		break;
	default:
		usage(cherry_usage);
	}

	init_revisions(&revs, prefix);
	revs.diff = 1;
	revs.combine_merges = 0;
	revs.ignore_merges = 1;
1129
	DIFF_OPT_SET(&revs.diffopt, RECURSIVE);
R
Rene Scharfe 已提交
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142

	if (add_pending_commit(head, &revs, 0))
		die("Unknown commit %s", head);
	if (add_pending_commit(upstream, &revs, UNINTERESTING))
		die("Unknown commit %s", upstream);

	/* Don't say anything if head and upstream are the same. */
	if (revs.pending.nr == 2) {
		struct object_array_entry *o = revs.pending.objects;
		if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
			return 0;
	}

1143
	get_patch_ids(&revs, &ids, prefix);
R
Rene Scharfe 已提交
1144 1145 1146 1147 1148

	if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
		die("Unknown commit %s", limit);

	/* reverse the list of commits */
1149 1150
	if (prepare_revision_walk(&revs))
		die("revision walk setup failed");
R
Rene Scharfe 已提交
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
	while ((commit = get_revision(&revs)) != NULL) {
		/* ignore merges */
		if (commit->parents && commit->parents->next)
			continue;

		commit_list_insert(commit, &list);
	}

	while (list) {
		char sign = '+';

		commit = list->item;
1163
		if (has_commit_patch_id(commit, &ids))
R
Rene Scharfe 已提交
1164 1165 1166
			sign = '-';

		if (verbose) {
1167 1168 1169
			struct strbuf buf;
			strbuf_init(&buf, 0);
			pretty_print_commit(CMIT_FMT_ONELINE, commit,
1170
			                    &buf, 0, NULL, NULL, 0, 0);
R
Rene Scharfe 已提交
1171
			printf("%c %s %s\n", sign,
1172 1173
			       sha1_to_hex(commit->object.sha1), buf.buf);
			strbuf_release(&buf);
R
Rene Scharfe 已提交
1174 1175 1176 1177 1178 1179 1180 1181 1182
		}
		else {
			printf("%c %s\n", sign,
			       sha1_to_hex(commit->object.sha1));
		}

		list = list->next;
	}

1183
	free_patch_ids(&ids);
R
Rene Scharfe 已提交
1184 1185
	return 0;
}