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

#include "cache.h"
#include "config.h"
#include "lockfile.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 "hashmap.h"
#include "argv-array.h"
#include "run-command.h"

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

static const char * const describe_usage[] = {
	N_("git describe [<options>] [<commit-ish>...]"),
	N_("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 first_parent;
static int abbrev = -1; /* unspecified */
static int max_candidates = 10;
static struct hashmap names;
static int have_util;
static struct string_list patterns = STRING_LIST_INIT_NODUP;
static struct string_list exclude_patterns = STRING_LIST_INIT_NODUP;
static int always;
static const char *suffix, *dirty, *broken;

/* 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 hashmap_entry entry;
	struct object_id peeled;
	struct tag *tag;
	unsigned prio:2; /* annotated tag = 2, tag = 1, head = 0 */
	unsigned name_checked:1;
	struct object_id oid;
	char *path;
};

static const char *prio_names[] = {
	N_("head"), N_("lightweight"), N_("annotated"),
};

static int commit_name_cmp(const void *unused_cmp_data,
			   const void *entry,
			   const void *entry_or_key,
			   const void *peeled)
{
	const struct commit_name *cn1 = entry;
	const struct commit_name *cn2 = entry_or_key;

	return oidcmp(&cn1->peeled, peeled ? peeled : &cn2->peeled);
}

static inline struct commit_name *find_commit_name(const struct object_id *peeled)
{
	return hashmap_get_from_hash(&names, sha1hash(peeled->hash), peeled->hash);
}

static int replace_name(struct commit_name *e,
			       int prio,
			       const struct object_id *oid,
			       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->oid);
			if (!t || parse_tag(t))
				return 1;
			e->tag = t;
		}

		t = lookup_tag(oid);
		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 struct object_id *peeled,
			       int prio,
			       const struct object_id *oid)
{
	struct commit_name *e = find_commit_name(peeled);
	struct tag *tag = NULL;
	if (replace_name(e, prio, oid, &tag)) {
		if (!e) {
			e = xmalloc(sizeof(struct commit_name));
			oidcpy(&e->peeled, peeled);
			hashmap_entry_init(e, sha1hash(peeled->hash));
			hashmap_add(&names, e);
			e->path = NULL;
		}
		e->tag = tag;
		e->prio = prio;
		e->name_checked = 0;
		oidcpy(&e->oid, oid);
		free(e->path);
		e->path = xstrdup(path);
	}
}

static int get_name(const char *path, const struct object_id *oid, int flag, void *cb_data)
{
	int is_tag = starts_with(path, "refs/tags/");
	struct object_id peeled;
	int is_annotated, prio;

	/* Reject anything outside refs/tags/ unless --all */
	if (!all && !is_tag)
		return 0;

	/*
	 * If we're given exclude patterns, first exclude any tag which match
	 * any of the exclude pattern.
	 */
	if (exclude_patterns.nr) {
		struct string_list_item *item;

		if (!is_tag)
			return 0;

		for_each_string_list_item(item, &exclude_patterns) {
			if (!wildmatch(item->string, path + 10, 0))
				return 0;
		}
	}

	/*
	 * If we're given patterns, accept only tags which match at least one
	 * pattern.
	 */
	if (patterns.nr) {
		int found = 0;
		struct string_list_item *item;

		if (!is_tag)
			return 0;

		for_each_string_list_item(item, &patterns) {
			if (!wildmatch(item->string, path + 10, 0)) {
				found = 1;
				break;
			}
		}

		if (!found)
			return 0;
	}

	/* Is it annotated? */
	if (!peel_ref(path, peeled.hash)) {
		is_annotated = !!oidcmp(oid, &peeled);
	} else {
		oidcpy(&peeled, oid);
		is_annotated = 0;
	}

	/*
	 * By default, we only use annotated tags, but with --tags
	 * we fall back to lightweight ones (even without --tags,
	 * we still remember lightweight ones, only to give hints
	 * in an error message).  --all allows any refs to be used.
	 */
	if (is_annotated)
		prio = 2;
	else if (is_tag)
		prio = 1;
	else
		prio = 0;

	add_to_known_names(all ? path + 5 : path + 10, &peeled, prio, oid);
	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->oid);
		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 struct object_id *oid)
{
	printf("-%d-g%s", depth, find_unique_abbrev(oid->hash, abbrev));
}

