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