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