7 #include "parse-options.h"
10 #define MAX_TAGS (FLAG_BITS - 1)
12 static const char * const describe_usage[] = {
13 "git-describe [options] <committish>*",
17 static int debug; /* Display lots of verbose info */
18 static int all; /* Default to annotated tags only */
19 static int tags; /* But allow any tags if --tags is specified */
20 static int longformat;
21 static int abbrev = DEFAULT_ABBREV;
22 static int max_candidates = 10;
23 const char *pattern = NULL;
28 int prio; /* annotated tag = 2, tag = 1, head = 0 */
29 unsigned char sha1[20];
30 char path[FLEX_ARRAY]; /* more */
32 static const char *prio_names[] = {
33 "head", "lightweight", "annotated",
36 static void add_to_known_names(const char *path,
37 struct commit *commit,
39 const unsigned char *sha1)
41 struct commit_name *e = commit->util;
42 if (!e || e->prio < prio) {
43 size_t len = strlen(path)+1;
45 e = xmalloc(sizeof(struct commit_name) + len);
48 hashcpy(e->sha1, sha1);
49 memcpy(e->path, path, len);
54 static int get_name(const char *path, const unsigned char *sha1, int flag, void *cb_data)
56 int might_be_tag = !prefixcmp(path, "refs/tags/");
57 struct commit *commit;
58 struct object *object;
59 unsigned char peeled[20];
62 if (!all && !might_be_tag)
65 if (!peel_ref(path, peeled) && !is_null_sha1(peeled)) {
66 commit = lookup_commit_reference_gently(peeled, 1);
69 is_tag = !!hashcmp(sha1, commit->object.sha1);
71 commit = lookup_commit_reference_gently(sha1, 1);
72 object = parse_object(sha1);
73 if (!commit || !object)
75 is_tag = object->type == OBJ_TAG;
78 /* If --all, then any refs are used.
79 * If --tags, then any tags are used.
80 * Otherwise only annotated tags are used.
85 if (pattern && fnmatch(pattern, path + 10, 0))
96 if (!tags && prio < 2)
99 add_to_known_names(all ? path + 5 : path + 10, commit, prio, sha1);
103 struct possible_tag {
104 struct commit_name *name;
107 unsigned flag_within;
110 static int compare_pt(const void *a_, const void *b_)
112 struct possible_tag *a = (struct possible_tag *)a_;
113 struct possible_tag *b = (struct possible_tag *)b_;
114 if (a->name->prio != b->name->prio)
115 return b->name->prio - a->name->prio;
116 if (a->depth != b->depth)
117 return a->depth - b->depth;
118 if (a->found_order != b->found_order)
119 return a->found_order - b->found_order;
123 static unsigned long finish_depth_computation(
124 struct commit_list **list,
125 struct possible_tag *best)
127 unsigned long seen_commits = 0;
129 struct commit *c = pop_commit(list);
130 struct commit_list *parents = c->parents;
132 if (c->object.flags & best->flag_within) {
133 struct commit_list *a = *list;
135 struct commit *i = a->item;
136 if (!(i->object.flags & best->flag_within))
145 struct commit *p = parents->item;
147 if (!(p->object.flags & SEEN))
148 insert_by_date(p, list);
149 p->object.flags |= c->object.flags;
150 parents = parents->next;
156 static void display_name(struct commit_name *n)
158 if (n->prio == 2 && !n->tag) {
159 n->tag = lookup_tag(n->sha1);
160 if (!n->tag || !n->tag->tag)
161 die("annotated tag %s not available", n->path);
162 if (strcmp(n->tag->tag, n->path))
163 warning("tag '%s' is really '%s' here", n->tag->tag, n->path);
167 printf("%s", n->tag->tag);
169 printf("%s", n->path);
172 find_unique_abbrev(n->tag->tagged->sha1, abbrev));
175 static void describe(const char *arg, int last_one)
177 unsigned char sha1[20];
178 struct commit *cmit, *gave_up_on = NULL;
179 struct commit_list *list;
180 static int initialized = 0;
181 struct commit_name *n;
182 struct possible_tag all_matches[MAX_TAGS];
183 unsigned int match_cnt = 0, annotated_cnt = 0, cur_match;
184 unsigned long seen_commits = 0;
186 if (get_sha1(arg, sha1))
187 die("Not a valid object name %s", arg);
188 cmit = lookup_commit_reference(sha1);
190 die("%s is not a valid '%s' object", arg, commit_type);
194 for_each_ref(get_name, NULL);
205 die("no tag exactly matches '%s'", sha1_to_hex(cmit->object.sha1));
207 fprintf(stderr, "searching to describe %s\n", arg);
210 cmit->object.flags = SEEN;
211 commit_list_insert(cmit, &list);
213 struct commit *c = pop_commit(&list);
214 struct commit_list *parents = c->parents;
218 if (match_cnt < max_candidates) {
219 struct possible_tag *t = &all_matches[match_cnt++];
221 t->depth = seen_commits - 1;
222 t->flag_within = 1u << match_cnt;
223 t->found_order = match_cnt;
224 c->object.flags |= t->flag_within;
233 for (cur_match = 0; cur_match < match_cnt; cur_match++) {
234 struct possible_tag *t = &all_matches[cur_match];
235 if (!(c->object.flags & t->flag_within))
238 if (annotated_cnt && !list) {
240 fprintf(stderr, "finished search at %s\n",
241 sha1_to_hex(c->object.sha1));
245 struct commit *p = parents->item;
247 if (!(p->object.flags & SEEN))
248 insert_by_date(p, &list);
249 p->object.flags |= c->object.flags;
250 parents = parents->next;
255 const unsigned char *sha1 = cmit->object.sha1;
257 printf("%s\n", find_unique_abbrev(sha1, abbrev));
260 die("cannot describe '%s'", sha1_to_hex(sha1));
263 qsort(all_matches, match_cnt, sizeof(all_matches[0]), compare_pt);
266 insert_by_date(gave_up_on, &list);
269 seen_commits += finish_depth_computation(&list, &all_matches[0]);
270 free_commit_list(list);
273 for (cur_match = 0; cur_match < match_cnt; cur_match++) {
274 struct possible_tag *t = &all_matches[cur_match];
275 fprintf(stderr, " %-11s %8d %s\n",
276 prio_names[t->name->prio],
277 t->depth, t->name->path);
279 fprintf(stderr, "traversed %lu commits\n", seen_commits);
282 "more than %i tags found; listed %i most recent\n"
283 "gave up search at %s\n",
284 max_candidates, max_candidates,
285 sha1_to_hex(gave_up_on->object.sha1));
289 display_name(all_matches[0].name);
291 printf("-%d-g%s", all_matches[0].depth,
292 find_unique_abbrev(cmit->object.sha1, abbrev));
296 clear_commit_marks(cmit, -1);
299 int cmd_describe(int argc, const char **argv, const char *prefix)
302 struct option options[] = {
303 OPT_BOOLEAN(0, "contains", &contains, "find the tag that comes after the commit"),
304 OPT_BOOLEAN(0, "debug", &debug, "debug search strategy on stderr"),
305 OPT_BOOLEAN(0, "all", &all, "use any ref in .git/refs"),
306 OPT_BOOLEAN(0, "tags", &tags, "use any tag in .git/refs/tags"),
307 OPT_BOOLEAN(0, "long", &longformat, "always use long format"),
308 OPT__ABBREV(&abbrev),
309 OPT_SET_INT(0, "exact-match", &max_candidates,
310 "only output exact matches", 0),
311 OPT_INTEGER(0, "candidates", &max_candidates,
312 "consider <n> most recent tags (default: 10)"),
313 OPT_STRING(0, "match", &pattern, "pattern",
314 "only consider tags matching <pattern>"),
315 OPT_BOOLEAN(0, "always", &always,
316 "show abbreviated commit object as fallback"),
320 argc = parse_options(argc, argv, options, describe_usage, 0);
321 if (max_candidates < 0)
323 else if (max_candidates > MAX_TAGS)
324 max_candidates = MAX_TAGS;
326 save_commit_buffer = 0;
328 if (longformat && abbrev == 0)
329 die("--long is incompatible with --abbrev=0");
332 const char **args = xmalloc((7 + argc) * sizeof(char*));
334 args[i++] = "name-rev";
335 args[i++] = "--name-only";
336 args[i++] = "--no-undefined";
338 args[i++] = "--always";
340 args[i++] = "--tags";
342 char *s = xmalloc(strlen("--refs=refs/tags/") + strlen(pattern) + 1);
343 sprintf(s, "--refs=refs/tags/%s", pattern);
347 memcpy(args + i, argv, argc * sizeof(char*));
348 args[i + argc] = NULL;
349 return cmd_name_rev(i + argc, args, prefix);
356 describe(*argv++, argc == 0);