aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnders Kaseorg <andersk@MIT.EDU>2012-12-11 18:20:24 -0500
committerJunio C Hamano <gitster@pobox.com>2012-12-11 15:36:13 -0800
commit50b03b04c06f44be0d09bcc2b56723e8de985d9a (patch)
treeea0ebd84e1a5d8757171f441a6b20f019324dcc4
parent3e53891f85c58b4adb016a429a1f3b7fae78ca03 (diff)
downloadgit-50b03b04c06f44be0d09bcc2b56723e8de985d9a.tar.gz
git-50b03b04c06f44be0d09bcc2b56723e8de985d9a.tar.xz
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>
-rw-r--r--contrib/completion/git-prompt.sh9
1 files changed, 9 insertions, 0 deletions
diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
index bf20491ec..5ab488cd6 100644
--- a/contrib/completion/git-prompt.sh
+++ b/contrib/completion/git-prompt.sh
@@ -49,6 +49,15 @@
# find one, or @{upstream} otherwise. Once you have set
# GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by
# setting the bash.showUpstream config variable.
+#
+# If you would like to see more information about the identity of
+# commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
+# to one of these values:
+#
+# contains relative to newer annotated tag (v1.6.3.2~35)
+# branch relative to newer tag or branch (master~4)
+# describe relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
+# default exactly matching tag
# __gitdir accepts 0 or 1 arguments (i.e., location)
# returns location of .git repo