summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoe Cridge <joe.cridge@me.com>2015-06-10 18:19:24 +0100
committerJunio C Hamano <gitster@pobox.com>2015-06-10 14:53:14 -0700
commitab7fade9198e0ab3cc5c8705f0383768a3c954db (patch)
tree819101f84b0391043b9568330e6185ae93bdb3a7
parent15a54fb8095502217fce7c7c6dd14e9066b62ebe (diff)
downloadgit-jc/prompt-document-ps1-state-separator.tar.gz
git-prompt.sh: document GIT_PS1_STATESEPARATORjc/prompt-document-ps1-state-separator
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>
-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 fb9296ba3d..be5467bb45 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