git-prompt.sh: document GIT_PS1_STATESEPARATOR
The environment variable GIT_PS1_STATESEPARATOR can be used to set the separator between the branch name and the state symbols in the prompt. At present the variable is not mentioned in the inline documentation which makes it difficult for the casual user to identify. Signed-off-by: Joe Cridge <joe.cridge@me.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Joe Cridge committed
Jun 10, 2015 at 18:19 UTC
ab7fade9198e0ab3cc5c8705f0383768a3c954db
1 file changed
+4
contrib/completion/git-prompt.sh
+4
@@ -61,6 +61,10 @@
61
# git always compare HEAD to @{upstream}
62
# svn always compare HEAD to your SVN upstream
63
#
64
+# You can change the separator between the branch name and the above
65
+# state symbols by setting GIT_PS1_STATESEPARATOR. The default separator
66
+# is SP.
67
+#
68
# By default, __git_ps1 will compare HEAD to your SVN upstream if it can
69
# find one, or @{upstream} otherwise. Once you have set
70
# GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by