* [bug] 2.39.0: error in help for ls-remote
[not found] <CAOh4nmk2KZBTuW9qn_ZgDY3yLRZ6NgGOWuBMLRRm1sU=pdmRoQ@mail.gmail.com>
@ 2023-10-31 18:11 ` Jeremy Hetzler
2023-10-31 19:09 ` Jeff King
0 siblings, 1 reply; 3+ messages in thread
From: Jeremy Hetzler @ 2023-10-31 18:11 UTC (permalink / raw
To: git
All,
The short help for ls-remote advertises that '-h' is short for '--heads':
> usage: git ls-remote [--heads] [--tags] [--refs] [--upload-pack=<exec>]
> [-q | --quiet] [--exit-code] [--get-url] [--sort=<key>]
> [--symref] [<repository> [<refs>...]]
>
>
> -q, --quiet do not print remote URL
> --upload-pack <exec> path of git-upload-pack on the remote host
> -t, --tags limit to tags
> -h, --heads limit to heads
> --refs do not show peeled tags
> --get-url take url.<base>.insteadOf into account
> --sort <key> field name to sort on
> --exit-code exit with exit code 2 if no matching refs are found
> --symref show underlying ref in addition to the object pointed by it
> -o, --server-option <server-specific>
> option to transmit
However, 'git ls-remote -h' instead prints the help. So perhaps the
help message should be revised.
git version 2.39.0
Thanks,
Jeremy
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [bug] 2.39.0: error in help for ls-remote
2023-10-31 18:11 ` [bug] 2.39.0: error in help for ls-remote Jeremy Hetzler
@ 2023-10-31 19:09 ` Jeff King
2023-10-31 23:06 ` Jeremy Hetzler
0 siblings, 1 reply; 3+ messages in thread
From: Jeff King @ 2023-10-31 19:09 UTC (permalink / raw
To: Jeremy Hetzler; +Cc: git
On Tue, Oct 31, 2023 at 02:11:23PM -0400, Jeremy Hetzler wrote:
> The short help for ls-remote advertises that '-h' is short for '--heads':
> [...]
> However, 'git ls-remote -h' instead prints the help. So perhaps the
> help message should be revised.
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [bug] 2.39.0: error in help for ls-remote
2023-10-31 19:09 ` Jeff King
@ 2023-10-31 23:06 ` Jeremy Hetzler
0 siblings, 0 replies; 3+ messages in thread
From: Jeremy Hetzler @ 2023-10-31 23:06 UTC (permalink / raw
To: Jeff King; +Cc: git
On Tue, Oct 31, 2023 at 3:10 PM Jeff King <peff@peff.net> wrote:
>
> 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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-10-31 23:07 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <CAOh4nmk2KZBTuW9qn_ZgDY3yLRZ6NgGOWuBMLRRm1sU=pdmRoQ@mail.gmail.com>
2023-10-31 18:11 ` [bug] 2.39.0: error in help for ls-remote Jeremy Hetzler
2023-10-31 19:09 ` Jeff King
2023-10-31 23:06 ` Jeremy Hetzler
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).