]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Merge branch 'jc/doc-single-h-is-for-help'
authorJunio C Hamano <gitster@pobox.com>
Wed, 11 Mar 2020 17:58:16 +0000 (10:58 -0700)
committerJunio C Hamano <gitster@pobox.com>
Wed, 11 Mar 2020 17:58:16 +0000 (10:58 -0700)
Both "git ls-remote -h" and "git grep -h" give short usage help,
like any other Git subcommand, but it is not unreasonable to expect
that the former would behave the same as "git ls-remote --head"
(there is no other sensible behaviour for the latter).  The
documentation has been updated in an attempt to clarify this.

* jc/doc-single-h-is-for-help:
  Documentation: clarify that `-h` alone stands for `help`

1  2 
Documentation/git-ls-remote.txt
Documentation/gitcli.txt

index a2ea1fd687e532447328cd919499569ff5d9abfa,c9e68582a422ff1f649c7b7a33aeb2bf5191012b..0a5c8b7d493efd0162774790b4ba1cab67e4c7db
@@@ -28,10 -28,12 +28,12 @@@ OPTION
        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.
+       displayed.  Note that `git ls-remote -h` used without
+       anything else on the command line gives help, consistent
+       with other git subcommands.
  
  --refs::
 -      Do not show peeled tags or pseudorefs like HEAD in the output.
 +      Do not show peeled tags or pseudorefs like `HEAD` in the output.
  
  -q::
  --quiet::
Simple merge