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