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

From: SZEDER Gábor <szeder@ira.uka.de>
Date: Jun 16, 2015, 13:32 UTC
Message-ID: <20150616153238.Horde.tGSXailmVRSmoEen3NAoPw4@webmail.informatik.kit.edu>
In-Reply-To: <1433956764-38130-1-git-send-email-joe.cridge@me.com>

Quoting Joe Cridge <joe.cridge@me.com>:

Show 5 quoted lines

> 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.

Thanks, makes sense.

Show 17 quoted lines

> Signed-off-by: Joe Cridge <joe.cridge@me.com>
> ---
>  contrib/completion/git-prompt.sh | 4 ++++
>  1 file changed, 4 insertions(+)
>
> 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"?

Show 6 quoted lines

> +#
>  # 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
> --
> 2.4.2