diff options
| author | Matthieu Moy <Matthieu.Moy@imag.fr> | 2015-09-19 09:47:50 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2015-09-21 10:48:23 -0700 |
| commit | 2b594bf90d84fd96f2b1fe904c1e62e391ceb4a0 (patch) | |
| tree | 959671d4d95361422d5bc1952d43e749214df32b /Documentation/git-commit-tree.txt | |
| parent | 318ca61531d3189aef7b32a924518db1dd9f3374 (diff) | |
| download | git-2b594bf90d84fd96f2b1fe904c1e62e391ceb4a0.tar.gz | |
Documentation: explain optional arguments better
Improve the documentation of commands taking optional arguments in two
ways:
* Documents the behavior of '-O' (for grep) and '-S' (for commands
creating commits) when used without the optional argument.
* Document the syntax of these options.
For the second point, the behavior is documented in gitcli(7), but it is
easy for users to miss, and hard for the same user to understand why e.g.
"git status -u no" does not work.
Document this explicitly in the documentation of each short option having
an optional argument: they are the most error prone since there is no '='
sign between the option and its argument.
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Reviewed-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-commit-tree.txt')
| -rw-r--r-- | Documentation/git-commit-tree.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index f5f2a8d326..a0b5457304 100644 --- a/Documentation/git-commit-tree.txt +++ b/Documentation/git-commit-tree.txt @@ -56,7 +56,9 @@ OPTIONS -S[<keyid>]:: --gpg-sign[=<keyid>]:: - GPG-sign commit. + GPG-sign commits. The `keyid` argument is optional and + defaults to the committer identity; if specified, it must be + stuck to the option without a space. --no-gpg-sign:: Countermand `commit.gpgSign` configuration variable that is |