From: Jeff King <peff@peff.net>
To: Jeremy Hetzler <jeremyhetzler@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [bug] 2.39.0: error in help for ls-remote
Date: Tue, 31 Oct 2023 15:09:59 -0400 [thread overview]
Message-ID: <20231031190959.GA875658@coredump.intra.peff.net> (raw)
In-Reply-To: <CAOh4nmm9fTm8fa=1Hyi8t3R-VMnf30-0xe0vcst57dvY-FrL+w@mail.gmail.com>
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
next prev parent reply other threads:[~2023-10-31 19:10 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
[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 [this message]
2023-10-31 23:06 ` Jeremy Hetzler
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231031190959.GA875658@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=jeremyhetzler@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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 NNTP newsgroup(s).