[thirdparty/git.git] / builtin / describe.c

#include "cache.h"
#include "commit.h"
#include "tag.h"
#include "refs.h"
#include "builtin.h"
#include "exec_cmd.h"
#include "parse-options.h"
#include "diff.h"
#include "hash.h"

#define SEEN		(1u<<0)
#define MAX_TAGS	(FLAG_BITS - 1)

static const char * const describe_usage[] = {
	"git describe [options] <committish>*",
	"git describe [options] --dirty",
	NULL
};

static int debug;	/* Display lots of verbose info */
static int all;	/* Any valid ref can be used */
static int tags;	/* Allow lightweight tags */
static int longformat;
static int abbrev = DEFAULT_ABBREV;
static int max_candidates = 10;
static struct hash_table names;
static int have_util;
static const char *pattern;
static int always;
static const char *dirty;

/* diff-index command arguments to check if working tree is dirty. */
static const char *diff_index_args[] = {
	"diff-index", "--quiet", "HEAD", "--", NULL
};


struct commit_name {
	struct commit_name *next;
	unsigned char peeled[20];
	struct tag *tag;
	unsigned prio:2; /* annotated tag = 2, tag = 1, head = 0 */
	unsigned name_checked:1;
	unsigned char sha1[20];
	const char *path;
};
static const char *prio_names[] = {
	"head", "lightweight", "annotated",
};

static inline unsigned int hash_sha1(const unsigned char *sha1)
{
	unsigned int hash;
	memcpy(&hash, sha1, sizeof(hash));
	return hash;
}

static inline struct commit_name *find_commit_name(const unsigned char *peeled)
{
	struct commit_name *n = lookup_hash(hash_sha1(peeled), &names);
	while (n && !!hashcmp(peeled, n->peeled))
		n = n->next;
	return n;
}

static int set_util(void *chain)
{
	struct commit_name *n;
	for (n = chain; n; n = n->next) {
		struct commit *c = lookup_commit_reference_gently(n->peeled, 1);
		if (c)
			c->util = n;
	}
	return 0;
}

static int replace_name(struct commit_name *e,
			       int prio,
			       const unsigned char *sha1,
			       struct tag **tag)
{
	if (!e || e->prio < prio)
		return 1;

	if (e->prio == 2 && prio == 2) {
		/* Multiple annotated tags point to the same commit.
		 * Select one to keep based upon their tagger date.
		 */
		struct tag *t;

		if (!e->tag) {
			t = lookup_tag(e->sha1);
			if (!t || parse_tag(t))
				return 1;
			e->tag = t;
		}

		t = lookup_tag(sha1);
		if (!t || parse_tag(t))
			return 0;
		*tag = t;

		if (e->tag->date < t->date)
			return 1;
	}

	return 0;
}

static void add_to_known_names(const char *path,
			       const unsigned char *peeled,
			       int prio,
			       const unsigned char *sha1)
{
	struct commit_name *e = find_commit_name(peeled);
	struct tag *tag = NULL;
	if (replace_name(e, prio, sha1, &tag)) {
		if (!e) {
			void **pos;
			e = xmalloc(sizeof(struct commit_name));
			hashcpy(e->peeled, peeled);
			pos = insert_hash(hash_sha1(peeled), e, &names);
			if (pos) {
				e->next = *pos;
				*pos = e;
			} else {
				e->next = NULL;
			}
		}
		e->tag = tag;
		e->prio = prio;
		e->name_checked = 0;
		hashcpy(e->sha1, sha1);
		e->path = path;
	}
}

static int get_name(const char *path, const unsigned char *sha1, int flag, void *cb_data)
{
	int might_be_tag = !prefixcmp(path, "refs/tags/");
	unsigned char peeled[20];
	int is_tag, prio;

	if (!all && !might_be_tag)
		return 0;

	if (!peel_ref(path, peeled) && !is_null_sha1(peeled)) {
		is_tag = !!hashcmp(sha1, peeled);
	} else {
		hashcpy(peeled, sha1);
		is_tag = 0;
	}

	/* If --all, then any refs are used.
	 * If --tags, then any tags are used.
	 * Otherwise only annotated tags are used.
	 */
	if (might_be_tag) {
		if (is_tag)
			prio = 2;
		else
			prio = 1;

		if (pattern && fnmatch(pattern, path + 10, 0))
			prio = 0;
	}
	else
		prio = 0;

	if (!all) {
		if (!prio)
			return 0;
	}
	add_to_known_names(all ? path + 5 : path + 10, peeled, prio, sha1);
	return 0;
}