static void describe(const char *arg, int last_one)
{
	struct object_id oid;
	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_oid(arg, &oid))
		die(_("Not a valid object name %s"), arg);
	cmit = lookup_commit_reference(&oid);
	if (!cmit)
		die(_("%s is not a valid '%s' object"), arg, commit_type);

	n = find_commit_name(&cmit->object.oid);
	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->oid : &oid);
		if (suffix)
			printf("%s", suffix);
		printf("\n");
		return;
	}

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

	if (!have_util) {
		struct hashmap_iter iter;
		struct commit *c;
		struct commit_name *n = hashmap_iter_first(&names, &iter);
		for (; n; n = hashmap_iter_next(&iter)) {
			c = lookup_commit_reference_gently(&n->peeled, 1);
			if (c)
				c->util = n;
		}
		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"),
					oid_to_hex(&c->object.oid));
			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 (first_parent)
				break;
		}
	}

	if (!match_cnt) {
		struct object_id *oid = &cmit->object.oid;
		if (always) {
			printf("%s", find_unique_abbrev(oid->hash, abbrev));
			if (suffix)
				printf("%s", suffix);
			printf("\n");
			return;
		}
		if (unannotated_cnt)
			die(_("No annotated tags can describe '%s'.\n"
			    "However, there were unannotated tags: try --tags."),
			    oid_to_hex(oid));
		else
			die(_("No tags can describe '%s'.\n"
			    "Try --always, or create some tags."),
			    oid_to_hex(oid));
	}

	QSORT(all_matches, match_cnt, 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) {
		static int label_width = -1;
		if (label_width < 0) {
			int i, w;
			for (i = 0; i < ARRAY_SIZE(prio_names); i++) {
				w = strlen(_(prio_names[i]));
				if (label_width < w)
					label_width = w;
			}
		}
		for (cur_match = 0; cur_match < match_cnt; cur_match++) {
			struct possible_tag *t = &all_matches[cur_match];
			fprintf(stderr, " %-*s %8d %s\n",
				label_width, _(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,
				oid_to_hex(&gave_up_on->object.oid));
		}
	}

	display_name(all_matches[0].name);
	if (abbrev)
		show_suffix(all_matches[0].depth, &cmit->object.oid);
	if (suffix)
		printf("%s", suffix);
	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_BOOL(0, "contains",   &contains, N_("find the tag that comes after the commit")),
		OPT_BOOL(0, "debug",      &debug, N_("debug search strategy on stderr")),
		OPT_BOOL(0, "all",        &all, N_("use any ref")),
		OPT_BOOL(0, "tags",       &tags, N_("use any tag, even unannotated")),
		OPT_BOOL(0, "long",       &longformat, N_("always use long format")),
		OPT_BOOL(0, "first-parent", &first_parent, N_("only follow first parent")),
		OPT__ABBREV(&abbrev),
		OPT_SET_INT(0, "exact-match", &max_candidates,
			    N_("only output exact matches"), 0),
		OPT_INTEGER(0, "candidates", &max_candidates,
			    N_("consider <n> most recent tags (default: 10)")),
		OPT_STRING_LIST(0, "match", &patterns, N_("pattern"),
			   N_("only consider tags matching <pattern>")),
		OPT_STRING_LIST(0, "exclude", &exclude_patterns, N_("pattern"),
			   N_("do not consider tags matching <pattern>")),
		OPT_BOOL(0, "always",        &always,
			N_("show abbreviated commit object as fallback")),
		{OPTION_STRING, 0, "dirty",  &dirty, N_("mark"),
			N_("append <mark> on dirty working tree (default: \"-dirty\")"),
			PARSE_OPT_OPTARG, NULL, (intptr_t) "-dirty"},
		{OPTION_STRING, 0, "broken",  &broken, N_("mark"),
			N_("append <mark> on broken working tree (default: \"-broken\")"),
			PARSE_OPT_OPTARG, NULL, (intptr_t) "-broken"},
		OPT_END(),
	};

	git_config(git_default_config, NULL);
	argc = parse_options(argc, argv, prefix, options, describe_usage, 0);
	if (abbrev < 0)
		abbrev = DEFAULT_ABBREV;

	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) {
		struct string_list_item *item;
		struct argv_array args;

		argv_array_init(&args);
		argv_array_pushl(&args, "name-rev",
				 "--peel-tag", "--name-only", "--no-undefined",
				 NULL);
		if (always)
			argv_array_push(&args, "--always");
		if (!all) {
			argv_array_push(&args, "--tags");
			for_each_string_list_item(item, &patterns)
				argv_array_pushf(&args, "--refs=refs/tags/%s", item->string);
			for_each_string_list_item(item, &exclude_patterns)
				argv_array_pushf(&args, "--exclude=refs/tags/%s", item->string);
		}
		if (argc)
			argv_array_pushv(&args, argv);
		else
			argv_array_push(&args, "HEAD");
		return cmd_name_rev(args.argc, args.argv, prefix);
	}

	hashmap_init(&names, commit_name_cmp, NULL, 0);
	for_each_rawref(get_name, NULL);
	if (!hashmap_get_size(&names) && !always)
		die(_("No names found, cannot describe anything."));

	if (argc == 0) {
		if (broken) {
			struct child_process cp = CHILD_PROCESS_INIT;
			argv_array_pushv(&cp.args, diff_index_args);
			cp.git_cmd = 1;
			cp.no_stdin = 1;
			cp.no_stdout = 1;

			if (!dirty)
				dirty = "-dirty";

			switch (run_command(&cp)) {
			case 0:
				suffix = NULL;
				break;
			case 1:
				suffix = dirty;
				break;
			default:
				/* diff-index aborted abnormally */
				suffix = broken;
			}
		} else if (dirty) {
			static struct lock_file index_lock;
			int fd;

			read_cache_preload(NULL);
			refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED,
				      NULL, NULL, NULL);
			fd = hold_locked_index(&index_lock, 0);
			if (0 <= fd)
				update_index_if_able(&the_index, &index_lock);

			if (!cmd_diff_index(ARRAY_SIZE(diff_index_args) - 1,
					    diff_index_args, prefix))
				suffix = NULL;
			else
				suffix = dirty;
		}
		describe("HEAD", 1);
	} else if (dirty) {
		die(_("--dirty is incompatible with commit-ishes"));
	} else if (broken) {
		die(_("--broken is incompatible with commit-ishes"));
	} else {
		while (argc-- > 0)
			describe(*argv++, argc == 0);
	}
	return 0;
}
Commit	Line	Data
908e5310	1	#include "cache.h"
b2141fc1	2	#include "config.h"
697cc8ef	3	#include "lockfile.h"
908e5310	4	#include "commit.h"
635d4134	5	#include "tag.h"
908e5310	6	#include "refs.h"
9a0eaf83	7	#include "builtin.h"
23615708	8	#include "exec_cmd.h"
166185be	9	#include "parse-options.h"
9f67d2e8	10	#include "diff.h"
29d8a834	11	#include "hashmap.h"
45bc950b	12	#include "argv-array.h"
b0176ce6	13	#include "run-command.h"
908e5310	14
c4472643	15	#define SEEN (1u << 0)
8713ab30 SP	16	#define MAX_TAGS (FLAG_BITS - 1)
8713ab30 SP	17
166185be	18	static const char * const describe_usage[] = {
9c9b4f2f AH	19	N_("git describe [<options>] [<commit-ish>...]"),
9c9b4f2f AH	20	N_("git describe [<options>] --dirty"),
166185be PH	21	NULL
166185be PH	22	};
908e5310	23
8713ab30	24	static int debug; /* Display lots of verbose info */
7e425c4f SP	25	static int all; /* Any valid ref can be used */
7e425c4f SP	26	static int tags; /* Allow lightweight tags */
518120e3	27	static int longformat;
e00dd1e9	28	static int first_parent;
dce96489	29	static int abbrev = -1; /* unspecified */
8713ab30	30	static int max_candidates = 10;
29d8a834	31	static struct hashmap names;
d1645d02	32	static int have_util;
43f8080e	33	static struct string_list patterns = STRING_LIST_INIT_NODUP;
77d21f29	34	static struct string_list exclude_patterns = STRING_LIST_INIT_NODUP;
da2478db	35	static int always;
b0176ce6	36	static const char suffix, dirty, *broken;
9f67d2e8 JP	37
	38	/* diff-index command arguments to check if working tree is dirty. */
	39	static const char *diff_index_args[] = {
	40	"diff-index", "--quiet", "HEAD", "--", NULL
	41	};
	42
