Re: [PATCH 2/2] doc/gitremote-helpers: match object-format option docs to code
- From
brian m. carlson <sandals@crustytoothpaste.net>
- Date
- Mar 7, 2024, 22:20 UTC
- Message-ID
- <Zeo9oAkL6kxZRugN@tapette.crustytoothpaste.net>
- In-Reply-To
- <20240307085632.GB2072294@coredump.intra.peff.net>
On 2024-03-07 at 08:56:32, Jeff King wrote:
Show 21 quoted lines
> Git's transport-helper code has always sent "option object-format\n", > and never provided the "true" or "algorithm" arguments. While the > "algorithm" request is something we might need or want to eventually > support, it probably makes sense for now to document the actual > behavior, especially as it has been in place for several years, since > 8b85ee4f47 (transport-helper: implement object-format extensions, > 2020-05-25). > > Signed-off-by: Jeff King <peff@peff.net> > --- > As I discussed in patch 1, remote-curl does handle the "true" thing > correctly. And that's really the helper that matters in practice (it's > possible some third party helper is looking for the explicit "true", but > presumably they'd have reported their confusion to the list). So we > could probably just start tacking on the "true" in transport-helper.c > and leave that part of the documentation untouched. > > I'm less sure of the specific-algorithm thing, just because it seems > like remote-curl would never make use of it anyway (preferring instead > to match whatever algorithm is used by the http remote). But maybe there > are pending interoperability plans that depend on this?
It was designed to allow indicating that we know how to support both SHA-1 and SHA-256 and we want one or the other (so we don't need to do an expensive conversion). However, if it's not implemented, I agree we should document what's implemented, and then extend it when interop comes.
-- brian m. carlson (he/him or they/them) Toronto, Ontario, CA