]> git.ipfire.org Git - thirdparty/git.git/commit - Documentation/git-am.txt
Documentation: explain optional arguments better
authorMatthieu Moy <Matthieu.Moy@imag.fr>
Sat, 19 Sep 2015 07:47:50 +0000 (09:47 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 21 Sep 2015 17:48:23 +0000 (10:48 -0700)
commit2b594bf90d84fd96f2b1fe904c1e62e391ceb4a0
tree959671d4d95361422d5bc1952d43e749214df32b
parent318ca61531d3189aef7b32a924518db1dd9f3374
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>
Documentation/git-am.txt
Documentation/git-cherry-pick.txt
Documentation/git-commit-tree.txt
Documentation/git-commit.txt
Documentation/git-grep.txt
Documentation/git-merge.txt
Documentation/git-rebase.txt
Documentation/git-revert.txt
Documentation/git-status.txt