e7eb5034	43	struct commit_name {
29d8a834	44	struct hashmap_entry entry;
6439b5d9	45	struct object_id peeled;
212945d4	46	struct tag *tag;
03e8b541 SP	47	unsigned prio:2; /* annotated tag = 2, tag = 1, head = 0 */
03e8b541 SP	48	unsigned name_checked:1;
6439b5d9	49	struct object_id oid;
219a0f33	50	char *path;
e7eb5034	51	};
c4472643	52
cf69fd49	53	static const char *prio_names[] = {
646c3bd1	54	N_("head"), N_("lightweight"), N_("annotated"),
cf69fd49	55	};
908e5310	56
7663cdc8	57	static int commit_name_cmp(const void *unused_cmp_data,
0068cede SB	58	const void *entry,
0068cede SB	59	const void *entry_or_key,
7663cdc8	60	const void *peeled)
29d8a834	61	{
0068cede SB	62	const struct commit_name *cn1 = entry;
	63	const struct commit_name *cn2 = entry_or_key;
	64
6439b5d9	65	return oidcmp(&cn1->peeled, peeled ? peeled : &cn2->peeled);
29d8a834 KB	66	}
29d8a834 KB	67
6439b5d9	68	static inline struct commit_name find_commit_name(const struct object_id peeled)
3cfa4db3	69	{
6439b5d9	70	return hashmap_get_from_hash(&names, sha1hash(peeled->hash), peeled->hash);
d1645d02 AK	71	}
d1645d02 AK	72
03e8b541 SP	73	static int replace_name(struct commit_name *e,
03e8b541 SP	74	int prio,
6439b5d9	75	const struct object_id *oid,
03e8b541 SP	76	struct tag **tag)
	77	{
	78	if (!e \|\| e->prio < prio)
	79	return 1;
	80
	81	if (e->prio == 2 && prio == 2) {
	82	/* Multiple annotated tags point to the same commit.
	83	* Select one to keep based upon their tagger date.
	84	*/
	85	struct tag *t;
	86
	87	if (!e->tag) {
d3101b53	88	t = lookup_tag(&e->oid);
03e8b541 SP	89	if (!t \|\| parse_tag(t))
	90	return 1;
	91	e->tag = t;
	92	}
	93
d3101b53	94	t = lookup_tag(oid);
03e8b541 SP	95	if (!t \|\| parse_tag(t))
	96	return 0;
	97	*tag = t;
	98
	99	if (e->tag->date < t->date)
	100	return 1;
	101	}
	102
	103	return 0;
	104	}
	105
