From 50b03b04c06f44be0d09bcc2b56723e8de985d9a Mon Sep 17 00:00:00 2001 From: Anders Kaseorg Date: Tue, 11 Dec 2012 18:20:24 -0500 Subject: [PATCH] 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 Signed-off-by: Junio C Hamano --- contrib/completion/git-prompt.sh | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh index bf20491ec3..5ab488cd65 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