Re: [PATCH 2/3] ls-remote: remove documentation for custom -h option
From: SZEDER Gábor <hidden>
Date: 2021-09-24 17:11:23
On Fri, Sep 24, 2021 at 06:51:45PM +0200, Ævar Arnfjörð Bjarmason wrote:
The custom handling of the "-h" option was broken in ba5f28bf79e (ls-remote: use parse-options api, 2016-01-19), first released with Git v2.8.0. We've been promising that it's a synonym of --head, but it's not. We could make this work again by supplying the PARSE_OPT_NO_INTERNAL_HELP flag to parse_options(), but if we were writing this command today we wouldn't make this an exception. Since it's been such a long time let's just remove this rather than restoring the exception to "-h" handling.
This breaks the case when '-h' is used in combination with a remote: $ git ls-remote -h origin 225bc32a989d7a22fa6addafd4ce7dcd04675dbf refs/heads/maint ddb1055343948e0d0bc81f8d20245f1ada6430a0 refs/heads/master 4c38ced6901a8523cea197b31b2616240ec9fb6e refs/heads/next ee03ddbf0ea6a78ad9a229bd029408bbff85232e refs/heads/seen 687d33056ee28fd03567f3725150e3fcd0582979 refs/heads/todo
quoted hunk ↗ jump to hunk
Reported-by: Ignacy Gawedzki <redacted> Signed-off-by: Ævar Arnfjörð Bjarmason <redacted> --- Documentation/git-ls-remote.txt | 1 - builtin/ls-remote.c | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-)diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index 492e573856f..6e241640bd9 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt@@ -21,7 +21,6 @@ commit IDs. OPTIONS ------- --h::
The description of this option contains the following: Note that git ls-remote -h used without anything else on the command line gives help, consistent with other git subcommands.
quoted hunk ↗ jump to hunk
--heads:: -t:: --tags::diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c index f4fd823af83..c5e68918b78 100644 --- a/builtin/ls-remote.c +++ b/builtin/ls-remote.c@@ -64,7 +64,7 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix) N_("path of git-upload-pack on the remote host"), PARSE_OPT_HIDDEN }, OPT_BIT('t', "tags", &flags, N_("limit to tags"), REF_TAGS), - OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_HEADS), + OPT_BIT(0, "heads", &flags, N_("limit to heads"), REF_HEADS), OPT_BIT(0, "refs", &flags, N_("do not show peeled tags"), REF_NORMAL), OPT_BOOL(0, "get-url", &get_url, N_("take url.<base>.insteadOf into account")),-- 2.33.0.1285.g7aff81f6560