64deb858	106	static void add_to_known_names(const char *path,
6439b5d9	107	const struct object_id *peeled,
212945d4	108	int prio,
6439b5d9	109	const struct object_id *oid)
908e5310	110	{
3cfa4db3	111	struct commit_name *e = find_commit_name(peeled);
03e8b541	112	struct tag *tag = NULL;
6439b5d9	113	if (replace_name(e, prio, oid, &tag)) {
1e1ade18 AK	114	if (!e) {
1e1ade18 AK	115	e = xmalloc(sizeof(struct commit_name));
6439b5d9	116	oidcpy(&e->peeled, peeled);
6439b5d9	117	hashmap_entry_init(e, sha1hash(peeled->hash));
29d8a834	118	hashmap_add(&names, e);
219a0f33	119	e->path = NULL;
1e1ade18	120	}
03e8b541	121	e->tag = tag;
e7eb5034	122	e->prio = prio;
03e8b541	123	e->name_checked = 0;
6439b5d9	124	oidcpy(&e->oid, oid);
219a0f33 MH	125	free(e->path);
219a0f33 MH	126	e->path = xstrdup(path);
908e5310	127	}
908e5310 LT	128	}
908e5310 LT	129
99a2cfbf	130	static int get_name(const char path, const struct object_id oid, int flag, void *cb_data)
908e5310	131	{
59556548	132	int is_tag = starts_with(path, "refs/tags/");
99a2cfbf	133	struct object_id peeled;
46e1d6eb	134	int is_annotated, prio;
feededd0	135
46e1d6eb JH	136	/* Reject anything outside refs/tags/ unless --all */
46e1d6eb JH	137	if (!all && !is_tag)
8a5a1884 SP	138	return 0;
8a5a1884 SP	139
77d21f29 JK	140	/*
	141	* If we're given exclude patterns, first exclude any tag which match
	142	* any of the exclude pattern.
	143	*/
	144	if (exclude_patterns.nr) {
	145	struct string_list_item *item;
	146
	147	if (!is_tag)
	148	return 0;
	149
	150	for_each_string_list_item(item, &exclude_patterns) {
55d34269	151	if (!wildmatch(item->string, path + 10, 0))
77d21f29 JK	152	return 0;
	153	}
	154	}
	155
43f8080e JK	156	/*
	157	* If we're given patterns, accept only tags which match at least one
	158	* pattern.
	159	*/
	160	if (patterns.nr) {
da769d29	161	int found = 0;
43f8080e JK	162	struct string_list_item *item;
	163
	164	if (!is_tag)
	165	return 0;
	166
	167	for_each_string_list_item(item, &patterns) {
3445c3dd	168	if (!wildmatch(item->string, path + 10, 0)) {
da769d29	169	found = 1;
43f8080e	170	break;
da769d29 MK	171	}
da769d29 MK	172	}
43f8080e	173
da769d29	174	if (!found)
43f8080e	175	return 0;
43f8080e	176	}
46e1d6eb JH	177
46e1d6eb JH	178	/* Is it annotated? */
99a2cfbf MH	179	if (!peel_ref(path, peeled.hash)) {
99a2cfbf MH	180	is_annotated = !!oidcmp(oid, &peeled);
feededd0	181	} else {
99a2cfbf	182	oidcpy(&peeled, oid);
46e1d6eb	183	is_annotated = 0;
feededd0	184	}
64deb858	185
46e1d6eb JH	186	/*
	187	* By default, we only use annotated tags, but with --tags
	188	* we fall back to lightweight ones (even without --tags,
	189	* we still remember lightweight ones, only to give hints
	190	* in an error message). --all allows any refs to be used.
2d9e7c9f	191	*/
46e1d6eb JH	192	if (is_annotated)
	193	prio = 2;
	194	else if (is_tag)
	195	prio = 1;
64deb858 JH	196	else
	197	prio = 0;
	198
6439b5d9	199	add_to_known_names(all ? path + 5 : path + 10, &peeled, prio, oid);
908e5310 LT	200	return 0;
	201	}
	202
