Re: [bug] 2.39.0: error in help for ls-remote

From: Jeremy Hetzler <jeremyhetzler@gmail.com>
Date: Oct 31, 2023, 23:06 UTC
Message-ID: <CAOh4nmmxjS177FhdvaEfqkomxe3Q51AbDQrn0RGz+7GXiqaMFA@mail.gmail.com>
In-Reply-To: <20231031190959.GA875658@coredump.intra.peff.net>

On Tue, Oct 31, 2023 at 3:10 PM Jeff King <peff@peff.net> wrote:

Show 19 quoted lines

>
> It does work as documented with an argument, like:
>
>   git ls-remote -h <remote>
>
> Yes, this is somewhat weird, but is a balance between consistency and
> backwards compatibility. See:
>
>   https://lore.kernel.org/git/YU4QxcORBBR01iV8@coredump.intra.peff.net/
>
> as a starting point for past discussions.
>
> The manpage (or "--help") describes the behavior correctly; it may be
> that the "-h" output could do so as well, but it's sometimes hard to
> communicate such subtleties in such a terse format. So there may be room
> for a patch to make things more clear there, but I think it may be
> difficult to do well.
>
> -Peff

I see.

I would still find it clearer if there were a fuller explanation in the "-h" output, but it's not a big deal. At least I'm not the only one who's been confused :)

Thanks, Jeremy