struct possible_tag {
	struct commit_name *name;
	int depth;
	int found_order;
	unsigned flag_within;
};

static int compare_pt(const void *a_, const void *b_)
{
	struct possible_tag *a = (struct possible_tag *)a_;
	struct possible_tag *b = (struct possible_tag *)b_;
	if (a->depth != b->depth)
		return a->depth - b->depth;
	if (a->found_order != b->found_order)
		return a->found_order - b->found_order;
	return 0;
}

static unsigned long finish_depth_computation(
	struct commit_list **list,
	struct possible_tag *best)
{
	unsigned long seen_commits = 0;
	while (*list) {
		struct commit *c = pop_commit(list);
		struct commit_list *parents = c->parents;
		seen_commits++;
		if (c->object.flags & best->flag_within) {
			struct commit_list *a = *list;
			while (a) {
				struct commit *i = a->item;
				if (!(i->object.flags & best->flag_within))
					break;
				a = a->next;
			}
			if (!a)
				break;
		} else
			best->depth++;
		while (parents) {
			struct commit *p = parents->item;
			parse_commit(p);
			if (!(p->object.flags & SEEN))
				commit_list_insert_by_date(p, list);
			p->object.flags |= c->object.flags;
			parents = parents->next;
		}
	}
	return seen_commits;
}

static void display_name(struct commit_name *n)
{
	if (n->prio == 2 && !n->tag) {
		n->tag = lookup_tag(n->sha1);
		if (!n->tag || parse_tag(n->tag))
			die("annotated tag %s not available", n->path);
	}
	if (n->tag && !n->name_checked) {
		if (!n->tag->tag)
			die("annotated tag %s has no embedded name", n->path);
		if (strcmp(n->tag->tag, all ? n->path + 5 : n->path))
			warning("tag '%s' is really '%s' here", n->tag->tag, n->path);
		n->name_checked = 1;
	}

	if (n->tag)
		printf("%s", n->tag->tag);
	else
		printf("%s", n->path);
}

static void show_suffix(int depth, const unsigned char *sha1)
{
	printf("-%d-g%s", depth, find_unique_abbrev(sha1, abbrev));
}

