Re: [PATCH v6 1/3] ls-refs: report unborn targets of symrefs

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 2, 2021, 22:17 UTC
Message-ID: <xmqq1rdyf71k.fsf@gitster.c.googlers.com>
In-Reply-To: <20210202183453.1907985-1-jonathantanmy@google.com>

Jonathan Tan <jonathantanmy@google.com> writes:

Show 9 quoted lines

> I'm not sure what the ideal endgame state is, but I could see how
> sending all symlinks would be useful (e.g. if a client wanted to mirror
> another repo with more fidelity). Right now I don't plan on adding
> support for dangling symrefs other than HEAD, though. Maybe I'll update
> it to something like:
>
>   If HEAD is a symref pointing to an unborn branch, the server may send
>   it in the form "unborn HEAD symref-target:<target>". In the future,
>   this may be extended to other symrefs as well.

Unless you plan to add support for symbolic refs that are not HEAD in immediate future, "In the future, ..." is not even necessary to say. The users cannot expect to exploit the missing feature anyway, and they cannot even plan to use it in near future.

I've been disturbed by the phrase "the server may send it" quite a lot, actually. In the original before the rewrite above, it was a good cop-out excuse "no, we do not send symbolic refs other than HEAD because we only say 'the server may' and do not promise anything beyond that". But now we are tightening the description to HEAD that we do intend to support well, it probably is a good idea to give users a promise a bit firmer than that.

    unborn If HEAD is a symref pointing to an unborn branch <b>, the
    server reports it as "unborn HEAD symref-target:refs/heads/<b>"
    in its response.

It would make it clear that by sending 'unborn' in the request, the client is not just allowing the server to include the unborn information in the response. It is asking the server, that has advertised that it is capable to do so, to exercise the feature.

> I think that there is a discussion point to be decided
> (advertise/allow/ignore vs allow/ignore), so I'll wait for that before
> sending v7.

What is the downside of having three choices (which allows phased deployment, where everybody starts as capable of responding without advertising in the first phase, and once everybody becomes capable of responding, they start advertising) and the reason we might prefer just allow/ignore instead? Too much complexity? It does not help the real deployment as much in practice as it seems on paper?

I am not advocating three-choice option; I am neutral, but do not see a good reason to reject it (while I can easily see a reason to reject the other one).

Thanks.