1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
11 #include "parse-options.h"
15 #include "argv-array.h"
16 #include "run-command.h"
17 #include "object-store.h"
18 #include "list-objects.h"
19 #include "commit-slab.h"
21 #define MAX_TAGS (FLAG_BITS - 1)
23 define_commit_slab(commit_names
, struct commit_name
*);
25 static const char * const describe_usage
[] = {
26 N_("git describe [<options>] [<commit-ish>...]"),
27 N_("git describe [<options>] --dirty"),
31 static int debug
; /* Display lots of verbose info */
32 static int all
; /* Any valid ref can be used */
33 static int tags
; /* Allow lightweight tags */
34 static int longformat
;
35 static int first_parent
;
36 static int abbrev
= -1; /* unspecified */
37 static int max_candidates
= 10;
38 static struct hashmap names
;
40 static struct string_list patterns
= STRING_LIST_INIT_NODUP
;
41 static struct string_list exclude_patterns
= STRING_LIST_INIT_NODUP
;
43 static const char *suffix
, *dirty
, *broken
;
44 static struct commit_names commit_names
;
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
52 struct hashmap_entry entry
;
53 struct object_id peeled
;
55 unsigned prio
:2; /* annotated tag = 2, tag = 1, head = 0 */
56 unsigned name_checked
:1;
61 static const char *prio_names
[] = {
62 N_("head"), N_("lightweight"), N_("annotated"),
65 static int commit_name_neq(const void *unused_cmp_data
,
66 const struct hashmap_entry
*eptr
,
67 const struct hashmap_entry
*entry_or_key
,
70 const struct commit_name
*cn1
, *cn2
;
72 cn1
= container_of(eptr
, const struct commit_name
, entry
);
73 cn2
= container_of(entry_or_key
, const struct commit_name
, entry
);
75 return !oideq(&cn1
->peeled
, peeled
? peeled
: &cn2
->peeled
);
78 static inline struct commit_name
*find_commit_name(const struct object_id
*peeled
)
80 return hashmap_get_entry_from_hash(&names
, oidhash(peeled
), peeled
,
81 struct commit_name
, entry
);
84 static int replace_name(struct commit_name
*e
,
86 const struct object_id
*oid
,
89 if (!e
|| e
->prio
< prio
)
92 if (e
->prio
== 2 && prio
== 2) {
93 /* Multiple annotated tags point to the same commit.
94 * Select one to keep based upon their tagger date.
99 t
= lookup_tag(the_repository
, &e
->oid
);
100 if (!t
|| parse_tag(t
))
105 t
= lookup_tag(the_repository
, oid
);
106 if (!t
|| parse_tag(t
))
110 if (e
->tag
->date
< t
->date
)
117 static void add_to_known_names(const char *path
,
118 const struct object_id
*peeled
,
120 const struct object_id
*oid
)
122 struct commit_name
*e
= find_commit_name(peeled
);
123 struct tag
*tag
= NULL
;
124 if (replace_name(e
, prio
, oid
, &tag
)) {
126 e
= xmalloc(sizeof(struct commit_name
));
127 oidcpy(&e
->peeled
, peeled
);
128 hashmap_entry_init(&e
->entry
, oidhash(peeled
));
129 hashmap_add(&names
, &e
->entry
);
135 oidcpy(&e
->oid
, oid
);
137 e
->path
= xstrdup(path
);
141 static int get_name(const char *path
, const struct object_id
*oid
, int flag
, void *cb_data
)
144 struct object_id peeled
;
145 int is_annotated
, prio
;
146 const char *path_to_match
= NULL
;
148 if (skip_prefix(path
, "refs/tags/", &path_to_match
)) {
151 if ((exclude_patterns
.nr
|| patterns
.nr
) &&
152 !skip_prefix(path
, "refs/heads/", &path_to_match
) &&
153 !skip_prefix(path
, "refs/remotes/", &path_to_match
)) {
154 /* Only accept reference of known type if there are match/exclude patterns */
158 /* Reject anything outside refs/tags/ unless --all */
163 * If we're given exclude patterns, first exclude any tag which match
164 * any of the exclude pattern.
166 if (exclude_patterns
.nr
) {
167 struct string_list_item
*item
;
169 for_each_string_list_item(item
, &exclude_patterns
) {
170 if (!wildmatch(item
->string
, path_to_match
, 0))
176 * If we're given patterns, accept only tags which match at least one
181 struct string_list_item
*item
;
183 for_each_string_list_item(item
, &patterns
) {
184 if (!wildmatch(item
->string
, path_to_match
, 0)) {
194 /* Is it annotated? */
195 if (!peel_ref(path
, &peeled
)) {
196 is_annotated
= !oideq(oid
, &peeled
);
198 oidcpy(&peeled
, oid
);
203 * By default, we only use annotated tags, but with --tags
204 * we fall back to lightweight ones (even without --tags,
205 * we still remember lightweight ones, only to give hints
206 * in an error message). --all allows any refs to be used.
215 add_to_known_names(all
? path
+ 5 : path
+ 10, &peeled
, prio
, oid
);
219 struct possible_tag
{
220 struct commit_name
*name
;
223 unsigned flag_within
;
226 static int compare_pt(const void *a_
, const void *b_
)
228 struct possible_tag
*a
= (struct possible_tag
*)a_
;
229 struct possible_tag
*b
= (struct possible_tag
*)b_
;
230 if (a
->depth
!= b
->depth
)
231 return a
->depth
- b
->depth
;
232 if (a
->found_order
!= b
->found_order
)
233 return a
->found_order
- b
->found_order
;
237 static unsigned long finish_depth_computation(
238 struct commit_list
**list
,
239 struct possible_tag
*best
)
241 unsigned long seen_commits
= 0;
243 struct commit
*c
= pop_commit(list
);
244 struct commit_list
*parents
= c
->parents
;
246 if (c
->object
.flags
& best
->flag_within
) {
247 struct commit_list
*a
= *list
;
249 struct commit
*i
= a
->item
;
250 if (!(i
->object
.flags
& best
->flag_within
))
259 struct commit
*p
= parents
->item
;
261 if (!(p
->object
.flags
& SEEN
))
262 commit_list_insert_by_date(p
, list
);
263 p
->object
.flags
|= c
->object
.flags
;
264 parents
= parents
->next
;
270 static void append_name(struct commit_name
*n
, struct strbuf
*dst
)
272 if (n
->prio
== 2 && !n
->tag
) {
273 n
->tag
= lookup_tag(the_repository
, &n
->oid
);
274 if (!n
->tag
|| parse_tag(n
->tag
))
275 die(_("annotated tag %s not available"), n
->path
);
277 if (n
->tag
&& !n
->name_checked
) {
279 die(_("annotated tag %s has no embedded name"), n
->path
);
280 if (strcmp(n
->tag
->tag
, all
? n
->path
+ 5 : n
->path
))
281 warning(_("tag '%s' is really '%s' here"), n
->tag
->tag
, n
->path
);
287 strbuf_addstr(dst
, "tags/");
288 strbuf_addstr(dst
, n
->tag
->tag
);
290 strbuf_addstr(dst
, n
->path
);
294 static void append_suffix(int depth
, const struct object_id
*oid
, struct strbuf
*dst
)
296 strbuf_addf(dst
, "-%d-g%s", depth
, find_unique_abbrev(oid
, abbrev
));
299 static void describe_commit(struct object_id
*oid
, struct strbuf
*dst
)
301 struct commit
*cmit
, *gave_up_on
= NULL
;
302 struct commit_list
*list
;
303 struct commit_name
*n
;
304 struct possible_tag all_matches
[MAX_TAGS
];
305 unsigned int match_cnt
= 0, annotated_cnt
= 0, cur_match
;
306 unsigned long seen_commits
= 0;
307 unsigned int unannotated_cnt
= 0;
309 cmit
= lookup_commit_reference(the_repository
, oid
);
311 n
= find_commit_name(&cmit
->object
.oid
);
312 if (n
&& (tags
|| all
|| n
->prio
== 2)) {
314 * Exact match to an existing ref.
318 append_suffix(0, n
->tag
? get_tagged_oid(n
->tag
) : oid
, dst
);
320 strbuf_addstr(dst
, suffix
);
325 die(_("no tag exactly matches '%s'"), oid_to_hex(&cmit
->object
.oid
));
327 fprintf(stderr
, _("No exact match on refs or tags, searching to describe\n"));
330 struct hashmap_iter iter
;
332 struct commit_name
*n
;
334 init_commit_names(&commit_names
);
335 hashmap_for_each_entry(&names
, &iter
, n
,
336 entry
/* member name */) {
337 c
= lookup_commit_reference_gently(the_repository
,
340 *commit_names_at(&commit_names
, c
) = n
;
346 cmit
->object
.flags
= SEEN
;
347 commit_list_insert(cmit
, &list
);
349 struct commit
*c
= pop_commit(&list
);
350 struct commit_list
*parents
= c
->parents
;
351 struct commit_name
**slot
;
354 slot
= commit_names_peek(&commit_names
, c
);
355 n
= slot
? *slot
: NULL
;
357 if (!tags
&& !all
&& n
->prio
< 2) {
359 } else if (match_cnt
< max_candidates
) {
360 struct possible_tag
*t
= &all_matches
[match_cnt
++];
362 t
->depth
= seen_commits
- 1;
363 t
->flag_within
= 1u << match_cnt
;
364 t
->found_order
= match_cnt
;
365 c
->object
.flags
|= t
->flag_within
;
374 for (cur_match
= 0; cur_match
< match_cnt
; cur_match
++) {
375 struct possible_tag
*t
= &all_matches
[cur_match
];
376 if (!(c
->object
.flags
& t
->flag_within
))
379 /* Stop if last remaining path already covered by best candidate(s) */
380 if (annotated_cnt
&& !list
) {
381 int best_depth
= INT_MAX
;
382 unsigned best_within
= 0;
383 for (cur_match
= 0; cur_match
< match_cnt
; cur_match
++) {
384 struct possible_tag
*t
= &all_matches
[cur_match
];
385 if (t
->depth
< best_depth
) {
386 best_depth
= t
->depth
;
387 best_within
= t
->flag_within
;
388 } else if (t
->depth
== best_depth
) {
389 best_within
|= t
->flag_within
;
392 if ((c
->object
.flags
& best_within
) == best_within
) {
394 fprintf(stderr
, _("finished search at %s\n"),
395 oid_to_hex(&c
->object
.oid
));
400 struct commit
*p
= parents
->item
;
402 if (!(p
->object
.flags
& SEEN
))
403 commit_list_insert_by_date(p
, &list
);
404 p
->object
.flags
|= c
->object
.flags
;
405 parents
= parents
->next
;
413 struct object_id
*cmit_oid
= &cmit
->object
.oid
;
415 strbuf_add_unique_abbrev(dst
, cmit_oid
, abbrev
);
417 strbuf_addstr(dst
, suffix
);
421 die(_("No annotated tags can describe '%s'.\n"
422 "However, there were unannotated tags: try --tags."),
423 oid_to_hex(cmit_oid
));
425 die(_("No tags can describe '%s'.\n"
426 "Try --always, or create some tags."),
427 oid_to_hex(cmit_oid
));
430 QSORT(all_matches
, match_cnt
, compare_pt
);
433 commit_list_insert_by_date(gave_up_on
, &list
);
436 seen_commits
+= finish_depth_computation(&list
, &all_matches
[0]);
437 free_commit_list(list
);
440 static int label_width
= -1;
441 if (label_width
< 0) {
443 for (i
= 0; i
< ARRAY_SIZE(prio_names
); i
++) {
444 w
= strlen(_(prio_names
[i
]));
449 for (cur_match
= 0; cur_match
< match_cnt
; cur_match
++) {
450 struct possible_tag
*t
= &all_matches
[cur_match
];
451 fprintf(stderr
, " %-*s %8d %s\n",
452 label_width
, _(prio_names
[t
->name
->prio
]),
453 t
->depth
, t
->name
->path
);
455 fprintf(stderr
, _("traversed %lu commits\n"), seen_commits
);
458 _("more than %i tags found; listed %i most recent\n"
459 "gave up search at %s\n"),
460 max_candidates
, max_candidates
,
461 oid_to_hex(&gave_up_on
->object
.oid
));
465 append_name(all_matches
[0].name
, dst
);
467 append_suffix(all_matches
[0].depth
, &cmit
->object
.oid
, dst
);
469 strbuf_addstr(dst
, suffix
);
472 struct process_commit_data
{
473 struct object_id current_commit
;
474 struct object_id looking_for
;
476 struct rev_info
*revs
;
479 static void process_commit(struct commit
*commit
, void *data
)
481 struct process_commit_data
*pcd
= data
;
482 pcd
->current_commit
= commit
->object
.oid
;
485 static void process_object(struct object
*obj
, const char *path
, void *data
)
487 struct process_commit_data
*pcd
= data
;
489 if (oideq(&pcd
->looking_for
, &obj
->oid
) && !pcd
->dst
->len
) {
490 reset_revision_walk();
491 describe_commit(&pcd
->current_commit
, pcd
->dst
);
492 strbuf_addf(pcd
->dst
, ":%s", path
);
493 free_commit_list(pcd
->revs
->commits
);
494 pcd
->revs
->commits
= NULL
;
498 static void describe_blob(struct object_id oid
, struct strbuf
*dst
)
500 struct rev_info revs
;
501 struct argv_array args
= ARGV_ARRAY_INIT
;
502 struct process_commit_data pcd
= { null_oid
, oid
, dst
, &revs
};
504 argv_array_pushl(&args
, "internal: The first arg is not parsed",
505 "--objects", "--in-commit-order", "--reverse", "HEAD",
508 repo_init_revisions(the_repository
, &revs
, NULL
);
509 if (setup_revisions(args
.argc
, args
.argv
, &revs
, NULL
) > 1)
510 BUG("setup_revisions could not handle all args?");
512 if (prepare_revision_walk(&revs
))
513 die("revision walk setup failed");
515 traverse_commit_list(&revs
, process_commit
, process_object
, &pcd
);
516 reset_revision_walk();
519 static void describe(const char *arg
, int last_one
)
521 struct object_id oid
;
523 struct strbuf sb
= STRBUF_INIT
;
526 fprintf(stderr
, _("describe %s\n"), arg
);
528 if (get_oid(arg
, &oid
))
529 die(_("Not a valid object name %s"), arg
);
530 cmit
= lookup_commit_reference_gently(the_repository
, &oid
, 1);
533 describe_commit(&oid
, &sb
);
534 else if (oid_object_info(the_repository
, &oid
, NULL
) == OBJ_BLOB
)
535 describe_blob(oid
, &sb
);
537 die(_("%s is neither a commit nor blob"), arg
);
542 clear_commit_marks(cmit
, -1);
547 int cmd_describe(int argc
, const char **argv
, const char *prefix
)
550 struct option options
[] = {
551 OPT_BOOL(0, "contains", &contains
, N_("find the tag that comes after the commit")),
552 OPT_BOOL(0, "debug", &debug
, N_("debug search strategy on stderr")),
553 OPT_BOOL(0, "all", &all
, N_("use any ref")),
554 OPT_BOOL(0, "tags", &tags
, N_("use any tag, even unannotated")),
555 OPT_BOOL(0, "long", &longformat
, N_("always use long format")),
556 OPT_BOOL(0, "first-parent", &first_parent
, N_("only follow first parent")),
557 OPT__ABBREV(&abbrev
),
558 OPT_SET_INT(0, "exact-match", &max_candidates
,
559 N_("only output exact matches"), 0),
560 OPT_INTEGER(0, "candidates", &max_candidates
,
561 N_("consider <n> most recent tags (default: 10)")),
562 OPT_STRING_LIST(0, "match", &patterns
, N_("pattern"),
563 N_("only consider tags matching <pattern>")),
564 OPT_STRING_LIST(0, "exclude", &exclude_patterns
, N_("pattern"),
565 N_("do not consider tags matching <pattern>")),
566 OPT_BOOL(0, "always", &always
,
567 N_("show abbreviated commit object as fallback")),
568 {OPTION_STRING
, 0, "dirty", &dirty
, N_("mark"),
569 N_("append <mark> on dirty working tree (default: \"-dirty\")"),
570 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "-dirty"},
571 {OPTION_STRING
, 0, "broken", &broken
, N_("mark"),
572 N_("append <mark> on broken working tree (default: \"-broken\")"),
573 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "-broken"},
577 git_config(git_default_config
, NULL
);
578 argc
= parse_options(argc
, argv
, prefix
, options
, describe_usage
, 0);
580 abbrev
= DEFAULT_ABBREV
;
582 if (max_candidates
< 0)
584 else if (max_candidates
> MAX_TAGS
)
585 max_candidates
= MAX_TAGS
;
587 save_commit_buffer
= 0;
589 if (longformat
&& abbrev
== 0)
590 die(_("--long is incompatible with --abbrev=0"));
593 struct string_list_item
*item
;
594 struct argv_array args
;
596 argv_array_init(&args
);
597 argv_array_pushl(&args
, "name-rev",
598 "--peel-tag", "--name-only", "--no-undefined",
601 argv_array_push(&args
, "--always");
603 argv_array_push(&args
, "--tags");
604 for_each_string_list_item(item
, &patterns
)
605 argv_array_pushf(&args
, "--refs=refs/tags/%s", item
->string
);
606 for_each_string_list_item(item
, &exclude_patterns
)
607 argv_array_pushf(&args
, "--exclude=refs/tags/%s", item
->string
);
610 argv_array_pushv(&args
, argv
);
612 argv_array_push(&args
, "HEAD");
613 return cmd_name_rev(args
.argc
, args
.argv
, prefix
);
616 hashmap_init(&names
, commit_name_neq
, NULL
, 0);
617 for_each_rawref(get_name
, NULL
);
618 if (!hashmap_get_size(&names
) && !always
)
619 die(_("No names found, cannot describe anything."));
623 struct child_process cp
= CHILD_PROCESS_INIT
;
624 argv_array_pushv(&cp
.args
, diff_index_args
);
632 switch (run_command(&cp
)) {
640 /* diff-index aborted abnormally */
644 struct lock_file index_lock
= LOCK_INIT
;
645 struct rev_info revs
;
646 struct argv_array args
= ARGV_ARRAY_INIT
;
651 refresh_index(&the_index
, REFRESH_QUIET
|REFRESH_UNMERGED
,
653 fd
= hold_locked_index(&index_lock
, 0);
655 repo_update_index_if_able(the_repository
, &index_lock
);
657 repo_init_revisions(the_repository
, &revs
, prefix
);
658 argv_array_pushv(&args
, diff_index_args
);
659 if (setup_revisions(args
.argc
, args
.argv
, &revs
, NULL
) != 1)
660 BUG("malformed internal diff-index command line");
661 result
= run_diff_index(&revs
, 0);
663 if (!diff_result_code(&revs
.diffopt
, result
))
670 die(_("--dirty is incompatible with commit-ishes"));
672 die(_("--broken is incompatible with commit-ishes"));
675 describe(*argv
++, argc
== 0);