Re: [PATCH] git-prompt.sh: Document GIT_PS1_STATESEPARATOR

From: Joe Cridge <joe.cridge@me.com>
Date: Jun 16, 2015, 14:27 UTC
Message-ID: <0C3610F1-72BD-4C70-A1B9-9F352E7084BE@me.com>
In-Reply-To: <20150616153238.Horde.tGSXailmVRSmoEen3NAoPw4@webmail.informatik.kit.edu>

Quoting SZEDER Gábor <szeder@ira.uka.de>:

Show 13 quoted lines

>> diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
>> index f18aedc..366f0bc 100644
>> --- a/contrib/completion/git-prompt.sh
>> +++ b/contrib/completion/git-prompt.sh
>> @@ -66,6 +66,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.
> 
> This is not a specification of a protocol or file or input/output format, where we formally use SP and LF.  Perhaps we could spell out SP as a space here, for the sake of the "casual user"?

Yes, I agree. Would it also be worth changing lines 25 and 29?

@@ 18,12 @@ # 3b) Alternatively, for a slightly faster prompt, __git_ps1 can # be used for PROMPT_COMMAND in Bash or for precmd() in Zsh # with two parameters, <pre> and <post>, which are strings # you would put in $PS1 before and after the status string # generated by the git-prompt machinery. e.g. # Bash: PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "' # will show username, at-sign, host, colon, cwd, then # various status string, followed by dollar and SP, as # your prompt. # ZSH: precmd () { __git_ps1 "%n" ":%~$ " "|%s" } # will show username, pipe, then various status string, # followed by colon, cwd, dollar and SP, as your prompt.