summaryrefslogtreecommitdiffstats
path: root/Documentation/git-ls-remote.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2020-03-11 18:58:16 +0100
committerJunio C Hamano <gitster@pobox.com>2020-03-11 18:58:16 +0100
commitcdef998b4619cb9acfe2955fcbe9db0ea2f46d33 (patch)
tree4c432e3949bd06dc86934f34cbe7f89c94abe191 /Documentation/git-ls-remote.txt
parentGit 2.26-rc1 (diff)
parentDocumentation: clarify that `-h` alone stands for `help` (diff)
downloadgit-cdef998b4619cb9acfe2955fcbe9db0ea2f46d33.tar.xz
git-cdef998b4619cb9acfe2955fcbe9db0ea2f46d33.zip
Merge branch 'jc/doc-single-h-is-for-help'
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`
Diffstat (limited to 'Documentation/git-ls-remote.txt')
-rw-r--r--Documentation/git-ls-remote.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index a2ea1fd687..0a5c8b7d49 100644
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -28,7 +28,9 @@ OPTIONS
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.