git-prompt.sh: document GIT_PS1_STATESEPARATOR

diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
index eaf5c369aacde207cbad4c9df9574e7b26634bb7..be5467bb45d2c77baa261df7c1fb0f0985dafec6 100644 (file)
--- 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
@@ -359,6 +363,7 @@ __git_ps1 ()
                        fi
                fi
 
+               local z="${GIT_PS1_STATESEPARATOR-" "}"
                local f="$w$i$s$u"
                if [ $pcmode = yes ]; then
                        local gitstring=
@@ -384,7 +389,7 @@ __git_ps1 ()
                                gitstring="\[$branch_color\]$branchstring\[$c_clear\]"
 
                                if [ -n "$w$i$s$u$r$p" ]; then
-                                       gitstring="$gitstring "
+                                       gitstring="$gitstring$z"
                                fi
                                if [ "$w" = "*" ]; then
                                        gitstring="$gitstring\[$bad_color\]$w"
@@ -400,13 +405,13 @@ __git_ps1 ()
                                fi
                                gitstring="$gitstring\[$c_clear\]$r$p"
                        else
-                               gitstring="$c${b##refs/heads/}${f:+ $f}$r$p"
+                               gitstring="$c${b##refs/heads/}${f:+$z$f}$r$p"
                        fi
                        gitstring=$(printf -- "$printf_format" "$gitstring")
                        PS1="$ps1pc_start$gitstring$ps1pc_end"
                else
                        # NO color option unless in PROMPT_COMMAND mode
-                       printf -- "$printf_format" "$c${b##refs/heads/}${f:+ $f}$r$p"
+                       printf -- "$printf_format" "$c${b##refs/heads/}${f:+$z$f}$r$p"
                fi
        fi
 }