1 #define USE_THE_REPOSITORY_VARIABLE
2 #define DISABLE_SIGN_COMPARE_WARNINGS
6 #include "environment.h"
13 #include "object-name.h"
14 #include "parse-options.h"
15 #include "read-cache-ll.h"
21 #include "run-command.h"
22 #include "object-store.h"
23 #include "list-objects.h"
24 #include "commit-slab.h"
25 #include "wildmatch.h"
27 #define MAX_TAGS (FLAG_BITS - 1)
28 #define DEFAULT_CANDIDATES 10
30 define_commit_slab(commit_names
, struct commit_name
*);
32 static const char * const describe_usage
[] = {
33 N_("git describe [--all] [--tags] [--contains] [--abbrev=<n>] [<commit-ish>...]"),
34 N_("git describe [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]"),
35 N_("git describe <blob>"),
39 static int debug
; /* Display lots of verbose info */
40 static int all
; /* Any valid ref can be used */
41 static int tags
; /* Allow lightweight tags */
42 static int longformat
;
43 static int first_parent
;
44 static int abbrev
= -1; /* unspecified */
45 static int max_candidates
= DEFAULT_CANDIDATES
;
46 static struct hashmap names
;
48 static struct string_list patterns
= STRING_LIST_INIT_NODUP
;
49 static struct string_list exclude_patterns
= STRING_LIST_INIT_NODUP
;
51 static const char *suffix
, *dirty
, *broken
;
52 static struct commit_names commit_names
;
54 /* diff-index command arguments to check if working tree is dirty. */
55 static const char *diff_index_args
[] = {
56 "diff-index", "--quiet", "HEAD", "--", NULL
59 static const char *update_index_args
[] = {
60 "update-index", "--unmerged", "-q", "--refresh", NULL
64 struct hashmap_entry entry
;
65 struct object_id peeled
;
67 unsigned prio
:2; /* annotated tag = 2, tag = 1, head = 0 */
68 unsigned name_checked
:1;
74 static const char *prio_names
[] = {
75 N_("head"), N_("lightweight"), N_("annotated"),
78 static int commit_name_neq(const void *cmp_data UNUSED
,
79 const struct hashmap_entry
*eptr
,
80 const struct hashmap_entry
*entry_or_key
,
83 const struct commit_name
*cn1
, *cn2
;
85 cn1
= container_of(eptr
, const struct commit_name
, entry
);
86 cn2
= container_of(entry_or_key
, const struct commit_name
, entry
);
88 return !oideq(&cn1
->peeled
, peeled
? peeled
: &cn2
->peeled
);
91 static inline struct commit_name
*find_commit_name(const struct object_id
*peeled
)
93 return hashmap_get_entry_from_hash(&names
, oidhash(peeled
), peeled
,
94 struct commit_name
, entry
);
97 static int replace_name(struct commit_name
*e
,
99 const struct object_id
*oid
,
102 if (!e
|| e
->prio
< prio
)
105 if (e
->prio
== 2 && prio
== 2) {
106 /* Multiple annotated tags point to the same commit.
107 * Select one to keep based upon their tagger date.
112 t
= lookup_tag(the_repository
, &e
->oid
);
113 if (!t
|| parse_tag(t
))
118 t
= lookup_tag(the_repository
, oid
);
119 if (!t
|| parse_tag(t
))
123 if (e
->tag
->date
< t
->date
)
130 static void add_to_known_names(const char *path
,
131 const struct object_id
*peeled
,
133 const struct object_id
*oid
)
135 struct commit_name
*e
= find_commit_name(peeled
);
136 struct tag
*tag
= NULL
;
137 if (replace_name(e
, prio
, oid
, &tag
)) {
139 e
= xmalloc(sizeof(struct commit_name
));
140 oidcpy(&e
->peeled
, peeled
);
141 hashmap_entry_init(&e
->entry
, oidhash(peeled
));
142 hashmap_add(&names
, &e
->entry
);
149 oidcpy(&e
->oid
, oid
);
151 e
->path
= xstrdup(path
);
155 static int get_name(const char *path
, const char *referent UNUSED
, const struct object_id
*oid
,
156 int flag UNUSED
, void *cb_data UNUSED
)
159 struct object_id peeled
;
160 int is_annotated
, prio
;
161 const char *path_to_match
= NULL
;
163 if (skip_prefix(path
, "refs/tags/", &path_to_match
)) {
166 if ((exclude_patterns
.nr
|| patterns
.nr
) &&
167 !skip_prefix(path
, "refs/heads/", &path_to_match
) &&
168 !skip_prefix(path
, "refs/remotes/", &path_to_match
)) {
169 /* Only accept reference of known type if there are match/exclude patterns */
173 /* Reject anything outside refs/tags/ unless --all */
178 * If we're given exclude patterns, first exclude any tag which match
179 * any of the exclude pattern.
181 if (exclude_patterns
.nr
) {
182 struct string_list_item
*item
;
184 for_each_string_list_item(item
, &exclude_patterns
) {
185 if (!wildmatch(item
->string
, path_to_match
, 0))
191 * If we're given patterns, accept only tags which match at least one
196 struct string_list_item
*item
;
198 for_each_string_list_item(item
, &patterns
) {
199 if (!wildmatch(item
->string
, path_to_match
, 0)) {
209 /* Is it annotated? */
210 if (!peel_iterated_oid(the_repository
, oid
, &peeled
)) {
211 is_annotated
= !oideq(oid
, &peeled
);
213 oidcpy(&peeled
, oid
);
218 * By default, we only use annotated tags, but with --tags
219 * we fall back to lightweight ones (even without --tags,
220 * we still remember lightweight ones, only to give hints
221 * in an error message). --all allows any refs to be used.
230 add_to_known_names(all
? path
+ 5 : path
+ 10, &peeled
, prio
, oid
);
234 struct possible_tag
{
235 struct commit_name
*name
;
238 unsigned flag_within
;
241 static int compare_pt(const void *a_
, const void *b_
)
243 struct possible_tag
*a
= (struct possible_tag
*)a_
;
244 struct possible_tag
*b
= (struct possible_tag
*)b_
;
245 if (a
->depth
!= b
->depth
)
246 return a
->depth
- b
->depth
;
247 if (a
->found_order
!= b
->found_order
)
248 return a
->found_order
- b
->found_order
;
252 static unsigned long finish_depth_computation(
253 struct commit_list
**list
,
254 struct possible_tag
*best
)
256 unsigned long seen_commits
= 0;
258 struct commit
*c
= pop_commit(list
);
259 struct commit_list
*parents
= c
->parents
;
261 if (c
->object
.flags
& best
->flag_within
) {
262 struct commit_list
*a
= *list
;
264 struct commit
*i
= a
->item
;
265 if (!(i
->object
.flags
& best
->flag_within
))
274 struct commit
*p
= parents
->item
;
275 repo_parse_commit(the_repository
, p
);
276 if (!(p
->object
.flags
& SEEN
))
277 commit_list_insert_by_date(p
, list
);
278 p
->object
.flags
|= c
->object
.flags
;
279 parents
= parents
->next
;
285 static void append_name(struct commit_name
*n
, struct strbuf
*dst
)
287 if (n
->prio
== 2 && !n
->tag
) {
288 n
->tag
= lookup_tag(the_repository
, &n
->oid
);
289 if (!n
->tag
|| parse_tag(n
->tag
))
290 die(_("annotated tag %s not available"), n
->path
);
292 if (n
->tag
&& !n
->name_checked
) {
293 if (strcmp(n
->tag
->tag
, all
? n
->path
+ 5 : n
->path
)) {
294 warning(_("tag '%s' is externally known as '%s'"),
295 n
->path
, n
->tag
->tag
);
303 strbuf_addstr(dst
, "tags/");
304 strbuf_addstr(dst
, n
->tag
->tag
);
306 strbuf_addstr(dst
, n
->path
);
310 static void append_suffix(int depth
, const struct object_id
*oid
, struct strbuf
*dst
)
312 strbuf_addf(dst
, "-%d-g%s", depth
,
313 repo_find_unique_abbrev(the_repository
, oid
, abbrev
));
316 static void describe_commit(struct object_id
*oid
, struct strbuf
*dst
)
318 struct commit
*cmit
, *gave_up_on
= NULL
;
319 struct commit_list
*list
;
320 struct commit_name
*n
;
321 struct possible_tag all_matches
[MAX_TAGS
];
322 unsigned int match_cnt
= 0, annotated_cnt
= 0, cur_match
;
323 unsigned long seen_commits
= 0;
324 unsigned int unannotated_cnt
= 0;
326 cmit
= lookup_commit_reference(the_repository
, oid
);
328 n
= find_commit_name(&cmit
->object
.oid
);
329 if (n
&& (tags
|| all
|| n
->prio
== 2)) {
331 * Exact match to an existing ref.
334 if (n
->misnamed
|| longformat
)
335 append_suffix(0, n
->tag
? get_tagged_oid(n
->tag
) : oid
, dst
);
337 strbuf_addstr(dst
, suffix
);
342 die(_("no tag exactly matches '%s'"), oid_to_hex(&cmit
->object
.oid
));
344 fprintf(stderr
, _("No exact match on refs or tags, searching to describe\n"));
347 struct hashmap_iter iter
;
349 struct commit_name
*n
;
351 init_commit_names(&commit_names
);
352 hashmap_for_each_entry(&names
, &iter
, n
,
353 entry
/* member name */) {
354 c
= lookup_commit_reference_gently(the_repository
,
357 *commit_names_at(&commit_names
, c
) = n
;
363 cmit
->object
.flags
= SEEN
;
364 commit_list_insert(cmit
, &list
);
366 struct commit
*c
= pop_commit(&list
);
367 struct commit_list
*parents
= c
->parents
;
368 struct commit_name
**slot
;
372 if (match_cnt
== max_candidates
||
373 match_cnt
== hashmap_get_size(&names
)) {
378 slot
= commit_names_peek(&commit_names
, c
);
379 n
= slot
? *slot
: NULL
;
381 if (!tags
&& !all
&& n
->prio
< 2) {
383 } else if (match_cnt
< max_candidates
) {
384 struct possible_tag
*t
= &all_matches
[match_cnt
++];
386 t
->depth
= seen_commits
- 1;
387 t
->flag_within
= 1u << match_cnt
;
388 t
->found_order
= match_cnt
;
389 c
->object
.flags
|= t
->flag_within
;
394 for (cur_match
= 0; cur_match
< match_cnt
; cur_match
++) {
395 struct possible_tag
*t
= &all_matches
[cur_match
];
396 if (!(c
->object
.flags
& t
->flag_within
))
399 /* Stop if last remaining path already covered by best candidate(s) */
400 if (annotated_cnt
&& !list
) {
401 int best_depth
= INT_MAX
;
402 unsigned best_within
= 0;
403 for (cur_match
= 0; cur_match
< match_cnt
; cur_match
++) {
404 struct possible_tag
*t
= &all_matches
[cur_match
];
405 if (t
->depth
< best_depth
) {
406 best_depth
= t
->depth
;
407 best_within
= t
->flag_within
;
408 } else if (t
->depth
== best_depth
) {
409 best_within
|= t
->flag_within
;
412 if ((c
->object
.flags
& best_within
) == best_within
) {
414 fprintf(stderr
, _("finished search at %s\n"),
415 oid_to_hex(&c
->object
.oid
));
420 struct commit
*p
= parents
->item
;
421 repo_parse_commit(the_repository
, p
);
422 if (!(p
->object
.flags
& SEEN
))
423 commit_list_insert_by_date(p
, &list
);
424 p
->object
.flags
|= c
->object
.flags
;
425 parents
= parents
->next
;
433 struct object_id
*cmit_oid
= &cmit
->object
.oid
;
435 strbuf_add_unique_abbrev(dst
, cmit_oid
, abbrev
);
437 strbuf_addstr(dst
, suffix
);
441 die(_("No annotated tags can describe '%s'.\n"
442 "However, there were unannotated tags: try --tags."),
443 oid_to_hex(cmit_oid
));
445 die(_("No tags can describe '%s'.\n"
446 "Try --always, or create some tags."),
447 oid_to_hex(cmit_oid
));
450 QSORT(all_matches
, match_cnt
, compare_pt
);
453 commit_list_insert_by_date(gave_up_on
, &list
);
456 seen_commits
+= finish_depth_computation(&list
, &all_matches
[0]);
457 free_commit_list(list
);
460 static int label_width
= -1;
461 if (label_width
< 0) {
463 for (i
= 0; i
< ARRAY_SIZE(prio_names
); i
++) {
464 w
= strlen(_(prio_names
[i
]));
469 for (cur_match
= 0; cur_match
< match_cnt
; cur_match
++) {
470 struct possible_tag
*t
= &all_matches
[cur_match
];
471 fprintf(stderr
, " %-*s %8d %s\n",
472 label_width
, _(prio_names
[t
->name
->prio
]),
473 t
->depth
, t
->name
->path
);
475 fprintf(stderr
, _("traversed %lu commits\n"), seen_commits
);
478 _("found %i tags; gave up search at %s\n"),
480 oid_to_hex(&gave_up_on
->object
.oid
));
484 append_name(all_matches
[0].name
, dst
);
485 if (all_matches
[0].name
->misnamed
|| abbrev
)
486 append_suffix(all_matches
[0].depth
, &cmit
->object
.oid
, dst
);
488 strbuf_addstr(dst
, suffix
);
491 struct process_commit_data
{
492 struct object_id current_commit
;
493 struct object_id looking_for
;
495 struct rev_info
*revs
;
498 static void process_commit(struct commit
*commit
, void *data
)
500 struct process_commit_data
*pcd
= data
;
501 pcd
->current_commit
= commit
->object
.oid
;
504 static void process_object(struct object
*obj
, const char *path
, void *data
)
506 struct process_commit_data
*pcd
= data
;
508 if (oideq(&pcd
->looking_for
, &obj
->oid
) && !pcd
->dst
->len
) {
509 reset_revision_walk();
510 describe_commit(&pcd
->current_commit
, pcd
->dst
);
511 strbuf_addf(pcd
->dst
, ":%s", path
);
512 free_commit_list(pcd
->revs
->commits
);
513 pcd
->revs
->commits
= NULL
;
517 static void describe_blob(struct object_id oid
, struct strbuf
*dst
)
519 struct rev_info revs
;
520 struct strvec args
= STRVEC_INIT
;
521 struct process_commit_data pcd
= { *null_oid(the_hash_algo
), oid
, dst
, &revs
};
523 strvec_pushl(&args
, "internal: The first arg is not parsed",
524 "--objects", "--in-commit-order", "--reverse", "HEAD",
527 repo_init_revisions(the_repository
, &revs
, NULL
);
528 if (setup_revisions(args
.nr
, args
.v
, &revs
, NULL
) > 1)
529 BUG("setup_revisions could not handle all args?");
531 if (prepare_revision_walk(&revs
))
532 die("revision walk setup failed");
534 traverse_commit_list(&revs
, process_commit
, process_object
, &pcd
);
535 reset_revision_walk();
536 release_revisions(&revs
);
540 static void describe(const char *arg
, int last_one
)
542 struct object_id oid
;
544 struct strbuf sb
= STRBUF_INIT
;
547 fprintf(stderr
, _("describe %s\n"), arg
);
549 if (repo_get_oid(the_repository
, arg
, &oid
))
550 die(_("Not a valid object name %s"), arg
);
551 cmit
= lookup_commit_reference_gently(the_repository
, &oid
, 1);
554 describe_commit(&oid
, &sb
);
555 else if (oid_object_info(the_repository
, &oid
, NULL
) == OBJ_BLOB
)
556 describe_blob(oid
, &sb
);
558 die(_("%s is neither a commit nor blob"), arg
);
563 clear_commit_marks(cmit
, -1);
568 static int option_parse_exact_match(const struct option
*opt
, const char *arg
,
571 int *val
= opt
->value
;
575 *val
= unset
? DEFAULT_CANDIDATES
: 0;
579 int cmd_describe(int argc
,
582 struct repository
*repo UNUSED
)
585 struct option options
[] = {
586 OPT_BOOL(0, "contains", &contains
, N_("find the tag that comes after the commit")),
587 OPT_BOOL(0, "debug", &debug
, N_("debug search strategy on stderr")),
588 OPT_BOOL(0, "all", &all
, N_("use any ref")),
589 OPT_BOOL(0, "tags", &tags
, N_("use any tag, even unannotated")),
590 OPT_BOOL(0, "long", &longformat
, N_("always use long format")),
591 OPT_BOOL(0, "first-parent", &first_parent
, N_("only follow first parent")),
592 OPT__ABBREV(&abbrev
),
593 OPT_CALLBACK_F(0, "exact-match", &max_candidates
, NULL
,
594 N_("only output exact matches"),
595 PARSE_OPT_NOARG
, option_parse_exact_match
),
596 OPT_INTEGER(0, "candidates", &max_candidates
,
597 N_("consider <n> most recent tags (default: 10)")),
598 OPT_STRING_LIST(0, "match", &patterns
, N_("pattern"),
599 N_("only consider tags matching <pattern>")),
600 OPT_STRING_LIST(0, "exclude", &exclude_patterns
, N_("pattern"),
601 N_("do not consider tags matching <pattern>")),
602 OPT_BOOL(0, "always", &always
,
603 N_("show abbreviated commit object as fallback")),
605 .type
= OPTION_STRING
,
606 .long_name
= "dirty",
609 .help
= N_("append <mark> on dirty working tree (default: \"-dirty\")"),
610 .flags
= PARSE_OPT_OPTARG
,
611 .defval
= (intptr_t) "-dirty",
614 .type
= OPTION_STRING
,
615 .long_name
= "broken",
618 .help
= N_("append <mark> on broken working tree (default: \"-broken\")"),
619 .flags
= PARSE_OPT_OPTARG
,
620 .defval
= (intptr_t) "-broken",
625 git_config(git_default_config
, NULL
);
626 argc
= parse_options(argc
, argv
, prefix
, options
, describe_usage
, 0);
628 abbrev
= DEFAULT_ABBREV
;
630 if (max_candidates
< 0)
632 else if (max_candidates
> MAX_TAGS
)
633 max_candidates
= MAX_TAGS
;
635 save_commit_buffer
= 0;
637 if (longformat
&& abbrev
== 0)
638 die(_("options '%s' and '%s' cannot be used together"), "--long", "--abbrev=0");
641 struct string_list_item
*item
;
643 const char **argv_copy
;
647 strvec_pushl(&args
, "name-rev",
648 "--peel-tag", "--name-only", "--no-undefined",
651 strvec_push(&args
, "--always");
653 strvec_push(&args
, "--tags");
654 for_each_string_list_item(item
, &patterns
)
655 strvec_pushf(&args
, "--refs=refs/tags/%s", item
->string
);
656 for_each_string_list_item(item
, &exclude_patterns
)
657 strvec_pushf(&args
, "--exclude=refs/tags/%s", item
->string
);
660 strvec_pushv(&args
, argv
);
662 strvec_push(&args
, "HEAD");
665 * `cmd_name_rev()` modifies the array, so we'd leak its
666 * contained strings if we didn't do a copy here.
668 ALLOC_ARRAY(argv_copy
, args
.nr
+ 1);
669 for (size_t i
= 0; i
< args
.nr
; i
++)
670 argv_copy
[i
] = args
.v
[i
];
671 argv_copy
[args
.nr
] = NULL
;
673 ret
= cmd_name_rev(args
.nr
, argv_copy
, prefix
, the_repository
);
680 hashmap_init(&names
, commit_name_neq
, NULL
, 0);
681 refs_for_each_rawref(get_main_ref_store(the_repository
), get_name
,
683 if (!hashmap_get_size(&names
) && !always
)
684 die(_("No names found, cannot describe anything."));
688 struct child_process cp
= CHILD_PROCESS_INIT
;
690 strvec_pushv(&cp
.args
, update_index_args
);
696 child_process_init(&cp
);
697 strvec_pushv(&cp
.args
, diff_index_args
);
705 switch (run_command(&cp
)) {
713 /* diff-index aborted abnormally */
717 struct lock_file index_lock
= LOCK_INIT
;
718 struct rev_info revs
;
722 prepare_repo_settings(the_repository
);
723 the_repository
->settings
.command_requires_full_index
= 0;
724 repo_read_index(the_repository
);
725 refresh_index(the_repository
->index
, REFRESH_QUIET
|REFRESH_UNMERGED
,
727 fd
= repo_hold_locked_index(the_repository
,
730 repo_update_index_if_able(the_repository
, &index_lock
);
732 repo_init_revisions(the_repository
, &revs
, prefix
);
734 if (setup_revisions(ARRAY_SIZE(diff_index_args
) - 1,
735 diff_index_args
, &revs
, NULL
) != 1)
736 BUG("malformed internal diff-index command line");
737 run_diff_index(&revs
, 0);
739 if (!diff_result_code(&revs
))
743 release_revisions(&revs
);
747 die(_("option '%s' and commit-ishes cannot be used together"), "--dirty");
749 die(_("option '%s' and commit-ishes cannot be used together"), "--broken");
752 describe(*argv
++, argc
== 0);