80dbae03	203	struct possible_tag {
80dbae03	204	struct commit_name *name;
cf69fd49 SP	205	int depth;
cf69fd49 SP	206	int found_order;
8713ab30	207	unsigned flag_within;
80dbae03 SP	208	};
80dbae03 SP	209
cf69fd49 SP	210	static int compare_pt(const void a_, const void b_)
	211	{
	212	struct possible_tag a = (struct possible_tag )a_;
	213	struct possible_tag b = (struct possible_tag )b_;
cf69fd49 SP	214	if (a->depth != b->depth)
	215	return a->depth - b->depth;
	216	if (a->found_order != b->found_order)
	217	return a->found_order - b->found_order;
	218	return 0;
	219	}
	220
1b600e65 SP	221	static unsigned long finish_depth_computation(
	222	struct commit_list **list,
	223	struct possible_tag *best)
	224	{
	225	unsigned long seen_commits = 0;
	226	while (*list) {
	227	struct commit *c = pop_commit(list);
	228	struct commit_list *parents = c->parents;
	229	seen_commits++;
	230	if (c->object.flags & best->flag_within) {
	231	struct commit_list a = list;
	232	while (a) {
	233	struct commit *i = a->item;
	234	if (!(i->object.flags & best->flag_within))
	235	break;
	236	a = a->next;
	237	}
	238	if (!a)
	239	break;
	240	} else
	241	best->depth++;
	242	while (parents) {
	243	struct commit *p = parents->item;
	244	parse_commit(p);
	245	if (!(p->object.flags & SEEN))
47e44ed1	246	commit_list_insert_by_date(p, list);
1b600e65 SP	247	p->object.flags \|= c->object.flags;
	248	parents = parents->next;
	249	}
	250	}
	251	return seen_commits;
	252	}
	253
