From: Junio C Hamano <gitster@pobox.com>
Date: Fri, 17 Aug 2012 06:16:22 +0000 (-0700)
Subject: gitcli: describe abbreviation of long options
X-Git-Tag: v1.7.11.6~26^2
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/9c81990bdd9277dc791914c1db7dfadbe3592d3a?ds=sidebyside;hp=-c

gitcli: describe abbreviation of long options

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

9c81990bdd9277dc791914c1db7dfadbe3592d3a
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index ea17f7a53b..3e72a5d68e 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
 ----------------------