From: Tamir Duberstein Date: Tue, 09 Jun 2026 02:32:14 GMT Subject: [PATCH v2] describe: limit default ref iteration to tags Message-ID: <20260608-describe-tag-ref-scope-v2-1-256fd36dca32@gmail.com> Unless --all is given, get_name() rejects every ref outside refs/tags/. The rejection happens only after the ref backend has enumerated the ref, so repositories with many other refs spend most of a simple describe invocation visiting refs which cannot affect its result. Commit 8a5a1884e9 (Avoid accessing non-tag refs in git-describe unless --all is requested, 2008-02-24) moved this rejection before object lookup, but left iteration unscoped. Pass the existing refs/tags/ restriction to the iterator unless --all is given so the backend can avoid unrelated refs. The benchmark checkout had 120,532 refs, of which 330 were tags. With `$repo` naming the checkout, `$commit` an exactly tagged commit, and `$parent` and `$this` the two binaries, I ran: hyperfine --warmup 3 --runs 15 \ --command-name parent \ '$parent -C $repo describe --exact-match $commit' \ --command-name 'this commit' \ '$this -C $repo describe --exact-match $commit' The results were: Benchmark 1: parent Time (mean ± σ): 171.7 ms ± 18.5 ms [User: 23.9 ms, System: 133.6 ms] Range (min … max): 142.3 ms … 198.3 ms 15 runs Benchmark 2: this commit Time (mean ± σ): 9.9 ms ± 1.1 ms [User: 3.3 ms, System: 4.7 ms] Range (min … max): 8.8 ms … 13.1 ms 15 runs Summary this commit ran 17.35 ± 2.63 times faster than parent Both revisions were built with -O3, -mcpu=native, and ThinLTO using Apple clang 21.0.0 on macOS 26.5. The machine was a MacBook Pro (Mac16,6) with a 16-core Apple M4 Max (12 performance and four efficiency cores) and 128 GB RAM. Signed-off-by: Tamir Duberstein --- Changes in v2: - Exercise the performance test with both ref backends. - Keep the ref count local to its setup test. - Report native hyperfine output for an exact-tag lookup. - Link to v1: https://patch.msgid.link/20260607-describe-tag-ref-scope-v1-1-653d232b86b5@gmail.com --- builtin/describe.c | 3 +++ t/perf/p6100-describe.sh | 15 +++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/builtin/describe.c b/builtin/describe.c index 1c47d7c0b7..3532c8ff22 100644 --- a/builtin/describe.c +++ b/builtin/describe.c @@ -740,6 +740,9 @@ int cmd_describe(int argc, return ret; } + if (!all) + for_each_ref_opts.prefix = "refs/tags/"; + hashmap_init(&names, commit_name_neq, NULL, 0); refs_for_each_ref_ext(get_main_ref_store(the_repository), get_name, NULL, &for_each_ref_opts); diff --git a/t/perf/p6100-describe.sh b/t/perf/p6100-describe.sh index 069f91ce49..ed9f1abe18 100755 --- a/t/perf/p6100-describe.sh +++ b/t/perf/p6100-describe.sh @@ -27,4 +27,19 @@ test_perf 'describe HEAD with one tag' ' git describe --match=new HEAD ' +test_expect_success 'set up many unrelated refs' ' + ref_count=10000 && + git tag -m tip tip HEAD && + for i in $(test_seq $ref_count) + do + printf "create refs/heads/describe-perf/%05d HEAD\n" $i || + return 1 + done >instructions && + git update-ref --stdin