summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2012-10-17 17:28:34 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-10-17 17:28:34 (GMT)
commit352611fc2c3b6f833910043687ed441bf3fb79df (patch)
tree65a6bad14e1386d0145bdc50ef4da7880d58e907
parent26c21f8ec65f296a7395c00e6ab0ca252912d1b2 (diff)
parent30462a7483c0acf77fab6364a3f505d16b650f21 (diff)
downloadgit-352611fc2c3b6f833910043687ed441bf3fb79df.zip
git-352611fc2c3b6f833910043687ed441bf3fb79df.tar.gz
git-352611fc2c3b6f833910043687ed441bf3fb79df.tar.bz2
Merge branch 'jc/doc-long-options' into maint
* jc/doc-long-options: gitcli: parse-options lets you omit tail of long options
-rw-r--r--Documentation/gitcli.txt12
1 files changed, 11 insertions, 1 deletions
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index f6ba90c..3bc1500 100644
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -93,7 +93,7 @@ ENHANCED OPTION PARSER
From the git 1.5.4 series and further, many git commands (not all of them at the
time of the writing though) come with an enhanced option parser.
-Here is an exhaustive list of the facilities provided by this option parser.
+Here is a list of the facilities provided by this option parser.
Magic Options
@@ -137,6 +137,16 @@ options. This means that you can for example use `git rm -rf` or
`git clean -fdx`.
+Abbreviating long options
+~~~~~~~~~~~~~~~~~~~~~~~~~
+Commands that support the enhanced option parser accepts unique
+prefix of a long option as if it is fully spelled out, but use this
+with a caution. For example, `git commit --amen` behaves as if you
+typed `git commit --amend`, but that is true only until a later version
+of Git introduces another option that shares the same prefix,
+e.g `git commit --amenity" option.
+
+
Separating argument from the option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can write the mandatory option parameter to an option as a separate