static void describe(const char *arg, int last_one)
{
	unsigned char sha1[20];
	struct commit *cmit, *gave_up_on = NULL;
	struct commit_list *list;
	struct commit_name *n;
	struct possible_tag all_matches[MAX_TAGS];
	unsigned int match_cnt = 0, annotated_cnt = 0, cur_match;
	unsigned long seen_commits = 0;
	unsigned int unannotated_cnt = 0;

	if (get_sha1(arg, sha1))
		die("Not a valid object name %s", arg);
	cmit = lookup_commit_reference(sha1);
	if (!cmit)
		die("%s is not a valid '%s' object", arg, commit_type);

	n = find_commit_name(cmit->object.sha1);
	if (n && (tags || all || n->prio == 2)) {
		/*
		 * Exact match to an existing ref.
		 */
		display_name(n);
		if (longformat)
			show_suffix(0, n->tag ? n->tag->tagged->sha1 : sha1);
		if (dirty)
			printf("%s", dirty);
		printf("\n");
		return;
	}

	if (!max_candidates)
		die("no tag exactly matches '%s'", sha1_to_hex(cmit->object.sha1));
	if (debug)
		fprintf(stderr, "searching to describe %s\n", arg);

	if (!have_util) {
		for_each_hash(&names, set_util);
		have_util = 1;
	}

	list = NULL;
	cmit->object.flags = SEEN;
	commit_list_insert(cmit, &list);
	while (list) {
		struct commit *c = pop_commit(&list);
		struct commit_list *parents = c->parents;
		seen_commits++;
		n = c->util;
		if (n) {
			if (!tags && !all && n->prio < 2) {
				unannotated_cnt++;
			} else if (match_cnt < max_candidates) {
				struct possible_tag *t = &all_matches[match_cnt++];
				t->name = n;
				t->depth = seen_commits - 1;
				t->flag_within = 1u << match_cnt;
				t->found_order = match_cnt;
				c->object.flags |= t->flag_within;
				if (n->prio == 2)
					annotated_cnt++;
			}
			else {
				gave_up_on = c;
				break;
			}
		}
		for (cur_match = 0; cur_match < match_cnt; cur_match++) {
			struct possible_tag *t = &all_matches[cur_match];
			if (!(c->object.flags & t->flag_within))
				t->depth++;
		}
		if (annotated_cnt && !list) {
			if (debug)
				fprintf(stderr, "finished search at %s\n",
					sha1_to_hex(c->object.sha1));
			break;
		}
		while (parents) {
			struct commit *p = parents->item;
			parse_commit(p);
			if (!(p->object.flags & SEEN))
				commit_list_insert_by_date(p, &list);
			p->object.flags |= c->object.flags;
			parents = parents->next;
		}
	}

	if (!match_cnt) {
		const unsigned char *sha1 = cmit->object.sha1;
		if (always) {
			printf("%s", find_unique_abbrev(sha1, abbrev));
			if (dirty)
				printf("%s", dirty);
			printf("\n");
			return;
		}
		if (unannotated_cnt)
			die("No annotated tags can describe '%s'.\n"
			    "However, there were unannotated tags: try --tags.",
			    sha1_to_hex(sha1));
		else
			die("No tags can describe '%s'.\n"
			    "Try --always, or create some tags.",
			    sha1_to_hex(sha1));
	}

	qsort(all_matches, match_cnt, sizeof(all_matches[0]), compare_pt);

	if (gave_up_on) {
		commit_list_insert_by_date(gave_up_on, &list);
		seen_commits--;
	}
	seen_commits += finish_depth_computation(&list, &all_matches[0]);
	free_commit_list(list);

	if (debug) {
		for (cur_match = 0; cur_match < match_cnt; cur_match++) {
			struct possible_tag *t = &all_matches[cur_match];
			fprintf(stderr, " %-11s %8d %s\n",
				prio_names[t->name->prio],
				t->depth, t->name->path);
		}
		fprintf(stderr, "traversed %lu commits\n", seen_commits);
		if (gave_up_on) {
			fprintf(stderr,
				"more than %i tags found; listed %i most recent\n"
				"gave up search at %s\n",
				max_candidates, max_candidates,
				sha1_to_hex(gave_up_on->object.sha1));
		}
	}

	display_name(all_matches[0].name);
	if (abbrev)
		show_suffix(all_matches[0].depth, cmit->object.sha1);
	if (dirty)
		printf("%s", dirty);
	printf("\n");

	if (!last_one)
		clear_commit_marks(cmit, -1);
}

int cmd_describe(int argc, const char **argv, const char *prefix)
{
	int contains = 0;
	struct option options[] = {
		OPT_BOOLEAN(0, "contains",   &contains, "find the tag that comes after the commit"),
		OPT_BOOLEAN(0, "debug",      &debug, "debug search strategy on stderr"),
		OPT_BOOLEAN(0, "all",        &all, "use any ref in .git/refs"),
		OPT_BOOLEAN(0, "tags",       &tags, "use any tag in .git/refs/tags"),
		OPT_BOOLEAN(0, "long",       &longformat, "always use long format"),
		OPT__ABBREV(&abbrev),
		OPT_SET_INT(0, "exact-match", &max_candidates,
			    "only output exact matches", 0),
		OPT_INTEGER(0, "candidates", &max_candidates,
			    "consider <n> most recent tags (default: 10)"),
		OPT_STRING(0, "match",       &pattern, "pattern",
			   "only consider tags matching <pattern>"),
		OPT_BOOLEAN(0, "always",     &always,
			   "show abbreviated commit object as fallback"),
		{OPTION_STRING, 0, "dirty",  &dirty, "mark",
			   "append <mark> on dirty working tree (default: \"-dirty\")",
		 PARSE_OPT_OPTARG, NULL, (intptr_t) "-dirty"},
		OPT_END(),
	};

	argc = parse_options(argc, argv, prefix, options, describe_usage, 0);
	if (max_candidates < 0)
		max_candidates = 0;
	else if (max_candidates > MAX_TAGS)
		max_candidates = MAX_TAGS;

	save_commit_buffer = 0;

	if (longformat && abbrev == 0)
		die("--long is incompatible with --abbrev=0");

	if (contains) {
		const char **args = xmalloc((7 + argc) * sizeof(char *));
		int i = 0;
		args[i++] = "name-rev";
		args[i++] = "--name-only";
		args[i++] = "--no-undefined";
		if (always)
			args[i++] = "--always";
		if (!all) {
			args[i++] = "--tags";
			if (pattern) {
				char *s = xmalloc(strlen("--refs=refs/tags/") + strlen(pattern) + 1);
				sprintf(s, "--refs=refs/tags/%s", pattern);
				args[i++] = s;
			}
		}
		memcpy(args + i, argv, argc * sizeof(char *));
		args[i + argc] = NULL;
		return cmd_name_rev(i + argc, args, prefix);
	}

	init_hash(&names);
	for_each_rawref(get_name, NULL);
	if (!names.nr && !always)
		die("No names found, cannot describe anything.");

	if (argc == 0) {
		if (dirty && !cmd_diff_index(ARRAY_SIZE(diff_index_args) - 1, diff_index_args, prefix))
			dirty = NULL;
		describe("HEAD", 1);
	} else if (dirty) {
		die("--dirty is incompatible with committishes");
	} else {
		while (argc-- > 0) {
			describe(*argv++, argc == 0);
		}
	}
	return 0;
}
Commit	Line	Data
908e5310 LT	1	#include "cache.h"
908e5310 LT	2	#include "commit.h"
635d4134	3	#include "tag.h"
908e5310	4	#include "refs.h"
9a0eaf83	5	#include "builtin.h"
23615708	6	#include "exec_cmd.h"
166185be	7	#include "parse-options.h"
9f67d2e8	8	#include "diff.h"
3cfa4db3	9	#include "hash.h"
908e5310	10
8713ab30 SP	11	#define SEEN (1u<<0)
	12	#define MAX_TAGS (FLAG_BITS - 1)
	13
