summaryrefslogtreecommitdiff
path: root/contrib/completion/git-prompt.sh
diff options
context:
space:
mode:
authorJoe Cridge <joe.cridge@me.com>2015-06-10 17:19:24 (GMT)
committerJunio C Hamano <gitster@pobox.com>2015-06-10 21:53:14 (GMT)
commitab7fade9198e0ab3cc5c8705f0383768a3c954db (patch)
tree819101f84b0391043b9568330e6185ae93bdb3a7 /contrib/completion/git-prompt.sh
parent15a54fb8095502217fce7c7c6dd14e9066b62ebe (diff)
downloadgit-ab7fade9198e0ab3cc5c8705f0383768a3c954db.zip
git-ab7fade9198e0ab3cc5c8705f0383768a3c954db.tar.gz
git-ab7fade9198e0ab3cc5c8705f0383768a3c954db.tar.bz2
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>
Diffstat (limited to 'contrib/completion/git-prompt.sh')
-rw-r--r--contrib/completion/git-prompt.sh4
1 files changed, 4 insertions, 0 deletions
diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
index fb9296b..be5467b 100644
--- a/contrib/completion/git-prompt.sh
+++ b/contrib/completion/git-prompt.sh
@@ -61,6 +61,10 @@
# git always compare HEAD to @{upstream}
# svn always compare HEAD to your SVN upstream
#
+# You can change the separator between the branch name and the above
+# state symbols by setting GIT_PS1_STATESEPARATOR. The default separator
+# is SP.
+#
# By default, __git_ps1 will compare HEAD to your SVN upstream if it can
# find one, or @{upstream} otherwise. Once you have set
# GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by