diff options
author | Junio C Hamano <gitster@pobox.com> | 2020-03-11 10:58:16 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2020-03-11 10:58:16 -0700 |
commit | cdef998b4619cb9acfe2955fcbe9db0ea2f46d33 (patch) | |
tree | 4c432e3949bd06dc86934f34cbe7f89c94abe191 /Documentation/gitcli.txt | |
parent | Git 2.26-rc1 (diff) | |
parent | Documentation: clarify that `-h` alone stands for `help` (diff) | |
download | tgif-cdef998b4619cb9acfe2955fcbe9db0ea2f46d33.tar.xz |
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/gitcli.txt')
-rw-r--r-- | Documentation/gitcli.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index 373cfa2264..92e4ba6a2f 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 |