9 #include "parse-options.h"
12 #include "argv-array.h"
13 #include "run-command.h"
15 #define SEEN (1u << 0)
16 #define MAX_TAGS (FLAG_BITS - 1)
18 static const char * const describe_usage
[] = {
19 N_("git describe [<options>] [<commit-ish>...]"),
20 N_("git describe [<options>] --dirty"),
24 static int debug
; /* Display lots of verbose info */
25 static int all
; /* Any valid ref can be used */
26 static int tags
; /* Allow lightweight tags */
27 static int longformat
;
28 static int first_parent
;
29 static int abbrev
= -1; /* unspecified */
30 static int max_candidates
= 10;
31 static struct hashmap names
;
33 static struct string_list patterns
= STRING_LIST_INIT_NODUP
;
34 static struct string_list exclude_patterns
= STRING_LIST_INIT_NODUP
;
36 static const char *suffix
, *dirty
, *broken
;
38 /* diff-index command arguments to check if working tree is dirty. */
39 static const char *diff_index_args
[] = {
40 "diff-index", "--quiet", "HEAD", "--", NULL
44 struct hashmap_entry entry
;
45 struct object_id peeled
;
47 unsigned prio
:2; /* annotated tag = 2, tag = 1, head = 0 */
48 unsigned name_checked
:1;
53 static const char *prio_names
[] = {
54 N_("head"), N_("lightweight"), N_("annotated"),
57 static int commit_name_cmp(const void *unused_cmp_data
,
59 const void *entry_or_key
,
62 const struct commit_name
*cn1
= entry
;
63 const struct commit_name
*cn2
= entry_or_key
;
65 return oidcmp(&cn1
->peeled
, peeled
? peeled
: &cn2
->peeled
);
68 static inline struct commit_name
*find_commit_name(const struct object_id
*peeled
)
70 return hashmap_get_from_hash(&names
, sha1hash(peeled
->hash
), peeled
->hash
);
73 static int replace_name(struct commit_name
*e
,
75 const struct object_id
*oid
,
78 if (!e
|| e
->prio
< prio
)
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.
88 t
= lookup_tag(&e
->oid
);
89 if (!t
|| parse_tag(t
))
95 if (!t
|| parse_tag(t
))
99 if (e
->tag
->date
< t
->date
)
106 static void add_to_known_names(const char *path
,
107 const struct object_id
*peeled
,
109 const struct object_id
*oid
)
111 struct commit_name
*e
= find_commit_name(peeled
);
112 struct tag
*tag
= NULL
;
113 if (replace_name(e
, prio
, oid
, &tag
)) {
115 e
= xmalloc(sizeof(struct commit_name
));
116 oidcpy(&e
->peeled
, peeled
);
117 hashmap_entry_init(e
, sha1hash(peeled
->hash
));
118 hashmap_add(&names
, e
);
124 oidcpy(&e
->oid
, oid
);
126 e
->path
= xstrdup(path
);
130 static int get_name(const char *path
, const struct object_id
*oid
, int flag
, void *cb_data
)
133 struct object_id peeled
;
134 int is_annotated
, prio
;
135 const char *path_to_match
= NULL
;
137 if (skip_prefix(path
, "refs/tags/", &path_to_match
)) {
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 */
147 /* Reject anything outside refs/tags/ unless --all */
152 * If we're given exclude patterns, first exclude any tag which match
153 * any of the exclude pattern.
155 if (exclude_patterns
.nr
) {
156 struct string_list_item
*item
;
158 for_each_string_list_item(item
, &exclude_patterns
) {
159 if (!wildmatch(item
->string
, path_to_match
, 0))
165 * If we're given patterns, accept only tags which match at least one
170 struct string_list_item
*item
;
172 for_each_string_list_item(item
, &patterns
) {
173 if (!wildmatch(item
->string
, path_to_match
, 0)) {
183 /* Is it annotated? */
184 if (!peel_ref(path
, peeled
.hash
)) {
185 is_annotated
= !!oidcmp(oid
, &peeled
);
187 oidcpy(&peeled
, oid
);
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.
204 add_to_known_names(all
? path
+ 5 : path
+ 10, &peeled
, prio
, oid
);
208 struct possible_tag
{
209 struct commit_name
*name
;
212 unsigned flag_within
;
215 static int compare_pt(const void *a_
, const void *b_
)
217 struct possible_tag
*a
= (struct possible_tag
*)a_
;
218 struct possible_tag
*b
= (struct possible_tag
*)b_
;
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
;
226 static unsigned long finish_depth_computation(
227 struct commit_list
**list
,
228 struct possible_tag
*best
)
230 unsigned long seen_commits
= 0;
232 struct commit
*c
= pop_commit(list
);
233 struct commit_list
*parents
= c
->parents
;
235 if (c
->object
.flags
& best
->flag_within
) {
236 struct commit_list
*a
= *list
;
238 struct commit
*i
= a
->item
;
239 if (!(i
->object
.flags
& best
->flag_within
))
248 struct commit
*p
= parents
->item
;
250 if (!(p
->object
.flags
& SEEN
))
251 commit_list_insert_by_date(p
, list
);
252 p
->object
.flags
|= c
->object
.flags
;
253 parents
= parents
->next
;
259 static void display_name(struct commit_name
*n
)
261 if (n
->prio
== 2 && !n
->tag
) {
262 n
->tag
= lookup_tag(&n
->oid
);
263 if (!n
->tag
|| parse_tag(n
->tag
))
264 die(_("annotated tag %s not available"), n
->path
);
266 if (n
->tag
&& !n
->name_checked
) {
268 die(_("annotated tag %s has no embedded name"), n
->path
);
269 if (strcmp(n
->tag
->tag
, all
? n
->path
+ 5 : n
->path
))
270 warning(_("tag '%s' is really '%s' here"), n
->tag
->tag
, n
->path
);
277 printf("%s", n
->tag
->tag
);
279 printf("%s", n
->path
);
283 static void show_suffix(int depth
, const struct object_id
*oid
)
285 printf("-%d-g%s", depth
, find_unique_abbrev(oid
->hash
, abbrev
));
288 static void describe(const char *arg
, int last_one
)
290 struct object_id oid
;
291 struct commit
*cmit
, *gave_up_on
= NULL
;
292 struct commit_list
*list
;
293 struct commit_name
*n
;
294 struct possible_tag all_matches
[MAX_TAGS
];
295 unsigned int match_cnt
= 0, annotated_cnt
= 0, cur_match
;
296 unsigned long seen_commits
= 0;
297 unsigned int unannotated_cnt
= 0;
299 if (get_oid(arg
, &oid
))
300 die(_("Not a valid object name %s"), arg
);
301 cmit
= lookup_commit_reference(&oid
);
303 die(_("%s is not a valid '%s' object"), arg
, commit_type
);
305 n
= find_commit_name(&cmit
->object
.oid
);
306 if (n
&& (tags
|| all
|| n
->prio
== 2)) {
308 * Exact match to an existing ref.
312 show_suffix(0, n
->tag
? &n
->tag
->tagged
->oid
: &oid
);
314 printf("%s", suffix
);
320 die(_("no tag exactly matches '%s'"), oid_to_hex(&cmit
->object
.oid
));
322 fprintf(stderr
, _("searching to describe %s\n"), arg
);
325 struct hashmap_iter iter
;
327 struct commit_name
*n
= hashmap_iter_first(&names
, &iter
);
328 for (; n
; n
= hashmap_iter_next(&iter
)) {
329 c
= lookup_commit_reference_gently(&n
->peeled
, 1);
337 cmit
->object
.flags
= SEEN
;
338 commit_list_insert(cmit
, &list
);
340 struct commit
*c
= pop_commit(&list
);
341 struct commit_list
*parents
= c
->parents
;
345 if (!tags
&& !all
&& n
->prio
< 2) {
347 } else if (match_cnt
< max_candidates
) {
348 struct possible_tag
*t
= &all_matches
[match_cnt
++];
350 t
->depth
= seen_commits
- 1;
351 t
->flag_within
= 1u << match_cnt
;
352 t
->found_order
= match_cnt
;
353 c
->object
.flags
|= t
->flag_within
;
362 for (cur_match
= 0; cur_match
< match_cnt
; cur_match
++) {
363 struct possible_tag
*t
= &all_matches
[cur_match
];
364 if (!(c
->object
.flags
& t
->flag_within
))
367 if (annotated_cnt
&& !list
) {
369 fprintf(stderr
, _("finished search at %s\n"),
370 oid_to_hex(&c
->object
.oid
));
374 struct commit
*p
= parents
->item
;
376 if (!(p
->object
.flags
& SEEN
))
377 commit_list_insert_by_date(p
, &list
);
378 p
->object
.flags
|= c
->object
.flags
;
379 parents
= parents
->next
;
387 struct object_id
*oid
= &cmit
->object
.oid
;
389 printf("%s", find_unique_abbrev(oid
->hash
, abbrev
));
391 printf("%s", suffix
);
396 die(_("No annotated tags can describe '%s'.\n"
397 "However, there were unannotated tags: try --tags."),
400 die(_("No tags can describe '%s'.\n"
401 "Try --always, or create some tags."),
405 QSORT(all_matches
, match_cnt
, compare_pt
);
408 commit_list_insert_by_date(gave_up_on
, &list
);
411 seen_commits
+= finish_depth_computation(&list
, &all_matches
[0]);
412 free_commit_list(list
);
415 static int label_width
= -1;
416 if (label_width
< 0) {
418 for (i
= 0; i
< ARRAY_SIZE(prio_names
); i
++) {
419 w
= strlen(_(prio_names
[i
]));
424 for (cur_match
= 0; cur_match
< match_cnt
; cur_match
++) {
425 struct possible_tag
*t
= &all_matches
[cur_match
];
426 fprintf(stderr
, " %-*s %8d %s\n",
427 label_width
, _(prio_names
[t
->name
->prio
]),
428 t
->depth
, t
->name
->path
);
430 fprintf(stderr
, _("traversed %lu commits\n"), seen_commits
);
433 _("more than %i tags found; listed %i most recent\n"
434 "gave up search at %s\n"),
435 max_candidates
, max_candidates
,
436 oid_to_hex(&gave_up_on
->object
.oid
));
440 display_name(all_matches
[0].name
);
442 show_suffix(all_matches
[0].depth
, &cmit
->object
.oid
);
444 printf("%s", suffix
);
448 clear_commit_marks(cmit
, -1);
451 int cmd_describe(int argc
, const char **argv
, const char *prefix
)
454 struct option options
[] = {
455 OPT_BOOL(0, "contains", &contains
, N_("find the tag that comes after the commit")),
456 OPT_BOOL(0, "debug", &debug
, N_("debug search strategy on stderr")),
457 OPT_BOOL(0, "all", &all
, N_("use any ref")),
458 OPT_BOOL(0, "tags", &tags
, N_("use any tag, even unannotated")),
459 OPT_BOOL(0, "long", &longformat
, N_("always use long format")),
460 OPT_BOOL(0, "first-parent", &first_parent
, N_("only follow first parent")),
461 OPT__ABBREV(&abbrev
),
462 OPT_SET_INT(0, "exact-match", &max_candidates
,
463 N_("only output exact matches"), 0),
464 OPT_INTEGER(0, "candidates", &max_candidates
,
465 N_("consider <n> most recent tags (default: 10)")),
466 OPT_STRING_LIST(0, "match", &patterns
, N_("pattern"),
467 N_("only consider tags matching <pattern>")),
468 OPT_STRING_LIST(0, "exclude", &exclude_patterns
, N_("pattern"),
469 N_("do not consider tags matching <pattern>")),
470 OPT_BOOL(0, "always", &always
,
471 N_("show abbreviated commit object as fallback")),
472 {OPTION_STRING
, 0, "dirty", &dirty
, N_("mark"),
473 N_("append <mark> on dirty working tree (default: \"-dirty\")"),
474 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "-dirty"},
475 {OPTION_STRING
, 0, "broken", &broken
, N_("mark"),
476 N_("append <mark> on broken working tree (default: \"-broken\")"),
477 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "-broken"},
481 git_config(git_default_config
, NULL
);
482 argc
= parse_options(argc
, argv
, prefix
, options
, describe_usage
, 0);
484 abbrev
= DEFAULT_ABBREV
;
486 if (max_candidates
< 0)
488 else if (max_candidates
> MAX_TAGS
)
489 max_candidates
= MAX_TAGS
;
491 save_commit_buffer
= 0;
493 if (longformat
&& abbrev
== 0)
494 die(_("--long is incompatible with --abbrev=0"));
497 struct string_list_item
*item
;
498 struct argv_array args
;
500 argv_array_init(&args
);
501 argv_array_pushl(&args
, "name-rev",
502 "--peel-tag", "--name-only", "--no-undefined",
505 argv_array_push(&args
, "--always");
507 argv_array_push(&args
, "--tags");
508 for_each_string_list_item(item
, &patterns
)
509 argv_array_pushf(&args
, "--refs=refs/tags/%s", item
->string
);
510 for_each_string_list_item(item
, &exclude_patterns
)
511 argv_array_pushf(&args
, "--exclude=refs/tags/%s", item
->string
);
514 argv_array_pushv(&args
, argv
);
516 argv_array_push(&args
, "HEAD");
517 return cmd_name_rev(args
.argc
, args
.argv
, prefix
);
520 hashmap_init(&names
, commit_name_cmp
, NULL
, 0);
521 for_each_rawref(get_name
, NULL
);
522 if (!hashmap_get_size(&names
) && !always
)
523 die(_("No names found, cannot describe anything."));
527 struct child_process cp
= CHILD_PROCESS_INIT
;
528 argv_array_pushv(&cp
.args
, diff_index_args
);
536 switch (run_command(&cp
)) {
544 /* diff-index aborted abnormally */
548 static struct lock_file index_lock
;
551 read_cache_preload(NULL
);
552 refresh_index(&the_index
, REFRESH_QUIET
|REFRESH_UNMERGED
,
554 fd
= hold_locked_index(&index_lock
, 0);
556 update_index_if_able(&the_index
, &index_lock
);
558 if (!cmd_diff_index(ARRAY_SIZE(diff_index_args
) - 1,
559 diff_index_args
, prefix
))
566 die(_("--dirty is incompatible with commit-ishes"));
568 die(_("--broken is incompatible with commit-ishes"));
571 describe(*argv
++, argc
== 0);