Re: [PATCH 3/3] transport-helper: send "true" value for object-format option

From: Junio C Hamano <gitster@pobox.com>
Date: Mar 20, 2024, 17:23 UTC
Message-ID: <xmqq1q84hl6d.fsf@gitster.g>
In-Reply-To: <20240320094103.GC2445682@coredump.intra.peff.net>

Jeff King <peff@peff.net> writes:

>   - remote-curl, which quietly converts missing values into "true". This
>     goes all the way back to ef08ef9ea0 (remote-helpers: Support custom
>     transport options, 2009-10-30), despite the fact that I don't think
>     any other option has ever made use of it.

Interesting.

Show 10 quoted lines

> When the documentation and code do not match, it is often good to fix
> the documentation rather than break compatibility. And in this case, we
> have had the mis-match since 8b85ee4f47 (transport-helper: implement
> object-format extensions, 2020-05-25). However, the sha256 feature was
> listed as experimental until 8e42eb0e9a (doc: sha256 is no longer
> experimental, 2023-07-31).
> ...
> And doing so has some value: it brings "object-format" in line with the
> syntax of other options, making the protocol more consistent. It also
> lets us use set_helper_option(), which has better error reporting.

I suspect that this may have been an attempt to mimick the value-less true in the configuration syntax, but I agree with the conclusion of this patch. Boolean "true" in the context of the transport options may be fairly common, but unlike configuration files, it is not something we have users write manually, and there is not much point giving a special short form.

Thanks for a pleasant read.  Will queue.