gitcli: describe abbreviation of long options
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Aug 16, 2012 at 23:16 UTC
9c81990bdd9277dc791914c1db7dfadbe3592d3a
1 file changed
+8
Documentation/gitcli.txt
+8
@@ -62,6 +62,14 @@ scripting git:
62
`git log -1 HEAD` but write `git log -1 HEAD --`; the former will not work
63
if you happen to have a file called `HEAD` in the work tree.
64
65
+ * many commands allow a long option "--option" to be abbreviated
66
+ only to their unique prefix (e.g. if there is no other option
67
+ whose name begins with "opt", you may be able to spell "--opt" to
68
+ invoke the "--option" flag), but you should fully spell them out
69
+ when writing your scripts; later versions of Git may introduce a
70
+ new option whose name shares the same prefix, e.g. "--optimize",
71
+ to make a short prefix that used to be unique no longer unique.
72
+
73
74
ENHANCED OPTION PARSER
75
----------------------