summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2012-08-22 11:53:25 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2012-08-22 11:53:25 -0700
commit210106b4255b0ec314d160fef15bb38af119e4f3 (patch)
treed3f3453fcd0468f60813e64c666881d03d23371e
parentMerge branch 'jc/maint-rev-list-topo-doc' (diff)
parentgitcli: describe abbreviation of long options (diff)
downloadtgif-210106b4255b0ec314d160fef15bb38af119e4f3.tar.xz
Merge branch 'jc/maint-abbrev-option-cli'
We did not document that many commands take unique prefix abbreviations of long options (e.g. "--option" may be the only flag that the command accepts that begin with "--opt", in which case you can give "--opt") anywhere easy to find for new people. * jc/maint-abbrev-option-cli: gitcli: describe abbreviation of long options
-rw-r--r--Documentation/gitcli.txt8
1 files changed, 8 insertions, 0 deletions
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
----------------------