aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2012-08-16 23:16:22 -0700
committerJunio C Hamano <gitster@pobox.com>2012-08-16 23:16:28 -0700
commit9c81990bdd9277dc791914c1db7dfadbe3592d3a (patch)
tree24a2ff017998af43900df2b9825e83d7a12c66d7
parent785ee4960c3d334cbc2b17ab74d2cebdf1b4db64 (diff)
downloadgit-9c81990bdd9277dc791914c1db7dfadbe3592d3a.tar.gz
git-9c81990bdd9277dc791914c1db7dfadbe3592d3a.tar.xz
gitcli: describe abbreviation of long options
Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/gitcli.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index ea17f7a53..3e72a5d68 100644
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -62,6 +62,14 @@ scripting git:
`git log -1 HEAD` but write `git log -1 HEAD --`; the former will not work
if you happen to have a file called `HEAD` in the work tree.
+ * many commands allow a long option "--option" to be abbreviated
+ only to their unique prefix (e.g. if there is no other option
+ whose name begins with "opt", you may be able to spell "--opt" to
+ invoke the "--option" flag), but you should fully spell them out
+ when writing your scripts; later versions of Git may introduce a
+ new option whose name shares the same prefix, e.g. "--optimize",
+ to make a short prefix that used to be unique no longer unique.
+
ENHANCED OPTION PARSER
----------------------