166185be	14	static const char * const describe_usage[] = {
1b1dd23f	15	"git describe [options] <committish>*",
9f67d2e8	16	"git describe [options] --dirty",
166185be PH	17	NULL
166185be PH	18	};
908e5310	19
8713ab30	20	static int debug; /* Display lots of verbose info */
7e425c4f SP	21	static int all; /* Any valid ref can be used */
7e425c4f SP	22	static int tags; /* Allow lightweight tags */
518120e3	23	static int longformat;
2d9e7c9f	24	static int abbrev = DEFAULT_ABBREV;
8713ab30	25	static int max_candidates = 10;
3cfa4db3	26	static struct hash_table names;
d1645d02	27	static int have_util;
cb2a1cc2	28	static const char *pattern;
da2478db	29	static int always;
9f67d2e8 JP	30	static const char *dirty;
	31
	32	/* diff-index command arguments to check if working tree is dirty. */
	33	static const char *diff_index_args[] = {
	34	"diff-index", "--quiet", "HEAD", "--", NULL
	35	};
	36
908e5310	37
e7eb5034	38	struct commit_name {
3cfa4db3 AK	39	struct commit_name *next;
3cfa4db3 AK	40	unsigned char peeled[20];
212945d4	41	struct tag *tag;
03e8b541 SP	42	unsigned prio:2; /* annotated tag = 2, tag = 1, head = 0 */
03e8b541 SP	43	unsigned name_checked:1;
212945d4	44	unsigned char sha1[20];
1e1ade18	45	const char *path;
e7eb5034	46	};
cf69fd49 SP	47	static const char *prio_names[] = {
	48	"head", "lightweight", "annotated",
	49	};
908e5310	50
3cfa4db3 AK	51	static inline unsigned int hash_sha1(const unsigned char *sha1)
	52	{
	53	unsigned int hash;
	54	memcpy(&hash, sha1, sizeof(hash));
	55	return hash;
	56	}
	57
	58	static inline struct commit_name find_commit_name(const unsigned char peeled)
	59	{
	60	struct commit_name *n = lookup_hash(hash_sha1(peeled), &names);
	61	while (n && !!hashcmp(peeled, n->peeled))
	62	n = n->next;
	63	return n;
	64	}
	65
d1645d02 AK	66	static int set_util(void *chain)
	67	{
	68	struct commit_name *n;
	69	for (n = chain; n; n = n->next) {
	70	struct commit *c = lookup_commit_reference_gently(n->peeled, 1);
	71	if (c)
	72	c->util = n;
	73	}
	74	return 0;
	75	}
	76
