Re: [BUG?] 'git describe seen'?

From: René Scharfe <l.s.r@web.de>
Date: Apr 18, 2021, 10:26 UTC
Message-ID: <5cb071aa-16d1-8ea8-39e7-a0f5b89cbf3a@web.de>
In-Reply-To: <xmqq1rb8bhl4.fsf@gitster.g>

Am 18.04.21 um 01:45 schrieb Junio C Hamano:

Show 42 quoted lines

> This does not seem a new problem at all, as v2.10.0 thru more recent
> versions of "git describe" seem to give me the same answer.
>
> Anyway, I am seeing a curious symptom.
>
> $ git rev-list --count v2.31.0..seen
> 716
> $ git rev-list --count v2.31.1..seen
> 687
>
> The above means that 'seen' is closer to v2.31.1 than v2.31.0; there
> are fewer commits that are not in v2.31.1 that are in 'seen', than
> commits that are not in v2.31.0 that are in 'seen'.
>
> That is naturally expected.
>
> $ git rev-list --count v2.31.0..v2.31.1
> 29
>
> And that difference of 29 matches the difference, which is 716 - 687.
>
> But here is what is puzzling.
>
> $ git describe seen
> v2.31.0-716-g7b65b53281
>
> $ git rev-list --first-parent master..seen |
>   while read v
>   do
> 	d=$(git describe $v)
> 	echo $v $d
> 	case "$d" in v2.31.1-*) break ;; esac
>   done
> 7b65b53281ae06ee25dd47dead4062125eb54427 v2.31.0-716-g7b65b53281
> eec14f0fec886c909a29d63a94537df5a62be618 v2.31.0-714-geec14f0fec
> ...
> 103835562c64abef2319995716230f92092f87af v2.31.0-569-g103835562c
> d4324831d9152b16e091646e22a6e03423a59c93 v2.31.1-516-gd4324831d9
>
> Is there something tricky about the topic merged at 10383556 (Merge
> branch 'jh/rfc-builtin-fsmonitor' into seen, 2021-04-17) to confuse
> the counting done in "git describe"?

You get the expected result if you only allow one or two candidates, but adding more of them changes that somehow. The patch below shows the values used for sorting the candidates; the numbers in the existing debug output are a bit confusing because they show the finished depth for the first entry and the raw ones for the rest:

   $ git describe --debug 103835562c --candidates=2
   describe 103835562c
   No exact match on refs or tags, searching to describe
         472        1 v2.31.1
         481        2 v2.31.0
    annotated        582 v2.31.1
    annotated        481 v2.31.0
   traversed 3621 commits
   more than 2 tags found; listed 2 most recent
   gave up search at 13d7ab6b5d7929825b626f050b62a11241ea4945
   v2.31.1-582-g103835562c

   $ git describe --debug 103835562c --candidates=3
   describe 103835562c
   No exact match on refs or tags, searching to describe
         496        2 v2.31.0
         499        1 v2.31.1
         524        3 v2.31.0-rc2
    annotated        569 v2.31.0
    annotated        499 v2.31.1
    annotated        524 v2.31.0-rc2
   traversed 3621 commits
   more than 3 tags found; listed 3 most recent
   gave up search at f01623b2c9d14207e497b21ebc6b3ec4afaf4b46
   v2.31.0-569-g103835562c

Why do the depths change if we add another candidate? I guess that's because this loop can increase the depth of each candidate for unflagged commits:

                for (cur_match = 0; cur_match < match_cnt; cur_match++) {
                        struct possible_tag *t = &all_matches[cur_match];
                        if (!(c->object.flags & t->flag_within))
                                t->depth++;
                }

Adding v2.31.0-rc2 increases the depth of v2.31.0 from 481 by 15 to 496 and of v2.31.1 from 472 by 27 to 499. We can print the IDs of those unflagged objects like this:

                for (cur_match = 0; cur_match < match_cnt; cur_match++) {
                        struct possible_tag *t = &all_matches[cur_match];
                        if (!(c->object.flags & t->flag_within)) {
                                t->depth++;
				if (match_cnt == 3)
					fprintf(stderr, "%s %s\n",
						oid_to_hex(&c->object.oid),
						t->name->path);
			}
                }

We can then get the commits that increase the depth of v2.31.0, but not of v2.31.1, when we add the third candidate, v2.31.0-rc2, using something like this:

   $ awk '$2 == "v2.31.0" {print $1}' err |
     grep -v -f <(awk '$2 == "v2.31.1" {print $1}' err) |
     git show --oneline --no-patch --stdin

   68b5c3aa48 Makefile: update 'make fuzz-all' docs to reflect modern clang
   241b5d3ebe fix xcalloc() argument order
   93c3d297b5 git mv foo FOO ; git mv foo bar gave an assert

And vice versa, the fifteen commits that increase the depth of v2.31.1, but not of v2.31.0:

   834845142d l10n: de.po: Update German translation for Git v2.31.0
   408985d301 l10n: pt_PT: add Portuguese translations part 1
   1369935987 l10n: vi.po(5104t): for git v2.31.0 l10n round 2
   b0adcc311b l10n: es: 2.31.0 round 2
   c21ad4d941 l10n: Add translation team info
   8c4abfb8be l10n: start Indonesian translation
   8278f87022 l10n: zh_TW.po: v2.31.0 round 2 (15 untranslated)
   2f176de687 l10n: bg.po: Updated Bulgarian translation (5104t)
   1ecef023a9 Merge branch 'fr_next' of github.com:jnavila/git
   5b888ad949 Merge branch 'master' of github.com:nafmo/git-l10n-sv
   068cb92300 l10n: fr: v2.31 rnd 2
   f6a7e896b8 l10n: tr: v2.31.0-rc1
   929dc48e96 l10n: sv.po: Update Swedish translation (5104t0f0u)
   9b7e82b940 l10n: git.pot: v2.31.0 round 2 (9 new, 8 removed)
   4dd8469336 Merge branch 'master' of github.com:git/git

That matches the observation above that the depth of v2.31.1 was increased by twelve more than the depth of v2.31.0.

And at that point I'm lost because I have no idea why adding v2.31.0-rc2 should increase the depth of v2.31.0 and v2.31.1 differently.

René

diff --git a/builtin/describe.c b/builtin/describe.c
index 40482d8e9f..24d7a8a9cb 100644
--- a/builtin/describe.c
+++ b/builtin/describe.c
@@ -432,6 +432,14 @@ static void describe_commit(struct object_id *oid, struct strbuf *dst)

 	QSORT(all_matches, match_cnt, compare_pt);

+	if (debug) {
+		for (cur_match = 0; cur_match < match_cnt; cur_match++) {
+			struct possible_tag *t = &all_matches[cur_match];
+			fprintf(stderr, " %8d %8d %s\n",
+				t->depth, t->found_order, t->name->path);
+		}
+	}
+
 	if (gave_up_on) {
 		commit_list_insert_by_date(gave_up_on, &list);
 		seen_commits--;