Skip to content

Commit 50b03b0

Browse files
anderskgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 3e53891 commit 50b03b0

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

contrib/completion/git-prompt.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,15 @@
4949
# find one, or @{upstream} otherwise. Once you have set
5050
# GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by
5151
# 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
5261

5362
# __gitdir accepts 0 or 1 arguments (i.e., location)
5463
# returns location of .git repo

0 commit comments

Comments
 (0)