summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2020-03-11 17:58:16 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-03-11 17:58:16 (GMT)
commitcdef998b4619cb9acfe2955fcbe9db0ea2f46d33 (patch)
tree4c432e3949bd06dc86934f34cbe7f89c94abe191
parentb4374e96c84ed9394fed363973eb540da308ed4f (diff)
parent1ff466c018692d0ac7c5f30a449632659e87a73b (diff)
downloadgit-cdef998b4619cb9acfe2955fcbe9db0ea2f46d33.zip
git-cdef998b4619cb9acfe2955fcbe9db0ea2f46d33.tar.gz
git-cdef998b4619cb9acfe2955fcbe9db0ea2f46d33.tar.bz2
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`
-rw-r--r--Documentation/git-ls-remote.txt4
-rw-r--r--Documentation/gitcli.txt5
2 files changed, 8 insertions, 1 deletions
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index a2ea1fd..0a5c8b7 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.
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index 373cfa2..92e4ba6 100644
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -126,6 +126,11 @@ usage: git describe [<options>] <commit-ish>*
--long always use long format
--abbrev[=<n>] use <n> digits to display SHA-1s
---------------------------------------------
++
+Note that some subcommand (e.g. `git grep`) may behave differently
+when there are things on the command line other than `-h`, but `git
+subcmd -h` without anything else on the command line is meant to
+consistently give the usage.
--help-all::
Some Git commands take options that are only used for plumbing or that