git-prompt: Document GIT_PS1_DESCRIBE_STYLE
GIT_PS1_DESCRIBE_STYLE was introduced in v1.6.3.2~35. Document it in the header comments. Signed-off-by: Anders Kaseorg <andersk@mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Anders Kaseorg committed
Dec 11, 2012 at 18:20 UTC
50b03b04c06f44be0d09bcc2b56723e8de985d9a
1 file changed
+9
contrib/completion/git-prompt.sh
+9
@@ -49,6 +49,15 @@
49
# find one, or @{upstream} otherwise. Once you have set
50
# GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by
51
# setting the bash.showUpstream config variable.
52
+#
53
+# If you would like to see more information about the identity of
54
+# commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
55
+# to one of these values:
56
+#
57
+# contains relative to newer annotated tag (v1.6.3.2~35)
58
+# branch relative to newer tag or branch (master~4)
59
+# describe relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
60
+# default exactly matching tag
61
62
# __gitdir accepts 0 or 1 arguments (i.e., location)
63
# returns location of .git repo