03e8b541 SP	77	static int replace_name(struct commit_name *e,
	78	int prio,
	79	const unsigned char *sha1,
	80	struct tag **tag)
	81	{
	82	if (!e \|\| e->prio < prio)
	83	return 1;
	84
	85	if (e->prio == 2 && prio == 2) {
	86	/* Multiple annotated tags point to the same commit.
	87	* Select one to keep based upon their tagger date.
	88	*/
	89	struct tag *t;
	90
	91	if (!e->tag) {
	92	t = lookup_tag(e->sha1);
	93	if (!t \|\| parse_tag(t))
	94	return 1;
	95	e->tag = t;
	96	}
	97
	98	t = lookup_tag(sha1);
	99	if (!t \|\| parse_tag(t))
	100	return 0;
	101	*tag = t;
	102
	103	if (e->tag->date < t->date)
	104	return 1;
	105	}
	106
	107	return 0;
	108	}
	109
64deb858	110	static void add_to_known_names(const char *path,
d1645d02	111	const unsigned char *peeled,
212945d4 SP	112	int prio,
212945d4 SP	113	const unsigned char *sha1)
908e5310	114	{
3cfa4db3	115	struct commit_name *e = find_commit_name(peeled);
03e8b541 SP	116	struct tag *tag = NULL;
03e8b541 SP	117	if (replace_name(e, prio, sha1, &tag)) {
1e1ade18	118	if (!e) {
3cfa4db3	119	void **pos;
1e1ade18	120	e = xmalloc(sizeof(struct commit_name));
3cfa4db3 AK	121	hashcpy(e->peeled, peeled);
	122	pos = insert_hash(hash_sha1(peeled), e, &names);
	123	if (pos) {
	124	e->next = *pos;
	125	*pos = e;
	126	} else {
	127	e->next = NULL;
	128	}
1e1ade18	129	}
03e8b541	130	e->tag = tag;
e7eb5034	131	e->prio = prio;
03e8b541	132	e->name_checked = 0;
212945d4	133	hashcpy(e->sha1, sha1);
1e1ade18	134	e->path = path;
908e5310	135	}
908e5310 LT	136	}
908e5310 LT	137
8da19775	138	static int get_name(const char path, const unsigned char sha1, int flag, void *cb_data)
908e5310	139	{
8a5a1884	140	int might_be_tag = !prefixcmp(path, "refs/tags/");
feededd0 SP	141	unsigned char peeled[20];
	142	int is_tag, prio;
	143
8a5a1884 SP	144	if (!all && !might_be_tag)
	145	return 0;
	146
feededd0	147	if (!peel_ref(path, peeled) && !is_null_sha1(peeled)) {
d1645d02	148	is_tag = !!hashcmp(sha1, peeled);
feededd0	149	} else {
d1645d02 AK	150	hashcpy(peeled, sha1);
d1645d02 AK	151	is_tag = 0;
feededd0	152	}
64deb858	153
2d9e7c9f JH	154	/* If --all, then any refs are used.
	155	* If --tags, then any tags are used.
	156	* Otherwise only annotated tags are used.
	157	*/
8a5a1884	158	if (might_be_tag) {
4ed19a3c	159	if (is_tag)
64deb858	160	prio = 2;
4ed19a3c	161	else
64deb858	162	prio = 1;
4ed19a3c MD	163
	164	if (pattern && fnmatch(pattern, path + 10, 0))
	165	prio = 0;
64deb858 JH	166	}
	167	else
	168	prio = 0;
	169
635d4134	170	if (!all) {
64deb858 JH	171	if (!prio)
64deb858 JH	172	return 0;
635d4134	173	}
d1645d02	174	add_to_known_names(all ? path + 5 : path + 10, peeled, prio, sha1);
908e5310 LT	175	return 0;
	176	}
	177
80dbae03	178	struct possible_tag {
80dbae03	179	struct commit_name *name;
cf69fd49 SP	180	int depth;
cf69fd49 SP	181	int found_order;
8713ab30	182	unsigned flag_within;
80dbae03 SP	183	};
80dbae03 SP	184
cf69fd49 SP	185	static int compare_pt(const void a_, const void b_)
	186	{
	187	struct possible_tag a = (struct possible_tag )a_;
	188	struct possible_tag b = (struct possible_tag )b_;
cf69fd49 SP	189	if (a->depth != b->depth)
	190	return a->depth - b->depth;
	191	if (a->found_order != b->found_order)
	192	return a->found_order - b->found_order;
	193	return 0;
	194	}
	195
