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