Bug: "git-remote ls -h"

Bug: "git-remote ls -h"

[Ian Whitlock]

Hi,

I found a bug and couldn't find another way to report it. I hope this is okay.
The help output for `git ls-remote` shows that `-h` should display remote HEADs, but instead the help output is displayed!

 ➜ git ls-remote -h     
usage: git ls-remote [--heads] [--tags] [--refs] [--upload-pack=<exec>]
                     [-q | --quiet] [--exit-code] [--get-url]
                     [--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


Small bug, but a bug nonetheless.

Thanks for building such a lovely tool

Re: Bug: "git-remote ls -h"

[Eric Sunshine]

On Wed, Jun 29, 2022 at 11:39 AM Ian Whitlock <ian@theknown.net> wrote:
> I found a bug and couldn't find another way to report it. I hope this is okay.
> The help output for `git ls-remote` shows that `-h` should display remote HEADs, but instead the help output is displayed!

Thanks for the report.

>  ➜ git ls-remote -h
> usage: git ls-remote [--heads] [--tags] [--refs] [--upload-pack=<exec>]
>                      [-q | --quiet] [--exit-code] [--get-url]
>                      [--symref] [<repository> [<refs>...]]

This is a known and documented behavior. The description of the `-h`
option in the `ls-remote` help page:

    Limit to only refs/heads and refs/tags, respectively. These
    options are not mutually exclusive; when given both, references
    stored in refs/heads and refs/tags are displayed. Note that git
    ls-remote -h used without anything else on the command line gives
    help, consistent with other git subcommands.

Re: Bug: "git-remote ls -h"

[Junio C Hamano]

Eric Sunshine <sunshine@sunshineco.com> writes:

> On Wed, Jun 29, 2022 at 11:39 AM Ian Whitlock <ian@theknown.net> wrote:
>> I found a bug and couldn't find another way to report it. I hope this is okay.
>> The help output for `git ls-remote` shows that `-h` should display remote HEADs, but instead the help output is displayed!
>
> Thanks for the report.
>
>>  ➜ git ls-remote -h
>> usage: git ls-remote [--heads] [--tags] [--refs] [--upload-pack=<exec>]
>>                      [-q | --quiet] [--exit-code] [--get-url]
>>                      [--symref] [<repository> [<refs>...]]
>
> This is a known and documented behavior. The description of the `-h`
> option in the `ls-remote` help page:
>
>     Limit to only refs/heads and refs/tags, respectively. These
>     options are not mutually exclusive; when given both, references
>     stored in refs/heads and refs/tags are displayed. Note that git
>     ls-remote -h used without anything else on the command line gives
>     help, consistent with other git subcommands.

Correct.

I do not mind a patch that teaches ls-remote to emit an extra line
of hint after giving the standard short-help-usage text, telling the
user that "git ls-remote -h origin" (replace 'origin' with whatever
the default remote is) can be used to learn the branches at the
remote.

Thanks.