1b600e65 SP	196	static unsigned long finish_depth_computation(
	197	struct commit_list **list,
	198	struct possible_tag *best)
	199	{
	200	unsigned long seen_commits = 0;
	201	while (*list) {
	202	struct commit *c = pop_commit(list);
	203	struct commit_list *parents = c->parents;
	204	seen_commits++;
	205	if (c->object.flags & best->flag_within) {
	206	struct commit_list a = list;
	207	while (a) {
	208	struct commit *i = a->item;
	209	if (!(i->object.flags & best->flag_within))
	210	break;
	211	a = a->next;
	212	}
	213	if (!a)
	214	break;
	215	} else
	216	best->depth++;
	217	while (parents) {
	218	struct commit *p = parents->item;
	219	parse_commit(p);
	220	if (!(p->object.flags & SEEN))
47e44ed1	221	commit_list_insert_by_date(p, list);
1b600e65 SP	222	p->object.flags \|= c->object.flags;
	223	parents = parents->next;
	224	}
	225	}
	226	return seen_commits;
	227	}
	228
212945d4 SP	229	static void display_name(struct commit_name *n)
	230	{
	231	if (n->prio == 2 && !n->tag) {
	232	n->tag = lookup_tag(n->sha1);
03e8b541	233	if (!n->tag \|\| parse_tag(n->tag))
212945d4	234	die("annotated tag %s not available", n->path);
03e8b541 SP	235	}
	236	if (n->tag && !n->name_checked) {
	237	if (!n->tag->tag)
	238	die("annotated tag %s has no embedded name", n->path);
81dc223d	239	if (strcmp(n->tag->tag, all ? n->path + 5 : n->path))
212945d4	240	warning("tag '%s' is really '%s' here", n->tag->tag, n->path);
03e8b541	241	n->name_checked = 1;
212945d4 SP	242	}
	243
	244	if (n->tag)
	245	printf("%s", n->tag->tag);
	246	else
	247	printf("%s", n->path);
870cf7d6 JH	248	}
	249
	250	static void show_suffix(int depth, const unsigned char *sha1)
	251	{
	252	printf("-%d-g%s", depth, find_unique_abbrev(sha1, abbrev));
212945d4 SP	253	}
212945d4 SP	254
554fe20d	255	static void describe(const char *arg, int last_one)
908e5310	256	{
4c34a2c5	257	unsigned char sha1[20];
8713ab30	258	struct commit cmit, gave_up_on = NULL;
908e5310	259	struct commit_list *list;
908e5310	260	struct commit_name *n;
cf69fd49	261	struct possible_tag all_matches[MAX_TAGS];
8713ab30 SP	262	unsigned int match_cnt = 0, annotated_cnt = 0, cur_match;
8713ab30 SP	263	unsigned long seen_commits = 0;
4d23660e	264	unsigned int unannotated_cnt = 0;
908e5310	265
31fff305 DL	266	if (get_sha1(arg, sha1))
31fff305 DL	267	die("Not a valid object name %s", arg);
4c34a2c5 JH	268	cmit = lookup_commit_reference(sha1);
4c34a2c5 JH	269	if (!cmit)
31fff305	270	die("%s is not a valid '%s' object", arg, commit_type);
4c34a2c5	271
3cfa4db3	272	n = find_commit_name(cmit->object.sha1);
7a0d61bb	273	if (n && (tags \|\| all \|\| n->prio == 2)) {
870cf7d6 JH	274	/*
	275	* Exact match to an existing ref.
	276	*/
212945d4	277	display_name(n);
870cf7d6	278	if (longformat)
14d4642e	279	show_suffix(0, n->tag ? n->tag->tagged->sha1 : sha1);
9f67d2e8 JP	280	if (dirty)
9f67d2e8 JP	281	printf("%s", dirty);
212945d4	282	printf("\n");
908e5310 LT	283	return;
	284	}
	285
2c33f757 SP	286	if (!max_candidates)
2c33f757 SP	287	die("no tag exactly matches '%s'", sha1_to_hex(cmit->object.sha1));
8713ab30 SP	288	if (debug)
	289	fprintf(stderr, "searching to describe %s\n", arg);
	290
d1645d02 AK	291	if (!have_util) {
	292	for_each_hash(&names, set_util);
	293	have_util = 1;
	294	}
	295
908e5310	296	list = NULL;
8713ab30	297	cmit->object.flags = SEEN;
908e5310 LT	298	commit_list_insert(cmit, &list);
908e5310 LT	299	while (list) {
80dbae03	300	struct commit *c = pop_commit(&list);
dccd0c2a	301	struct commit_list *parents = c->parents;
8713ab30	302	seen_commits++;
e7eb5034	303	n = c->util;
908e5310	304	if (n) {
4d23660e TR	305	if (!tags && !all && n->prio < 2) {
	306	unannotated_cnt++;
	307	} else if (match_cnt < max_candidates) {
8713ab30 SP	308	struct possible_tag *t = &all_matches[match_cnt++];
	309	t->name = n;
	310	t->depth = seen_commits - 1;
	311	t->flag_within = 1u << match_cnt;
8a8169c0	312	t->found_order = match_cnt;
8713ab30 SP	313	c->object.flags \|= t->flag_within;
	314	if (n->prio == 2)
	315	annotated_cnt++;
	316	}
	317	else {
	318	gave_up_on = c;
	319	break;
	320	}
	321	}
	322	for (cur_match = 0; cur_match < match_cnt; cur_match++) {
	323	struct possible_tag *t = &all_matches[cur_match];
	324	if (!(c->object.flags & t->flag_within))
	325	t->depth++;
	326	}
	327	if (annotated_cnt && !list) {
	328	if (debug)
	329	fprintf(stderr, "finished search at %s\n",
	330	sha1_to_hex(c->object.sha1));
	331	break;
dccd0c2a SP	332	}
	333	while (parents) {
	334	struct commit *p = parents->item;
	335	parse_commit(p);
8713ab30	336	if (!(p->object.flags & SEEN))
47e44ed1	337	commit_list_insert_by_date(p, &list);
8713ab30	338	p->object.flags \|= c->object.flags;
dccd0c2a	339	parents = parents->next;
80dbae03 SP	340	}
	341	}
	342
da2478db JH	343	if (!match_cnt) {
	344	const unsigned char *sha1 = cmit->object.sha1;
	345	if (always) {
9f67d2e8 JP	346	printf("%s", find_unique_abbrev(sha1, abbrev));
	347	if (dirty)
	348	printf("%s", dirty);
	349	printf("\n");
da2478db JH	350	return;
da2478db JH	351	}
4d23660e TR	352	if (unannotated_cnt)
	353	die("No annotated tags can describe '%s'.\n"
	354	"However, there were unannotated tags: try --tags.",
	355	sha1_to_hex(sha1));
	356	else
	357	die("No tags can describe '%s'.\n"
	358	"Try --always, or create some tags.",
	359	sha1_to_hex(sha1));
da2478db	360	}
80dbae03	361
cf69fd49	362	qsort(all_matches, match_cnt, sizeof(all_matches[0]), compare_pt);
1b600e65 SP	363
1b600e65 SP	364	if (gave_up_on) {
47e44ed1	365	commit_list_insert_by_date(gave_up_on, &list);
1b600e65 SP	366	seen_commits--;
	367	}
	368	seen_commits += finish_depth_computation(&list, &all_matches[0]);
	369	free_commit_list(list);
	370
8713ab30 SP	371	if (debug) {
	372	for (cur_match = 0; cur_match < match_cnt; cur_match++) {
	373	struct possible_tag *t = &all_matches[cur_match];
cf69fd49 SP	374	fprintf(stderr, " %-11s %8d %s\n",
cf69fd49 SP	375	prio_names[t->name->prio],
8713ab30 SP	376	t->depth, t->name->path);
	377	}
	378	fprintf(stderr, "traversed %lu commits\n", seen_commits);
	379	if (gave_up_on) {
	380	fprintf(stderr,
	381	"more than %i tags found; listed %i most recent\n"
	382	"gave up search at %s\n",
	383	max_candidates, max_candidates,
	384	sha1_to_hex(gave_up_on->object.sha1));
	385	}
80dbae03	386	}
212945d4 SP	387
	388	display_name(all_matches[0].name);
	389	if (abbrev)
870cf7d6	390	show_suffix(all_matches[0].depth, cmit->object.sha1);
9f67d2e8 JP	391	if (dirty)
9f67d2e8 JP	392	printf("%s", dirty);
212945d4	393	printf("\n");
80dbae03	394
8713ab30 SP	395	if (!last_one)
8713ab30 SP	396	clear_commit_marks(cmit, -1);
908e5310 LT	397	}
908e5310 LT	398
9a0eaf83	399	int cmd_describe(int argc, const char *argv, const char prefix)
908e5310	400	{
23615708	401	int contains = 0;
166185be PH	402	struct option options[] = {
	403	OPT_BOOLEAN(0, "contains", &contains, "find the tag that comes after the commit"),
	404	OPT_BOOLEAN(0, "debug", &debug, "debug search strategy on stderr"),
	405	OPT_BOOLEAN(0, "all", &all, "use any ref in .git/refs"),
	406	OPT_BOOLEAN(0, "tags", &tags, "use any tag in .git/refs/tags"),
518120e3	407	OPT_BOOLEAN(0, "long", &longformat, "always use long format"),
166185be	408	OPT__ABBREV(&abbrev),
2c33f757 SP	409	OPT_SET_INT(0, "exact-match", &max_candidates,
2c33f757 SP	410	"only output exact matches", 0),
166185be	411	OPT_INTEGER(0, "candidates", &max_candidates,
30ffa603 PH	412	"consider <n> most recent tags (default: 10)"),
	413	OPT_STRING(0, "match", &pattern, "pattern",
	414	"only consider tags matching <pattern>"),
da2478db JH	415	OPT_BOOLEAN(0, "always", &always,
da2478db JH	416	"show abbreviated commit object as fallback"),
9f67d2e8 JP	417	{OPTION_STRING, 0, "dirty", &dirty, "mark",
	418	"append <mark> on dirty working tree (default: \"-dirty\")",
	419	PARSE_OPT_OPTARG, NULL, (intptr_t) "-dirty"},
166185be PH	420	OPT_END(),
166185be PH	421	};
908e5310	422
37782920	423	argc = parse_options(argc, argv, prefix, options, describe_usage, 0);
2c33f757 SP	424	if (max_candidates < 0)
2c33f757 SP	425	max_candidates = 0;
166185be PH	426	else if (max_candidates > MAX_TAGS)
166185be PH	427	max_candidates = MAX_TAGS;
4c34a2c5	428
8c599c74	429	save_commit_buffer = 0;
8112894d	430
518120e3 SB	431	if (longformat && abbrev == 0)
	432	die("--long is incompatible with --abbrev=0");
	433
23615708	434	if (contains) {
4b25d091	435	const char *args = xmalloc((7 + argc) sizeof(char *));
3f7701a4 NP	436	int i = 0;
	437	args[i++] = "name-rev";
	438	args[i++] = "--name-only";
a2cf9f44	439	args[i++] = "--no-undefined";
da2478db JH	440	if (always)
da2478db JH	441	args[i++] = "--always";
30ffa603	442	if (!all) {
3f7701a4	443	args[i++] = "--tags";
30ffa603 PH	444	if (pattern) {
	445	char *s = xmalloc(strlen("--refs=refs/tags/") + strlen(pattern) + 1);
	446	sprintf(s, "--refs=refs/tags/%s", pattern);
	447	args[i++] = s;
	448	}
	449	}
4b25d091	450	memcpy(args + i, argv, argc * sizeof(char *));
3f7701a4 NP	451	args[i + argc] = NULL;
3f7701a4 NP	452	return cmd_name_rev(i + argc, args, prefix);
23615708 SP	453	}
23615708 SP	454
3cfa4db3	455	init_hash(&names);
56a5f3af	456	for_each_rawref(get_name, NULL);
3cfa4db3	457	if (!names.nr && !always)
fb423da0 RS	458	die("No names found, cannot describe anything.");
fb423da0 RS	459
166185be	460	if (argc == 0) {
9f67d2e8 JP	461	if (dirty && !cmd_diff_index(ARRAY_SIZE(diff_index_args) - 1, diff_index_args, prefix))
9f67d2e8 JP	462	dirty = NULL;
fec9ebf1	463	describe("HEAD", 1);
9f67d2e8 JP	464	} else if (dirty) {
9f67d2e8 JP	465	die("--dirty is incompatible with committishes");
166185be PH	466	} else {
	467	while (argc-- > 0) {
	468	describe(*argv++, argc == 0);
fec9ebf1	469	}
166185be	470	}
908e5310 LT	471	return 0;
908e5310 LT	472	}