[PATCH 2/3] ls-remote: remove documentation for custom -h option
- From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
- Date
- Sep 24, 2021, 16:51 UTC
- Message-ID
- <patch-2.3-32b8dbecfe0-20210924T164820Z-avarab@gmail.com>
- In-Reply-To
- <cover-0.3-00000000000-20210924T164820Z-avarab@gmail.com>
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.
Reported-by: Ignacy Gawedzki <ignacy.gawedzki@green-communications.fr> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> --- 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:: --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