212945d4 SP	254	static void display_name(struct commit_name *n)
	255	{
	256	if (n->prio == 2 && !n->tag) {
d3101b53	257	n->tag = lookup_tag(&n->oid);
03e8b541	258	if (!n->tag \|\| parse_tag(n->tag))
e41f1cb3	259	die(_("annotated tag %s not available"), n->path);
03e8b541 SP	260	}
	261	if (n->tag && !n->name_checked) {
	262	if (!n->tag->tag)
e41f1cb3	263	die(_("annotated tag %s has no embedded name"), n->path);
81dc223d	264	if (strcmp(n->tag->tag, all ? n->path + 5 : n->path))
e41f1cb3	265	warning(_("tag '%s' is really '%s' here"), n->tag->tag, n->path);
03e8b541	266	n->name_checked = 1;
212945d4 SP	267	}
	268
	269	if (n->tag)
	270	printf("%s", n->tag->tag);
	271	else
	272	printf("%s", n->path);
870cf7d6 JH	273	}
870cf7d6 JH	274
6439b5d9	275	static void show_suffix(int depth, const struct object_id *oid)
870cf7d6	276	{
6439b5d9	277	printf("-%d-g%s", depth, find_unique_abbrev(oid->hash, abbrev));
212945d4 SP	278	}
212945d4 SP	279
554fe20d	280	static void describe(const char *arg, int last_one)
908e5310	281	{
6439b5d9	282	struct object_id oid;
8713ab30	283	struct commit cmit, gave_up_on = NULL;
908e5310	284	struct commit_list *list;
908e5310	285	struct commit_name *n;
cf69fd49	286	struct possible_tag all_matches[MAX_TAGS];
8713ab30 SP	287	unsigned int match_cnt = 0, annotated_cnt = 0, cur_match;
8713ab30 SP	288	unsigned long seen_commits = 0;
4d23660e	289	unsigned int unannotated_cnt = 0;
908e5310	290
6439b5d9	291	if (get_oid(arg, &oid))
e41f1cb3	292	die(_("Not a valid object name %s"), arg);
bc83266a	293	cmit = lookup_commit_reference(&oid);
4c34a2c5	294	if (!cmit)
e41f1cb3	295	die(_("%s is not a valid '%s' object"), arg, commit_type);
4c34a2c5	296
6439b5d9	297	n = find_commit_name(&cmit->object.oid);
7a0d61bb	298	if (n && (tags \|\| all \|\| n->prio == 2)) {
870cf7d6 JH	299	/*
	300	* Exact match to an existing ref.
	301	*/
212945d4	302	display_name(n);
870cf7d6	303	if (longformat)
6439b5d9	304	show_suffix(0, n->tag ? &n->tag->tagged->oid : &oid);
b0176ce6 SB	305	if (suffix)
b0176ce6 SB	306	printf("%s", suffix);
212945d4	307	printf("\n");
908e5310 LT	308	return;
	309	}
	310
2c33f757	311	if (!max_candidates)
f2fd0760	312	die(_("no tag exactly matches '%s'"), oid_to_hex(&cmit->object.oid));
8713ab30	313	if (debug)
e41f1cb3	314	fprintf(stderr, _("searching to describe %s\n"), arg);
8713ab30	315
d1645d02	316	if (!have_util) {
29d8a834 KB	317	struct hashmap_iter iter;
	318	struct commit *c;
	319	struct commit_name *n = hashmap_iter_first(&names, &iter);
	320	for (; n; n = hashmap_iter_next(&iter)) {
bc83266a	321	c = lookup_commit_reference_gently(&n->peeled, 1);
29d8a834 KB	322	if (c)
	323	c->util = n;
	324	}
d1645d02 AK	325	have_util = 1;
	326	}
	327
908e5310	328	list = NULL;
8713ab30	329	cmit->object.flags = SEEN;
908e5310 LT	330	commit_list_insert(cmit, &list);
908e5310 LT	331	while (list) {
80dbae03	332	struct commit *c = pop_commit(&list);
dccd0c2a	333	struct commit_list *parents = c->parents;
8713ab30	334	seen_commits++;
e7eb5034	335	n = c->util;
908e5310	336	if (n) {
4d23660e TR	337	if (!tags && !all && n->prio < 2) {
	338	unannotated_cnt++;
	339	} else if (match_cnt < max_candidates) {
8713ab30 SP	340	struct possible_tag *t = &all_matches[match_cnt++];
	341	t->name = n;
	342	t->depth = seen_commits - 1;
	343	t->flag_within = 1u << match_cnt;
8a8169c0	344	t->found_order = match_cnt;
8713ab30 SP	345	c->object.flags \|= t->flag_within;
	346	if (n->prio == 2)
	347	annotated_cnt++;
	348	}
	349	else {
	350	gave_up_on = c;
	351	break;
	352	}
	353	}
	354	for (cur_match = 0; cur_match < match_cnt; cur_match++) {
	355	struct possible_tag *t = &all_matches[cur_match];
	356	if (!(c->object.flags & t->flag_within))
	357	t->depth++;
	358	}
	359	if (annotated_cnt && !list) {
	360	if (debug)
e41f1cb3	361	fprintf(stderr, _("finished search at %s\n"),
f2fd0760	362	oid_to_hex(&c->object.oid));
8713ab30	363	break;
dccd0c2a SP	364	}
	365	while (parents) {
	366	struct commit *p = parents->item;
	367	parse_commit(p);
8713ab30	368	if (!(p->object.flags & SEEN))
47e44ed1	369	commit_list_insert_by_date(p, &list);
8713ab30	370	p->object.flags \|= c->object.flags;
dccd0c2a	371	parents = parents->next;
e00dd1e9 MC	372
	373	if (first_parent)
	374	break;
80dbae03 SP	375	}
	376	}
	377
da2478db	378	if (!match_cnt) {
f2fd0760	379	struct object_id *oid = &cmit->object.oid;
da2478db	380	if (always) {
f2fd0760	381	printf("%s", find_unique_abbrev(oid->hash, abbrev));
b0176ce6 SB	382	if (suffix)
b0176ce6 SB	383	printf("%s", suffix);
9f67d2e8	384	printf("\n");
da2478db JH	385	return;
da2478db JH	386	}
4d23660e	387	if (unannotated_cnt)
e41f1cb3 ÆAB	388	die(_("No annotated tags can describe '%s'.\n"
e41f1cb3 ÆAB	389	"However, there were unannotated tags: try --tags."),
f2fd0760	390	oid_to_hex(oid));
4d23660e	391	else
e41f1cb3 ÆAB	392	die(_("No tags can describe '%s'.\n"
e41f1cb3 ÆAB	393	"Try --always, or create some tags."),
f2fd0760	394	oid_to_hex(oid));
da2478db	395	}
80dbae03	396
9ed0d8d6	397	QSORT(all_matches, match_cnt, compare_pt);
1b600e65 SP	398
1b600e65 SP	399	if (gave_up_on) {
47e44ed1	400	commit_list_insert_by_date(gave_up_on, &list);
1b600e65 SP	401	seen_commits--;
	402	}
	403	seen_commits += finish_depth_computation(&list, &all_matches[0]);
	404	free_commit_list(list);
	405
8713ab30	406	if (debug) {
646c3bd1 MG	407	static int label_width = -1;
	408	if (label_width < 0) {
	409	int i, w;
	410	for (i = 0; i < ARRAY_SIZE(prio_names); i++) {
	411	w = strlen(_(prio_names[i]));
	412	if (label_width < w)
	413	label_width = w;
	414	}
	415	}
8713ab30 SP	416	for (cur_match = 0; cur_match < match_cnt; cur_match++) {
8713ab30 SP	417	struct possible_tag *t = &all_matches[cur_match];
646c3bd1 MG	418	fprintf(stderr, " %-*s %8d %s\n",
646c3bd1 MG	419	label_width, _(prio_names[t->name->prio]),
8713ab30 SP	420	t->depth, t->name->path);
8713ab30 SP	421	}
e41f1cb3	422	fprintf(stderr, _("traversed %lu commits\n"), seen_commits);
8713ab30 SP	423	if (gave_up_on) {
8713ab30 SP	424	fprintf(stderr,
e41f1cb3 ÆAB	425	_("more than %i tags found; listed %i most recent\n"
e41f1cb3 ÆAB	426	"gave up search at %s\n"),
8713ab30	427	max_candidates, max_candidates,
f2fd0760	428	oid_to_hex(&gave_up_on->object.oid));
8713ab30	429	}
80dbae03	430	}
212945d4 SP	431
	432	display_name(all_matches[0].name);
	433	if (abbrev)
6439b5d9	434	show_suffix(all_matches[0].depth, &cmit->object.oid);
b0176ce6 SB	435	if (suffix)
b0176ce6 SB	436	printf("%s", suffix);
212945d4	437	printf("\n");
80dbae03	438
8713ab30 SP	439	if (!last_one)
8713ab30 SP	440	clear_commit_marks(cmit, -1);
908e5310 LT	441	}
908e5310 LT	442
9a0eaf83	443	int cmd_describe(int argc, const char *argv, const char prefix)
908e5310	444	{
23615708	445	int contains = 0;
166185be	446	struct option options[] = {
d5d09d47 SB	447	OPT_BOOL(0, "contains", &contains, N_("find the tag that comes after the commit")),
	448	OPT_BOOL(0, "debug", &debug, N_("debug search strategy on stderr")),
	449	OPT_BOOL(0, "all", &all, N_("use any ref")),
	450	OPT_BOOL(0, "tags", &tags, N_("use any tag, even unannotated")),
	451	OPT_BOOL(0, "long", &longformat, N_("always use long format")),
	452	OPT_BOOL(0, "first-parent", &first_parent, N_("only follow first parent")),
166185be	453	OPT__ABBREV(&abbrev),
2c33f757	454	OPT_SET_INT(0, "exact-match", &max_candidates,
bfb0737d	455	N_("only output exact matches"), 0),
166185be	456	OPT_INTEGER(0, "candidates", &max_candidates,
bfb0737d	457	N_("consider <n> most recent tags (default: 10)")),
43f8080e	458	OPT_STRING_LIST(0, "match", &patterns, N_("pattern"),
bfb0737d	459	N_("only consider tags matching <pattern>")),
77d21f29 JK	460	OPT_STRING_LIST(0, "exclude", &exclude_patterns, N_("pattern"),
77d21f29 JK	461	N_("do not consider tags matching <pattern>")),
d5d09d47 SB	462	OPT_BOOL(0, "always", &always,
d5d09d47 SB	463	N_("show abbreviated commit object as fallback")),
bfb0737d	464	{OPTION_STRING, 0, "dirty", &dirty, N_("mark"),
d5d09d47 SB	465	N_("append <mark> on dirty working tree (default: \"-dirty\")"),
d5d09d47 SB	466	PARSE_OPT_OPTARG, NULL, (intptr_t) "-dirty"},
b0176ce6 SB	467	{OPTION_STRING, 0, "broken", &broken, N_("mark"),
	468	N_("append <mark> on broken working tree (default: \"-broken\")"),
	469	PARSE_OPT_OPTARG, NULL, (intptr_t) "-broken"},
166185be PH	470	OPT_END(),
166185be PH	471	};
908e5310	472
dce96489	473	git_config(git_default_config, NULL);
37782920	474	argc = parse_options(argc, argv, prefix, options, describe_usage, 0);
dce96489 LT	475	if (abbrev < 0)
	476	abbrev = DEFAULT_ABBREV;
	477
2c33f757 SP	478	if (max_candidates < 0)
2c33f757 SP	479	max_candidates = 0;
166185be PH	480	else if (max_candidates > MAX_TAGS)
166185be PH	481	max_candidates = MAX_TAGS;
4c34a2c5	482
8c599c74	483	save_commit_buffer = 0;
8112894d	484
518120e3	485	if (longformat && abbrev == 0)
e41f1cb3	486	die(_("--long is incompatible with --abbrev=0"));
518120e3	487
23615708	488	if (contains) {
43f8080e	489	struct string_list_item *item;
45bc950b JH	490	struct argv_array args;
	491
	492	argv_array_init(&args);
adfc1857 JH	493	argv_array_pushl(&args, "name-rev",
adfc1857 JH	494	"--peel-tag", "--name-only", "--no-undefined",
45bc950b	495	NULL);
da2478db	496	if (always)
45bc950b	497	argv_array_push(&args, "--always");
30ffa603	498	if (!all) {
45bc950b	499	argv_array_push(&args, "--tags");
43f8080e JK	500	for_each_string_list_item(item, &patterns)
43f8080e JK	501	argv_array_pushf(&args, "--refs=refs/tags/%s", item->string);
77d21f29 JK	502	for_each_string_list_item(item, &exclude_patterns)
77d21f29 JK	503	argv_array_pushf(&args, "--exclude=refs/tags/%s", item->string);
45bc950b	504	}
2bd07065 SG	505	if (argc)
	506	argv_array_pushv(&args, argv);
	507	else
	508	argv_array_push(&args, "HEAD");
45bc950b	509	return cmd_name_rev(args.argc, args.argv, prefix);
23615708 SP	510	}
23615708 SP	511
0068cede	512	hashmap_init(&names, commit_name_cmp, NULL, 0);
99a2cfbf	513	for_each_rawref(get_name, NULL);
8b604d19	514	if (!hashmap_get_size(&names) && !always)
e41f1cb3	515	die(_("No names found, cannot describe anything."));
fb423da0	516
166185be	517	if (argc == 0) {
b0176ce6 SB	518	if (broken) {
	519	struct child_process cp = CHILD_PROCESS_INIT;
	520	argv_array_pushv(&cp.args, diff_index_args);
	521	cp.git_cmd = 1;
	522	cp.no_stdin = 1;
	523	cp.no_stdout = 1;
	524
	525	if (!dirty)
	526	dirty = "-dirty";
	527
	528	switch (run_command(&cp)) {
	529	case 0:
	530	suffix = NULL;
	531	break;
	532	case 1:
	533	suffix = dirty;
	534	break;
	535	default:
	536	/* diff-index aborted abnormally */
	537	suffix = broken;
	538	}
	539	} else if (dirty) {
bb571486 AC	540	static struct lock_file index_lock;
	541	int fd;
	542
	543	read_cache_preload(NULL);
	544	refresh_index(&the_index, REFRESH_QUIET\|REFRESH_UNMERGED,
	545	NULL, NULL, NULL);
	546	fd = hold_locked_index(&index_lock, 0);
	547	if (0 <= fd)
	548	update_index_if_able(&the_index, &index_lock);
	549
	550	if (!cmd_diff_index(ARRAY_SIZE(diff_index_args) - 1,
	551	diff_index_args, prefix))
b0176ce6 SB	552	suffix = NULL;
	553	else
	554	suffix = dirty;
bb571486	555	}
fec9ebf1	556	describe("HEAD", 1);
9f67d2e8	557	} else if (dirty) {
a8a5406a	558	die(_("--dirty is incompatible with commit-ishes"));
b0176ce6 SB	559	} else if (broken) {
b0176ce6 SB	560	die(_("--broken is incompatible with commit-ishes"));
166185be	561	} else {
c4472643	562	while (argc-- > 0)
166185be	563	describe(*argv++, argc == 0);
166185be	564	}
908e5310 LT	565	return 0;
908e5310 LT	566	}